From 53dc843a45bb963f7a880f5f7973107d5b1fb99c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Thu, 25 Apr 2024 14:26:03 -0300 Subject: [PATCH 01/28] add typedoc, test doc generation --- package-lock.json | 4 +--- package.json | 2 ++ typedoc.json | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index b35dc857b..7ed3a6b62 100644 --- a/package-lock.json +++ b/package-lock.json @@ -97,6 +97,7 @@ "streamx": "^2.15.1", "tempy": "^3.1.0", "ts-proto": "^1.156.7", + "typedoc": "^0.25.13", "typescript": "^5.4.5" } }, @@ -8831,7 +8832,6 @@ "version": "0.25.13", "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.13.tgz", "integrity": "sha512-pQqiwiJ+Z4pigfOnnysObszLiU3mVLWAExSPf+Mu06G/qsc3wzbuM56SZQvONhHLncLUhYzOVkjFFpFfL5AzhQ==", - "peer": true, "dependencies": { "lunr": "^2.3.9", "marked": "^4.3.0", @@ -8862,7 +8862,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "peer": true, "dependencies": { "balanced-match": "^1.0.0" } @@ -8871,7 +8870,6 @@ "version": "9.0.4", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", - "peer": true, "dependencies": { "brace-expansion": "^2.0.1" }, diff --git a/package.json b/package.json index e59824c46..ddfc10a58 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "build:types": "tsc -p tsconfig.npm.json && cpy 'src/**/*.d.ts' dist", "bench": "nanobench benchmarks/*.js", "type": "tsc", + "doc": "typedoc", "protobuf": "node ./scripts/build-messages.js", "db:generate:project": "drizzle-kit generate:sqlite --schema src/schema/project.js --out drizzle/project", "db:generate:client": "drizzle-kit generate:sqlite --schema src/schema/client.js --out drizzle/client", @@ -116,6 +117,7 @@ "streamx": "^2.15.1", "tempy": "^3.1.0", "ts-proto": "^1.156.7", + "typedoc": "^0.25.13", "typescript": "^5.4.5" }, "dependencies": { diff --git a/typedoc.json b/typedoc.json index a1bd45a02..99b684530 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { - "entryPoints": ["./index.js", "./src/**/*.js"], - "allReflectionsHaveOwnDocument": true, + "entryPoints": ["src/**/*.js", "src/**/*.ts"], + "out": "docs/api", "cleanOutputDir": false, "readme": "none", "name": "API", From 27196f7490196642e5fec20f0f2f230eb07529b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Thu, 25 Apr 2024 14:34:24 -0300 Subject: [PATCH 02/28] add markdown plugin, add md rendered docs --- .prettierignore | 3 +- docs/api/.nojekyll | 1 + docs/api/README.md | 62 +++ docs/api/classes/blob_api.BlobApi.md | 87 ++++ docs/api/classes/blob_store.BlobStore.md | 281 +++++++++++ ...b_store_live_download.DriveLiveDownload.md | 66 +++ .../blob_store_live_download.LiveDownload.md | 67 +++ docs/api/classes/core_manager.CoreManager.md | 321 +++++++++++++ .../core_manager_core_index.CoreIndex.md | 161 +++++++ ...m_access_file_pool.RandomAccessFilePool.md | 105 ++++ .../core_manager_remote_bitfield.default.md | 307 ++++++++++++ .../classes/core_ownership.CoreOwnership.md | 84 ++++ docs/api/classes/datastore.DataStore.md | 251 ++++++++++ docs/api/classes/datatype-1.DataType.md | 278 +++++++++++ docs/api/classes/datatype.DataType.md | 280 +++++++++++ ...iscovery_local_discovery.LocalDiscovery.md | 160 +++++++ .../fastify_controller.FastifyController.md | 86 ++++ docs/api/classes/icon_api.IconApi.md | 104 ++++ docs/api/classes/index_writer.IndexWriter.md | 92 ++++ docs/api/classes/invite_api.InviteApi.md | 129 +++++ docs/api/classes/lib_hashmap.default.md | 197 ++++++++ docs/api/classes/local_peers.LocalPeers.md | 198 ++++++++ .../local_peers.PeerDisconnectedError.md | 59 +++ .../local_peers.PeerFailedConnectionError.md | 59 +++ .../classes/local_peers.UnknownPeerError.md | 59 +++ docs/api/classes/logger.Logger.md | 133 ++++++ .../api/classes/mapeo_manager.MapeoManager.md | 377 +++++++++++++++ .../api/classes/mapeo_project.MapeoProject.md | 449 ++++++++++++++++++ docs/api/classes/member_api.MemberApi.md | 164 +++++++ docs/api/classes/roles.Roles.md | 125 +++++ .../sync_core_sync_state.CoreSyncState.md | 166 +++++++ ...namespace_sync_state.NamespaceSyncState.md | 104 ++++ ...peer_sync_controller.PeerSyncController.md | 145 ++++++ docs/api/classes/sync_sync_api.SyncApi.md | 156 ++++++ docs/api/classes/sync_sync_state.SyncState.md | 85 ++++ docs/api/classes/utils.ExhaustivenessError.md | 59 +++ ..._store_live_download.BlobDownloadEvents.md | 37 ++ ...b_store_live_download.BlobDownloadState.md | 86 ++++ docs/api/interfaces/core_manager.Events.md | 65 +++ docs/api/interfaces/core_manager.HaveMsg.md | 54 +++ .../interfaces/datatype-1.DataTypeEvents.md | 41 ++ .../api/interfaces/datatype.DataTypeEvents.md | 41 ++ ...scovery_local_discovery.DiscoveryEvents.md | 35 ++ .../fastify_controller.StartOpts.md | 32 ++ ...tify_plugins_blobs.BlobServerPluginOpts.md | 35 ++ ...tify_plugins_icons.IconServerPluginOpts.md | 35 ++ .../fastify_plugins_maps.MapsPluginContext.md | 29 ++ .../fastify_plugins_maps.MapsPluginOpts.md | 32 ++ ...fallback_map.FallbackMapPluginDecorator.md | 54 +++ ...llback_map.OfflineFallbackMapPluginOpts.md | 43 ++ ...s_static_maps.StaticMapsPluginDecorator.md | 61 +++ ...s_maps_static_maps.StaticMapsPluginOpts.md | 32 ++ .../generated_extensions.HaveExtension.md | 54 +++ .../generated_extensions.ProjectExtension.md | 76 +++ .../generated_keys.EncryptionKeys.md | 65 +++ .../interfaces/generated_keys.ProjectKeys.md | 43 ++ .../interfaces/generated_rpc.DeviceInfo.md | 32 ++ docs/api/interfaces/icon_api.BitmapOpts.md | 43 ++ docs/api/interfaces/icon_api.SvgOpts.md | 32 ++ .../interfaces/invite_api.InviteApiEvents.md | 61 +++ .../api/interfaces/invite_api.InviteCancel.md | 21 + .../interfaces/invite_api.InviteRpcMessage.md | 76 +++ .../invite_api.ProjectJoinDetails.md | 43 ++ .../local_peers.LocalPeersEvents.md | 204 ++++++++ .../interfaces/local_peers.PeerInfoBase.md | 43 ++ .../mapeo_manager.MapeoManagerEvents.md | 37 ++ .../interfaces/member_api.InviteResponse.md | 32 ++ docs/api/interfaces/member_api.MemberInfo.md | 54 +++ docs/api/interfaces/roles.DocCapability.md | 62 +++ docs/api/interfaces/roles.Role.md | 71 +++ .../interfaces/schema_client.ProjectInfo.md | 21 + .../sync_core_sync_state.CoreState.md | 62 +++ .../sync_core_sync_state.DerivedState.md | 49 ++ .../sync_core_sync_state.InternalState.md | 67 +++ docs/api/interfaces/sync_sync_api.State.md | 49 ++ .../interfaces/sync_sync_api.SyncEvents.md | 35 ++ .../interfaces/sync_sync_api.SyncTypeState.md | 88 ++++ docs/api/modules/blob_api.md | 34 ++ docs/api/modules/blob_store.md | 55 +++ docs/api/modules/blob_store_live_download.md | 58 +++ docs/api/modules/config_import.md | 72 +++ docs/api/modules/constants.md | 19 + docs/api/modules/core_manager.md | 70 +++ docs/api/modules/core_manager_bitfield_rle.md | 96 ++++ docs/api/modules/core_manager_compat.md | 19 + docs/api/modules/core_manager_core_index.md | 42 ++ .../core_manager_random_access_file_pool.md | 9 + .../modules/core_manager_remote_bitfield.md | 23 + docs/api/modules/core_ownership.md | 86 ++++ docs/api/modules/datastore.md | 69 +++ docs/api/modules/datatype-1.md | 133 ++++++ docs/api/modules/datatype.md | 142 ++++++ docs/api/modules/discovery_local_discovery.md | 59 +++ docs/api/modules/fastify_controller.md | 13 + docs/api/modules/fastify_plugins_blobs.md | 44 ++ docs/api/modules/fastify_plugins_constants.md | 30 ++ docs/api/modules/fastify_plugins_icons.md | 34 ++ docs/api/modules/fastify_plugins_maps.md | 60 +++ ...stify_plugins_maps_offline_fallback_map.md | 49 ++ .../fastify_plugins_maps_static_maps.md | 49 ++ docs/api/modules/fastify_plugins_utils.md | 73 +++ docs/api/modules/generated_extensions.md | 142 ++++++ docs/api/modules/generated_keys.md | 57 +++ docs/api/modules/generated_rpc.md | 225 +++++++++ docs/api/modules/icon_api.md | 116 +++++ docs/api/modules/index.md | 43 ++ docs/api/modules/index_writer.md | 47 ++ docs/api/modules/invite_api.md | 121 +++++ docs/api/modules/lib_hashmap.md | 23 + docs/api/modules/lib_ponyfills.md | 33 ++ docs/api/modules/lib_string.md | 31 ++ docs/api/modules/lib_timing_safe_equal.md | 43 ++ docs/api/modules/local_peers.md | 86 ++++ docs/api/modules/logger.md | 9 + docs/api/modules/mapeo_manager.md | 63 +++ docs/api/modules/mapeo_project.md | 103 ++++ docs/api/modules/member_api.md | 74 +++ docs/api/modules/roles.md | 247 ++++++++++ docs/api/modules/schema_client.md | 70 +++ docs/api/modules/schema_project.md | 217 +++++++++ docs/api/modules/schema_schema_to_drizzle.md | 54 +++ docs/api/modules/schema_types.md | 92 ++++ docs/api/modules/schema_utils.md | 117 +++++ docs/api/modules/sync_core_sync_state.md | 78 +++ docs/api/modules/sync_namespace_sync_state.md | 57 +++ docs/api/modules/sync_peer_sync_controller.md | 80 ++++ docs/api/modules/sync_sync_api.md | 54 +++ docs/api/modules/sync_sync_state.md | 23 + docs/api/modules/types.md | 241 ++++++++++ docs/api/modules/utils.md | 416 ++++++++++++++++ docs/api/modules/utils_types.md | 60 +++ package-lock.json | 6 +- package.json | 3 +- 133 files changed, 11957 insertions(+), 4 deletions(-) create mode 100644 docs/api/.nojekyll create mode 100644 docs/api/README.md create mode 100644 docs/api/classes/blob_api.BlobApi.md create mode 100644 docs/api/classes/blob_store.BlobStore.md create mode 100644 docs/api/classes/blob_store_live_download.DriveLiveDownload.md create mode 100644 docs/api/classes/blob_store_live_download.LiveDownload.md create mode 100644 docs/api/classes/core_manager.CoreManager.md create mode 100644 docs/api/classes/core_manager_core_index.CoreIndex.md create mode 100644 docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md create mode 100644 docs/api/classes/core_manager_remote_bitfield.default.md create mode 100644 docs/api/classes/core_ownership.CoreOwnership.md create mode 100644 docs/api/classes/datastore.DataStore.md create mode 100644 docs/api/classes/datatype-1.DataType.md create mode 100644 docs/api/classes/datatype.DataType.md create mode 100644 docs/api/classes/discovery_local_discovery.LocalDiscovery.md create mode 100644 docs/api/classes/fastify_controller.FastifyController.md create mode 100644 docs/api/classes/icon_api.IconApi.md create mode 100644 docs/api/classes/index_writer.IndexWriter.md create mode 100644 docs/api/classes/invite_api.InviteApi.md create mode 100644 docs/api/classes/lib_hashmap.default.md create mode 100644 docs/api/classes/local_peers.LocalPeers.md create mode 100644 docs/api/classes/local_peers.PeerDisconnectedError.md create mode 100644 docs/api/classes/local_peers.PeerFailedConnectionError.md create mode 100644 docs/api/classes/local_peers.UnknownPeerError.md create mode 100644 docs/api/classes/logger.Logger.md create mode 100644 docs/api/classes/mapeo_manager.MapeoManager.md create mode 100644 docs/api/classes/mapeo_project.MapeoProject.md create mode 100644 docs/api/classes/member_api.MemberApi.md create mode 100644 docs/api/classes/roles.Roles.md create mode 100644 docs/api/classes/sync_core_sync_state.CoreSyncState.md create mode 100644 docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md create mode 100644 docs/api/classes/sync_peer_sync_controller.PeerSyncController.md create mode 100644 docs/api/classes/sync_sync_api.SyncApi.md create mode 100644 docs/api/classes/sync_sync_state.SyncState.md create mode 100644 docs/api/classes/utils.ExhaustivenessError.md create mode 100644 docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md create mode 100644 docs/api/interfaces/blob_store_live_download.BlobDownloadState.md create mode 100644 docs/api/interfaces/core_manager.Events.md create mode 100644 docs/api/interfaces/core_manager.HaveMsg.md create mode 100644 docs/api/interfaces/datatype-1.DataTypeEvents.md create mode 100644 docs/api/interfaces/datatype.DataTypeEvents.md create mode 100644 docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md create mode 100644 docs/api/interfaces/fastify_controller.StartOpts.md create mode 100644 docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md create mode 100644 docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md create mode 100644 docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md create mode 100644 docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md create mode 100644 docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md create mode 100644 docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md create mode 100644 docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md create mode 100644 docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md create mode 100644 docs/api/interfaces/generated_extensions.HaveExtension.md create mode 100644 docs/api/interfaces/generated_extensions.ProjectExtension.md create mode 100644 docs/api/interfaces/generated_keys.EncryptionKeys.md create mode 100644 docs/api/interfaces/generated_keys.ProjectKeys.md create mode 100644 docs/api/interfaces/generated_rpc.DeviceInfo.md create mode 100644 docs/api/interfaces/icon_api.BitmapOpts.md create mode 100644 docs/api/interfaces/icon_api.SvgOpts.md create mode 100644 docs/api/interfaces/invite_api.InviteApiEvents.md create mode 100644 docs/api/interfaces/invite_api.InviteCancel.md create mode 100644 docs/api/interfaces/invite_api.InviteRpcMessage.md create mode 100644 docs/api/interfaces/invite_api.ProjectJoinDetails.md create mode 100644 docs/api/interfaces/local_peers.LocalPeersEvents.md create mode 100644 docs/api/interfaces/local_peers.PeerInfoBase.md create mode 100644 docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md create mode 100644 docs/api/interfaces/member_api.InviteResponse.md create mode 100644 docs/api/interfaces/member_api.MemberInfo.md create mode 100644 docs/api/interfaces/roles.DocCapability.md create mode 100644 docs/api/interfaces/roles.Role.md create mode 100644 docs/api/interfaces/schema_client.ProjectInfo.md create mode 100644 docs/api/interfaces/sync_core_sync_state.CoreState.md create mode 100644 docs/api/interfaces/sync_core_sync_state.DerivedState.md create mode 100644 docs/api/interfaces/sync_core_sync_state.InternalState.md create mode 100644 docs/api/interfaces/sync_sync_api.State.md create mode 100644 docs/api/interfaces/sync_sync_api.SyncEvents.md create mode 100644 docs/api/interfaces/sync_sync_api.SyncTypeState.md create mode 100644 docs/api/modules/blob_api.md create mode 100644 docs/api/modules/blob_store.md create mode 100644 docs/api/modules/blob_store_live_download.md create mode 100644 docs/api/modules/config_import.md create mode 100644 docs/api/modules/constants.md create mode 100644 docs/api/modules/core_manager.md create mode 100644 docs/api/modules/core_manager_bitfield_rle.md create mode 100644 docs/api/modules/core_manager_compat.md create mode 100644 docs/api/modules/core_manager_core_index.md create mode 100644 docs/api/modules/core_manager_random_access_file_pool.md create mode 100644 docs/api/modules/core_manager_remote_bitfield.md create mode 100644 docs/api/modules/core_ownership.md create mode 100644 docs/api/modules/datastore.md create mode 100644 docs/api/modules/datatype-1.md create mode 100644 docs/api/modules/datatype.md create mode 100644 docs/api/modules/discovery_local_discovery.md create mode 100644 docs/api/modules/fastify_controller.md create mode 100644 docs/api/modules/fastify_plugins_blobs.md create mode 100644 docs/api/modules/fastify_plugins_constants.md create mode 100644 docs/api/modules/fastify_plugins_icons.md create mode 100644 docs/api/modules/fastify_plugins_maps.md create mode 100644 docs/api/modules/fastify_plugins_maps_offline_fallback_map.md create mode 100644 docs/api/modules/fastify_plugins_maps_static_maps.md create mode 100644 docs/api/modules/fastify_plugins_utils.md create mode 100644 docs/api/modules/generated_extensions.md create mode 100644 docs/api/modules/generated_keys.md create mode 100644 docs/api/modules/generated_rpc.md create mode 100644 docs/api/modules/icon_api.md create mode 100644 docs/api/modules/index.md create mode 100644 docs/api/modules/index_writer.md create mode 100644 docs/api/modules/invite_api.md create mode 100644 docs/api/modules/lib_hashmap.md create mode 100644 docs/api/modules/lib_ponyfills.md create mode 100644 docs/api/modules/lib_string.md create mode 100644 docs/api/modules/lib_timing_safe_equal.md create mode 100644 docs/api/modules/local_peers.md create mode 100644 docs/api/modules/logger.md create mode 100644 docs/api/modules/mapeo_manager.md create mode 100644 docs/api/modules/mapeo_project.md create mode 100644 docs/api/modules/member_api.md create mode 100644 docs/api/modules/roles.md create mode 100644 docs/api/modules/schema_client.md create mode 100644 docs/api/modules/schema_project.md create mode 100644 docs/api/modules/schema_schema_to_drizzle.md create mode 100644 docs/api/modules/schema_types.md create mode 100644 docs/api/modules/schema_utils.md create mode 100644 docs/api/modules/sync_core_sync_state.md create mode 100644 docs/api/modules/sync_namespace_sync_state.md create mode 100644 docs/api/modules/sync_peer_sync_controller.md create mode 100644 docs/api/modules/sync_sync_api.md create mode 100644 docs/api/modules/sync_sync_state.md create mode 100644 docs/api/modules/types.md create mode 100644 docs/api/modules/utils.md create mode 100644 docs/api/modules/utils_types.md diff --git a/.prettierignore b/.prettierignore index 110243302..d97c24ba5 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,4 +2,5 @@ /drizzle/*/meta/ /src/generated/ *.snapshot.cjs -/tests/fixtures/ \ No newline at end of file +/tests/fixtures/ +/docs/* diff --git a/docs/api/.nojekyll b/docs/api/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/docs/api/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 000000000..6d371a183 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,62 @@ +API + +# API + +## Table of contents + +### Modules + +- [blob-api](modules/blob_api.md) +- [blob-store](modules/blob_store.md) +- [blob-store/live-download](modules/blob_store_live_download.md) +- [config-import](modules/config_import.md) +- [constants](modules/constants.md) +- [core-manager](modules/core_manager.md) +- [core-manager/bitfield-rle](modules/core_manager_bitfield_rle.md) +- [core-manager/compat](modules/core_manager_compat.md) +- [core-manager/core-index](modules/core_manager_core_index.md) +- [core-manager/random-access-file-pool](modules/core_manager_random_access_file_pool.md) +- [core-manager/remote-bitfield](modules/core_manager_remote_bitfield.md) +- [core-ownership](modules/core_ownership.md) +- [datastore](modules/datastore.md) +- [datatype](modules/datatype.md) +- [datatype](modules/datatype-1.md) +- [discovery/local-discovery](modules/discovery_local_discovery.md) +- [fastify-controller](modules/fastify_controller.md) +- [fastify-plugins/blobs](modules/fastify_plugins_blobs.md) +- [fastify-plugins/constants](modules/fastify_plugins_constants.md) +- [fastify-plugins/icons](modules/fastify_plugins_icons.md) +- [fastify-plugins/maps](modules/fastify_plugins_maps.md) +- [fastify-plugins/maps/offline-fallback-map](modules/fastify_plugins_maps_offline_fallback_map.md) +- [fastify-plugins/maps/static-maps](modules/fastify_plugins_maps_static_maps.md) +- [fastify-plugins/utils](modules/fastify_plugins_utils.md) +- [generated/extensions](modules/generated_extensions.md) +- [generated/keys](modules/generated_keys.md) +- [generated/rpc](modules/generated_rpc.md) +- [icon-api](modules/icon_api.md) +- [index](modules/index.md) +- [index-writer](modules/index_writer.md) +- [invite-api](modules/invite_api.md) +- [lib/hashmap](modules/lib_hashmap.md) +- [lib/ponyfills](modules/lib_ponyfills.md) +- [lib/string](modules/lib_string.md) +- [lib/timing-safe-equal](modules/lib_timing_safe_equal.md) +- [local-peers](modules/local_peers.md) +- [logger](modules/logger.md) +- [mapeo-manager](modules/mapeo_manager.md) +- [mapeo-project](modules/mapeo_project.md) +- [member-api](modules/member_api.md) +- [roles](modules/roles.md) +- [schema/client](modules/schema_client.md) +- [schema/project](modules/schema_project.md) +- [schema/schema-to-drizzle](modules/schema_schema_to_drizzle.md) +- [schema/types](modules/schema_types.md) +- [schema/utils](modules/schema_utils.md) +- [sync/core-sync-state](modules/sync_core_sync_state.md) +- [sync/namespace-sync-state](modules/sync_namespace_sync_state.md) +- [sync/peer-sync-controller](modules/sync_peer_sync_controller.md) +- [sync/sync-api](modules/sync_sync_api.md) +- [sync/sync-state](modules/sync_sync_state.md) +- [types](modules/types.md) +- [utils](modules/utils.md) +- [utils\_types](modules/utils_types.md) diff --git a/docs/api/classes/blob_api.BlobApi.md b/docs/api/classes/blob_api.BlobApi.md new file mode 100644 index 000000000..d6ef80cfa --- /dev/null +++ b/docs/api/classes/blob_api.BlobApi.md @@ -0,0 +1,87 @@ +[API](../README.md) / [blob-api](../modules/blob_api.md) / BlobApi + +# Class: BlobApi + +[blob-api](../modules/blob_api.md).BlobApi + +## Table of contents + +### Constructors + +- [constructor](blob_api.BlobApi.md#constructor) + +### Methods + +- [create](blob_api.BlobApi.md#create) +- [getUrl](blob_api.BlobApi.md#geturl) + +## Constructors + +### constructor + +• **new BlobApi**(`options`): [`BlobApi`](blob_api.BlobApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.blobStore` | [`BlobStore`](blob_store.BlobStore.md) | +| `options.getMediaBaseUrl` | () => `Promise`\<`string`\> | + +#### Returns + +[`BlobApi`](blob_api.BlobApi.md) + +#### Defined in + +[src/blob-api.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L18) + +## Methods + +### create + +▸ **create**(`filepaths`, `metadata`): `Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> + +Write blobs for provided variants of a file + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filepaths` | `Object` | +| `filepaths.original` | `string` | +| `filepaths.preview?` | `string` | +| `filepaths.thumbnail?` | `string` | +| `metadata` | `Object` | +| `metadata.mimeType` | `string` | + +#### Returns + +`Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> + +#### Defined in + +[src/blob-api.js:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L46) + +___ + +### getUrl + +▸ **getUrl**(`blobId`): `Promise`\<`string`\> + +Get a url for a blob based on its BlobId + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/blob-api.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L28) diff --git a/docs/api/classes/blob_store.BlobStore.md b/docs/api/classes/blob_store.BlobStore.md new file mode 100644 index 000000000..6853471fe --- /dev/null +++ b/docs/api/classes/blob_store.BlobStore.md @@ -0,0 +1,281 @@ +[API](../README.md) / [blob-store](../modules/blob_store.md) / BlobStore + +# Class: BlobStore + +[blob-store](../modules/blob_store.md).BlobStore + +## Table of contents + +### Constructors + +- [constructor](blob_store.BlobStore.md#constructor) + +### Accessors + +- [writerDriveId](blob_store.BlobStore.md#writerdriveid) + +### Methods + +- [clear](blob_store.BlobStore.md#clear) +- [createEntryReadStream](blob_store.BlobStore.md#createentryreadstream) +- [createReadStream](blob_store.BlobStore.md#createreadstream) +- [createWriteStream](blob_store.BlobStore.md#createwritestream) +- [download](blob_store.BlobStore.md#download) +- [entry](blob_store.BlobStore.md#entry) +- [get](blob_store.BlobStore.md#get) +- [getEntryBlob](blob_store.BlobStore.md#getentryblob) +- [put](blob_store.BlobStore.md#put) + +## Constructors + +### constructor + +• **new BlobStore**(`options`): [`BlobStore`](blob_store.BlobStore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | + +#### Returns + +[`BlobStore`](blob_store.BlobStore.md) + +#### Defined in + +[src/blob-store/index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L45) + +## Accessors + +### writerDriveId + +• `get` **writerDriveId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/blob-store/index.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L77) + +## Methods + +### clear + +▸ **clear**(`blobId`, `options?`): `Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | +| `options?` | `Object` | | +| `options.diff` | `undefined` \| `boolean` | Enable to return an object with a `block` property with number of bytes removed | + +#### Returns + +`Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Defined in + +[src/blob-store/index.js:234](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L234) + +___ + +### createEntryReadStream + +▸ **createEntryReadStream**(`driveId`, `entry`, `options?`): `Promise`\<`BlobReadStream`\> + +Optimization for creating the blobs read stream when you have +previously read the entry from Hyperdrive using `drive.entry` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `driveId` | `string` | Hyperdrive drive discovery id | +| `entry` | `HyperdriveEntry` | Hyperdrive entry | +| `options?` | `Object` | | +| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<`BlobReadStream`\> + +#### Defined in + +[src/blob-store/index.js:150](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L150) + +___ + +### createReadStream + +▸ **createReadStream**(`blobId`, `options?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | +| `options?` | `Object` | | +| `options.timeout` | `undefined` \| `number` | Optional timeout to wait for a blob to download | +| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[src/blob-store/index.js:130](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L130) + +___ + +### createWriteStream + +▸ **createWriteStream**(`blobId`, `options?`): `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | `Omit`\<[`BlobId`](../modules/blob_api.md#blobid), ``"driveId"``\> | | +| `options?` | `Object` | | +| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | + +#### Returns + +`Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } + +#### Defined in + +[src/blob-store/index.js:201](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L201) + +___ + +### download + +▸ **download**(`filter?`, `options?`): [`LiveDownload`](blob_store_live_download.LiveDownload.md) + +Download blobs from all drives, optionally filtering particular blob types +or blob variants. Download will be 'live' and will continue downloading new +data as it becomes available from any replicating drive. + +If no filter is specified, all blobs will be downloaded. If a filter is +specified, then _only_ blobs that match the filter will be downloaded. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `filter?` | [`BlobFilter`](../modules/types.md#blobfilter) | Filter blob types and/or variants to download. Filter is { [BlobType]: BlobVariants[] }. At least one blob variant must be specified for each blob type. | +| `options` | `Object` | | +| `options.signal` | `undefined` \| `AbortSignal` | Optional AbortSignal to cancel in-progress download | + +#### Returns + +[`LiveDownload`](blob_store_live_download.LiveDownload.md) + +EventEmitter with `.state` propery, emits `state` with new state when it updates + +#### Defined in + +[src/blob-store/index.js:117](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L117) + +___ + +### entry + +▸ **entry**(`blobId`, `options?`): `Promise`\<``null`` \| `HyperdriveEntry`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | +| `options?` | `Object` | | +| `options.follow` | `undefined` \| `boolean` | Set to `true` to follow symlinks (16 max or throws an error) | +| `options.timeout` | `undefined` | Optional timeout to wait for a blob to download | +| `options.wait` | `undefined` \| ``false`` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<``null`` \| `HyperdriveEntry`\> + +#### Defined in + +[src/blob-store/index.js:217](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L217) + +___ + +### get + +▸ **get**(`blobId`, `opts?`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | `undefined` | | +| `opts` | `Object` | `{}` | | +| `opts.timeout` | `undefined` | `undefined` | Optional timeout to wait for a blob to download | +| `opts.wait` | `undefined` \| ``false`` | `false` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/blob-store/index.js:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L96) + +___ + +### getEntryBlob + +▸ **getEntryBlob**(`driveId`, `entry`, `opts?`): `Promise`\<``null`` \| `Buffer`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `driveId` | `string` | Hyperdrive drive id | +| `entry` | `HyperdriveEntry` | Hyperdrive entry | +| `opts?` | `Object` | | +| `opts.length` | `undefined` \| `number` | | + +#### Returns + +`Promise`\<``null`` \| `Buffer`\> + +#### Defined in + +[src/blob-store/index.js:170](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L170) + +___ + +### put + +▸ **put**(`blobId`, `blob`, `options?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | `Omit`\<[`BlobId`](../modules/blob_api.md#blobid), ``"driveId"``\> | | +| `blob` | `Buffer` | | +| `options?` | `Object` | | +| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | + +#### Returns + +`Promise`\<`string`\> + +discovery key as hex string of hyperdrive where blob is stored + +#### Defined in + +[src/blob-store/index.js:190](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L190) diff --git a/docs/api/classes/blob_store_live_download.DriveLiveDownload.md b/docs/api/classes/blob_store_live_download.DriveLiveDownload.md new file mode 100644 index 000000000..966924598 --- /dev/null +++ b/docs/api/classes/blob_store_live_download.DriveLiveDownload.md @@ -0,0 +1,66 @@ +[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / DriveLiveDownload + +# Class: DriveLiveDownload + +[blob-store/live-download](../modules/blob_store_live_download.md).DriveLiveDownload + +LiveDownload class + +## Hierarchy + +- `TypedEmitter` + + ↳ **`DriveLiveDownload`** + +## Table of contents + +### Constructors + +- [constructor](blob_store_live_download.DriveLiveDownload.md#constructor) + +### Accessors + +- [state](blob_store_live_download.DriveLiveDownload.md#state) + +## Constructors + +### constructor + +• **new DriveLiveDownload**(`drive`, `options?`): [`DriveLiveDownload`](blob_store_live_download.DriveLiveDownload.md) + +Like drive.download() but 'live', + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `drive` | `Hyperdrive` | | +| `options` | `Object` | | +| `options.filter` | `undefined` \| [`BlobFilter`](../modules/types.md#blobfilter) | Filter blobs of specific types and/or sizes to download | +| `options.signal` | `undefined` \| `AbortSignal` | | + +#### Returns + +[`DriveLiveDownload`](blob_store_live_download.DriveLiveDownload.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/blob-store/live-download.js:107](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L107) + +## Accessors + +### state + +• `get` **state**(): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) + +#### Returns + +[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) + +#### Defined in + +[src/blob-store/live-download.js:129](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L129) diff --git a/docs/api/classes/blob_store_live_download.LiveDownload.md b/docs/api/classes/blob_store_live_download.LiveDownload.md new file mode 100644 index 000000000..a1c998405 --- /dev/null +++ b/docs/api/classes/blob_store_live_download.LiveDownload.md @@ -0,0 +1,67 @@ +[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / LiveDownload + +# Class: LiveDownload + +[blob-store/live-download](../modules/blob_store_live_download.md).LiveDownload + +LiveDownload class + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LiveDownload`** + +## Table of contents + +### Constructors + +- [constructor](blob_store_live_download.LiveDownload.md#constructor) + +### Accessors + +- [state](blob_store_live_download.LiveDownload.md#state) + +## Constructors + +### constructor + +• **new LiveDownload**(`drives`, `emitter`, `options`): [`LiveDownload`](blob_store_live_download.LiveDownload.md) + +Like drive.download() but 'live', and for multiple drives + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `drives` | `Iterable`\<`Hyperdrive`\> | | +| `emitter` | [`InternalDriveEmitter`](../modules/blob_store.md#internaldriveemitter) | | +| `options` | `Object` | | +| `options.filter` | `undefined` \| [`BlobFilter`](../modules/types.md#blobfilter) | Filter blobs of specific types and/or sizes to download | +| `options.signal` | `undefined` \| `AbortSignal` | | + +#### Returns + +[`LiveDownload`](blob_store_live_download.LiveDownload.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/blob-store/live-download.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L42) + +## Accessors + +### state + +• `get` **state**(): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) + +#### Returns + +[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) + +#### Defined in + +[src/blob-store/live-download.js:78](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L78) diff --git a/docs/api/classes/core_manager.CoreManager.md b/docs/api/classes/core_manager.CoreManager.md new file mode 100644 index 000000000..1db06f168 --- /dev/null +++ b/docs/api/classes/core_manager.CoreManager.md @@ -0,0 +1,321 @@ +[API](../README.md) / [core-manager](../modules/core_manager.md) / CoreManager + +# Class: CoreManager + +[core-manager](../modules/core_manager.md).CoreManager + +## Hierarchy + +- `TypedEmitter` + + ↳ **`CoreManager`** + +## Table of contents + +### Constructors + +- [constructor](core_manager.CoreManager.md#constructor) + +### Accessors + +- [creatorCore](core_manager.CoreManager.md#creatorcore) +- [deviceId](core_manager.CoreManager.md#deviceid) +- [namespaces](core_manager.CoreManager.md#namespaces) + +### Methods + +- [[kCoreManagerReplicate]](core_manager.CoreManager.md#[kcoremanagerreplicate]) +- [addCore](core_manager.CoreManager.md#addcore) +- [close](core_manager.CoreManager.md#close) +- [deleteOthersData](core_manager.CoreManager.md#deleteothersdata) +- [getCoreByDiscoveryKey](core_manager.CoreManager.md#getcorebydiscoverykey) +- [getCoreByKey](core_manager.CoreManager.md#getcorebykey) +- [getCores](core_manager.CoreManager.md#getcores) +- [getWriterCore](core_manager.CoreManager.md#getwritercore) +- [ready](core_manager.CoreManager.md#ready) +- [requestCoreKey](core_manager.CoreManager.md#requestcorekey) + +## Constructors + +### constructor + +• **new CoreManager**(`options`): [`CoreManager`](core_manager.CoreManager.md) + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | `Object` | `undefined` | | +| `options.autoDownload` | `undefined` \| `boolean` | `true` | Immediately start downloading cores - should only be set to false for tests | +| `options.db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | `undefined` | Drizzle better-sqlite3 database instance | +| `options.encryptionKeys` | `undefined` \| `Partial`\<`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `Buffer`\>\> | `{}` | Encryption keys for each namespace | +| `options.keyManager` | `KeyManager` | `undefined` | mapeo/crypto KeyManager instance | +| `options.logger` | `undefined` \| [`Logger`](logger.Logger.md) | `undefined` | | +| `options.projectKey` | `Buffer` | `undefined` | 32-byte public key of the project creator core | +| `options.projectSecretKey` | `undefined` \| `Buffer` | `undefined` | 32-byte secret key of the project creator core | +| `options.storage` | `HypercoreStorage` | `undefined` | Folder to store all hypercore data | + +#### Returns + +[`CoreManager`](core_manager.CoreManager.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/core-manager/index.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L70) + +## Accessors + +### creatorCore + +• `get` **creatorCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/core-manager/index.js:189](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L189) + +___ + +### deviceId + +• `get` **deviceId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/core-manager/index.js:185](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L185) + +___ + +### namespaces + +• `get` **namespaces**(): readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Returns + +readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Defined in + +[src/core-manager/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L55) + +## Methods + +### [kCoreManagerReplicate] + +▸ **[kCoreManagerReplicate]**(`stream`): `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +ONLY FOR TESTING +Replicate all cores in core manager + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | + +#### Returns + +`Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Defined in + +[src/core-manager/index.js:460](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L460) + +___ + +### addCore + +▸ **addCore**(`key`, `namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Add a core to the manager (will be persisted across restarts) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `Buffer` | 32-byte public key of core to add | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | + +#### Returns + +[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:266](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L266) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +Close all open cores and end any replication streams +TODO: gracefully close replication streams + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:248](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L248) + +___ + +### deleteOthersData + +▸ **deleteOthersData**(`namespace`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:479](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L479) + +___ + +### getCoreByDiscoveryKey + +▸ **getCoreByDiscoveryKey**(`discoveryKey`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Get a core by its discovery key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:237](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L237) + +___ + +### getCoreByKey + +▸ **getCoreByKey**(`key`): `undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> + +Get a core by its public key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `Buffer` | + +#### Returns + +`undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/core-manager/index.js:226](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L226) + +___ + +### getCores + +▸ **getCores**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] + +Get an array of all cores in the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] + +#### Defined in + +[src/core-manager/index.js:216](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L216) + +___ + +### getWriterCore + +▸ **getWriterCore**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Get the writer core for the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:207](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L207) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +Resolves when all cores have finished loading + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:198](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L198) + +___ + +### requestCoreKey + +▸ **requestCoreKey**(`peerKey`, `discoveryKey`): `void` + +Send an extension message over the project creator core replication stream +requesting a core key for the given discovery key. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerKey` | `Buffer` | +| `discoveryKey` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:345](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L345) diff --git a/docs/api/classes/core_manager_core_index.CoreIndex.md b/docs/api/classes/core_manager_core_index.CoreIndex.md new file mode 100644 index 000000000..9757b89e7 --- /dev/null +++ b/docs/api/classes/core_manager_core_index.CoreIndex.md @@ -0,0 +1,161 @@ +[API](../README.md) / [core-manager/core-index](../modules/core_manager_core_index.md) / CoreIndex + +# Class: CoreIndex + +[core-manager/core-index](../modules/core_manager_core_index.md).CoreIndex + +An in-memory index of open cores. + +## Table of contents + +### Constructors + +- [constructor](core_manager_core_index.CoreIndex.md#constructor) + +### Methods + +- [[iterator]](core_manager_core_index.CoreIndex.md#[iterator]) +- [add](core_manager_core_index.CoreIndex.md#add) +- [getByCoreKey](core_manager_core_index.CoreIndex.md#getbycorekey) +- [getByDiscoveryId](core_manager_core_index.CoreIndex.md#getbydiscoveryid) +- [getByNamespace](core_manager_core_index.CoreIndex.md#getbynamespace) +- [getWriter](core_manager_core_index.CoreIndex.md#getwriter) + +## Constructors + +### constructor + +• **new CoreIndex**(): [`CoreIndex`](core_manager_core_index.CoreIndex.md) + +#### Returns + +[`CoreIndex`](core_manager_core_index.CoreIndex.md) + +## Methods + +### [iterator] + +▸ **[iterator]**(): `IterableIterator`\<[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)\> + +#### Returns + +`IterableIterator`\<[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)\> + +#### Defined in + +[src/core-manager/core-index.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L15) + +___ + +### add + +▸ **add**(`options`): `void` + +NB. Need to pass key here because `core.key` is not populated until the +core is ready, but we know it beforehand. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | `Object` | `undefined` | | +| `options.core` | `Hypercore`\<``"binary"``, `Buffer`\> | `undefined` | Hypercore instance | +| `options.key` | `Buffer` | `undefined` | Buffer containing public key of this core | +| `options.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | `undefined` | | +| `options.writer` | `undefined` \| `boolean` | `false` | Is this a writer core? | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/core-index.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L29) + +___ + +### getByCoreKey + +▸ **getByCoreKey**(`coreKey`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Get a core by its public key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coreKey` | `Buffer` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:83](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L83) + +___ + +### getByDiscoveryId + +▸ **getByDiscoveryId**(`discoveryId`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Get a core by its discoveryId (discover key as hex string) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryId` | `string` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L73) + +___ + +### getByNamespace + +▸ **getByNamespace**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] + +Get all known cores in a namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] + +#### Defined in + +[src/core-manager/core-index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L45) + +___ + +### getWriter + +▸ **getWriter**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +Get the write core for the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L59) diff --git a/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md b/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md new file mode 100644 index 000000000..193beb470 --- /dev/null +++ b/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md @@ -0,0 +1,105 @@ +[API](../README.md) / [core-manager/random-access-file-pool](../modules/core_manager_random_access_file_pool.md) / RandomAccessFilePool + +# Class: RandomAccessFilePool + +[core-manager/random-access-file-pool](../modules/core_manager_random_access_file_pool.md).RandomAccessFilePool + +File descriptor pool for random-access-storage to limit the number of file +descriptors used. Important particularly for Android where the hard limit for +the app is 1024. + +## Table of contents + +### Constructors + +- [constructor](core_manager_random_access_file_pool.RandomAccessFilePool.md#constructor) + +### Properties + +- [active](core_manager_random_access_file_pool.RandomAccessFilePool.md#active) +- [maxSize](core_manager_random_access_file_pool.RandomAccessFilePool.md#maxsize) + +### Methods + +- [\_onactive](core_manager_random_access_file_pool.RandomAccessFilePool.md#_onactive) +- [\_oninactive](core_manager_random_access_file_pool.RandomAccessFilePool.md#_oninactive) + +## Constructors + +### constructor + +• **new RandomAccessFilePool**(`maxSize`): [`RandomAccessFilePool`](core_manager_random_access_file_pool.RandomAccessFilePool.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `maxSize` | `number` | max number of file descriptors to use | + +#### Returns + +[`RandomAccessFilePool`](core_manager_random_access_file_pool.RandomAccessFilePool.md) + +#### Defined in + +[src/core-manager/random-access-file-pool.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L8) + +## Properties + +### active + +• **active**: `Set`\<`RandomAccessFile`\> + +#### Defined in + +[src/core-manager/random-access-file-pool.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L11) + +___ + +### maxSize + +• **maxSize**: `number` + +#### Defined in + +[src/core-manager/random-access-file-pool.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L9) + +## Methods + +### \_onactive + +▸ **_onactive**(`file`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `file` | `RandomAccessFile` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/random-access-file-pool.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L15) + +___ + +### \_oninactive + +▸ **_oninactive**(`file`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `file` | `RandomAccessFile` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/random-access-file-pool.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L27) diff --git a/docs/api/classes/core_manager_remote_bitfield.default.md b/docs/api/classes/core_manager_remote_bitfield.default.md new file mode 100644 index 000000000..7d5f6cdcc --- /dev/null +++ b/docs/api/classes/core_manager_remote_bitfield.default.md @@ -0,0 +1,307 @@ +[API](../README.md) / [core-manager/remote-bitfield](../modules/core_manager_remote_bitfield.md) / default + +# Class: default + +[core-manager/remote-bitfield](../modules/core_manager_remote_bitfield.md).default + +## Table of contents + +### Constructors + +- [constructor](core_manager_remote_bitfield.default.md#constructor) + +### Properties + +- [\_maxSegments](core_manager_remote_bitfield.default.md#_maxsegments) +- [\_pages](core_manager_remote_bitfield.default.md#_pages) +- [\_segments](core_manager_remote_bitfield.default.md#_segments) + +### Methods + +- [findFirst](core_manager_remote_bitfield.default.md#findfirst) +- [findLast](core_manager_remote_bitfield.default.md#findlast) +- [firstSet](core_manager_remote_bitfield.default.md#firstset) +- [firstUnset](core_manager_remote_bitfield.default.md#firstunset) +- [get](core_manager_remote_bitfield.default.md#get) +- [getBitfield](core_manager_remote_bitfield.default.md#getbitfield) +- [insert](core_manager_remote_bitfield.default.md#insert) +- [lastSet](core_manager_remote_bitfield.default.md#lastset) +- [lastUnset](core_manager_remote_bitfield.default.md#lastunset) +- [set](core_manager_remote_bitfield.default.md#set) +- [setRange](core_manager_remote_bitfield.default.md#setrange) + +## Constructors + +### constructor + +• **new default**(): [`default`](core_manager_remote_bitfield.default.md) + +#### Returns + +[`default`](core_manager_remote_bitfield.default.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:207](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L207) + +## Properties + +### \_maxSegments + +• **\_maxSegments**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:212](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L212) + +[src/core-manager/remote-bitfield.js:253](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L253) + +[src/core-manager/remote-bitfield.js:281](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L281) + +[src/core-manager/remote-bitfield.js:394](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L394) + +___ + +### \_pages + +• **\_pages**: `BigSparseArray`\<`RemoteBitfieldPage`\> + +#### Defined in + +[src/core-manager/remote-bitfield.js:209](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L209) + +___ + +### \_segments + +• **\_segments**: `BigSparseArray`\<`RemoteBitfieldSegment`\> + +#### Defined in + +[src/core-manager/remote-bitfield.js:211](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L211) + +## Methods + +### findFirst + +▸ **findFirst**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:304](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L304) + +___ + +### findLast + +▸ **findLast**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:340](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L340) + +___ + +### firstSet + +▸ **firstSet**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:327](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L327) + +___ + +### firstUnset + +▸ **firstUnset**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:333](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L333) + +___ + +### get + +▸ **get**(`index`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/remote-bitfield.js:218](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L218) + +___ + +### getBitfield + +▸ **getBitfield**(`index`): ``null`` \| `RemoteBitfieldPage` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +``null`` \| `RemoteBitfieldPage` + +#### Defined in + +[src/core-manager/remote-bitfield.js:230](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L230) + +___ + +### insert + +▸ **insert**(`start`, `bitfield`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `bitfield` | `Uint32Array` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/remote-bitfield.js:378](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L378) + +___ + +### lastSet + +▸ **lastSet**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:364](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L364) + +___ + +### lastUnset + +▸ **lastUnset**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:370](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L370) + +___ + +### set + +▸ **set**(`index`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:242](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L242) + +___ + +### setRange + +▸ **setRange**(`start`, `length`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `length` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:269](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L269) diff --git a/docs/api/classes/core_ownership.CoreOwnership.md b/docs/api/classes/core_ownership.CoreOwnership.md new file mode 100644 index 000000000..be30c1010 --- /dev/null +++ b/docs/api/classes/core_ownership.CoreOwnership.md @@ -0,0 +1,84 @@ +[API](../README.md) / [core-ownership](../modules/core_ownership.md) / CoreOwnership + +# Class: CoreOwnership + +[core-ownership](../modules/core_ownership.md).CoreOwnership + +## Table of contents + +### Constructors + +- [constructor](core_ownership.CoreOwnership.md#constructor) + +### Methods + +- [getCoreId](core_ownership.CoreOwnership.md#getcoreid) +- [getOwner](core_ownership.CoreOwnership.md#getowner) + +## Constructors + +### constructor + +• **new CoreOwnership**(`opts`): [`CoreOwnership`](core_ownership.CoreOwnership.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.coreKeypairs` | `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`KeyPair`](../modules/types.md#keypair)\> | +| `opts.dataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | +| `opts.identityKeypair` | [`KeyPair`](../modules/types.md#keypair) | + +#### Returns + +[`CoreOwnership`](core_ownership.CoreOwnership.md) + +#### Defined in + +[src/core-ownership.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L33) + +## Methods + +### getCoreId + +▸ **getCoreId**(`deviceId`, `namespace`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +`Promise`\<`string`\> + +coreId of core belonging to `deviceId` for `namespace` + +#### Defined in + +[src/core-ownership.js:83](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L83) + +___ + +### getOwner + +▸ **getOwner**(`coreId`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coreId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +deviceId of device that owns the core + +#### Defined in + +[src/core-ownership.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L60) diff --git a/docs/api/classes/datastore.DataStore.md b/docs/api/classes/datastore.DataStore.md new file mode 100644 index 000000000..728be3e71 --- /dev/null +++ b/docs/api/classes/datastore.DataStore.md @@ -0,0 +1,251 @@ +[API](../README.md) / [datastore](../modules/datastore.md) / DataStore + +# Class: DataStore\ + +[datastore](../modules/datastore.md).DataStore + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | keyof [`NamespaceSchemas`](../modules/datastore.md#namespaceschemas) | +| `TSchemaName` | [`NamespaceSchemas`](../modules/datastore.md#namespaceschemas)[`TNamespace`][`number`] | + +## Hierarchy + +- `TypedEmitter` + + ↳ **`DataStore`** + +## Table of contents + +### Constructors + +- [constructor](datastore.DataStore.md#constructor) + +### Accessors + +- [indexer](datastore.DataStore.md#indexer) +- [namespace](datastore.DataStore.md#namespace) +- [schemas](datastore.DataStore.md#schemas) +- [writerCore](datastore.DataStore.md#writercore) + +### Methods + +- [close](datastore.DataStore.md#close) +- [getIndexState](datastore.DataStore.md#getindexstate) +- [read](datastore.DataStore.md#read) +- [readRaw](datastore.DataStore.md#readraw) +- [write](datastore.DataStore.md#write) +- [writeRaw](datastore.DataStore.md#writeraw) + +## Constructors + +### constructor + +• **new DataStore**\<`TNamespace`, `TSchemaName`\>(`opts`): [`DataStore`](datastore.DataStore.md)\<`TNamespace`, `TSchemaName`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | extends ``"auth"`` \| ``"config"`` \| ``"data"`` = ``"auth"`` \| ``"config"`` \| ``"data"`` | +| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` = \{ `auth`: readonly [``"coreOwnership"``, ``"role"``] ; `config`: readonly [``"translation"``, ``"preset"``, ``"field"``, ``"projectSettings"``, ``"deviceInfo"``, ``"icon"``] ; `data`: readonly [``"observation"``, ``"track"``] }[`TNamespace`][`number`] | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.batch` | (`entries`: `Entry`\<``"binary"``\>[]) => `Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | +| `opts.namespace` | `TNamespace` | +| `opts.storage` | `StorageParam` | + +#### Returns + +[`DataStore`](datastore.DataStore.md)\<`TNamespace`, `TSchemaName`\> + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/datastore/index.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L72) + +## Accessors + +### indexer + +• `get` **indexer**(): `MultiCoreIndexer`\<``"binary"``\> + +#### Returns + +`MultiCoreIndexer`\<``"binary"``\> + +#### Defined in + +[src/datastore/index.js:94](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L94) + +___ + +### namespace + +• `get` **namespace**(): `TNamespace` + +#### Returns + +`TNamespace` + +#### Defined in + +[src/datastore/index.js:98](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L98) + +___ + +### schemas + +• `get` **schemas**(): (``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] + +#### Returns + +(``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] + +#### Defined in + +[src/datastore/index.js:102](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L102) + +___ + +### writerCore + +• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/datastore/index.js:107](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L107) + +## Methods + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/datastore/index.js:229](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L229) + +___ + +### getIndexState + +▸ **getIndexState**(): `IndexState` + +#### Returns + +`IndexState` + +#### Defined in + +[src/datastore/index.js:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L111) + +___ + +### read + +▸ **read**(`versionId`): `Promise`\<`MapeoDoc`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`MapeoDoc`\> + +#### Defined in + +[src/datastore/index.js:198](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L198) + +___ + +### readRaw + +▸ **readRaw**(`versionId`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/datastore/index.js:220](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L220) + +___ + +### write + +▸ **write**\<`TDoc`\>(`doc`): `Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> + +UNSAFE: Does not check links: [] refer to a valid doc - should only be used +internally. + +Write a doc, must be one of the schema types supported by the namespace of +this DataStore. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{} & `CoreOwnershipSignatures`, ``"versionId"``\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | `TDoc` | + +#### Returns + +`Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> + +#### Defined in + +[src/datastore/index.js:157](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L157) + +___ + +### writeRaw + +▸ **writeRaw**(`buf`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buf` | `Buffer` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/datastore/index.js:208](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L208) diff --git a/docs/api/classes/datatype-1.DataType.md b/docs/api/classes/datatype-1.DataType.md new file mode 100644 index 000000000..3a84317df --- /dev/null +++ b/docs/api/classes/datatype-1.DataType.md @@ -0,0 +1,278 @@ +[API](../README.md) / [datatype](../modules/datatype-1.md) / DataType + +# Class: DataType\ + +[datatype](../modules/datatype-1.md).DataType + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TDataStore` | extends [`datastore`](../modules/datastore.md) | +| `TTable` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | +| `TSchemaName` | extends `TTable`[``"_"``][``"name"``] | +| `TDoc` | extends [`MapeoDocMap`](../modules/datatype.md#mapeodocmap)[`TSchemaName`] | +| `TValue` | extends [`MapeoValueMap`](../modules/datatype.md#mapeovaluemap)[`TSchemaName`] | + +## Hierarchy + +- `TypedEmitter`\<[`DataTypeEvents`](../interfaces/datatype-1.DataTypeEvents.md)\<`TDoc`\>\> + + ↳ **`DataType`** + +## Table of contents + +### Constructors + +- [constructor](datatype-1.DataType.md#constructor) + +### Accessors + +- [[kTable]](datatype-1.DataType.md#[ktable]) +- [writerCore](datatype-1.DataType.md#writercore) + +### Methods + +- [[kCreateWithDocId]](datatype-1.DataType.md#[kcreatewithdocid]) +- [[kSelect]](datatype-1.DataType.md#[kselect]) +- [create](datatype-1.DataType.md#create) +- [delete](datatype-1.DataType.md#delete) +- [getByDocId](datatype-1.DataType.md#getbydocid) +- [getByVersionId](datatype-1.DataType.md#getbyversionid) +- [getMany](datatype-1.DataType.md#getmany) +- [update](datatype-1.DataType.md#update) + +## Constructors + +### constructor + +• **new DataType**\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>(`«destructured»`): [`DataType`](datatype-1.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TDataStore` | extends [`DataStore`](datastore.DataStore.md)\<``"auth"`` \| ``"config"`` \| ``"data"``, ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``\> | +| `TTable` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | +| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` | +| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | +| `TValue` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `dataStore` | `TDataStore` | +| › `db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | +| › `getPermissions?` | () => `any` | +| › `table` | `TTable` | + +#### Returns + +[`DataType`](datatype-1.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> + +#### Overrides + +TypedEmitter\<DataTypeEvents\<TDoc\>\>.constructor + +#### Defined in + +[src/datatype/index.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L50) + +## Accessors + +### [kTable] + +• `get` **[kTable]**(): `TTable` + +#### Returns + +`TTable` + +#### Defined in + +[src/datatype/index.d.ts:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L62) + +___ + +### writerCore + +• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/datatype/index.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L64) + +## Methods + +### [kCreateWithDocId] + +▸ **[kCreateWithDocId]**(`docId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | +| `value` | [`CoreOwnershipWithSignaturesValue`](../modules/types.md#coreownershipwithsignaturesvalue) \| `Exclude`\<`TValue`, \{ `schemaName`: ``"coreOwnership"`` }\> | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L66) + +___ + +### [kSelect] + +▸ **[kSelect]**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[src/datatype/index.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L73) + +___ + +### create + +▸ **create**\<`T`\>(`value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `T` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L75) + +___ + +### delete + +▸ **delete**(`docId`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L97) + +___ + +### getByDocId + +▸ **getByDocId**(`docId`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L82) + +___ + +### getByVersionId + +▸ **getByVersionId**(`versionId`): `Promise`\<`TDoc`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`TDoc`\> + +#### Defined in + +[src/datatype/index.d.ts:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L84) + +___ + +### getMany + +▸ **getMany**(`opts?`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `Object` | +| `opts.includeDeleted?` | `boolean` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> + +#### Defined in + +[src/datatype/index.d.ts:86](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L86) + +___ + +### update + +▸ **update**\<`T`\>(`versionId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` \| `string`[] | +| `value` | `T` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L90) diff --git a/docs/api/classes/datatype.DataType.md b/docs/api/classes/datatype.DataType.md new file mode 100644 index 000000000..326d4be22 --- /dev/null +++ b/docs/api/classes/datatype.DataType.md @@ -0,0 +1,280 @@ +[API](../README.md) / [datatype](../modules/datatype.md) / DataType + +# Class: DataType\ + +[datatype](../modules/datatype.md).DataType + +## Type parameters + +| Name | +| :------ | +| `TDataStore` | +| `TSchemaName` | +| `TTable` | +| `TDoc` | +| `TValue` | + +## Hierarchy + +- `TypedEmitter` + + ↳ **`DataType`** + +## Table of contents + +### Constructors + +- [constructor](datatype.DataType.md#constructor) + +### Accessors + +- [[kTable]](datatype.DataType.md#[ktable]) +- [writerCore](datatype.DataType.md#writercore) + +### Methods + +- [[kCreateWithDocId]](datatype.DataType.md#[kcreatewithdocid]) +- [[kSelect]](datatype.DataType.md#[kselect]) +- [create](datatype.DataType.md#create) +- [delete](datatype.DataType.md#delete) +- [getByDocId](datatype.DataType.md#getbydocid) +- [getByVersionId](datatype.DataType.md#getbyversionid) +- [getMany](datatype.DataType.md#getmany) +- [update](datatype.DataType.md#update) + +## Constructors + +### constructor + +• **new DataType**\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\>(`opts`): [`DataType`](datatype.DataType.md)\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TDataStore` | extends [`DataStore`](datastore.DataStore.md)\<``"auth"`` \| ``"config"`` \| ``"data"``, ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``\> | +| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` | +| `TTable` | extends \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } | +| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | +| `TValue` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.dataStore` | `TDataStore` | +| `opts.db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | +| `opts.getPermissions` | `undefined` \| () => `any` | +| `opts.table` | `TTable` | + +#### Returns + +[`DataType`](datatype.DataType.md)\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\> + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/datatype/index.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L81) + +## Accessors + +### [kTable] + +• `get` **[kTable]**(): `TTable` + +#### Returns + +`TTable` + +#### Defined in + +[src/datatype/index.js:116](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L116) + +___ + +### writerCore + +• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/datatype/index.js:120](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L120) + +## Methods + +### [kCreateWithDocId] + +▸ **[kCreateWithDocId]**(`docId`, `value`, `opts?`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `docId` | `string` | `undefined` | | +| `value` | [`CoreOwnershipWithSignaturesValue`](../modules/types.md#coreownershipwithsignaturesvalue) \| `TValue` | `undefined` | | +| `opts?` | `Object` | `{}` | only used internally to skip the checkExisting check when creating a document with a random ID (collisions should be too small probability to be worth checking for) | +| `opts.checkExisting?` | `boolean` | `true` | - | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Defined in + +[src/datatype/index.js:139](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L139) + +___ + +### [kSelect] + +▸ **[kSelect]**(): `Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, ``"sync"``, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, ``"single"``, `GetSelectTableName`\<`TTable`\> extends `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, ``"not-null"``\> : {}, ``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"``\> : {}\>\>, ``"then"`` \| ``"catch"`` \| ``"finally"``\> & \{ `catch?`: `undefined` ; `finally?`: `undefined` ; `then?`: `undefined` }\> + +#### Returns + +`Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, ``"sync"``, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, ``"single"``, `GetSelectTableName`\<`TTable`\> extends `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, ``"not-null"``\> : {}, ``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"``\> : {}\>\>, ``"then"`` \| ``"catch"`` \| ``"finally"``\> & \{ `catch?`: `undefined` ; `finally?`: `undefined` ; `then?`: `undefined` }\> + +#### Defined in + +[src/datatype/index.js:242](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L242) + +___ + +### create + +▸ **create**\<`T`\>(`value`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `T` | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Defined in + +[src/datatype/index.js:128](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L128) + +___ + +### delete + +▸ **delete**(`docId`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Defined in + +[src/datatype/index.js:222](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L222) + +___ + +### getByDocId + +▸ **getByDocId**(`docId`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Defined in + +[src/datatype/index.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L175) + +___ + +### getByVersionId + +▸ **getByVersionId**(`versionId`): `Promise`\<`MapeoDoc`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`MapeoDoc`\> + +#### Defined in + +[src/datatype/index.js:183](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L183) + +___ + +### getMany + +▸ **getMany**(`opts?`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in (...)]: (...) }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }[]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `opts?` | `Object` | `{}` | +| `opts.includeDeleted?` | `boolean` | `false` | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in (...)]: (...) }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }[]\> + +#### Defined in + +[src/datatype/index.js:188](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L188) + +___ + +### update + +▸ **update**\<`T`\>(`versionId`, `value`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` \| `string`[] | +| `value` | `T` | + +#### Returns + +`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> + +#### Defined in + +[src/datatype/index.js:202](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L202) diff --git a/docs/api/classes/discovery_local_discovery.LocalDiscovery.md b/docs/api/classes/discovery_local_discovery.LocalDiscovery.md new file mode 100644 index 000000000..47038652d --- /dev/null +++ b/docs/api/classes/discovery_local_discovery.LocalDiscovery.md @@ -0,0 +1,160 @@ +[API](../README.md) / [discovery/local-discovery](../modules/discovery_local_discovery.md) / LocalDiscovery + +# Class: LocalDiscovery + +[discovery/local-discovery](../modules/discovery_local_discovery.md).LocalDiscovery + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LocalDiscovery`** + +## Table of contents + +### Constructors + +- [constructor](discovery_local_discovery.LocalDiscovery.md#constructor) + +### Accessors + +- [connections](discovery_local_discovery.LocalDiscovery.md#connections) +- [publicKey](discovery_local_discovery.LocalDiscovery.md#publickey) + +### Methods + +- [address](discovery_local_discovery.LocalDiscovery.md#address) +- [connectPeer](discovery_local_discovery.LocalDiscovery.md#connectpeer) +- [start](discovery_local_discovery.LocalDiscovery.md#start) +- [stop](discovery_local_discovery.LocalDiscovery.md#stop) + +## Constructors + +### constructor + +• **new LocalDiscovery**(`opts`): [`LocalDiscovery`](discovery_local_discovery.LocalDiscovery.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.identityKeypair` | [`Keypair`](../modules/discovery_local_discovery.md#keypair) | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | + +#### Returns + +[`LocalDiscovery`](discovery_local_discovery.LocalDiscovery.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/discovery/local-discovery.js:43](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L43) + +## Accessors + +### connections + +• `get` **connections**(): `IterableIterator`\<[`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)\> + +#### Returns + +`IterableIterator`\<[`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)\> + +#### Defined in + +[src/discovery/local-discovery.js:241](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L241) + +___ + +### publicKey + +• `get` **publicKey**(): `Buffer` + +#### Returns + +`Buffer` + +#### Defined in + +[src/discovery/local-discovery.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L61) + +## Methods + +### address + +▸ **address**(): ``null`` \| `string` \| `AddressInfo` + +#### Returns + +``null`` \| `string` \| `AddressInfo` + +#### Defined in + +[src/discovery/local-discovery.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L65) + +___ + +### connectPeer + +▸ **connectPeer**(`peer`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peer` | `Object` | +| `peer.address` | `string` | +| `peer.name` | `string` | +| `peer.port` | `number` | + +#### Returns + +`void` + +#### Defined in + +[src/discovery/local-discovery.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L90) + +___ + +### start + +▸ **start**(): `Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Returns + +`Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Defined in + +[src/discovery/local-discovery.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L70) + +___ + +### stop + +▸ **stop**(`opts?`): `Promise`\<`void`\> + +Close all servers and stop multicast advertising and browsing. Will wait +for open sockets to close unless opts.force=true in which case open sockets +are force-closed after opts.timeout milliseconds + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts?` | `Object` | | +| `opts.force` | `undefined` \| `boolean` | Force-close open sockets after timeout milliseconds | +| `opts.timeout` | `undefined` \| `number` | Optional timeout when calling stop() with force=true | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/discovery/local-discovery.js:255](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L255) diff --git a/docs/api/classes/fastify_controller.FastifyController.md b/docs/api/classes/fastify_controller.FastifyController.md new file mode 100644 index 000000000..af79da21e --- /dev/null +++ b/docs/api/classes/fastify_controller.FastifyController.md @@ -0,0 +1,86 @@ +[API](../README.md) / [fastify-controller](../modules/fastify_controller.md) / FastifyController + +# Class: FastifyController + +[fastify-controller](../modules/fastify_controller.md).FastifyController + +## Table of contents + +### Constructors + +- [constructor](fastify_controller.FastifyController.md#constructor) + +### Methods + +- [start](fastify_controller.FastifyController.md#start) +- [started](fastify_controller.FastifyController.md#started) +- [stop](fastify_controller.FastifyController.md#stop) + +## Constructors + +### constructor + +• **new FastifyController**(`opts`): [`FastifyController`](fastify_controller.FastifyController.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.fastify` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | + +#### Returns + +[`FastifyController`](fastify_controller.FastifyController.md) + +#### Defined in + +[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L21) + +## Methods + +### start + +▸ **start**(`opts?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | [`StartOpts`](../interfaces/fastify_controller.StartOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L73) + +___ + +### started + +▸ **started**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L77) + +___ + +### stop + +▸ **stop**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L81) diff --git a/docs/api/classes/icon_api.IconApi.md b/docs/api/classes/icon_api.IconApi.md new file mode 100644 index 000000000..ccb7a9cb8 --- /dev/null +++ b/docs/api/classes/icon_api.IconApi.md @@ -0,0 +1,104 @@ +[API](../README.md) / [icon-api](../modules/icon_api.md) / IconApi + +# Class: IconApi + +[icon-api](../modules/icon_api.md).IconApi + +## Table of contents + +### Constructors + +- [constructor](icon_api.IconApi.md#constructor) + +### Methods + +- [[kGetIconBlob]](icon_api.IconApi.md#[kgeticonblob]) +- [create](icon_api.IconApi.md#create) +- [getIconUrl](icon_api.IconApi.md#geticonurl) + +## Constructors + +### constructor + +• **new IconApi**(`opts`): [`IconApi`](icon_api.IconApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.getMediaBaseUrl` | () => `Promise`\<`string`\> | +| `opts.iconDataStore` | [`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\> | +| `opts.iconDataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | + +#### Returns + +[`IconApi`](icon_api.IconApi.md) + +#### Defined in + +[src/icon-api.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L40) + +## Methods + +### [kGetIconBlob] + +▸ **[kGetIconBlob]**(`iconId`, `opts`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iconId` | `string` | +| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/icon-api.js:80](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L80) + +___ + +### create + +▸ **create**(`icon`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `icon` | `Object` | +| `icon.name` | `string` | +| `icon.variants` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/icon-api.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L53) + +___ + +### getIconUrl + +▸ **getIconUrl**(`iconId`, `opts`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iconId` | `string` | +| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/icon-api.js:93](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L93) diff --git a/docs/api/classes/index_writer.IndexWriter.md b/docs/api/classes/index_writer.IndexWriter.md new file mode 100644 index 000000000..f681212b6 --- /dev/null +++ b/docs/api/classes/index_writer.IndexWriter.md @@ -0,0 +1,92 @@ +[API](../README.md) / [index-writer](../modules/index_writer.md) / IndexWriter + +# Class: IndexWriter\ + +[index-writer](../modules/index_writer.md).IndexWriter + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TTables` | [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | + +## Table of contents + +### Constructors + +- [constructor](index_writer.IndexWriter.md#constructor) + +### Accessors + +- [schemas](index_writer.IndexWriter.md#schemas) + +### Methods + +- [batch](index_writer.IndexWriter.md#batch) + +## Constructors + +### constructor + +• **new IndexWriter**\<`TTables`\>(`opts`): [`IndexWriter`](index_writer.IndexWriter.md)\<`TTables`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TTables` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) = [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.getWinner` | `undefined` \| \(`docA`: `T`, `docB`: `U`) => `T` \| `U` | custom function to determine the "winner" of two forked documents. Defaults to choosing the document with the most recent `updatedAt` | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | | +| `opts.mapDoc` | `undefined` \| (`doc`: `MapeoDocInternal`, `version`: `VersionIdObject`) => `MapeoDoc` | optionally transform a document prior to indexing. Can also validate, if an error is thrown then the document will not be indexed | +| `opts.sqlite` | `Database` | | +| `opts.tables` | `TTables`[] | | + +#### Returns + +[`IndexWriter`](index_writer.IndexWriter.md)\<`TTables`\> + +#### Defined in + +[src/index-writer/index.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L38) + +## Accessors + +### schemas + +• `get` **schemas**(): `TTables`[``"_"``][``"name"``][] + +#### Returns + +`TTables`[``"_"``][``"name"``][] + +#### Defined in + +[src/index-writer/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L55) + +## Methods + +### batch + +▸ **batch**(`entries`): `Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `entries` | `Entry`\<``"binary"``\>[] | + +#### Returns + +`Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> + +map of indexed docIds by schemaName + +#### Defined in + +[src/index-writer/index.js:63](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L63) diff --git a/docs/api/classes/invite_api.InviteApi.md b/docs/api/classes/invite_api.InviteApi.md new file mode 100644 index 000000000..59d59ec70 --- /dev/null +++ b/docs/api/classes/invite_api.InviteApi.md @@ -0,0 +1,129 @@ +[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteApi + +# Class: InviteApi + +[invite-api](../modules/invite_api.md).InviteApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`InviteApi`** + +## Table of contents + +### Constructors + +- [constructor](invite_api.InviteApi.md#constructor) + +### Properties + +- [rpc](invite_api.InviteApi.md#rpc) + +### Methods + +- [accept](invite_api.InviteApi.md#accept) +- [getPending](invite_api.InviteApi.md#getpending) +- [reject](invite_api.InviteApi.md#reject) + +## Constructors + +### constructor + +• **new InviteApi**(`options`): [`InviteApi`](invite_api.InviteApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.logger` | `undefined` \| [`Logger`](logger.Logger.md) | +| `options.queries` | `Object` | +| `options.queries.addProject` | (`projectDetails`: `Pick`\<[`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` }) => `Promise`\<`unknown`\> | +| `options.queries.isMember` | (`projectId`: `string`) => `boolean` | +| `options.rpc` | [`LocalPeers`](local_peers.LocalPeers.md) | + +#### Returns + +[`InviteApi`](invite_api.InviteApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/invite-api.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L175) + +## Properties + +### rpc + +• **rpc**: [`LocalPeers`](local_peers.LocalPeers.md) + +#### Defined in + +[src/invite-api.js:180](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L180) + +## Methods + +### accept + +▸ **accept**(`invite`): `Promise`\<`string`\> + +Attempt to accept the invite. + +This can fail if the invitor has canceled the invite or if you cannot +connect to the invitor's device. + +If the invite is accepted and you had other invites to the same project, +those invites are removed, and the invitors are told that you're already +part of this project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `Pick`\<[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, ``"inviteId"``\> | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/invite-api.js:286](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L286) + +___ + +### getPending + +▸ **getPending**(): [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>[] + +#### Returns + +[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>[] + +#### Defined in + +[src/invite-api.js:267](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L267) + +___ + +### reject + +▸ **reject**(`invite`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `Pick`\<[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, ``"inviteId"``\> | + +#### Returns + +`void` + +#### Defined in + +[src/invite-api.js:416](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L416) diff --git a/docs/api/classes/lib_hashmap.default.md b/docs/api/classes/lib_hashmap.default.md new file mode 100644 index 000000000..507eaebfa --- /dev/null +++ b/docs/api/classes/lib_hashmap.default.md @@ -0,0 +1,197 @@ +[API](../README.md) / [lib/hashmap](../modules/lib_hashmap.md) / default + +# Class: default\ + +[lib/hashmap](../modules/lib_hashmap.md).default + +`Map` uses same-value-zero equality for keys, which makes it more difficult +to use reference types like buffers. + +`HashMap` is very similar to `Map`, but accepts a hash function for keys. +This function should return a primitive, such as a number or string, which +will be used as the key. + +It doesn't contain all the functionality of `Map` because we don't need it, +but it should be fairly easy to update as needed. + +**`Example`** + +```ts +const join = (arr) => arr.join(' ') + +const map = new HashMap(join) + +map.set([1, 2], 3) +map.get([1, 2]) +// => 3 +``` + +## Type parameters + +| Name | +| :------ | +| `K` | +| `V` | + +## Table of contents + +### Constructors + +- [constructor](lib_hashmap.default.md#constructor) + +### Accessors + +- [size](lib_hashmap.default.md#size) + +### Methods + +- [delete](lib_hashmap.default.md#delete) +- [get](lib_hashmap.default.md#get) +- [has](lib_hashmap.default.md#has) +- [set](lib_hashmap.default.md#set) +- [values](lib_hashmap.default.md#values) + +## Constructors + +### constructor + +• **new default**\<`K`, `V`\>(`hash`, `iterable?`): [`default`](lib_hashmap.default.md)\<`K`, `V`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | `K` | +| `V` | extends `unknown` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `hash` | (`key`: `K`) => [`Primitive`](../modules/lib_hashmap.md#primitive) | `undefined` | +| `iterable?` | `Iterable`\<[`K`, `V`]\> | `[]` | + +#### Returns + +[`default`](lib_hashmap.default.md)\<`K`, `V`\> + +#### Defined in + +[src/lib/hashmap.js:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L37) + +## Accessors + +### size + +• `get` **size**(): `number` + +#### Returns + +`number` + +#### Defined in + +[src/lib/hashmap.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L45) + +## Methods + +### delete + +▸ **delete**(`key`): `boolean` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to remove. | + +#### Returns + +`boolean` + +`true` if the key was present and removed, `false` otherwise. + +#### Defined in + +[src/lib/hashmap.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L53) + +___ + +### get + +▸ **get**(`key`): `undefined` \| `V` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to look up. | + +#### Returns + +`undefined` \| `V` + +The element associated with `key`, or `undefined` if it's not present. + +#### Defined in + +[src/lib/hashmap.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L62) + +___ + +### has + +▸ **has**(`key`): `boolean` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to look up. | + +#### Returns + +`boolean` + +`true` if `key` is present in the map, `false` otherwise. + +#### Defined in + +[src/lib/hashmap.js:71](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L71) + +___ + +### set + +▸ **set**(`key`, `value`): [`default`](lib_hashmap.default.md)\<`K`, `V`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to update. | +| `value` | `V` | The value to add at `key`. | + +#### Returns + +[`default`](lib_hashmap.default.md)\<`K`, `V`\> + +The map. + +#### Defined in + +[src/lib/hashmap.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L81) + +___ + +### values + +▸ **values**(): `IterableIterator`\<`V`\> + +#### Returns + +`IterableIterator`\<`V`\> + +#### Defined in + +[src/lib/hashmap.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L90) diff --git a/docs/api/classes/local_peers.LocalPeers.md b/docs/api/classes/local_peers.LocalPeers.md new file mode 100644 index 000000000..ccbb72418 --- /dev/null +++ b/docs/api/classes/local_peers.LocalPeers.md @@ -0,0 +1,198 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / LocalPeers + +# Class: LocalPeers + +[local-peers](../modules/local_peers.md).LocalPeers + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LocalPeers`** + +## Table of contents + +### Constructors + +- [constructor](local_peers.LocalPeers.md#constructor) + +### Accessors + +- [peers](local_peers.LocalPeers.md#peers) + +### Methods + +- [connect](local_peers.LocalPeers.md#connect) +- [sendDeviceInfo](local_peers.LocalPeers.md#senddeviceinfo) +- [sendInvite](local_peers.LocalPeers.md#sendinvite) +- [sendInviteCancel](local_peers.LocalPeers.md#sendinvitecancel) +- [sendInviteResponse](local_peers.LocalPeers.md#sendinviteresponse) +- [sendProjectJoinDetails](local_peers.LocalPeers.md#sendprojectjoindetails) + +## Constructors + +### constructor + +• **new LocalPeers**(`opts?`): [`LocalPeers`](local_peers.LocalPeers.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `Object` | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | + +#### Returns + +[`LocalPeers`](local_peers.LocalPeers.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/local-peers.js:236](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L236) + +## Accessors + +### peers + +• `get` **peers**(): ([`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] + +#### Returns + +([`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] + +#### Defined in + +[src/local-peers.js:241](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L241) + +## Methods + +### connect + +▸ **connect**(`stream`): [`ReplicationStream`](../modules/types.md#replicationstream) + +Connect to a peer over an existing NoiseSecretStream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | `NoiseSecretStream`\<`any`\> | a NoiseSecretStream from @hyperswarm/secret-stream | + +#### Returns + +[`ReplicationStream`](../modules/types.md#replicationstream) + +#### Defined in + +[src/local-peers.js:310](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L310) + +___ + +### sendDeviceInfo + +▸ **sendDeviceInfo**(`deviceId`, `deviceInfo`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deviceId` | `string` | id of the peer you want to send to (publicKey of peer as hex string) | +| `deviceInfo` | [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | device info to send | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:298](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L298) + +___ + +### sendInvite + +▸ **sendInvite**(`deviceId`, `invite`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `invite` | [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:254](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L254) + +___ + +### sendInviteCancel + +▸ **sendInviteCancel**(`deviceId`, `inviteCancel`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `inviteCancel` | [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:265](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L265) + +___ + +### sendInviteResponse + +▸ **sendInviteResponse**(`deviceId`, `inviteResponse`): `Promise`\<`void`\> + +Respond to an invite from a peer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deviceId` | `string` | id of the peer you want to respond to (publicKey of peer as hex string) | +| `inviteResponse` | [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:277](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L277) + +___ + +### sendProjectJoinDetails + +▸ **sendProjectJoinDetails**(`deviceId`, `details`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `details` | [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:287](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L287) diff --git a/docs/api/classes/local_peers.PeerDisconnectedError.md b/docs/api/classes/local_peers.PeerDisconnectedError.md new file mode 100644 index 000000000..e26b271b1 --- /dev/null +++ b/docs/api/classes/local_peers.PeerDisconnectedError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerDisconnectedError + +# Class: PeerDisconnectedError + +[local-peers](../modules/local_peers.md).PeerDisconnectedError + +## Hierarchy + +- `Error` + + ↳ **`PeerDisconnectedError`** + +## Table of contents + +### Constructors + +- [constructor](local_peers.PeerDisconnectedError.md#constructor) + +### Properties + +- [name](local_peers.PeerDisconnectedError.md#name) + +## Constructors + +### constructor + +• **new PeerDisconnectedError**(`message?`): [`PeerDisconnectedError`](local_peers.PeerDisconnectedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerDisconnectedError`](local_peers.PeerDisconnectedError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:597](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L597) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:599](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L599) diff --git a/docs/api/classes/local_peers.PeerFailedConnectionError.md b/docs/api/classes/local_peers.PeerFailedConnectionError.md new file mode 100644 index 000000000..4ceae4883 --- /dev/null +++ b/docs/api/classes/local_peers.PeerFailedConnectionError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerFailedConnectionError + +# Class: PeerFailedConnectionError + +[local-peers](../modules/local_peers.md).PeerFailedConnectionError + +## Hierarchy + +- `Error` + + ↳ **`PeerFailedConnectionError`** + +## Table of contents + +### Constructors + +- [constructor](local_peers.PeerFailedConnectionError.md#constructor) + +### Properties + +- [name](local_peers.PeerFailedConnectionError.md#name) + +## Constructors + +### constructor + +• **new PeerFailedConnectionError**(`message?`): [`PeerFailedConnectionError`](local_peers.PeerFailedConnectionError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerFailedConnectionError`](local_peers.PeerFailedConnectionError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:605](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L605) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:607](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L607) diff --git a/docs/api/classes/local_peers.UnknownPeerError.md b/docs/api/classes/local_peers.UnknownPeerError.md new file mode 100644 index 000000000..838a8e68f --- /dev/null +++ b/docs/api/classes/local_peers.UnknownPeerError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / UnknownPeerError + +# Class: UnknownPeerError + +[local-peers](../modules/local_peers.md).UnknownPeerError + +## Hierarchy + +- `Error` + + ↳ **`UnknownPeerError`** + +## Table of contents + +### Constructors + +- [constructor](local_peers.UnknownPeerError.md#constructor) + +### Properties + +- [name](local_peers.UnknownPeerError.md#name) + +## Constructors + +### constructor + +• **new UnknownPeerError**(`message?`): [`UnknownPeerError`](local_peers.UnknownPeerError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`UnknownPeerError`](local_peers.UnknownPeerError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:589](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L589) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:591](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L591) diff --git a/docs/api/classes/logger.Logger.md b/docs/api/classes/logger.Logger.md new file mode 100644 index 000000000..08fcf6a19 --- /dev/null +++ b/docs/api/classes/logger.Logger.md @@ -0,0 +1,133 @@ +[API](../README.md) / [logger](../modules/logger.md) / Logger + +# Class: Logger + +[logger](../modules/logger.md).Logger + +## Table of contents + +### Constructors + +- [constructor](logger.Logger.md#constructor) + +### Properties + +- [deviceId](logger.Logger.md#deviceid) + +### Accessors + +- [enabled](logger.Logger.md#enabled) + +### Methods + +- [extend](logger.Logger.md#extend) +- [log](logger.Logger.md#log) +- [create](logger.Logger.md#create) + +## Constructors + +### constructor + +• **new Logger**(`opts`): [`Logger`](logger.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.baseLogger` | `undefined` \| `Debugger` | +| `opts.deviceId` | `string` | +| `opts.ns` | `undefined` \| `string` | + +#### Returns + +[`Logger`](logger.Logger.md) + +#### Defined in + +[src/logger.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L72) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/logger.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L73) + +## Accessors + +### enabled + +• `get` **enabled**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/logger.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L77) + +## Methods + +### extend + +▸ **extend**(`ns`): [`Logger`](logger.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ns` | `string` | + +#### Returns + +[`Logger`](logger.Logger.md) + +#### Defined in + +[src/logger.js:91](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L91) + +___ + +### log + +▸ **log**(`...args`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [formatter: any, ...args: any[]] | + +#### Returns + +`void` + +#### Defined in + +[src/logger.js:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L84) + +___ + +### create + +▸ **create**(`ns`, `logger?`): [`Logger`](logger.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ns` | `string` | +| `logger?` | [`Logger`](logger.Logger.md) | + +#### Returns + +[`Logger`](logger.Logger.md) + +#### Defined in + +[src/logger.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L59) diff --git a/docs/api/classes/mapeo_manager.MapeoManager.md b/docs/api/classes/mapeo_manager.MapeoManager.md new file mode 100644 index 000000000..79da96876 --- /dev/null +++ b/docs/api/classes/mapeo_manager.MapeoManager.md @@ -0,0 +1,377 @@ +[API](../README.md) / [mapeo-manager](../modules/mapeo_manager.md) / MapeoManager + +# Class: MapeoManager + +[mapeo-manager](../modules/mapeo_manager.md).MapeoManager + +## Hierarchy + +- `TypedEmitter` + + ↳ **`MapeoManager`** + +## Table of contents + +### Constructors + +- [constructor](mapeo_manager.MapeoManager.md#constructor) + +### Accessors + +- [[kRPC]](mapeo_manager.MapeoManager.md#[krpc]) +- [deviceId](mapeo_manager.MapeoManager.md#deviceid) +- [invite](mapeo_manager.MapeoManager.md#invite) + +### Methods + +- [[kManagerReplicate]](mapeo_manager.MapeoManager.md#[kmanagerreplicate]) +- [addProject](mapeo_manager.MapeoManager.md#addproject) +- [connectPeer](mapeo_manager.MapeoManager.md#connectpeer) +- [createProject](mapeo_manager.MapeoManager.md#createproject) +- [getDeviceInfo](mapeo_manager.MapeoManager.md#getdeviceinfo) +- [getMapStyleJsonUrl](mapeo_manager.MapeoManager.md#getmapstylejsonurl) +- [getProject](mapeo_manager.MapeoManager.md#getproject) +- [leaveProject](mapeo_manager.MapeoManager.md#leaveproject) +- [listLocalPeers](mapeo_manager.MapeoManager.md#listlocalpeers) +- [listProjects](mapeo_manager.MapeoManager.md#listprojects) +- [setDeviceInfo](mapeo_manager.MapeoManager.md#setdeviceinfo) +- [startLocalPeerDiscoveryServer](mapeo_manager.MapeoManager.md#startlocalpeerdiscoveryserver) +- [stopLocalPeerDiscoveryServer](mapeo_manager.MapeoManager.md#stoplocalpeerdiscoveryserver) + +## Constructors + +### constructor + +• **new MapeoManager**(`opts`): [`MapeoManager`](mapeo_manager.MapeoManager.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.clientMigrationsFolder` | `string` | path for drizzle migrations folder for client database | +| `opts.coreStorage` | `string` \| [`CoreStorage`](../modules/types.md#corestorage) | Folder for hypercore storage or a function that returns a RandomAccessStorage instance | +| `opts.dbFolder` | `string` | Folder for sqlite Dbs. Folder must exist. Use ':memory:' to store everything in-memory | +| `opts.defaultConfigPath` | `undefined` \| `string` | | +| `opts.deviceType` | `undefined` \| [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) | Device type, shared with local peers and project members | +| `opts.fastify` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | Fastify server instance | +| `opts.projectMigrationsFolder` | `string` | path for drizzle migrations folder for project database | +| `opts.rootKey` | `Buffer` | 16-bytes of random data that uniquely identify the device, used to derive a 32-byte master key, which is used to derive all the keypairs used for Mapeo | + +#### Returns + +[`MapeoManager`](mapeo_manager.MapeoManager.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L110) + +## Accessors + +### [kRPC] + +• `get` **[kRPC]**(): [`LocalPeers`](local_peers.LocalPeers.md) + +MapeoRPC instance, used for tests + +#### Returns + +[`LocalPeers`](local_peers.LocalPeers.md) + +#### Defined in + +[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L201) + +___ + +### deviceId + +• `get` **deviceId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L205) + +___ + +### invite + +• `get` **invite**(): [`InviteApi`](invite_api.InviteApi.md) + +#### Returns + +[`InviteApi`](invite_api.InviteApi.md) + +#### Defined in + +[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L731) + +## Methods + +### [kManagerReplicate] + +▸ **[kManagerReplicate]**(`isInitiator`): [`ReplicationStream`](../modules/types.md#replicationstream) + +Create a Mapeo replication stream. This replication connects the Mapeo RPC +channel and allows invites. All active projects will sync automatically to +this replication stream. Only use for local (trusted) connections, because +the RPC channel key is public. To sync a specific project without +connecting RPC, use project[kProjectReplication]. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `isInitiator` | `boolean` | + +#### Returns + +[`ReplicationStream`](../modules/types.md#replicationstream) + +#### Defined in + +[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L218) + +___ + +### addProject + +▸ **addProject**(`projectJoinDetails`, `opts?`): `Promise`\<`string`\> + +Add a project to this device. After adding a project the client should +await `project.$waitForInitialSync()` to ensure that the device has +downloaded their proof of project membership and the project config. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `projectJoinDetails` | `Pick`\<[`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` } | `undefined` | | +| `opts?` | `Object` | `{}` | For internal use in tests, set opts.waitForSync = false to not wait for sync during addProject() | +| `opts.waitForSync?` | `boolean` | `true` | - | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L542) + +___ + +### connectPeer + +▸ **connectPeer**(`peer`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peer` | `Object` | +| `peer.address` | `string` | +| `peer.name` | `string` | +| `peer.port` | `number` | + +#### Returns + +`void` + +#### Defined in + +[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L746) + +___ + +### createProject + +▸ **createProject**(`options?`): `Promise`\<`string`\> + +Create a new project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.configPath?` | `string` | + +#### Returns + +`Promise`\<`string`\> + +Project public id + +#### Defined in + +[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L350) + +___ + +### getDeviceInfo + +▸ **getDeviceInfo**(): \{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam)\> + +#### Returns + +\{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam)\> + +#### Defined in + +[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L719) + +___ + +### getMapStyleJsonUrl + +▸ **getMapStyleJsonUrl**(): `Promise`\<`string`\> + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L806) + +___ + +### getProject + +▸ **getProject**(`projectPublicId`): `Promise`\<[`MapeoProject`](mapeo_project.MapeoProject.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectPublicId` | `string` | + +#### Returns + +`Promise`\<[`MapeoProject`](mapeo_project.MapeoProject.md)\> + +#### Defined in + +[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L426) + +___ + +### leaveProject + +▸ **leaveProject**(`projectPublicId`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectPublicId` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L760) + +___ + +### listLocalPeers + +▸ **listLocalPeers**(): `Promise`\<[`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]\> + +#### Returns + +`Promise`\<[`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]\> + +#### Defined in + +[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L753) + +___ + +### listProjects + +▸ **listProjects**(): `Promise`\<`Pick`\<{}, ``"name"``\> & \{ `createdAt?`: `string` ; `projectId`: `string` ; `updatedAt?`: `string` }[]\> + +#### Returns + +`Promise`\<`Pick`\<{}, ``"name"``\> & \{ `createdAt?`: `string` ; `projectId`: `string` ; `updatedAt?`: `string` }[]\> + +#### Defined in + +[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L485) + +___ + +### setDeviceInfo + +▸ **setDeviceInfo**\<`T`\>(`deviceInfo`): `Promise`\<`void`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam) \| `ExactObject`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam), `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceInfo` | `T` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L686) + +___ + +### startLocalPeerDiscoveryServer + +▸ **startLocalPeerDiscoveryServer**(): `Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Returns + +`Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Defined in + +[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L736) + +___ + +### stopLocalPeerDiscoveryServer + +▸ **stopLocalPeerDiscoveryServer**(`opts?`): `Promise`\<`void`\> + +Close all servers and stop multicast advertising and browsing. Will wait +for open sockets to close unless opts.force=true in which case open sockets +are force-closed after opts.timeout milliseconds + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts?` | `Object` | | +| `opts.force` | `undefined` \| `boolean` | Force-close open sockets after timeout milliseconds | +| `opts.timeout` | `undefined` \| `number` | Optional timeout when calling stop() with force=true | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L741) diff --git a/docs/api/classes/mapeo_project.MapeoProject.md b/docs/api/classes/mapeo_project.MapeoProject.md new file mode 100644 index 000000000..c82aeebf4 --- /dev/null +++ b/docs/api/classes/mapeo_project.MapeoProject.md @@ -0,0 +1,449 @@ +[API](../README.md) / [mapeo-project](../modules/mapeo_project.md) / MapeoProject + +# Class: MapeoProject + +[mapeo-project](../modules/mapeo_project.md).MapeoProject + +## Hierarchy + +- `TypedEmitter` + + ↳ **`MapeoProject`** + +## Table of contents + +### Constructors + +- [constructor](mapeo_project.MapeoProject.md#constructor) + +### Properties + +- [$blobs](mapeo_project.MapeoProject.md#$blobs) +- [EMPTY\_PROJECT\_SETTINGS](mapeo_project.MapeoProject.md#empty_project_settings) + +### Accessors + +- [$icons](mapeo_project.MapeoProject.md#$icons) +- [$member](mapeo_project.MapeoProject.md#$member) +- [$sync](mapeo_project.MapeoProject.md#$sync) +- [[kBlobStore]](mapeo_project.MapeoProject.md#[kblobstore]) +- [[kCoreManager]](mapeo_project.MapeoProject.md#[kcoremanager]) +- [[kCoreOwnership]](mapeo_project.MapeoProject.md#[kcoreownership]) +- [[kDataTypes]](mapeo_project.MapeoProject.md#[kdatatypes]) +- [deviceId](mapeo_project.MapeoProject.md#deviceid) +- [field](mapeo_project.MapeoProject.md#field) +- [observation](mapeo_project.MapeoProject.md#observation) +- [preset](mapeo_project.MapeoProject.md#preset) +- [track](mapeo_project.MapeoProject.md#track) + +### Methods + +- [$getOwnRole](mapeo_project.MapeoProject.md#$getownrole) +- [$getProjectSettings](mapeo_project.MapeoProject.md#$getprojectsettings) +- [$setProjectSettings](mapeo_project.MapeoProject.md#$setprojectsettings) +- [[kProjectLeave]](mapeo_project.MapeoProject.md#[kprojectleave]) +- [[kProjectReplicate]](mapeo_project.MapeoProject.md#[kprojectreplicate]) +- [[kSetOwnDeviceInfo]](mapeo_project.MapeoProject.md#[ksetowndeviceinfo]) +- [close](mapeo_project.MapeoProject.md#close) +- [importConfig](mapeo_project.MapeoProject.md#importconfig) +- [ready](mapeo_project.MapeoProject.md#ready) + +## Constructors + +### constructor + +• **new MapeoProject**(`opts`): [`MapeoProject`](mapeo_project.MapeoProject.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreStorage` | [`CoreStorage`](../modules/types.md#corestorage) | Folder to store all hypercore data | +| `opts.dbPath` | `string` | Path to store project sqlite db. Use `:memory:` for memory storage | +| `opts.encryptionKeys` | [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | Encryption keys for each namespace | +| `opts.getMediaBaseUrl` | (`mediaType`: ``"blobs"`` \| ``"icons"``) => `Promise`\<`string`\> | | +| `opts.keyManager` | `KeyManager` | mapeo/crypto KeyManager instance | +| `opts.localPeers` | [`LocalPeers`](local_peers.LocalPeers.md) | | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | | +| `opts.projectKey` | `Buffer` | 32-byte public key of the project creator core | +| `opts.projectMigrationsFolder` | `string` | path for drizzle migration folder for project | +| `opts.projectSecretKey` | `undefined` \| `Buffer` | 32-byte secret key of the project creator core | +| `opts.sharedDb` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | | +| `opts.sharedIndexWriter` | [`IndexWriter`](index_writer.IndexWriter.md)\<[`MapeoDocTables`](../modules/index_writer.md#mapeodoctables)\> | | + +#### Returns + +[`MapeoProject`](mapeo_project.MapeoProject.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/mapeo-project.js:103](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L103) + +## Properties + +### $blobs + +• **$blobs**: [`BlobApi`](blob_api.BlobApi.md) + +#### Defined in + +[src/mapeo-project.js:284](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L284) + +___ + +### EMPTY\_PROJECT\_SETTINGS + +▪ `Static` **EMPTY\_PROJECT\_SETTINGS**: `Readonly`\<{}\> = `EMPTY_PROJECT_SETTINGS` + +#### Defined in + +[src/mapeo-project.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L85) + +## Accessors + +### $icons + +• `get` **$icons**(): [`IconApi`](icon_api.IconApi.md) + +#### Returns + +[`IconApi`](icon_api.IconApi.md) + +#### Defined in + +[src/mapeo-project.js:566](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L566) + +___ + +### $member + +• `get` **$member**(): [`MemberApi`](member_api.MemberApi.md) + +#### Returns + +[`MemberApi`](member_api.MemberApi.md) + +#### Defined in + +[src/mapeo-project.js:453](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L453) + +___ + +### $sync + +• `get` **$sync**(): [`SyncApi`](sync_sync_api.SyncApi.md) + +#### Returns + +[`SyncApi`](sync_sync_api.SyncApi.md) + +#### Defined in + +[src/mapeo-project.js:457](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L457) + +___ + +### [kBlobStore] + +• `get` **[kBlobStore]**(): [`BlobStore`](blob_store.BlobStore.md) + +#### Returns + +[`BlobStore`](blob_store.BlobStore.md) + +#### Defined in + +[src/mapeo-project.js:373](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L373) + +___ + +### [kCoreManager] + +• `get` **[kCoreManager]**(): [`CoreManager`](core_manager.CoreManager.md) + +CoreManager instance, used for tests + +#### Returns + +[`CoreManager`](core_manager.CoreManager.md) + +#### Defined in + +[src/mapeo-project.js:355](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L355) + +___ + +### [kCoreOwnership] + +• `get` **[kCoreOwnership]**(): [`CoreOwnership`](core_ownership.CoreOwnership.md) + +CoreOwnership instance, used for tests + +#### Returns + +[`CoreOwnership`](core_ownership.CoreOwnership.md) + +#### Defined in + +[src/mapeo-project.js:362](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L362) + +___ + +### [kDataTypes] + +• `get` **[kDataTypes]**(): `Object` + +DataTypes object mappings, used for tests + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `coreOwnership` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | +| `deviceInfo` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\> | +| `field` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> | +| `icon` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | +| `observation` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> | +| `preset` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> | +| `projectSettings` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\> | +| `role` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | +| `track` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> | + +#### Defined in + +[src/mapeo-project.js:369](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L369) + +___ + +### deviceId + +• `get` **deviceId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/mapeo-project.js:377](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L377) + +___ + +### field + +• `get` **field**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> + +#### Returns + +[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:449](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L449) + +___ + +### observation + +• `get` **observation**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> + +#### Returns + +[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:440](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L440) + +___ + +### preset + +• `get` **preset**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> + +#### Returns + +[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:446](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L446) + +___ + +### track + +• `get` **track**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> + +#### Returns + +[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:443](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L443) + +## Methods + +### $getOwnRole + +▸ **$getOwnRole**(): `Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Returns + +`Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Defined in + +[src/mapeo-project.js:508](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L508) + +___ + +### $getProjectSettings + +▸ **$getProjectSettings**(): `Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> + +#### Returns + +`Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> + +#### Defined in + +[src/mapeo-project.js:497](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L497) + +___ + +### $setProjectSettings + +▸ **$setProjectSettings**(`settings`): `Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `settings` | `Partial`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> | + +#### Returns + +`Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> + +#### Defined in + +[src/mapeo-project.js:465](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L465) + +___ + +### [kProjectLeave] + +▸ **[kProjectLeave]**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:570](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L570) + +___ + +### [kProjectReplicate] + +▸ **[kProjectReplicate]**(`stream`): `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +Replicate a project to a @hyperswarm/secret-stream. Invites will not +function because the RPC channel is not connected for project replication, +and only this project will replicate (to replicate multiple projects you +need to replicate the manager instance via manager[kManagerReplicate]) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | A duplex stream, a @hyperswarm/secret-stream, or a Protomux instance | + +#### Returns + +`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Defined in + +[src/mapeo-project.js:521](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L521) + +___ + +### [kSetOwnDeviceInfo] + +▸ **[kSetOwnDeviceInfo]**(`value`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `Pick`\<{}, ``"name"`` \| ``"deviceType"``\> | + +#### Returns + +`Promise`\<{}\> + +#### Defined in + +[src/mapeo-project.js:540](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L540) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:390](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L390) + +___ + +### importConfig + +▸ **importConfig**(`opts`): `Promise`\<`Error`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.configPath` | `string` | + +#### Returns + +`Promise`\<`Error`[]\> + +#### Defined in + +[src/mapeo-project.js:651](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L651) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +Resolves when hypercores have all loaded + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:384](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L384) diff --git a/docs/api/classes/member_api.MemberApi.md b/docs/api/classes/member_api.MemberApi.md new file mode 100644 index 000000000..716f3cd75 --- /dev/null +++ b/docs/api/classes/member_api.MemberApi.md @@ -0,0 +1,164 @@ +[API](../README.md) / [member-api](../modules/member_api.md) / MemberApi + +# Class: MemberApi + +[member-api](../modules/member_api.md).MemberApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`MemberApi`** + +## Table of contents + +### Constructors + +- [constructor](member_api.MemberApi.md#constructor) + +### Methods + +- [assignRole](member_api.MemberApi.md#assignrole) +- [getById](member_api.MemberApi.md#getbyid) +- [getMany](member_api.MemberApi.md#getmany) +- [invite](member_api.MemberApi.md#invite) +- [requestCancelInvite](member_api.MemberApi.md#requestcancelinvite) + +## Constructors + +### constructor + +• **new MemberApi**(`opts`): [`MemberApi`](member_api.MemberApi.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreOwnership` | [`CoreOwnership`](core_ownership.CoreOwnership.md) | | +| `opts.dataTypes` | `Object` | | +| `opts.dataTypes.deviceInfo` | `Pick`\<[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\>, ``"getByDocId"`` \| ``"getMany"``\> | - | +| `opts.dataTypes.project` | `Pick`\<[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\>, ``"getByDocId"``\> | - | +| `opts.deviceId` | `string` | public key of this device as hex string | +| `opts.encryptionKeys` | [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | | +| `opts.projectKey` | `Buffer` | | +| `opts.roles` | [`Roles`](roles.Roles.md) | | +| `opts.rpc` | [`LocalPeers`](local_peers.LocalPeers.md) | | + +#### Returns + +[`MemberApi`](member_api.MemberApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/member-api.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L59) + +## Methods + +### assignRole + +▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/member-api.js:308](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L308) + +___ + +### getById + +▸ **getById**(`deviceId`): `Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)\> + +#### Defined in + +[src/member-api.js:239](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L239) + +___ + +### getMany + +▸ **getMany**(): `Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)[]\> + +#### Returns + +`Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)[]\> + +#### Defined in + +[src/member-api.js:269](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L269) + +___ + +### invite + +▸ **invite**(`deviceId`, `opts`): `Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> + +Send an invite. Resolves when receiving a response. Rejects if the invite +is canceled, or if something else goes wrong. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `opts` | `Object` | +| `opts.roleDescription` | `undefined` \| `string` | +| `opts.roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | +| `opts.roleName` | `undefined` \| `string` | + +#### Returns + +`Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> + +#### Defined in + +[src/member-api.js:93](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L93) + +___ + +### requestCancelInvite + +▸ **requestCancelInvite**(`deviceId`): `void` + +Attempt to cancel an outbound invite, if it exists. + +No-op if we weren't inviting this device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/member-api.js:231](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L231) diff --git a/docs/api/classes/roles.Roles.md b/docs/api/classes/roles.Roles.md new file mode 100644 index 000000000..9617f7db5 --- /dev/null +++ b/docs/api/classes/roles.Roles.md @@ -0,0 +1,125 @@ +[API](../README.md) / [roles](../modules/roles.md) / Roles + +# Class: Roles + +[roles](../modules/roles.md).Roles + +## Table of contents + +### Constructors + +- [constructor](roles.Roles.md#constructor) + +### Properties + +- [NO\_ROLE](roles.Roles.md#no_role) + +### Methods + +- [assignRole](roles.Roles.md#assignrole) +- [getAll](roles.Roles.md#getall) +- [getRole](roles.Roles.md#getrole) + +## Constructors + +### constructor + +• **new Roles**(`opts`): [`Roles`](roles.Roles.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | | +| `opts.coreOwnership` | [`CoreOwnership`](core_ownership.CoreOwnership.md) | | +| `opts.dataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | | +| `opts.deviceKey` | `Buffer` | public key of this device | +| `opts.projectKey` | `Buffer` | | + +#### Returns + +[`Roles`](roles.Roles.md) + +#### Defined in + +[src/roles.js:240](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L240) + +## Properties + +### NO\_ROLE + +▪ `Static` **NO\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> = `NO_ROLE` + +#### Defined in + +[src/roles.js:223](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L223) + +## Methods + +### assignRole + +▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> + +Assign a role to the specified `deviceId`. Devices without an assigned role +are unable to sync, except the project creator who can do anything. Only +the project creator can assign their own role. Will throw if the device's +role cannot assign the role by consulting `roleAssignment`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/roles.js:332](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L332) + +___ + +### getAll + +▸ **getAll**(): `Promise`\<`Map`\<`string`, [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> + +Get roles of all devices in the project. For your own device, if you have +not yet synced your own role record, the "no role" capabilties is +returned. The project creator will have the creator role unless a +different one has been assigned. + +#### Returns + +`Promise`\<`Map`\<`string`, [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> + +Map of deviceId to Role + +#### Defined in + +[src/roles.js:285](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L285) + +___ + +### getRole + +▸ **getRole**(`deviceId`): `Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +Get the role for device `deviceId`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Defined in + +[src/roles.js:254](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L254) diff --git a/docs/api/classes/sync_core_sync_state.CoreSyncState.md b/docs/api/classes/sync_core_sync_state.CoreSyncState.md new file mode 100644 index 000000000..bbd49f6ce --- /dev/null +++ b/docs/api/classes/sync_core_sync_state.CoreSyncState.md @@ -0,0 +1,166 @@ +[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / CoreSyncState + +# Class: CoreSyncState + +[sync/core-sync-state](../modules/sync_core_sync_state.md).CoreSyncState + +Track sync state for a core identified by `discoveryId`. Can start tracking +state before the core instance exists locally, via the "preHave" messages +received over the project creator core. + +Because deriving the state is expensive (it iterates through the bitfields of +all peers), this is designed to be pull-based: the onUpdate event signals +that the state is updated, but does not pass the state. The consumer can +"pull" the state when it wants it via `coreSyncState.getState()`. + +Each peer (including the local peer) has a state of: + 1. `have` - number of blocks the peer has locally + 2. `want` - number of blocks the peer wants, and at least one peer has + 3. `wanted` - number of blocks the peer has that at least one peer wants + 4. `missing` - number of blocks the peer wants but no peer has + +## Table of contents + +### Constructors + +- [constructor](sync_core_sync_state.CoreSyncState.md#constructor) + +### Methods + +- [addPeer](sync_core_sync_state.CoreSyncState.md#addpeer) +- [attachCore](sync_core_sync_state.CoreSyncState.md#attachcore) +- [getState](sync_core_sync_state.CoreSyncState.md#getstate) +- [insertPreHaves](sync_core_sync_state.CoreSyncState.md#insertprehaves) +- [setPeerWants](sync_core_sync_state.CoreSyncState.md#setpeerwants) + +## Constructors + +### constructor + +• **new CoreSyncState**(`opts`): [`CoreSyncState`](sync_core_sync_state.CoreSyncState.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | +| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | | + +#### Returns + +[`CoreSyncState`](sync_core_sync_state.CoreSyncState.md) + +#### Defined in + +[src/sync/core-sync-state.js:74](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L74) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:176](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L176) + +___ + +### attachCore + +▸ **attachCore**(`core`): `void` + +Attach a core. The sync state can be initialized without a core instance, +because we could receive peer want and have states via extension messages +before we have the core key that allows us to create a core instance. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `core` | `Hypercore`\<``"binary"``, `Buffer`\> | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:105](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L105) + +___ + +### getState + +▸ **getState**(): [`DerivedState`](../interfaces/sync_core_sync_state.DerivedState.md) + +#### Returns + +[`DerivedState`](../interfaces/sync_core_sync_state.DerivedState.md) + +#### Defined in + +[src/sync/core-sync-state.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L85) + +___ + +### insertPreHaves + +▸ **insertPreHaves**(`peerId`, `start`, `bitfield`): `void` + +Add a pre-emptive "have" bitfield for a peer. This is used when we receive +a peer "have" via extension message - it allows us to have a state for the +peer before the peer actually starts syncing this core + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `start` | `number` | +| `bitfield` | `Uint32Array` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:147](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L147) + +___ + +### setPeerWants + +▸ **setPeerWants**(`peerId`, `ranges`): `void` + +Add a ranges of wanted blocks for a peer. By default a peer wants all +blocks in a core - calling this will change the peer to only want the +blocks/ranges that are added here + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `ranges` | \{ `length`: `number` ; `start`: `number` }[] | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:165](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L165) diff --git a/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md b/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md new file mode 100644 index 000000000..052c53ea2 --- /dev/null +++ b/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md @@ -0,0 +1,104 @@ +[API](../README.md) / [sync/namespace-sync-state](../modules/sync_namespace_sync_state.md) / NamespaceSyncState + +# Class: NamespaceSyncState\ + +[sync/namespace-sync-state](../modules/sync_namespace_sync_state.md).NamespaceSyncState + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | [`core-manager`](../modules/core_manager.md) | + +## Table of contents + +### Constructors + +- [constructor](sync_namespace_sync_state.NamespaceSyncState.md#constructor) + +### Accessors + +- [namespace](sync_namespace_sync_state.NamespaceSyncState.md#namespace) + +### Methods + +- [addPeer](sync_namespace_sync_state.NamespaceSyncState.md#addpeer) +- [getState](sync_namespace_sync_state.NamespaceSyncState.md#getstate) + +## Constructors + +### constructor + +• **new NamespaceSyncState**\<`TNamespace`\>(`opts`): [`NamespaceSyncState`](sync_namespace_sync_state.NamespaceSyncState.md)\<`TNamespace`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | extends ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` = ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | | +| `opts.namespace` | `TNamespace` | | +| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | | + +#### Returns + +[`NamespaceSyncState`](sync_namespace_sync_state.NamespaceSyncState.md)\<`TNamespace`\> + +#### Defined in + +[src/sync/namespace-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L28) + +## Accessors + +### namespace + +• `get` **namespace**(): `TNamespace` + +#### Returns + +`TNamespace` + +#### Defined in + +[src/sync/namespace-sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L53) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/namespace-sync-state.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L90) + +___ + +### getState + +▸ **getState**(): [`SyncState`](../modules/sync_namespace_sync_state.md#syncstate) + +#### Returns + +[`SyncState`](../modules/sync_namespace_sync_state.md#syncstate) + +#### Defined in + +[src/sync/namespace-sync-state.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L58) diff --git a/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md b/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md new file mode 100644 index 000000000..0b8c96ead --- /dev/null +++ b/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md @@ -0,0 +1,145 @@ +[API](../README.md) / [sync/peer-sync-controller](../modules/sync_peer_sync_controller.md) / PeerSyncController + +# Class: PeerSyncController + +[sync/peer-sync-controller](../modules/sync_peer_sync_controller.md).PeerSyncController + +## Table of contents + +### Constructors + +- [constructor](sync_peer_sync_controller.PeerSyncController.md#constructor) + +### Accessors + +- [peerId](sync_peer_sync_controller.PeerSyncController.md#peerid) +- [peerKey](sync_peer_sync_controller.PeerSyncController.md#peerkey) +- [syncCapability](sync_peer_sync_controller.PeerSyncController.md#synccapability) + +### Methods + +- [disableDataSync](sync_peer_sync_controller.PeerSyncController.md#disabledatasync) +- [enableDataSync](sync_peer_sync_controller.PeerSyncController.md#enabledatasync) +- [handleDiscoveryKey](sync_peer_sync_controller.PeerSyncController.md#handlediscoverykey) + +## Constructors + +### constructor + +• **new PeerSyncController**(`opts`): [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | +| `opts.protomux` | `Protomux`\<[`OpenedNoiseStream`](../modules/utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | +| `opts.roles` | [`Roles`](roles.Roles.md) | +| `opts.syncState` | [`SyncState`](sync_sync_state.SyncState.md) | + +#### Returns + +[`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md) + +#### Defined in + +[src/sync/peer-sync-controller.js:47](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L47) + +## Accessors + +### peerId + +• `get` **peerId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/sync/peer-sync-controller.js:74](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L74) + +___ + +### peerKey + +• `get` **peerKey**(): `Buffer` + +#### Returns + +`Buffer` + +#### Defined in + +[src/sync/peer-sync-controller.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L70) + +___ + +### syncCapability + +• `get` **syncCapability**(): `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/sync_peer_sync_controller.md#synccapability)\> + +#### Returns + +`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/sync_peer_sync_controller.md#synccapability)\> + +#### Defined in + +[src/sync/peer-sync-controller.js:78](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L78) + +## Methods + +### disableDataSync + +▸ **disableDataSync**(): `void` + +Disable syncing of data (in the data and blob namespaces). + +Syncing of metadata (auth, config and blobIndex namespaces) will continue +in the background without user interaction. + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L96) + +___ + +### enableDataSync + +▸ **enableDataSync**(): `void` + +Enable syncing of data (in the data and blob namespaces) + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L85) + +___ + +### handleDiscoveryKey + +▸ **handleDiscoveryKey**(`discoveryKey`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:104](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L104) diff --git a/docs/api/classes/sync_sync_api.SyncApi.md b/docs/api/classes/sync_sync_api.SyncApi.md new file mode 100644 index 000000000..12a56903f --- /dev/null +++ b/docs/api/classes/sync_sync_api.SyncApi.md @@ -0,0 +1,156 @@ +[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncApi + +# Class: SyncApi + +[sync/sync-api](../modules/sync_sync_api.md).SyncApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`SyncApi`** + +## Table of contents + +### Constructors + +- [constructor](sync_sync_api.SyncApi.md#constructor) + +### Properties + +- [[kSyncState]](sync_sync_api.SyncApi.md#[ksyncstate]) + +### Methods + +- [[kHandleDiscoveryKey]](sync_sync_api.SyncApi.md#[khandlediscoverykey]) +- [getState](sync_sync_api.SyncApi.md#getstate) +- [start](sync_sync_api.SyncApi.md#start) +- [stop](sync_sync_api.SyncApi.md#stop) +- [waitForSync](sync_sync_api.SyncApi.md#waitforsync) + +## Constructors + +### constructor + +• **new SyncApi**(`opts`): [`SyncApi`](sync_sync_api.SyncApi.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `opts` | `Object` | `undefined` | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | `undefined` | +| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | `undefined` | +| `opts.roles` | [`Roles`](roles.Roles.md) | `undefined` | +| `opts.throttleMs` | `undefined` \| `number` | `200` | + +#### Returns + +[`SyncApi`](sync_sync_api.SyncApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/sync/sync-api.js:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L67) + +## Properties + +### [kSyncState] + +• **[kSyncState]**: [`SyncState`](sync_sync_state.SyncState.md) + +#### Defined in + +[src/sync/sync-api.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L72) + +## Methods + +### [kHandleDiscoveryKey] + +▸ **[kHandleDiscoveryKey]**(`discoveryKey`, `protomux`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | +| `protomux` | `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:88](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L88) + +___ + +### getState + +▸ **getState**(): [`State`](../interfaces/sync_sync_api.State.md) + +Get the current sync state (initial and full). Also emitted via the 'sync-state' event + +#### Returns + +[`State`](../interfaces/sync_sync_api.State.md) + +#### Defined in + +[src/sync/sync-api.js:119](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L119) + +___ + +### start + +▸ **start**(): `void` + +Start syncing data cores + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:136](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L136) + +___ + +### stop + +▸ **stop**(): `void` + +Stop syncing data cores (metadata cores will continue syncing in the background) + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:149](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L149) + +___ + +### waitForSync + +▸ **waitForSync**(`type`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`SyncType`](../modules/sync_sync_api.md#synctype) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/sync/sync-api.js:163](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L163) diff --git a/docs/api/classes/sync_sync_state.SyncState.md b/docs/api/classes/sync_sync_state.SyncState.md new file mode 100644 index 000000000..a4f444765 --- /dev/null +++ b/docs/api/classes/sync_sync_state.SyncState.md @@ -0,0 +1,85 @@ +[API](../README.md) / [sync/sync-state](../modules/sync_sync_state.md) / SyncState + +# Class: SyncState + +[sync/sync-state](../modules/sync_sync_state.md).SyncState + +Emit sync state when it changes + +## Hierarchy + +- `TypedEmitter` + + ↳ **`SyncState`** + +## Table of contents + +### Constructors + +- [constructor](sync_sync_state.SyncState.md#constructor) + +### Methods + +- [addPeer](sync_sync_state.SyncState.md#addpeer) +- [getState](sync_sync_state.SyncState.md#getstate) + +## Constructors + +### constructor + +• **new SyncState**(`opts`): [`SyncState`](sync_sync_state.SyncState.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `opts` | `Object` | `undefined` | +| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | `undefined` | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | `undefined` | +| `opts.throttleMs` | `undefined` \| `number` | `200` | + +#### Returns + +[`SyncState`](sync_sync_state.SyncState.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/sync/sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L33) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L53) + +___ + +### getState + +▸ **getState**(): [`State`](../modules/sync_sync_state.md#state) + +#### Returns + +[`State`](../modules/sync_sync_state.md#state) + +#### Defined in + +[src/sync/sync-state.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L62) diff --git a/docs/api/classes/utils.ExhaustivenessError.md b/docs/api/classes/utils.ExhaustivenessError.md new file mode 100644 index 000000000..bcecc32ac --- /dev/null +++ b/docs/api/classes/utils.ExhaustivenessError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [utils](../modules/utils.md) / ExhaustivenessError + +# Class: ExhaustivenessError + +[utils](../modules/utils.md).ExhaustivenessError + +## Hierarchy + +- `Error` + + ↳ **`ExhaustivenessError`** + +## Table of contents + +### Constructors + +- [constructor](utils.ExhaustivenessError.md#constructor) + +### Properties + +- [name](utils.ExhaustivenessError.md#name) + +## Constructors + +### constructor + +• **new ExhaustivenessError**(`value`): [`ExhaustivenessError`](utils.ExhaustivenessError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `never` | + +#### Returns + +[`ExhaustivenessError`](utils.ExhaustivenessError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/utils.js:63](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L63) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/utils.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L65) diff --git a/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md b/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md new file mode 100644 index 000000000..9ba9099a7 --- /dev/null +++ b/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md @@ -0,0 +1,37 @@ +[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / BlobDownloadEvents + +# Interface: BlobDownloadEvents\<\> + +[blob-store/live-download](../modules/blob_store_live_download.md).BlobDownloadEvents + +## Table of contents + +### Properties + +- [state](blob_store_live_download.BlobDownloadEvents.md#state) + +## Properties + +### state + +• **state**: (`state`: [`BlobDownloadState`](blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror)) => `void` + +Emitted with the current download state whenever it changes (not emitted during initial 'checking' status) + +#### Type declaration + +▸ (`state`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`BlobDownloadState`](blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) | + +##### Returns + +`void` + +#### Defined in + +[src/blob-store/live-download.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L22) diff --git a/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md b/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md new file mode 100644 index 000000000..266aa725c --- /dev/null +++ b/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md @@ -0,0 +1,86 @@ +[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / BlobDownloadState + +# Interface: BlobDownloadState\<\> + +[blob-store/live-download](../modules/blob_store_live_download.md).BlobDownloadState + +## Table of contents + +### Properties + +- [error](blob_store_live_download.BlobDownloadState.md#error) +- [haveBytes](blob_store_live_download.BlobDownloadState.md#havebytes) +- [haveCount](blob_store_live_download.BlobDownloadState.md#havecount) +- [status](blob_store_live_download.BlobDownloadState.md#status) +- [wantBytes](blob_store_live_download.BlobDownloadState.md#wantbytes) +- [wantCount](blob_store_live_download.BlobDownloadState.md#wantcount) + +## Properties + +### error + +• **error**: ``null`` + +If status = 'error' then this will be an Error object + +#### Defined in + +[src/blob-store/live-download.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L14) + +___ + +### haveBytes + +• **haveBytes**: `number` + +The bytes already downloaded + +#### Defined in + +[src/blob-store/live-download.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L11) + +___ + +### haveCount + +• **haveCount**: `number` + +The number of files already downloaded + +#### Defined in + +[src/blob-store/live-download.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L10) + +___ + +### status + +• **status**: ``"checking"`` \| ``"downloading"`` \| ``"downloaded"`` \| ``"aborted"`` + +#### Defined in + +[src/blob-store/live-download.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L15) + +___ + +### wantBytes + +• **wantBytes**: `number` + +The bytes pending download + +#### Defined in + +[src/blob-store/live-download.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L13) + +___ + +### wantCount + +• **wantCount**: `number` + +The number of files pending download + +#### Defined in + +[src/blob-store/live-download.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L12) diff --git a/docs/api/interfaces/core_manager.Events.md b/docs/api/interfaces/core_manager.Events.md new file mode 100644 index 000000000..6efcf8efd --- /dev/null +++ b/docs/api/interfaces/core_manager.Events.md @@ -0,0 +1,65 @@ +[API](../README.md) / [core-manager](../modules/core_manager.md) / Events + +# Interface: Events\<\> + +[core-manager](../modules/core_manager.md).Events + +## Table of contents + +### Properties + +- [add-core](core_manager.Events.md#add-core) +- [peer-have](core_manager.Events.md#peer-have) + +## Properties + +### add-core + +• **add-core**: (`coreRecord`: [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)) => `void` + +#### Type declaration + +▸ (`coreRecord`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `coreRecord` | [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) | + +##### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L25) + +___ + +### peer-have + +• **peer-have**: (`namespace`: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `msg`: \{ `bitfield`: `Uint32Array` ; `coreDiscoveryId`: `string` ; `peerId`: `string` ; `start`: `number` }) => `void` + +#### Type declaration + +▸ (`namespace`, `msg`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | +| `msg` | `Object` | +| `msg.bitfield` | `Uint32Array` | +| `msg.coreDiscoveryId` | `string` | +| `msg.peerId` | `string` | +| `msg.start` | `number` | + +##### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L26) diff --git a/docs/api/interfaces/core_manager.HaveMsg.md b/docs/api/interfaces/core_manager.HaveMsg.md new file mode 100644 index 000000000..f74bfa4db --- /dev/null +++ b/docs/api/interfaces/core_manager.HaveMsg.md @@ -0,0 +1,54 @@ +[API](../README.md) / [core-manager](../modules/core_manager.md) / HaveMsg + +# Interface: HaveMsg\<\> + +[core-manager](../modules/core_manager.md).HaveMsg + +## Table of contents + +### Properties + +- [bitfield](core_manager.HaveMsg.md#bitfield) +- [discoveryKey](core_manager.HaveMsg.md#discoverykey) +- [namespace](core_manager.HaveMsg.md#namespace) +- [start](core_manager.HaveMsg.md#start) + +## Properties + +### bitfield + +• **bitfield**: `Uint32Array` + +#### Defined in + +[src/core-manager/index.js:500](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L500) + +___ + +### discoveryKey + +• **discoveryKey**: `Buffer` + +#### Defined in + +[src/core-manager/index.js:498](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L498) + +___ + +### namespace + +• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` + +#### Defined in + +[src/core-manager/index.js:501](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L501) + +___ + +### start + +• **start**: `number` + +#### Defined in + +[src/core-manager/index.js:499](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L499) diff --git a/docs/api/interfaces/datatype-1.DataTypeEvents.md b/docs/api/interfaces/datatype-1.DataTypeEvents.md new file mode 100644 index 000000000..e82fb395c --- /dev/null +++ b/docs/api/interfaces/datatype-1.DataTypeEvents.md @@ -0,0 +1,41 @@ +[API](../README.md) / [datatype](../modules/datatype-1.md) / DataTypeEvents + +# Interface: DataTypeEvents\ + +[datatype](../modules/datatype-1.md).DataTypeEvents + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TDoc` | extends `MapeoDoc` | + +## Table of contents + +### Properties + +- [updated-docs](datatype-1.DataTypeEvents.md#updated-docs) + +## Properties + +### updated-docs + +• **updated-docs**: (`docs`: `TDoc`[]) => `void` + +#### Type declaration + +▸ (`docs`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `docs` | `TDoc`[] | + +##### Returns + +`void` + +#### Defined in + +[src/datatype/index.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L30) diff --git a/docs/api/interfaces/datatype.DataTypeEvents.md b/docs/api/interfaces/datatype.DataTypeEvents.md new file mode 100644 index 000000000..f7bb2cabc --- /dev/null +++ b/docs/api/interfaces/datatype.DataTypeEvents.md @@ -0,0 +1,41 @@ +[API](../README.md) / [datatype](../modules/datatype.md) / DataTypeEvents + +# Interface: DataTypeEvents\ + +[datatype](../modules/datatype.md).DataTypeEvents + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TDoc` | extends `MapeoDoc` | + +## Table of contents + +### Properties + +- [updated-docs](datatype.DataTypeEvents.md#updated-docs) + +## Properties + +### updated-docs + +• **updated-docs**: (`docs`: `TDoc`[]) => `void` + +#### Type declaration + +▸ (`docs`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `docs` | `TDoc`[] | + +##### Returns + +`void` + +#### Defined in + +[src/datatype/index.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L44) diff --git a/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md b/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md new file mode 100644 index 000000000..a95f568bc --- /dev/null +++ b/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md @@ -0,0 +1,35 @@ +[API](../README.md) / [discovery/local-discovery](../modules/discovery_local_discovery.md) / DiscoveryEvents + +# Interface: DiscoveryEvents\<\> + +[discovery/local-discovery](../modules/discovery_local_discovery.md).DiscoveryEvents + +## Table of contents + +### Properties + +- [connection](discovery_local_discovery.DiscoveryEvents.md#connection) + +## Properties + +### connection + +• **connection**: (`connection`: [`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)) => `void` + +#### Type declaration + +▸ (`connection`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `connection` | [`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream) | + +##### Returns + +`void` + +#### Defined in + +[src/discovery/local-discovery.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L20) diff --git a/docs/api/interfaces/fastify_controller.StartOpts.md b/docs/api/interfaces/fastify_controller.StartOpts.md new file mode 100644 index 000000000..070a44bcb --- /dev/null +++ b/docs/api/interfaces/fastify_controller.StartOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [fastify-controller](../modules/fastify_controller.md) / StartOpts + +# Interface: StartOpts\<\> + +[fastify-controller](../modules/fastify_controller.md).StartOpts + +## Table of contents + +### Properties + +- [host](fastify_controller.StartOpts.md#host) +- [port](fastify_controller.StartOpts.md#port) + +## Properties + +### host + +• **host**: `undefined` \| `string` + +#### Defined in + +[src/fastify-controller.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L7) + +___ + +### port + +• **port**: `undefined` \| `number` + +#### Defined in + +[src/fastify-controller.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L8) diff --git a/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md b/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md new file mode 100644 index 000000000..c66225bdd --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md @@ -0,0 +1,35 @@ +[API](../README.md) / [fastify-plugins/blobs](../modules/fastify_plugins_blobs.md) / BlobServerPluginOpts + +# Interface: BlobServerPluginOpts\<\> + +[fastify-plugins/blobs](../modules/fastify_plugins_blobs.md).BlobServerPluginOpts + +## Table of contents + +### Properties + +- [getBlobStore](fastify_plugins_blobs.BlobServerPluginOpts.md#getblobstore) + +## Properties + +### getBlobStore + +• **getBlobStore**: (`projectPublicId`: `string`) => `Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> + +#### Type declaration + +▸ (`projectPublicId`): `Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `projectPublicId` | `string` | + +##### Returns + +`Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> + +#### Defined in + +[src/fastify-plugins/blobs.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/blobs.js#L18) diff --git a/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md b/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md new file mode 100644 index 000000000..0134b28e2 --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md @@ -0,0 +1,35 @@ +[API](../README.md) / [fastify-plugins/icons](../modules/fastify_plugins_icons.md) / IconServerPluginOpts + +# Interface: IconServerPluginOpts\<\> + +[fastify-plugins/icons](../modules/fastify_plugins_icons.md).IconServerPluginOpts + +## Table of contents + +### Properties + +- [getProject](fastify_plugins_icons.IconServerPluginOpts.md#getproject) + +## Properties + +### getProject + +• **getProject**: (`projectId`: `string`) => `Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> + +#### Type declaration + +▸ (`projectId`): `Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `projectId` | `string` | + +##### Returns + +`Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> + +#### Defined in + +[src/fastify-plugins/icons.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/icons.js#L51) diff --git a/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md b/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md new file mode 100644 index 000000000..020671638 --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md @@ -0,0 +1,29 @@ +[API](../README.md) / [fastify-plugins/maps](../modules/fastify_plugins_maps.md) / MapsPluginContext + +# Interface: MapsPluginContext\<\> + +[fastify-plugins/maps](../modules/fastify_plugins_maps.md).MapsPluginContext + +## Table of contents + +### Properties + +- [getStyleJsonUrl](fastify_plugins_maps.MapsPluginContext.md#getstylejsonurl) + +## Properties + +### getStyleJsonUrl + +• **getStyleJsonUrl**: () => `Promise`\<`string`\> + +#### Type declaration + +▸ (): `Promise`\<`string`\> + +##### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/fastify-plugins/maps/index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L45) diff --git a/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md new file mode 100644 index 000000000..d69b1642c --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [fastify-plugins/maps](../modules/fastify_plugins_maps.md) / MapsPluginOpts + +# Interface: MapsPluginOpts\<\> + +[fastify-plugins/maps](../modules/fastify_plugins_maps.md).MapsPluginOpts + +## Table of contents + +### Properties + +- [defaultOnlineStyleUrl](fastify_plugins_maps.MapsPluginOpts.md#defaultonlinestyleurl) +- [prefix](fastify_plugins_maps.MapsPluginOpts.md#prefix) + +## Properties + +### defaultOnlineStyleUrl + +• **defaultOnlineStyleUrl**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/index.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L40) + +___ + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/index.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L39) diff --git a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md new file mode 100644 index 000000000..71abb84a9 --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md @@ -0,0 +1,54 @@ +[API](../README.md) / [fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md) / FallbackMapPluginDecorator + +# Interface: FallbackMapPluginDecorator\<\> + +[fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md).FallbackMapPluginDecorator + +## Table of contents + +### Properties + +- [getResolvedStyleJson](fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md#getresolvedstylejson) +- [getStyleJsonStats](fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md#getstylejsonstats) + +## Properties + +### getResolvedStyleJson + +• **getResolvedStyleJson**: (`serverAddress`: `string`) => `Promise`\<`any`\> + +#### Type declaration + +▸ (`serverAddress`): `Promise`\<`any`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `serverAddress` | `string` | + +##### Returns + +`Promise`\<`any`\> + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L28) + +___ + +### getStyleJsonStats + +• **getStyleJsonStats**: () => `Promise`\<`Stats`\> + +#### Type declaration + +▸ (): `Promise`\<`Stats`\> + +##### Returns + +`Promise`\<`Stats`\> + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L29) diff --git a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md new file mode 100644 index 000000000..cd664c284 --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md @@ -0,0 +1,43 @@ +[API](../README.md) / [fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md) / OfflineFallbackMapPluginOpts + +# Interface: OfflineFallbackMapPluginOpts\<\> + +[fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md).OfflineFallbackMapPluginOpts + +## Table of contents + +### Properties + +- [prefix](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#prefix) +- [sourcesDir](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#sourcesdir) +- [styleJsonPath](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#stylejsonpath) + +## Properties + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L21) + +___ + +### sourcesDir + +• **sourcesDir**: `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L23) + +___ + +### styleJsonPath + +• **styleJsonPath**: `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L22) diff --git a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md new file mode 100644 index 000000000..4bb613441 --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md @@ -0,0 +1,61 @@ +[API](../README.md) / [fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md) / StaticMapsPluginDecorator + +# Interface: StaticMapsPluginDecorator\<\> + +[fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md).StaticMapsPluginDecorator + +## Table of contents + +### Properties + +- [getResolvedStyleJson](fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md#getresolvedstylejson) +- [getStyleJsonStats](fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md#getstylejsonstats) + +## Properties + +### getResolvedStyleJson + +• **getResolvedStyleJson**: (`styleId`: `string`, `serverAddress`: `string`) => `Promise`\<`string`\> + +#### Type declaration + +▸ (`styleId`, `serverAddress`): `Promise`\<`string`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `styleId` | `string` | +| `serverAddress` | `string` | + +##### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L31) + +___ + +### getStyleJsonStats + +• **getStyleJsonStats**: (`styleId`: `string`) => `Promise`\<`Stats`\> + +#### Type declaration + +▸ (`styleId`): `Promise`\<`Stats`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `styleId` | `string` | + +##### Returns + +`Promise`\<`Stats`\> + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L32) diff --git a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md new file mode 100644 index 000000000..07815f44e --- /dev/null +++ b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md) / StaticMapsPluginOpts + +# Interface: StaticMapsPluginOpts\<\> + +[fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md).StaticMapsPluginOpts + +## Table of contents + +### Properties + +- [prefix](fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md#prefix) +- [staticRootDir](fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md#staticrootdir) + +## Properties + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L25) + +___ + +### staticRootDir + +• **staticRootDir**: `string` + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L26) diff --git a/docs/api/interfaces/generated_extensions.HaveExtension.md b/docs/api/interfaces/generated_extensions.HaveExtension.md new file mode 100644 index 000000000..53b8c417b --- /dev/null +++ b/docs/api/interfaces/generated_extensions.HaveExtension.md @@ -0,0 +1,54 @@ +[API](../README.md) / [generated/extensions](../modules/generated_extensions.md) / HaveExtension + +# Interface: HaveExtension + +[generated/extensions](../modules/generated_extensions.md).HaveExtension + +## Table of contents + +### Properties + +- [discoveryKey](generated_extensions.HaveExtension.md#discoverykey) +- [encodedBitfield](generated_extensions.HaveExtension.md#encodedbitfield) +- [namespace](generated_extensions.HaveExtension.md#namespace) +- [start](generated_extensions.HaveExtension.md#start) + +## Properties + +### discoveryKey + +• **discoveryKey**: `Buffer` + +#### Defined in + +[src/generated/extensions.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L15) + +___ + +### encodedBitfield + +• **encodedBitfield**: `Buffer` + +#### Defined in + +[src/generated/extensions.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L17) + +___ + +### namespace + +• **namespace**: [`HaveExtension_Namespace`](../modules/generated_extensions.md#haveextension_namespace) + +#### Defined in + +[src/generated/extensions.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L18) + +___ + +### start + +• **start**: `number` + +#### Defined in + +[src/generated/extensions.ts:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L16) diff --git a/docs/api/interfaces/generated_extensions.ProjectExtension.md b/docs/api/interfaces/generated_extensions.ProjectExtension.md new file mode 100644 index 000000000..893bf3114 --- /dev/null +++ b/docs/api/interfaces/generated_extensions.ProjectExtension.md @@ -0,0 +1,76 @@ +[API](../README.md) / [generated/extensions](../modules/generated_extensions.md) / ProjectExtension + +# Interface: ProjectExtension + +[generated/extensions](../modules/generated_extensions.md).ProjectExtension + +## Table of contents + +### Properties + +- [authCoreKeys](generated_extensions.ProjectExtension.md#authcorekeys) +- [blobCoreKeys](generated_extensions.ProjectExtension.md#blobcorekeys) +- [blobIndexCoreKeys](generated_extensions.ProjectExtension.md#blobindexcorekeys) +- [configCoreKeys](generated_extensions.ProjectExtension.md#configcorekeys) +- [dataCoreKeys](generated_extensions.ProjectExtension.md#datacorekeys) +- [wantCoreKeys](generated_extensions.ProjectExtension.md#wantcorekeys) + +## Properties + +### authCoreKeys + +• **authCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L7) + +___ + +### blobCoreKeys + +• **blobCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L11) + +___ + +### blobIndexCoreKeys + +• **blobIndexCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L10) + +___ + +### configCoreKeys + +• **configCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L8) + +___ + +### dataCoreKeys + +• **dataCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L9) + +___ + +### wantCoreKeys + +• **wantCoreKeys**: `Buffer`[] + +#### Defined in + +[src/generated/extensions.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L6) diff --git a/docs/api/interfaces/generated_keys.EncryptionKeys.md b/docs/api/interfaces/generated_keys.EncryptionKeys.md new file mode 100644 index 000000000..a38943b6e --- /dev/null +++ b/docs/api/interfaces/generated_keys.EncryptionKeys.md @@ -0,0 +1,65 @@ +[API](../README.md) / [generated/keys](../modules/generated_keys.md) / EncryptionKeys + +# Interface: EncryptionKeys + +[generated/keys](../modules/generated_keys.md).EncryptionKeys + +## Table of contents + +### Properties + +- [auth](generated_keys.EncryptionKeys.md#auth) +- [blob](generated_keys.EncryptionKeys.md#blob) +- [blobIndex](generated_keys.EncryptionKeys.md#blobindex) +- [config](generated_keys.EncryptionKeys.md#config) +- [data](generated_keys.EncryptionKeys.md#data) + +## Properties + +### auth + +• **auth**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L5) + +___ + +### blob + +• `Optional` **blob**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L9) + +___ + +### blobIndex + +• `Optional` **blobIndex**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L8) + +___ + +### config + +• `Optional` **config**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L7) + +___ + +### data + +• `Optional` **data**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L6) diff --git a/docs/api/interfaces/generated_keys.ProjectKeys.md b/docs/api/interfaces/generated_keys.ProjectKeys.md new file mode 100644 index 000000000..6c626f172 --- /dev/null +++ b/docs/api/interfaces/generated_keys.ProjectKeys.md @@ -0,0 +1,43 @@ +[API](../README.md) / [generated/keys](../modules/generated_keys.md) / ProjectKeys + +# Interface: ProjectKeys + +[generated/keys](../modules/generated_keys.md).ProjectKeys + +## Table of contents + +### Properties + +- [encryptionKeys](generated_keys.ProjectKeys.md#encryptionkeys) +- [projectKey](generated_keys.ProjectKeys.md#projectkey) +- [projectSecretKey](generated_keys.ProjectKeys.md#projectsecretkey) + +## Properties + +### encryptionKeys + +• **encryptionKeys**: `undefined` \| [`EncryptionKeys`](generated_keys.EncryptionKeys.md) + +#### Defined in + +[src/generated/keys.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L15) + +___ + +### projectKey + +• **projectKey**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L13) + +___ + +### projectSecretKey + +• `Optional` **projectSecretKey**: `Buffer` + +#### Defined in + +[src/generated/keys.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L14) diff --git a/docs/api/interfaces/generated_rpc.DeviceInfo.md b/docs/api/interfaces/generated_rpc.DeviceInfo.md new file mode 100644 index 000000000..af8f5327e --- /dev/null +++ b/docs/api/interfaces/generated_rpc.DeviceInfo.md @@ -0,0 +1,32 @@ +[API](../README.md) / [generated/rpc](../modules/generated_rpc.md) / DeviceInfo + +# Interface: DeviceInfo + +[generated/rpc](../modules/generated_rpc.md).DeviceInfo + +## Table of contents + +### Properties + +- [deviceType](generated_rpc.DeviceInfo.md#devicetype) +- [name](generated_rpc.DeviceInfo.md#name) + +## Properties + +### deviceType + +• `Optional` **deviceType**: [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) + +#### Defined in + +[src/generated/rpc.ts:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L72) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[src/generated/rpc.ts:71](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L71) diff --git a/docs/api/interfaces/icon_api.BitmapOpts.md b/docs/api/interfaces/icon_api.BitmapOpts.md new file mode 100644 index 000000000..d5864b5de --- /dev/null +++ b/docs/api/interfaces/icon_api.BitmapOpts.md @@ -0,0 +1,43 @@ +[API](../README.md) / [icon-api](../modules/icon_api.md) / BitmapOpts + +# Interface: BitmapOpts\<\> + +[icon-api](../modules/icon_api.md).BitmapOpts + +## Table of contents + +### Properties + +- [mimeType](icon_api.BitmapOpts.md#mimetype) +- [pixelDensity](icon_api.BitmapOpts.md#pixeldensity) +- [size](icon_api.BitmapOpts.md#size) + +## Properties + +### mimeType + +• **mimeType**: ``"image/png"`` + +#### Defined in + +[src/icon-api.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L8) + +___ + +### pixelDensity + +• **pixelDensity**: ``1`` \| ``2`` \| ``3`` + +#### Defined in + +[src/icon-api.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L9) + +___ + +### size + +• **size**: `Size` + +#### Defined in + +[src/icon-api.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L10) diff --git a/docs/api/interfaces/icon_api.SvgOpts.md b/docs/api/interfaces/icon_api.SvgOpts.md new file mode 100644 index 000000000..046cfc62a --- /dev/null +++ b/docs/api/interfaces/icon_api.SvgOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [icon-api](../modules/icon_api.md) / SvgOpts + +# Interface: SvgOpts\<\> + +[icon-api](../modules/icon_api.md).SvgOpts + +## Table of contents + +### Properties + +- [mimeType](icon_api.SvgOpts.md#mimetype) +- [size](icon_api.SvgOpts.md#size) + +## Properties + +### mimeType + +• **mimeType**: ``"image/svg+xml"`` + +#### Defined in + +[src/icon-api.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L13) + +___ + +### size + +• **size**: `Size` + +#### Defined in + +[src/icon-api.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L14) diff --git a/docs/api/interfaces/invite_api.InviteApiEvents.md b/docs/api/interfaces/invite_api.InviteApiEvents.md new file mode 100644 index 000000000..682ccf2ba --- /dev/null +++ b/docs/api/interfaces/invite_api.InviteApiEvents.md @@ -0,0 +1,61 @@ +[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteApiEvents + +# Interface: InviteApiEvents\<\> + +[invite-api](../modules/invite_api.md).InviteApiEvents + +## Table of contents + +### Properties + +- [invite-received](invite_api.InviteApiEvents.md#invite-received) +- [invite-removed](invite_api.InviteApiEvents.md#invite-removed) + +## Properties + +### invite-received + +• **invite-received**: (`invite`: [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>) => `void` + +#### Type declaration + +▸ (`invite`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\> | + +##### Returns + +`void` + +#### Defined in + +[src/invite-api.js:154](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L154) + +___ + +### invite-removed + +• **invite-removed**: (`invite`: [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, `removalReason`: [`InviteRemovalReason`](../modules/invite_api.md#inviteremovalreason)) => `void` + +#### Type declaration + +▸ (`invite`, `removalReason`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\> | +| `removalReason` | [`InviteRemovalReason`](../modules/invite_api.md#inviteremovalreason) | + +##### Returns + +`void` + +#### Defined in + +[src/invite-api.js:155](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L155) diff --git a/docs/api/interfaces/invite_api.InviteCancel.md b/docs/api/interfaces/invite_api.InviteCancel.md new file mode 100644 index 000000000..1ee31a93b --- /dev/null +++ b/docs/api/interfaces/invite_api.InviteCancel.md @@ -0,0 +1,21 @@ +[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteCancel + +# Interface: InviteCancel + +[invite-api](../modules/invite_api.md).InviteCancel + +## Table of contents + +### Properties + +- [inviteId](invite_api.InviteCancel.md#inviteid) + +## Properties + +### inviteId + +• **inviteId**: `Buffer` + +#### Defined in + +[src/generated/rpc.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L15) diff --git a/docs/api/interfaces/invite_api.InviteRpcMessage.md b/docs/api/interfaces/invite_api.InviteRpcMessage.md new file mode 100644 index 000000000..7a2a16f95 --- /dev/null +++ b/docs/api/interfaces/invite_api.InviteRpcMessage.md @@ -0,0 +1,76 @@ +[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteRpcMessage + +# Interface: InviteRpcMessage + +[invite-api](../modules/invite_api.md).InviteRpcMessage + +## Table of contents + +### Properties + +- [inviteId](invite_api.InviteRpcMessage.md#inviteid) +- [invitorName](invite_api.InviteRpcMessage.md#invitorname) +- [projectName](invite_api.InviteRpcMessage.md#projectname) +- [projectPublicId](invite_api.InviteRpcMessage.md#projectpublicid) +- [roleDescription](invite_api.InviteRpcMessage.md#roledescription) +- [roleName](invite_api.InviteRpcMessage.md#rolename) + +## Properties + +### inviteId + +• **inviteId**: `Buffer` + +#### Defined in + +[src/generated/rpc.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L6) + +___ + +### invitorName + +• **invitorName**: `string` + +#### Defined in + +[src/generated/rpc.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L11) + +___ + +### projectName + +• **projectName**: `string` + +#### Defined in + +[src/generated/rpc.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L8) + +___ + +### projectPublicId + +• **projectPublicId**: `string` + +#### Defined in + +[src/generated/rpc.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L7) + +___ + +### roleDescription + +• `Optional` **roleDescription**: `string` + +#### Defined in + +[src/generated/rpc.ts:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L10) + +___ + +### roleName + +• `Optional` **roleName**: `string` + +#### Defined in + +[src/generated/rpc.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L9) diff --git a/docs/api/interfaces/invite_api.ProjectJoinDetails.md b/docs/api/interfaces/invite_api.ProjectJoinDetails.md new file mode 100644 index 000000000..df0503414 --- /dev/null +++ b/docs/api/interfaces/invite_api.ProjectJoinDetails.md @@ -0,0 +1,43 @@ +[API](../README.md) / [invite-api](../modules/invite_api.md) / ProjectJoinDetails + +# Interface: ProjectJoinDetails + +[invite-api](../modules/invite_api.md).ProjectJoinDetails + +## Table of contents + +### Properties + +- [encryptionKeys](invite_api.ProjectJoinDetails.md#encryptionkeys) +- [inviteId](invite_api.ProjectJoinDetails.md#inviteid) +- [projectKey](invite_api.ProjectJoinDetails.md#projectkey) + +## Properties + +### encryptionKeys + +• **encryptionKeys**: `undefined` \| [`EncryptionKeys`](generated_keys.EncryptionKeys.md) + +#### Defined in + +[src/generated/rpc.ts:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L67) + +___ + +### inviteId + +• **inviteId**: `Buffer` + +#### Defined in + +[src/generated/rpc.ts:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L65) + +___ + +### projectKey + +• **projectKey**: `Buffer` + +#### Defined in + +[src/generated/rpc.ts:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L66) diff --git a/docs/api/interfaces/local_peers.LocalPeersEvents.md b/docs/api/interfaces/local_peers.LocalPeersEvents.md new file mode 100644 index 000000000..a1d2645e2 --- /dev/null +++ b/docs/api/interfaces/local_peers.LocalPeersEvents.md @@ -0,0 +1,204 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / LocalPeersEvents + +# Interface: LocalPeersEvents\<\> + +[local-peers](../modules/local_peers.md).LocalPeersEvents + +## Table of contents + +### Properties + +- [discovery-key](local_peers.LocalPeersEvents.md#discovery-key) +- [got-project-details](local_peers.LocalPeersEvents.md#got-project-details) +- [invite](local_peers.LocalPeersEvents.md#invite) +- [invite-cancel](local_peers.LocalPeersEvents.md#invite-cancel) +- [invite-response](local_peers.LocalPeersEvents.md#invite-response) +- [peer-add](local_peers.LocalPeersEvents.md#peer-add) +- [peers](local_peers.LocalPeersEvents.md#peers) + +## Properties + +### discovery-key + +• **discovery-key**: (`discoveryKey`: `Buffer`, `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\>) => `void` + +Emitted when a new hypercore is replicated (by a peer) to a peer protomux instance (passed as the second parameter) + +#### Type declaration + +▸ (`discoveryKey`, `protomux`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | +| `protomux` | `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:215](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L215) + +___ + +### got-project-details + +• **got-project-details**: (`peerId`: `string`, `details`: [`ProjectJoinDetails`](invite_api.ProjectJoinDetails.md)) => `void` + +Emitted when project details are received + +#### Type declaration + +▸ (`peerId`, `details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `details` | [`ProjectJoinDetails`](invite_api.ProjectJoinDetails.md) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:214](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L214) + +___ + +### invite + +• **invite**: (`peerId`: `string`, `invite`: [`InviteRpcMessage`](invite_api.InviteRpcMessage.md)) => `void` + +Emitted when an invite is received + +#### Type declaration + +▸ (`peerId`, `invite`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `invite` | [`InviteRpcMessage`](invite_api.InviteRpcMessage.md) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:211](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L211) + +___ + +### invite-cancel + +• **invite-cancel**: (`peerId`: `string`, `invite`: [`InviteCancel`](invite_api.InviteCancel.md)) => `void` + +Emitted when we receive a cancelation for an invite + +#### Type declaration + +▸ (`peerId`, `invite`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `invite` | [`InviteCancel`](invite_api.InviteCancel.md) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:212](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L212) + +___ + +### invite-response + +• **invite-response**: (`peerId`: `string`, `inviteResponse`: [`InviteResponse`](member_api.InviteResponse.md)) => `void` + +Emitted when an invite response is received + +#### Type declaration + +▸ (`peerId`, `inviteResponse`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `inviteResponse` | [`InviteResponse`](member_api.InviteResponse.md) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:213](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L213) + +___ + +### peer-add + +• **peer-add**: (`peer`: [`PeerInfoConnected`](../modules/local_peers.md#peerinfoconnected)) => `void` + +Emitted when a new peer is connected + +#### Type declaration + +▸ (`peer`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peer` | [`PeerInfoConnected`](../modules/local_peers.md#peerinfoconnected) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:210](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L210) + +___ + +### peers + +• **peers**: (`peers`: [`PeerInfo`](../modules/local_peers.md#peerinfo)[]) => `void` + +Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status + +#### Type declaration + +▸ (`peers`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peers` | [`PeerInfo`](../modules/local_peers.md#peerinfo)[] | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:209](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L209) diff --git a/docs/api/interfaces/local_peers.PeerInfoBase.md b/docs/api/interfaces/local_peers.PeerInfoBase.md new file mode 100644 index 000000000..64f33e692 --- /dev/null +++ b/docs/api/interfaces/local_peers.PeerInfoBase.md @@ -0,0 +1,43 @@ +[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerInfoBase + +# Interface: PeerInfoBase\<\> + +[local-peers](../modules/local_peers.md).PeerInfoBase + +## Table of contents + +### Properties + +- [deviceId](local_peers.PeerInfoBase.md#deviceid) +- [deviceType](local_peers.PeerInfoBase.md#devicetype) +- [name](local_peers.PeerInfoBase.md#name) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/local-peers.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L40) + +___ + +### deviceType + +• **deviceType**: `undefined` \| [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) + +#### Defined in + +[src/local-peers.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L42) + +___ + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/local-peers.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L41) diff --git a/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md b/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md new file mode 100644 index 000000000..3a0285413 --- /dev/null +++ b/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md @@ -0,0 +1,37 @@ +[API](../README.md) / [mapeo-manager](../modules/mapeo_manager.md) / MapeoManagerEvents + +# Interface: MapeoManagerEvents\<\> + +[mapeo-manager](../modules/mapeo_manager.md).MapeoManagerEvents + +## Table of contents + +### Properties + +- [local-peers](mapeo_manager.MapeoManagerEvents.md#local-peers) + +## Properties + +### local-peers + +• **local-peers**: (`peers`: [`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]) => `void` + +Emitted when the list of connected peers changes (new ones added, or connection status changes) + +#### Type declaration + +▸ (`peers`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peers` | [`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[] | + +##### Returns + +`void` + +#### Defined in + +[src/mapeo-manager.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L70) diff --git a/docs/api/interfaces/member_api.InviteResponse.md b/docs/api/interfaces/member_api.InviteResponse.md new file mode 100644 index 000000000..c2e85f91d --- /dev/null +++ b/docs/api/interfaces/member_api.InviteResponse.md @@ -0,0 +1,32 @@ +[API](../README.md) / [member-api](../modules/member_api.md) / InviteResponse + +# Interface: InviteResponse + +[member-api](../modules/member_api.md).InviteResponse + +## Table of contents + +### Properties + +- [decision](member_api.InviteResponse.md#decision) +- [inviteId](member_api.InviteResponse.md#inviteid) + +## Properties + +### decision + +• **decision**: [`InviteResponse_Decision`](../modules/generated_rpc.md#inviteresponse_decision) + +#### Defined in + +[src/generated/rpc.ts:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L20) + +___ + +### inviteId + +• **inviteId**: `Buffer` + +#### Defined in + +[src/generated/rpc.ts:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L19) diff --git a/docs/api/interfaces/member_api.MemberInfo.md b/docs/api/interfaces/member_api.MemberInfo.md new file mode 100644 index 000000000..923e9520f --- /dev/null +++ b/docs/api/interfaces/member_api.MemberInfo.md @@ -0,0 +1,54 @@ +[API](../README.md) / [member-api](../modules/member_api.md) / MemberInfo + +# Interface: MemberInfo\<\> + +[member-api](../modules/member_api.md).MemberInfo + +## Table of contents + +### Properties + +- [deviceId](member_api.MemberInfo.md#deviceid) +- [deviceType](member_api.MemberInfo.md#devicetype) +- [name](member_api.MemberInfo.md#name) +- [role](member_api.MemberInfo.md#role) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/member-api.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L29) + +___ + +### deviceType + +• **deviceType**: `undefined` \| ``"UNRECOGNIZED"`` \| ``"mobile"`` \| ``"tablet"`` \| ``"desktop"`` + +#### Defined in + +[src/member-api.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L32) + +___ + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/member-api.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L31) + +___ + +### role + +• **role**: [`Role`](roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> + +#### Defined in + +[src/member-api.js:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L30) diff --git a/docs/api/interfaces/roles.DocCapability.md b/docs/api/interfaces/roles.DocCapability.md new file mode 100644 index 000000000..02ecb7015 --- /dev/null +++ b/docs/api/interfaces/roles.DocCapability.md @@ -0,0 +1,62 @@ +[API](../README.md) / [roles](../modules/roles.md) / DocCapability + +# Interface: DocCapability\<\> + +[roles](../modules/roles.md).DocCapability + +## Table of contents + +### Properties + +- [readOthers](roles.DocCapability.md#readothers) +- [readOwn](roles.DocCapability.md#readown) +- [writeOthers](roles.DocCapability.md#writeothers) +- [writeOwn](roles.DocCapability.md#writeown) + +## Properties + +### readOthers + +• **readOthers**: `boolean` + +can read other's data + +#### Defined in + +[src/roles.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L59) + +___ + +### readOwn + +• **readOwn**: `boolean` + +can read own data + +#### Defined in + +[src/roles.js:57](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L57) + +___ + +### writeOthers + +• **writeOthers**: `boolean` + +can edit or delete other's data + +#### Defined in + +[src/roles.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L60) + +___ + +### writeOwn + +• **writeOwn**: `boolean` + +can write own data + +#### Defined in + +[src/roles.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L58) diff --git a/docs/api/interfaces/roles.Role.md b/docs/api/interfaces/roles.Role.md new file mode 100644 index 000000000..60809a25b --- /dev/null +++ b/docs/api/interfaces/roles.Role.md @@ -0,0 +1,71 @@ +[API](../README.md) / [roles](../modules/roles.md) / Role + +# Interface: Role\ + +[roles](../modules/roles.md).Role + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`RoleId`](../modules/roles.md#roleid) = [`RoleId`](../modules/roles.md#roleid) | + +## Table of contents + +### Properties + +- [docs](roles.Role.md#docs) +- [name](roles.Role.md#name) +- [roleAssignment](roles.Role.md#roleassignment) +- [roleId](roles.Role.md#roleid) +- [sync](roles.Role.md#sync) + +## Properties + +### docs + +• **docs**: `Record`\<``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``, [`DocCapability`](roles.DocCapability.md)\> + +#### Defined in + +[src/roles.js:68](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L68) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[src/roles.js:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L67) + +___ + +### roleAssignment + +• **roleAssignment**: (``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``)[] + +#### Defined in + +[src/roles.js:69](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L69) + +___ + +### roleId + +• **roleId**: `T` + +#### Defined in + +[src/roles.js:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L66) + +___ + +### sync + +• **sync**: `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, ``"allowed"`` \| ``"blocked"``\> + +#### Defined in + +[src/roles.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L70) diff --git a/docs/api/interfaces/schema_client.ProjectInfo.md b/docs/api/interfaces/schema_client.ProjectInfo.md new file mode 100644 index 000000000..6e53aeda8 --- /dev/null +++ b/docs/api/interfaces/schema_client.ProjectInfo.md @@ -0,0 +1,21 @@ +[API](../README.md) / [schema/client](../modules/schema_client.md) / ProjectInfo + +# Interface: ProjectInfo\<\> + +[schema/client](../modules/schema_client.md).ProjectInfo + +## Table of contents + +### Properties + +- [name](schema_client.ProjectInfo.md#name) + +## Properties + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/schema/client.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L12) diff --git a/docs/api/interfaces/sync_core_sync_state.CoreState.md b/docs/api/interfaces/sync_core_sync_state.CoreState.md new file mode 100644 index 000000000..a1a2e2f28 --- /dev/null +++ b/docs/api/interfaces/sync_core_sync_state.CoreState.md @@ -0,0 +1,62 @@ +[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / CoreState + +# Interface: CoreState\<\> + +[sync/core-sync-state](../modules/sync_core_sync_state.md).CoreState + +## Table of contents + +### Properties + +- [have](sync_core_sync_state.CoreState.md#have) +- [missing](sync_core_sync_state.CoreState.md#missing) +- [want](sync_core_sync_state.CoreState.md#want) +- [wanted](sync_core_sync_state.CoreState.md#wanted) + +## Properties + +### have + +• **have**: `number` + +blocks the peer has locally + +#### Defined in + +[src/sync/core-sync-state.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L22) + +___ + +### missing + +• **missing**: `number` + +blocks the peer wants but no peer has + +#### Defined in + +[src/sync/core-sync-state.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L25) + +___ + +### want + +• **want**: `number` + +blocks the peer wants, and at least one peer has + +#### Defined in + +[src/sync/core-sync-state.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L23) + +___ + +### wanted + +• **wanted**: `number` + +blocks the peer has that at least one peer wants + +#### Defined in + +[src/sync/core-sync-state.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L24) diff --git a/docs/api/interfaces/sync_core_sync_state.DerivedState.md b/docs/api/interfaces/sync_core_sync_state.DerivedState.md new file mode 100644 index 000000000..59290ed1e --- /dev/null +++ b/docs/api/interfaces/sync_core_sync_state.DerivedState.md @@ -0,0 +1,49 @@ +[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / DerivedState + +# Interface: DerivedState\<\> + +[sync/core-sync-state](../modules/sync_core_sync_state.md).DerivedState + +## Table of contents + +### Properties + +- [coreLength](sync_core_sync_state.DerivedState.md#corelength) +- [localState](sync_core_sync_state.DerivedState.md#localstate) +- [remoteStates](sync_core_sync_state.DerivedState.md#remotestates) + +## Properties + +### coreLength + +• **coreLength**: `number` + +known (sparse) length of the core + +#### Defined in + +[src/sync/core-sync-state.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L32) + +___ + +### localState + +• **localState**: [`CoreState`](sync_core_sync_state.CoreState.md) + +local state + +#### Defined in + +[src/sync/core-sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L33) + +___ + +### remoteStates + +• **remoteStates**: `Object` + +map of state of all known peers + +#### Defined in + +[src/sync/core-sync-state.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L34) diff --git a/docs/api/interfaces/sync_core_sync_state.InternalState.md b/docs/api/interfaces/sync_core_sync_state.InternalState.md new file mode 100644 index 000000000..5e50e1023 --- /dev/null +++ b/docs/api/interfaces/sync_core_sync_state.InternalState.md @@ -0,0 +1,67 @@ +[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / InternalState + +# Interface: InternalState\<\> + +[sync/core-sync-state](../modules/sync_core_sync_state.md).InternalState + +## Table of contents + +### Properties + +- [length](sync_core_sync_state.InternalState.md#length) +- [localState](sync_core_sync_state.InternalState.md#localstate) +- [namespace](sync_core_sync_state.InternalState.md#namespace) +- [peerSyncControllers](sync_core_sync_state.InternalState.md#peersynccontrollers) +- [remoteStates](sync_core_sync_state.InternalState.md#remotestates) + +## Properties + +### length + +• **length**: `undefined` \| `number` + +Core length, e.g. how many blocks in the core (including blocks that are not downloaded) + +#### Defined in + +[src/sync/core-sync-state.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L14) + +___ + +### localState + +• **localState**: `PeerState` + +#### Defined in + +[src/sync/core-sync-state.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L15) + +___ + +### namespace + +• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` + +#### Defined in + +[src/sync/core-sync-state.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L18) + +___ + +### peerSyncControllers + +• **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/sync_peer_sync_controller.PeerSyncController.md)\> + +#### Defined in + +[src/sync/core-sync-state.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L17) + +___ + +### remoteStates + +• **remoteStates**: `Map`\<`string`, `PeerState`\> + +#### Defined in + +[src/sync/core-sync-state.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L16) diff --git a/docs/api/interfaces/sync_sync_api.State.md b/docs/api/interfaces/sync_sync_api.State.md new file mode 100644 index 000000000..45d7f6bc4 --- /dev/null +++ b/docs/api/interfaces/sync_sync_api.State.md @@ -0,0 +1,49 @@ +[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / State + +# Interface: State\<\> + +[sync/sync-api](../modules/sync_sync_api.md).State + +## Table of contents + +### Properties + +- [connectedPeers](sync_sync_api.State.md#connectedpeers) +- [data](sync_sync_api.State.md#data) +- [initial](sync_sync_api.State.md#initial) + +## Properties + +### connectedPeers + +• **connectedPeers**: `number` + +Number of connected peers + +#### Defined in + +[src/sync/sync-api.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L33) + +___ + +### data + +• **data**: [`SyncTypeState`](sync_sync_api.SyncTypeState.md) + +State of data sync (observations, map data, photos, audio, video etc.) + +#### Defined in + +[src/sync/sync-api.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L32) + +___ + +### initial + +• **initial**: [`SyncTypeState`](sync_sync_api.SyncTypeState.md) + +State of initial sync (sync of auth, metadata and project config) + +#### Defined in + +[src/sync/sync-api.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L31) diff --git a/docs/api/interfaces/sync_sync_api.SyncEvents.md b/docs/api/interfaces/sync_sync_api.SyncEvents.md new file mode 100644 index 000000000..de6be6029 --- /dev/null +++ b/docs/api/interfaces/sync_sync_api.SyncEvents.md @@ -0,0 +1,35 @@ +[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncEvents + +# Interface: SyncEvents\<\> + +[sync/sync-api](../modules/sync_sync_api.md).SyncEvents + +## Table of contents + +### Properties + +- [sync-state](sync_sync_api.SyncEvents.md#sync-state) + +## Properties + +### sync-state + +• **sync-state**: (`syncState`: [`State`](sync_sync_api.State.md)) => `void` + +#### Type declaration + +▸ (`syncState`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `syncState` | [`State`](sync_sync_api.State.md) | + +##### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L38) diff --git a/docs/api/interfaces/sync_sync_api.SyncTypeState.md b/docs/api/interfaces/sync_sync_api.SyncTypeState.md new file mode 100644 index 000000000..87b522949 --- /dev/null +++ b/docs/api/interfaces/sync_sync_api.SyncTypeState.md @@ -0,0 +1,88 @@ +[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncTypeState + +# Interface: SyncTypeState\<\> + +[sync/sync-api](../modules/sync_sync_api.md).SyncTypeState + +## Table of contents + +### Properties + +- [dataToSync](sync_sync_api.SyncTypeState.md#datatosync) +- [have](sync_sync_api.SyncTypeState.md#have) +- [missing](sync_sync_api.SyncTypeState.md#missing) +- [syncing](sync_sync_api.SyncTypeState.md#syncing) +- [want](sync_sync_api.SyncTypeState.md#want) +- [wanted](sync_sync_api.SyncTypeState.md#wanted) + +## Properties + +### dataToSync + +• **dataToSync**: `boolean` + +Is there data available to sync? (want > 0 || wanted > 0) + +#### Defined in + +[src/sync/sync-api.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L25) + +___ + +### have + +• **have**: `number` + +Number of blocks we have locally + +#### Defined in + +[src/sync/sync-api.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L21) + +___ + +### missing + +• **missing**: `number` + +Number of blocks missing (we don't have them, but connected peers don't have them either) + +#### Defined in + +[src/sync/sync-api.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L24) + +___ + +### syncing + +• **syncing**: `boolean` + +Are we currently syncing? + +#### Defined in + +[src/sync/sync-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L26) + +___ + +### want + +• **want**: `number` + +Number of blocks we want from connected peers + +#### Defined in + +[src/sync/sync-api.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L22) + +___ + +### wanted + +• **wanted**: `number` + +Number of blocks that connected peers want from us + +#### Defined in + +[src/sync/sync-api.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L23) diff --git a/docs/api/modules/blob_api.md b/docs/api/modules/blob_api.md new file mode 100644 index 000000000..ca5ef434a --- /dev/null +++ b/docs/api/modules/blob_api.md @@ -0,0 +1,34 @@ +[API](../README.md) / blob-api + +# Module: blob-api + +## Table of contents + +### Classes + +- [BlobApi](../classes/blob_api.BlobApi.md) + +### Type Aliases + +- [BlobId](blob_api.md#blobid) +- [BlobType](blob_api.md#blobtype) + +## Type Aliases + +### BlobId + +Ƭ **BlobId**: `Simplify`\<`ValueOf`\<\{ [KeyType in BlobType]: BlobIdBase\ }\>\> + +#### Defined in + +[src/types.ts:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L34) + +___ + +### BlobType + +Ƭ **BlobType**: keyof `SupportedBlobVariants` + +#### Defined in + +[src/types.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L17) diff --git a/docs/api/modules/blob_store.md b/docs/api/modules/blob_store.md new file mode 100644 index 000000000..e562392fc --- /dev/null +++ b/docs/api/modules/blob_store.md @@ -0,0 +1,55 @@ +[API](../README.md) / blob-store + +# Module: blob-store + +## Table of contents + +### References + +- [BlobId](blob_store.md#blobid) + +### Classes + +- [BlobStore](../classes/blob_store.BlobStore.md) + +### Type Aliases + +- [InternalDriveEmitter](blob_store.md#internaldriveemitter) + +### Variables + +- [SUPPORTED\_BLOB\_VARIANTS](blob_store.md#supported_blob_variants) + +## References + +### BlobId + +Re-exports [BlobId](blob_api.md#blobid) + +## Type Aliases + +### InternalDriveEmitter + +Ƭ **InternalDriveEmitter**\<\>: `TypedEmitter`\<\{ `add-drive`: (`drive`: `__module`) => `void` }\> + +#### Defined in + +[src/blob-store/index.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L8) + +## Variables + +### SUPPORTED\_BLOB\_VARIANTS + +• `Const` **SUPPORTED\_BLOB\_VARIANTS**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `audio` | readonly [``"original"``] | +| `photo` | readonly [``"original"``, ``"preview"``, ``"thumbnail"``] | +| `video` | readonly [``"original"``] | + +#### Defined in + +[src/blob-store/index.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L13) diff --git a/docs/api/modules/blob_store_live_download.md b/docs/api/modules/blob_store_live_download.md new file mode 100644 index 000000000..73f0b2acd --- /dev/null +++ b/docs/api/modules/blob_store_live_download.md @@ -0,0 +1,58 @@ +[API](../README.md) / blob-store/live-download + +# Module: blob-store/live-download + +## Table of contents + +### Classes + +- [DriveLiveDownload](../classes/blob_store_live_download.DriveLiveDownload.md) +- [LiveDownload](../classes/blob_store_live_download.LiveDownload.md) + +### Interfaces + +- [BlobDownloadEvents](../interfaces/blob_store_live_download.BlobDownloadEvents.md) +- [BlobDownloadState](../interfaces/blob_store_live_download.BlobDownloadState.md) + +### Type Aliases + +- [BlobDownloadStateError](blob_store_live_download.md#blobdownloadstateerror) + +### Functions + +- [combineStates](blob_store_live_download.md#combinestates) + +## Type Aliases + +### BlobDownloadStateError + +Ƭ **BlobDownloadStateError**\<\>: `Omit`\<[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md), ``"error"`` \| ``"status"``\> & \{ `error`: `Error` ; `status`: ``"error"`` } + +#### Defined in + +[src/blob-store/live-download.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L18) + +## Functions + +### combineStates + +▸ **combineStates**(`liveDownloads`, `options?`): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) + +Reduce multiple states into one. Factored out for unit testing because I +don't trust my coding. Probably a smarter way to do this, but this works. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `liveDownloads` | `Iterable`\<\{ `state`: [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) }\> | +| `options` | `Object` | +| `options.signal?` | `AbortSignal` | + +#### Returns + +[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) + +#### Defined in + +[src/blob-store/live-download.js:296](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L296) diff --git a/docs/api/modules/config_import.md b/docs/api/modules/config_import.md new file mode 100644 index 000000000..1a20d8269 --- /dev/null +++ b/docs/api/modules/config_import.md @@ -0,0 +1,72 @@ +[API](../README.md) / config-import + +# Module: config-import + +## Table of contents + +### Type Aliases + +- [Entry](config_import.md#entry) +- [IconData](config_import.md#icondata) +- [PresetsFile](config_import.md#presetsfile) + +### Functions + +- [readConfig](config_import.md#readconfig) + +## Type Aliases + +### Entry + +Ƭ **Entry**\<\>: `yauzl.Entry` + +#### Defined in + +[src/config-import.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L12) + +___ + +### IconData + +Ƭ **IconData**\<\>: `Parameters`\<[`icon-api`](icon_api.md)[``"create"``]\>[``0``] + +#### Defined in + +[src/config-import.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L21) + +___ + +### PresetsFile + +Ƭ **PresetsFile**\<\>: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fields` | \{ `[id: string]`: `unknown`; } | +| `presets` | \{ `[id: string]`: `unknown`; } | + +#### Defined in + +[src/config-import.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L18) + +## Functions + +### readConfig + +▸ **readConfig**(`configPath`): `Promise`\<\{ `warnings`: ; `close`: () => `Promise`\<`void`\> ; `fields`: () => `Iterable`\<\{ `name`: `string` ; `value`: {} }\> ; `icons`: () => `AsyncIterable`\<\{ `name`: `string` ; `variants`: [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] }\> ; `presets`: () => `Iterable`\<\{ `fieldNames`: `string`[] ; `iconName`: `undefined` \| `string` ; `value`: {} }\> }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configPath` | `string` | + +#### Returns + +`Promise`\<\{ `warnings`: ; `close`: () => `Promise`\<`void`\> ; `fields`: () => `Iterable`\<\{ `name`: `string` ; `value`: {} }\> ; `icons`: () => `AsyncIterable`\<\{ `name`: `string` ; `variants`: [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] }\> ; `presets`: () => `Iterable`\<\{ `fieldNames`: `string`[] ; `iconName`: `undefined` \| `string` ; `value`: {} }\> }\> + +#### Defined in + +[src/config-import.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L27) diff --git a/docs/api/modules/constants.md b/docs/api/modules/constants.md new file mode 100644 index 000000000..3adb1590d --- /dev/null +++ b/docs/api/modules/constants.md @@ -0,0 +1,19 @@ +[API](../README.md) / constants + +# Module: constants + +## Table of contents + +### Variables + +- [NAMESPACES](constants.md#namespaces) + +## Variables + +### NAMESPACES + +• `Const` **NAMESPACES**: readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Defined in + +[src/constants.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/constants.js#L3) diff --git a/docs/api/modules/core_manager.md b/docs/api/modules/core_manager.md new file mode 100644 index 000000000..2bf197810 --- /dev/null +++ b/docs/api/modules/core_manager.md @@ -0,0 +1,70 @@ +[API](../README.md) / core-manager + +# Module: core-manager + +## Table of contents + +### References + +- [CoreRecord](core_manager.md#corerecord) +- [Namespace](core_manager.md#namespace) + +### Classes + +- [CoreManager](../classes/core_manager.CoreManager.md) + +### Interfaces + +- [Events](../interfaces/core_manager.Events.md) +- [HaveMsg](../interfaces/core_manager.HaveMsg.md) + +### Type Aliases + +- [Core](core_manager.md#core) +- [DuplexStream](core_manager.md#duplexstream) + +### Variables + +- [kCoreManagerReplicate](core_manager.md#kcoremanagerreplicate) + +## References + +### CoreRecord + +Re-exports [CoreRecord](core_manager_core_index.md#corerecord) + +___ + +### Namespace + +Re-exports [Namespace](core_manager_core_index.md#namespace) + +## Type Aliases + +### Core + +Ƭ **Core**\<\>: `__module` + +#### Defined in + +[src/core-manager/index.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L19) + +___ + +### DuplexStream + +Ƭ **DuplexStream**\<\>: `Duplex` + +#### Defined in + +[src/core-manager/index.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L22) + +## Variables + +### kCoreManagerReplicate + +• `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](core_manager.md#kcoremanagerreplicate) + +#### Defined in + +[src/core-manager/index.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L17) diff --git a/docs/api/modules/core_manager_bitfield_rle.md b/docs/api/modules/core_manager_bitfield_rle.md new file mode 100644 index 000000000..ea51c3da8 --- /dev/null +++ b/docs/api/modules/core_manager_bitfield_rle.md @@ -0,0 +1,96 @@ +[API](../README.md) / core-manager/bitfield-rle + +# Module: core-manager/bitfield-rle + +## Table of contents + +### Functions + +- [decode](core_manager_bitfield_rle.md#decode) +- [decodingLength](core_manager_bitfield_rle.md#decodinglength) +- [encode](core_manager_bitfield_rle.md#encode) +- [encodingLength](core_manager_bitfield_rle.md#encodinglength) + +## Functions + +### decode + +▸ **decode**(`buffer`, `offset?`): `Uint32Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buffer` | `Buffer` | +| `offset?` | `number` | + +#### Returns + +`Uint32Array` + +#### Defined in + +[src/core-manager/bitfield-rle.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L72) + +___ + +### decodingLength + +▸ **decodingLength**(`buffer`, `offset`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buffer` | `Buffer` | +| `offset` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/bitfield-rle.js:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L111) + +___ + +### encode + +▸ **encode**(`bitfield`, `buffer?`, `offset?`): `Buffer` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bitfield` | `Uint32Array` | +| `buffer?` | `Buffer` | +| `offset?` | `number` | + +#### Returns + +`Buffer` + +#### Defined in + +[src/core-manager/bitfield-rle.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L38) + +___ + +### encodingLength + +▸ **encodingLength**(`bitfield`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bitfield` | `Buffer` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/bitfield-rle.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L60) diff --git a/docs/api/modules/core_manager_compat.md b/docs/api/modules/core_manager_compat.md new file mode 100644 index 000000000..fa149f4fc --- /dev/null +++ b/docs/api/modules/core_manager_compat.md @@ -0,0 +1,19 @@ +[API](../README.md) / core-manager/compat + +# Module: core-manager/compat + +## Table of contents + +### Variables + +- [quickbit](core_manager_compat.md#quickbit) + +## Variables + +### quickbit + +• **quickbit**: `__module` = `universal` + +#### Defined in + +[src/core-manager/compat.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/compat.js#L8) diff --git a/docs/api/modules/core_manager_core_index.md b/docs/api/modules/core_manager_core_index.md new file mode 100644 index 000000000..46115eb8a --- /dev/null +++ b/docs/api/modules/core_manager_core_index.md @@ -0,0 +1,42 @@ +[API](../README.md) / core-manager/core-index + +# Module: core-manager/core-index + +## Table of contents + +### Classes + +- [CoreIndex](../classes/core_manager_core_index.CoreIndex.md) + +### Type Aliases + +- [CoreRecord](core_manager_core_index.md#corerecord) +- [Namespace](core_manager_core_index.md#namespace) + +## Type Aliases + +### CoreRecord + +Ƭ **CoreRecord**\<\>: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `core` | [`Core`](core_manager.md#core) | +| `key` | `Buffer` | +| `namespace` | [`Namespace`](core_manager_core_index.md#namespace) | + +#### Defined in + +[src/core-manager/index.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L21) + +___ + +### Namespace + +Ƭ **Namespace**\<\>: typeof [`NAMESPACES`](constants.md#namespaces)[`number`] + +#### Defined in + +[src/core-manager/index.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L20) diff --git a/docs/api/modules/core_manager_random_access_file_pool.md b/docs/api/modules/core_manager_random_access_file_pool.md new file mode 100644 index 000000000..fd9417078 --- /dev/null +++ b/docs/api/modules/core_manager_random_access_file_pool.md @@ -0,0 +1,9 @@ +[API](../README.md) / core-manager/random-access-file-pool + +# Module: core-manager/random-access-file-pool + +## Table of contents + +### Classes + +- [RandomAccessFilePool](../classes/core_manager_random_access_file_pool.RandomAccessFilePool.md) diff --git a/docs/api/modules/core_manager_remote_bitfield.md b/docs/api/modules/core_manager_remote_bitfield.md new file mode 100644 index 000000000..b69dd33e1 --- /dev/null +++ b/docs/api/modules/core_manager_remote_bitfield.md @@ -0,0 +1,23 @@ +[API](../README.md) / core-manager/remote-bitfield + +# Module: core-manager/remote-bitfield + +## Table of contents + +### Classes + +- [default](../classes/core_manager_remote_bitfield.default.md) + +### Variables + +- [BITS\_PER\_PAGE](core_manager_remote_bitfield.md#bits_per_page) + +## Variables + +### BITS\_PER\_PAGE + +• `Const` **BITS\_PER\_PAGE**: ``32768`` + +#### Defined in + +[src/core-manager/remote-bitfield.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L8) diff --git a/docs/api/modules/core_ownership.md b/docs/api/modules/core_ownership.md new file mode 100644 index 000000000..2ad1d6d3e --- /dev/null +++ b/docs/api/modules/core_ownership.md @@ -0,0 +1,86 @@ +[API](../README.md) / core-ownership + +# Module: core-ownership + +## Table of contents + +### Classes + +- [CoreOwnership](../classes/core_ownership.CoreOwnership.md) + +### Type Aliases + +- [CoreOwnershipWithSignatures](core_ownership.md#coreownershipwithsignatures) + +### Functions + +- [getWinner](core_ownership.md#getwinner) +- [mapAndValidateCoreOwnership](core_ownership.md#mapandvalidatecoreownership) + +## Type Aliases + +### CoreOwnershipWithSignatures + +Ƭ **CoreOwnershipWithSignatures**: `Extract`\<`ReturnType`\, \{ `schemaName`: ``"coreOwnership"`` }\> + +#### Defined in + +[src/types.ts:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L55) + +## Functions + +### getWinner + +▸ **getWinner**\<`T`, `U`\>(`docA`, `docB`): `T` \| `U` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `IndexableDocument` | +| `U` | extends `IndexableDocument` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docA` | `T` | +| `docB` | `U` | + +#### Returns + +`T` \| `U` + +T | U + +#### Defined in + +[src/core-ownership.js:184](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L184) + +___ + +### mapAndValidateCoreOwnership + +▸ **mapAndValidateCoreOwnership**(`doc`, `version`): `Object` + +- Validate that the doc is written to the core identified by doc.authCoreId +- Verify the signatures +- Remove the signatures (we don't add them to the indexer) +- Set doc.links to an empty array - this forces the indexer to treat every + document as a fork, so getWinner is called for every doc, which resolves to + the doc with the lowest index (e.g. the first) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | {} & `CoreOwnershipSignatures` | +| `version` | `VersionIdObject` | + +#### Returns + +`Object` + +#### Defined in + +[src/core-ownership.js:126](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L126) diff --git a/docs/api/modules/datastore.md b/docs/api/modules/datastore.md new file mode 100644 index 000000000..9747c7e78 --- /dev/null +++ b/docs/api/modules/datastore.md @@ -0,0 +1,69 @@ +[API](../README.md) / datastore + +# Module: datastore + +## Table of contents + +### Classes + +- [DataStore](../classes/datastore.DataStore.md) + +### Type Aliases + +- [DataStoreEvents](datastore.md#datastoreevents) +- [MapeoDocTablesMap](datastore.md#mapeodoctablesmap) +- [NamespaceSchemas](datastore.md#namespaceschemas) +- [OmitUnion](datastore.md#omitunion) + +## Type Aliases + +### DataStoreEvents + +Ƭ **DataStoreEvents**\<`TSchemaName`\>: \{ [S in Exclude\]: Function } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | + +#### Defined in + +[src/datastore/index.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L22) + +___ + +### MapeoDocTablesMap + +Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } + +#### Defined in + +[src/datatype/index.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L23) + +___ + +### NamespaceSchemas + +Ƭ **NamespaceSchemas**\<\>: typeof `NAMESPACE_SCHEMAS` + +#### Defined in + +[src/datastore/index.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L44) + +___ + +### OmitUnion + +Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | + +#### Defined in + +[src/datastore/index.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L27) diff --git a/docs/api/modules/datatype-1.md b/docs/api/modules/datatype-1.md new file mode 100644 index 000000000..f3335bbf1 --- /dev/null +++ b/docs/api/modules/datatype-1.md @@ -0,0 +1,133 @@ +[API](../README.md) / datatype + +# Module: datatype + +## Table of contents + +### References + +- [MapeoDocTables](datatype-1.md#mapeodoctables) +- [MapeoDocTablesMap](datatype-1.md#mapeodoctablesmap) + +### Classes + +- [DataType](../classes/datatype-1.DataType.md) + +### Interfaces + +- [DataTypeEvents](../interfaces/datatype-1.DataTypeEvents.md) + +### Type Aliases + +- [ExcludeSchema](datatype-1.md#excludeschema) +- [GetMapeoDocTables](datatype-1.md#getmapeodoctables) +- [MapeoDocTableName](datatype-1.md#mapeodoctablename) +- [OmitUnion](datatype-1.md#omitunion) + +### Variables + +- [kCreateWithDocId](datatype-1.md#kcreatewithdocid) +- [kSelect](datatype-1.md#kselect) +- [kTable](datatype-1.md#ktable) + +## References + +### MapeoDocTables + +Re-exports [MapeoDocTables](index_writer.md#mapeodoctables) + +___ + +### MapeoDocTablesMap + +Re-exports [MapeoDocTablesMap](datastore.md#mapeodoctablesmap) + +## Type Aliases + +### ExcludeSchema + +Ƭ **ExcludeSchema**\<`T`, `S`\>: `Exclude`\<`T`, \{ `schemaName`: `S` }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `MapeoValue` | +| `S` | extends `MapeoValue`[``"schemaName"``] | + +#### Defined in + +[src/datatype/index.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L38) + +___ + +### GetMapeoDocTables + +Ƭ **GetMapeoDocTables**\<`T`\>: `T`[keyof `T` & [`MapeoDocTableName`](datatype-1.md#mapeodoctablename)] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/datatype/index.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L18) + +___ + +### MapeoDocTableName + +Ƭ **MapeoDocTableName**: \`$\{MapeoDoc["schemaName"]}Table\` + +#### Defined in + +[src/datatype/index.d.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L17) + +___ + +### OmitUnion + +Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | + +#### Defined in + +[src/datatype/index.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L37) + +## Variables + +### kCreateWithDocId + +• `Const` **kCreateWithDocId**: unique `symbol` + +#### Defined in + +[src/datatype/index.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L33) + +___ + +### kSelect + +• `Const` **kSelect**: unique `symbol` + +#### Defined in + +[src/datatype/index.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L34) + +___ + +### kTable + +• `Const` **kTable**: unique `symbol` + +#### Defined in + +[src/datatype/index.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L35) diff --git a/docs/api/modules/datatype.md b/docs/api/modules/datatype.md new file mode 100644 index 000000000..693a0002e --- /dev/null +++ b/docs/api/modules/datatype.md @@ -0,0 +1,142 @@ +[API](../README.md) / datatype + +# Module: datatype + +## Table of contents + +### Classes + +- [DataType](../classes/datatype.DataType.md) + +### Interfaces + +- [DataTypeEvents](../interfaces/datatype.DataTypeEvents.md) + +### Type Aliases + +- [GetMapeoDocTables](datatype.md#getmapeodoctables) +- [MapeoDocMap](datatype.md#mapeodocmap) +- [MapeoDocTableName](datatype.md#mapeodoctablename) +- [MapeoDocTables](datatype.md#mapeodoctables) +- [MapeoDocTablesMap](datatype.md#mapeodoctablesmap) +- [MapeoValueMap](datatype.md#mapeovaluemap) +- [OmitUnion](datatype.md#omitunion) + +### Variables + +- [kCreateWithDocId](datatype.md#kcreatewithdocid) +- [kSelect](datatype.md#kselect) +- [kTable](datatype.md#ktable) + +## Type Aliases + +### GetMapeoDocTables + +Ƭ **GetMapeoDocTables**\<`T`\>: `T`[keyof `T` & [`MapeoDocTableName`](datatype.md#mapeodoctablename)] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/datatype/index.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L27) + +___ + +### MapeoDocMap + +Ƭ **MapeoDocMap**: \{ [K in MapeoDoc["schemaName"]]: Extract\ } + +#### Defined in + +[src/types.ts:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L46) + +___ + +### MapeoDocTableName + +Ƭ **MapeoDocTableName**\<\>: \`$\{MapeoDoc["schemaName"]}Table\` + +#### Defined in + +[src/datatype/index.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L23) + +___ + +### MapeoDocTables + +Ƭ **MapeoDocTables**\<\>: [`GetMapeoDocTables`](datatype.md#getmapeodoctables)\<[`schema/project`](schema_project.md)\> \| [`GetMapeoDocTables`](datatype.md#getmapeodoctables)\<[`schema/client`](schema_client.md)\> + +#### Defined in + +[src/datatype/index.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L31) + +___ + +### MapeoDocTablesMap + +Ƭ **MapeoDocTablesMap**\<\>: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } + +#### Defined in + +[src/datatype/index.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L34) + +___ + +### MapeoValueMap + +Ƭ **MapeoValueMap**: \{ [K in MapeoValue["schemaName"]]: Extract\ } + +#### Defined in + +[src/types.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L50) + +___ + +### OmitUnion + +Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | + +#### Defined in + +[src/datatype/index.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L39) + +## Variables + +### kCreateWithDocId + +• `Const` **kCreateWithDocId**: typeof [`kCreateWithDocId`](datatype.md#kcreatewithdocid) + +#### Defined in + +[src/datatype/index.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L53) + +___ + +### kSelect + +• `Const` **kSelect**: typeof [`kSelect`](datatype.md#kselect) + +#### Defined in + +[src/datatype/index.js:54](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L54) + +___ + +### kTable + +• `Const` **kTable**: typeof [`kTable`](datatype.md#ktable) + +#### Defined in + +[src/datatype/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L55) diff --git a/docs/api/modules/discovery_local_discovery.md b/docs/api/modules/discovery_local_discovery.md new file mode 100644 index 000000000..9a5c3c73a --- /dev/null +++ b/docs/api/modules/discovery_local_discovery.md @@ -0,0 +1,59 @@ +[API](../README.md) / discovery/local-discovery + +# Module: discovery/local-discovery + +## Table of contents + +### Classes + +- [LocalDiscovery](../classes/discovery_local_discovery.LocalDiscovery.md) + +### Interfaces + +- [DiscoveryEvents](../interfaces/discovery_local_discovery.DiscoveryEvents.md) + +### Type Aliases + +- [Keypair](discovery_local_discovery.md#keypair) +- [OpenedNoiseStream](discovery_local_discovery.md#openednoisestream) + +### Variables + +- [ERR\_DUPLICATE](discovery_local_discovery.md#err_duplicate) + +## Type Aliases + +### Keypair + +Ƭ **Keypair**\<\>: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `publicKey` | `Buffer` | +| `secretKey` | `Buffer` | + +#### Defined in + +[src/discovery/local-discovery.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L13) + +___ + +### OpenedNoiseStream + +Ƭ **OpenedNoiseStream**\<\>: [`utils`](utils.md) + +#### Defined in + +[src/discovery/local-discovery.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L14) + +## Variables + +### ERR\_DUPLICATE + +• `Const` **ERR\_DUPLICATE**: ``"Duplicate connection"`` + +#### Defined in + +[src/discovery/local-discovery.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L16) diff --git a/docs/api/modules/fastify_controller.md b/docs/api/modules/fastify_controller.md new file mode 100644 index 000000000..5c4162987 --- /dev/null +++ b/docs/api/modules/fastify_controller.md @@ -0,0 +1,13 @@ +[API](../README.md) / fastify-controller + +# Module: fastify-controller + +## Table of contents + +### Classes + +- [FastifyController](../classes/fastify_controller.FastifyController.md) + +### Interfaces + +- [StartOpts](../interfaces/fastify_controller.StartOpts.md) diff --git a/docs/api/modules/fastify_plugins_blobs.md b/docs/api/modules/fastify_plugins_blobs.md new file mode 100644 index 000000000..78c602e52 --- /dev/null +++ b/docs/api/modules/fastify_plugins_blobs.md @@ -0,0 +1,44 @@ +[API](../README.md) / fastify-plugins/blobs + +# Module: fastify-plugins/blobs + +## Table of contents + +### References + +- [BlobId](fastify_plugins_blobs.md#blobid) + +### Interfaces + +- [BlobServerPluginOpts](../interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md) + +### Functions + +- [default](fastify_plugins_blobs.md#default) + +## References + +### BlobId + +Re-exports [BlobId](blob_api.md#blobid) + +## Functions + +### default + +▸ **default**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | `RegisterOptions` & [`BlobServerPluginOpts`](../interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/blobs.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/blobs.js#L8) diff --git a/docs/api/modules/fastify_plugins_constants.md b/docs/api/modules/fastify_plugins_constants.md new file mode 100644 index 000000000..ac8bf3fb4 --- /dev/null +++ b/docs/api/modules/fastify_plugins_constants.md @@ -0,0 +1,30 @@ +[API](../README.md) / fastify-plugins/constants + +# Module: fastify-plugins/constants + +## Table of contents + +### Variables + +- [HEX\_REGEX\_32\_BYTES](fastify_plugins_constants.md#hex_regex_32_bytes) +- [Z\_BASE\_32\_REGEX\_32\_BYTES](fastify_plugins_constants.md#z_base_32_regex_32_bytes) + +## Variables + +### HEX\_REGEX\_32\_BYTES + +• `Const` **HEX\_REGEX\_32\_BYTES**: ``"^[0-9a-fA-F]{64}$"`` + +#### Defined in + +[src/fastify-plugins/constants.js:2](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/constants.js#L2) + +___ + +### Z\_BASE\_32\_REGEX\_32\_BYTES + +• `Const` **Z\_BASE\_32\_REGEX\_32\_BYTES**: ``"^[0-9a-zA-Z]{52}$"`` + +#### Defined in + +[src/fastify-plugins/constants.js:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/constants.js#L5) diff --git a/docs/api/modules/fastify_plugins_icons.md b/docs/api/modules/fastify_plugins_icons.md new file mode 100644 index 000000000..d47751cf9 --- /dev/null +++ b/docs/api/modules/fastify_plugins_icons.md @@ -0,0 +1,34 @@ +[API](../README.md) / fastify-plugins/icons + +# Module: fastify-plugins/icons + +## Table of contents + +### Interfaces + +- [IconServerPluginOpts](../interfaces/fastify_plugins_icons.IconServerPluginOpts.md) + +### Functions + +- [default](fastify_plugins_icons.md#default) + +## Functions + +### default + +▸ **default**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | `RegisterOptions` & [`IconServerPluginOpts`](../interfaces/fastify_plugins_icons.IconServerPluginOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/icons.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/icons.js#L8) diff --git a/docs/api/modules/fastify_plugins_maps.md b/docs/api/modules/fastify_plugins_maps.md new file mode 100644 index 000000000..b7f06b4b5 --- /dev/null +++ b/docs/api/modules/fastify_plugins_maps.md @@ -0,0 +1,60 @@ +[API](../README.md) / fastify-plugins/maps + +# Module: fastify-plugins/maps + +## Table of contents + +### Interfaces + +- [MapsPluginContext](../interfaces/fastify_plugins_maps.MapsPluginContext.md) +- [MapsPluginOpts](../interfaces/fastify_plugins_maps.MapsPluginOpts.md) + +### Variables + +- [DEFAULT\_MAPBOX\_STYLE\_URL](fastify_plugins_maps.md#default_mapbox_style_url) +- [PLUGIN\_NAME](fastify_plugins_maps.md#plugin_name) + +### Functions + +- [plugin](fastify_plugins_maps.md#plugin) + +## Variables + +### DEFAULT\_MAPBOX\_STYLE\_URL + +• `Const` **DEFAULT\_MAPBOX\_STYLE\_URL**: ``"https://api.mapbox.com/styles/v1/mapbox/outdoors-v12"`` + +#### Defined in + +[src/fastify-plugins/maps/index.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L14) + +___ + +### PLUGIN\_NAME + +• `Const` **PLUGIN\_NAME**: ``"mapeo-maps"`` + +#### Defined in + +[src/fastify-plugins/maps/index.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L13) + +## Functions + +### plugin + +▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | [`MapsPluginOpts`](../interfaces/fastify_plugins_maps.MapsPluginOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L30) diff --git a/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md b/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md new file mode 100644 index 000000000..3c52d9cfa --- /dev/null +++ b/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md @@ -0,0 +1,49 @@ +[API](../README.md) / fastify-plugins/maps/offline-fallback-map + +# Module: fastify-plugins/maps/offline-fallback-map + +## Table of contents + +### Interfaces + +- [FallbackMapPluginDecorator](../interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md) +- [OfflineFallbackMapPluginOpts](../interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md) + +### Variables + +- [PLUGIN\_NAME](fastify_plugins_maps_offline_fallback_map.md#plugin_name) + +### Functions + +- [plugin](fastify_plugins_maps_offline_fallback_map.md#plugin) + +## Variables + +### PLUGIN\_NAME + +• `Const` **PLUGIN\_NAME**: ``"mapeo-static-maps"`` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L12) + +## Functions + +### plugin + +▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | [`OfflineFallbackMapPluginOpts`](../interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L14) diff --git a/docs/api/modules/fastify_plugins_maps_static_maps.md b/docs/api/modules/fastify_plugins_maps_static_maps.md new file mode 100644 index 000000000..2d005bfe4 --- /dev/null +++ b/docs/api/modules/fastify_plugins_maps_static_maps.md @@ -0,0 +1,49 @@ +[API](../README.md) / fastify-plugins/maps/static-maps + +# Module: fastify-plugins/maps/static-maps + +## Table of contents + +### Interfaces + +- [StaticMapsPluginDecorator](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md) +- [StaticMapsPluginOpts](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md) + +### Variables + +- [PLUGIN\_NAME](fastify_plugins_maps_static_maps.md#plugin_name) + +### Functions + +- [plugin](fastify_plugins_maps_static_maps.md#plugin) + +## Variables + +### PLUGIN\_NAME + +• `Const` **PLUGIN\_NAME**: ``"mapeo-static-maps"`` + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L16) + +## Functions + +### plugin + +▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | [`StaticMapsPluginOpts`](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L18) diff --git a/docs/api/modules/fastify_plugins_utils.md b/docs/api/modules/fastify_plugins_utils.md new file mode 100644 index 000000000..c96dc708c --- /dev/null +++ b/docs/api/modules/fastify_plugins_utils.md @@ -0,0 +1,73 @@ +[API](../README.md) / fastify-plugins/utils + +# Module: fastify-plugins/utils + +## Table of contents + +### Variables + +- [NotFoundError](fastify_plugins_utils.md#notfounderror) + +### Functions + +- [createStyleJsonResponseHeaders](fastify_plugins_utils.md#createstylejsonresponseheaders) +- [getFastifyServerAddress](fastify_plugins_utils.md#getfastifyserveraddress) + +## Variables + +### NotFoundError + +• `Const` **NotFoundError**: `FastifyErrorConstructor`\<{}, [any?, any?, any?]\> + +#### Defined in + +[src/fastify-plugins/utils.js:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L4) + +## Functions + +### createStyleJsonResponseHeaders + +▸ **createStyleJsonResponseHeaders**(`lastModified`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lastModified` | `Readonly`\<`Date`\> | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `Access-Control-Allow-Headers` | `string` | +| `Access-Control-Allow-Origin` | `string` | +| `Cache-Control` | `string` | +| `Last-Modified` | `string` | + +#### Defined in + +[src/fastify-plugins/utils.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L44) + +___ + +### getFastifyServerAddress + +▸ **getFastifyServerAddress**(`server`, `options?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `server` | `Server`\ | +| `options?` | `Object` | +| `options.timeout?` | `number` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/fastify-plugins/utils.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L15) diff --git a/docs/api/modules/generated_extensions.md b/docs/api/modules/generated_extensions.md new file mode 100644 index 000000000..c08c8a048 --- /dev/null +++ b/docs/api/modules/generated_extensions.md @@ -0,0 +1,142 @@ +[API](../README.md) / generated/extensions + +# Module: generated/extensions + +## Table of contents + +### Interfaces + +- [HaveExtension](../interfaces/generated_extensions.HaveExtension.md) +- [ProjectExtension](../interfaces/generated_extensions.ProjectExtension.md) + +### Type Aliases + +- [HaveExtension\_Namespace](generated_extensions.md#haveextension_namespace) + +### Variables + +- [HaveExtension](generated_extensions.md#haveextension) +- [HaveExtension\_Namespace](generated_extensions.md#haveextension_namespace-1) +- [ProjectExtension](generated_extensions.md#projectextension) + +### Functions + +- [haveExtension\_NamespaceFromJSON](generated_extensions.md#haveextension_namespacefromjson) +- [haveExtension\_NamespaceToNumber](generated_extensions.md#haveextension_namespacetonumber) + +## Type Aliases + +### HaveExtension\_Namespace + +Ƭ **HaveExtension\_Namespace**: typeof [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace-1)[keyof typeof [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace-1)] + +#### Defined in + +[src/generated/extensions.ts:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L21) + +[src/generated/extensions.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L30) + +## Variables + +### HaveExtension + +• **HaveExtension**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | +| `encode` | (`message`: [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | + +#### Defined in + +[src/generated/extensions.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L14) + +[src/generated/extensions.ts:190](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L190) + +___ + +### HaveExtension\_Namespace + +• `Const` **HaveExtension\_Namespace**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | +| `auth` | ``"auth"`` | +| `blob` | ``"blob"`` | +| `blobIndex` | ``"blobIndex"`` | +| `config` | ``"config"`` | +| `data` | ``"data"`` | + +#### Defined in + +[src/generated/extensions.ts:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L21) + +[src/generated/extensions.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L30) + +___ + +### ProjectExtension + +• **ProjectExtension**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | +| `encode` | (`message`: [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | + +#### Defined in + +[src/generated/extensions.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L5) + +[src/generated/extensions.ts:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L85) + +## Functions + +### haveExtension\_NamespaceFromJSON + +▸ **haveExtension_NamespaceFromJSON**(`object`): [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `any` | + +#### Returns + +[`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) + +#### Defined in + +[src/generated/extensions.ts:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L32) + +___ + +### haveExtension\_NamespaceToNumber + +▸ **haveExtension_NamespaceToNumber**(`object`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) | + +#### Returns + +`number` + +#### Defined in + +[src/generated/extensions.ts:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L56) diff --git a/docs/api/modules/generated_keys.md b/docs/api/modules/generated_keys.md new file mode 100644 index 000000000..669017786 --- /dev/null +++ b/docs/api/modules/generated_keys.md @@ -0,0 +1,57 @@ +[API](../README.md) / generated/keys + +# Module: generated/keys + +## Table of contents + +### Interfaces + +- [EncryptionKeys](../interfaces/generated_keys.EncryptionKeys.md) +- [ProjectKeys](../interfaces/generated_keys.ProjectKeys.md) + +### Variables + +- [EncryptionKeys](generated_keys.md#encryptionkeys) +- [ProjectKeys](generated_keys.md#projectkeys) + +## Variables + +### EncryptionKeys + +• **EncryptionKeys**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | +| `encode` | (`message`: [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | + +#### Defined in + +[src/generated/keys.ts:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L4) + +[src/generated/keys.ts:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L22) + +___ + +### ProjectKeys + +• **ProjectKeys**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | +| `encode` | (`message`: [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | + +#### Defined in + +[src/generated/keys.ts:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L12) + +[src/generated/keys.ts:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L111) diff --git a/docs/api/modules/generated_rpc.md b/docs/api/modules/generated_rpc.md new file mode 100644 index 000000000..d4fdbf2eb --- /dev/null +++ b/docs/api/modules/generated_rpc.md @@ -0,0 +1,225 @@ +[API](../README.md) / generated/rpc + +# Module: generated/rpc + +## Table of contents + +### References + +- [Invite](generated_rpc.md#invite) +- [InviteCancel](generated_rpc.md#invitecancel) +- [InviteResponse](generated_rpc.md#inviteresponse) +- [ProjectJoinDetails](generated_rpc.md#projectjoindetails) + +### Interfaces + +- [DeviceInfo](../interfaces/generated_rpc.DeviceInfo.md) + +### Type Aliases + +- [DeviceInfo\_DeviceType](generated_rpc.md#deviceinfo_devicetype) +- [InviteResponse\_Decision](generated_rpc.md#inviteresponse_decision) + +### Variables + +- [DeviceInfo](generated_rpc.md#deviceinfo) +- [DeviceInfo\_DeviceType](generated_rpc.md#deviceinfo_devicetype-1) +- [InviteResponse\_Decision](generated_rpc.md#inviteresponse_decision-1) + +### Functions + +- [deviceInfo\_DeviceTypeFromJSON](generated_rpc.md#deviceinfo_devicetypefromjson) +- [deviceInfo\_DeviceTypeToNumber](generated_rpc.md#deviceinfo_devicetypetonumber) +- [inviteResponse\_DecisionFromJSON](generated_rpc.md#inviteresponse_decisionfromjson) +- [inviteResponse\_DecisionToNumber](generated_rpc.md#inviteresponse_decisiontonumber) + +## References + +### Invite + +Renames and re-exports [InviteRpcMessage](invite_api.md#inviterpcmessage) + +___ + +### InviteCancel + +Re-exports [InviteCancel](invite_api.md#invitecancel) + +___ + +### InviteResponse + +Re-exports [InviteResponse](member_api.md#inviteresponse) + +___ + +### ProjectJoinDetails + +Re-exports [ProjectJoinDetails](invite_api.md#projectjoindetails) + +## Type Aliases + +### DeviceInfo\_DeviceType + +Ƭ **DeviceInfo\_DeviceType**: typeof [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype-1)[keyof typeof [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype-1)] + +#### Defined in + +[src/generated/rpc.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L75) + +[src/generated/rpc.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L82) + +___ + +### InviteResponse\_Decision + +Ƭ **InviteResponse\_Decision**: typeof [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision-1)[keyof typeof [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision-1)] + +#### Defined in + +[src/generated/rpc.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L23) + +[src/generated/rpc.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L30) + +## Variables + +### DeviceInfo + +• **DeviceInfo**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | +| `encode` | (`message`: [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | + +#### Defined in + +[src/generated/rpc.ts:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L70) + +[src/generated/rpc.ts:390](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L390) + +___ + +### DeviceInfo\_DeviceType + +• `Const` **DeviceInfo\_DeviceType**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | +| `desktop` | ``"desktop"`` | +| `mobile` | ``"mobile"`` | +| `tablet` | ``"tablet"`` | + +#### Defined in + +[src/generated/rpc.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L75) + +[src/generated/rpc.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L82) + +___ + +### InviteResponse\_Decision + +• `Const` **InviteResponse\_Decision**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `ACCEPT` | ``"ACCEPT"`` | +| `ALREADY` | ``"ALREADY"`` | +| `REJECT` | ``"REJECT"`` | +| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | + +#### Defined in + +[src/generated/rpc.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L23) + +[src/generated/rpc.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L30) + +## Functions + +### deviceInfo\_DeviceTypeFromJSON + +▸ **deviceInfo_DeviceTypeFromJSON**(`object`): [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `any` | + +#### Returns + +[`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) + +#### Defined in + +[src/generated/rpc.ts:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L84) + +___ + +### deviceInfo\_DeviceTypeToNumber + +▸ **deviceInfo_DeviceTypeToNumber**(`object`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) | + +#### Returns + +`number` + +#### Defined in + +[src/generated/rpc.ts:102](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L102) + +___ + +### inviteResponse\_DecisionFromJSON + +▸ **inviteResponse_DecisionFromJSON**(`object`): [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `any` | + +#### Returns + +[`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) + +#### Defined in + +[src/generated/rpc.ts:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L32) + +___ + +### inviteResponse\_DecisionToNumber + +▸ **inviteResponse_DecisionToNumber**(`object`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) | + +#### Returns + +`number` + +#### Defined in + +[src/generated/rpc.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L50) diff --git a/docs/api/modules/icon_api.md b/docs/api/modules/icon_api.md new file mode 100644 index 000000000..c3d480f0f --- /dev/null +++ b/docs/api/modules/icon_api.md @@ -0,0 +1,116 @@ +[API](../README.md) / icon-api + +# Module: icon-api + +## Table of contents + +### Classes + +- [IconApi](../classes/icon_api.IconApi.md) + +### Interfaces + +- [BitmapOpts](../interfaces/icon_api.BitmapOpts.md) +- [SvgOpts](../interfaces/icon_api.SvgOpts.md) + +### Type Aliases + +- [IconVariant](icon_api.md#iconvariant) +- [IconVariants](icon_api.md#iconvariants) + +### Variables + +- [kGetIconBlob](icon_api.md#kgeticonblob) + +### Functions + +- [constructIconPath](icon_api.md#constructiconpath) +- [getBestVariant](icon_api.md#getbestvariant) + +## Type Aliases + +### IconVariant + +Ƭ **IconVariant**\<\>: `any`[][`number`] + +#### Defined in + +[src/icon-api.js:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L4) + +___ + +### IconVariants + +Ƭ **IconVariants**\<\>: `IconValue`[``"variants"``] + +#### Defined in + +[src/icon-api.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L3) + +## Variables + +### kGetIconBlob + +• `Const` **kGetIconBlob**: typeof [`kGetIconBlob`](icon_api.md#kgeticonblob) + +#### Defined in + +[src/icon-api.js:1](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L1) + +## Functions + +### constructIconPath + +▸ **constructIconPath**(`opts`): `string` + +General purpose path builder for an icon + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.extension` | `string` | +| `opts.iconId` | `string` | +| `opts.pixelDensity` | `undefined` \| `number` | +| `opts.size` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/icon-api.js:258](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L258) + +___ + +### getBestVariant + +▸ **getBestVariant**(`variants`, `opts`): {} \| {} + +Given a list of icon variants returns the variant that most closely matches the desired parameters. +Rules, in order of precedence: + +1. Matching mime type (throw if no matches) +2. Matching size. If no exact match: + 1. If smaller ones exist, prefer closest smaller size. + 2. Otherwise prefer closest larger size. +3. Matching pixel density (when asking for PNGs). If no exact match: + 1. If smaller ones exist, prefer closest smaller density. + 2. Otherwise prefer closest larger density. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | ({} \| {})[] | +| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | + +#### Returns + +{} \| {} + +#### Defined in + +[src/icon-api.js:146](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L146) diff --git a/docs/api/modules/index.md b/docs/api/modules/index.md new file mode 100644 index 000000000..974d49488 --- /dev/null +++ b/docs/api/modules/index.md @@ -0,0 +1,43 @@ +[API](../README.md) / index + +# Module: index + +## Table of contents + +### References + +- [FastifyController](index.md#fastifycontroller) +- [MapeoManager](index.md#mapeomanager) +- [MapeoMapsFastifyPlugin](index.md#mapeomapsfastifyplugin) +- [MapeoOfflineFallbackMapFastifyPlugin](index.md#mapeoofflinefallbackmapfastifyplugin) +- [MapeoStaticMapsFastifyPlugin](index.md#mapeostaticmapsfastifyplugin) + +## References + +### FastifyController + +Re-exports [FastifyController](../classes/fastify_controller.FastifyController.md) + +___ + +### MapeoManager + +Re-exports [MapeoManager](../classes/mapeo_manager.MapeoManager.md) + +___ + +### MapeoMapsFastifyPlugin + +Renames and re-exports [plugin](fastify_plugins_maps.md#plugin) + +___ + +### MapeoOfflineFallbackMapFastifyPlugin + +Renames and re-exports [plugin](fastify_plugins_maps_offline_fallback_map.md#plugin) + +___ + +### MapeoStaticMapsFastifyPlugin + +Renames and re-exports [plugin](fastify_plugins_maps_static_maps.md#plugin) diff --git a/docs/api/modules/index_writer.md b/docs/api/modules/index_writer.md new file mode 100644 index 000000000..c6986475e --- /dev/null +++ b/docs/api/modules/index_writer.md @@ -0,0 +1,47 @@ +[API](../README.md) / index-writer + +# Module: index-writer + +## Table of contents + +### Classes + +- [IndexWriter](../classes/index_writer.IndexWriter.md) + +### Type Aliases + +- [IndexedDocIds](index_writer.md#indexeddocids) +- [MapeoDocInternal](index_writer.md#mapeodocinternal) +- [MapeoDocTables](index_writer.md#mapeodoctables) + +## Type Aliases + +### IndexedDocIds + +Ƭ **IndexedDocIds**\<\>: \{ [K in MapeoDoc["schemaName"]]?: string[] } + +#### Defined in + +[src/index-writer/index.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L15) + +___ + +### MapeoDocInternal + +Ƭ **MapeoDocInternal**\<\>: `ReturnType`\<`decode`\> + +#### Defined in + +[src/index-writer/index.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L18) + +___ + +### MapeoDocTables + +Ƭ **MapeoDocTables**: [`GetMapeoDocTables`](datatype-1.md#getmapeodoctables)\<[`schema/project`](schema_project.md)\> \| [`GetMapeoDocTables`](datatype-1.md#getmapeodoctables)\<[`schema/client`](schema_client.md)\> + +Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables) + +#### Defined in + +[src/datatype/index.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L20) diff --git a/docs/api/modules/invite_api.md b/docs/api/modules/invite_api.md new file mode 100644 index 000000000..2c367044b --- /dev/null +++ b/docs/api/modules/invite_api.md @@ -0,0 +1,121 @@ +[API](../README.md) / invite-api + +# Module: invite-api + +## Table of contents + +### Classes + +- [InviteApi](../classes/invite_api.InviteApi.md) + +### Interfaces + +- [InviteApiEvents](../interfaces/invite_api.InviteApiEvents.md) +- [InviteCancel](../interfaces/invite_api.InviteCancel.md) +- [InviteRpcMessage](../interfaces/invite_api.InviteRpcMessage.md) +- [ProjectJoinDetails](../interfaces/invite_api.ProjectJoinDetails.md) + +### Type Aliases + +- [Invite](invite_api.md#invite) +- [InviteInternal](invite_api.md#inviteinternal) +- [InviteRemovalReason](invite_api.md#inviteremovalreason) + +### Variables + +- [InviteCancel](invite_api.md#invitecancel) +- [InviteRpcMessage](invite_api.md#inviterpcmessage) +- [ProjectJoinDetails](invite_api.md#projectjoindetails) + +## Type Aliases + +### Invite + +Ƭ **Invite**\<\>: [`types`](types.md) + +#### Defined in + +[src/invite-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L26) + +___ + +### InviteInternal + +Ƭ **InviteInternal**\<\>: [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) & \{ `receivedAt`: `number` } + +#### Defined in + +[src/invite-api.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L23) + +___ + +### InviteRemovalReason + +Ƭ **InviteRemovalReason**\<\>: ``"accepted"`` \| ``"rejected"`` \| ``"canceled"`` \| ``"accepted other"`` \| ``"connection error"`` \| ``"internal error"`` + +#### Defined in + +[src/invite-api.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L36) + +## Variables + +### InviteCancel + +• **InviteCancel**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | +| `encode` | (`message`: [`InviteCancel`](../interfaces/invite_api.InviteCancel.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | + +#### Defined in + +[src/generated/rpc.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L14) + +[src/generated/rpc.ts:220](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L220) + +___ + +### InviteRpcMessage + +• **InviteRpcMessage**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | +| `encode` | (`message`: [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | + +#### Defined in + +[src/generated/rpc.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L5) + +[src/generated/rpc.ts:120](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L120) + +___ + +### ProjectJoinDetails + +• **ProjectJoinDetails**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | +| `encode` | (`message`: [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | + +#### Defined in + +[src/generated/rpc.ts:64](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L64) + +[src/generated/rpc.ts:321](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L321) diff --git a/docs/api/modules/lib_hashmap.md b/docs/api/modules/lib_hashmap.md new file mode 100644 index 000000000..6b9f1c73d --- /dev/null +++ b/docs/api/modules/lib_hashmap.md @@ -0,0 +1,23 @@ +[API](../README.md) / lib/hashmap + +# Module: lib/hashmap + +## Table of contents + +### Classes + +- [default](../classes/lib_hashmap.default.md) + +### Type Aliases + +- [Primitive](lib_hashmap.md#primitive) + +## Type Aliases + +### Primitive + +Ƭ **Primitive**\<\>: `string` \| `number` \| `bigint` \| `boolean` \| `undefined` \| `symbol` \| ``null`` + +#### Defined in + +[src/lib/hashmap.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L3) diff --git a/docs/api/modules/lib_ponyfills.md b/docs/api/modules/lib_ponyfills.md new file mode 100644 index 000000000..9593f5238 --- /dev/null +++ b/docs/api/modules/lib_ponyfills.md @@ -0,0 +1,33 @@ +[API](../README.md) / lib/ponyfills + +# Module: lib/ponyfills + +## Table of contents + +### Functions + +- [abortSignalAny](lib_ponyfills.md#abortsignalany) + +## Functions + +### abortSignalAny + +▸ **abortSignalAny**(`iterable`): `AbortSignal` + +Ponyfill of `AbortSignal.any()`. + +[0]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any_static + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iterable` | `Iterable`\<`AbortSignal`\> | + +#### Returns + +`AbortSignal` + +#### Defined in + +[src/lib/ponyfills.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/ponyfills.js#L11) diff --git a/docs/api/modules/lib_string.md b/docs/api/modules/lib_string.md new file mode 100644 index 000000000..2dd1b510e --- /dev/null +++ b/docs/api/modules/lib_string.md @@ -0,0 +1,31 @@ +[API](../README.md) / lib/string + +# Module: lib/string + +## Table of contents + +### Functions + +- [isBlank](lib_string.md#isblank) + +## Functions + +### isBlank + +▸ **isBlank**(`str`): `boolean` + +Returns `true` if the string is empty or only contains whitespace, `false` otherwise. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/lib/string.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/string.js#L9) diff --git a/docs/api/modules/lib_timing_safe_equal.md b/docs/api/modules/lib_timing_safe_equal.md new file mode 100644 index 000000000..cddfd4b8c --- /dev/null +++ b/docs/api/modules/lib_timing_safe_equal.md @@ -0,0 +1,43 @@ +[API](../README.md) / lib/timing-safe-equal + +# Module: lib/timing-safe-equal + +## Table of contents + +### Functions + +- [default](lib_timing_safe_equal.md#default) + +## Functions + +### default + +▸ **default**\<`T`\>(`a`, `b`): `boolean` + +Compare two values in constant time. + +Useful when you want to avoid leaking data. + +Like `crypto.timingSafeEqual`, but works with strings and doesn't throw if +lengths differ. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `string` \| `ArrayBufferView` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `a` | `T` | +| `b` | `T` | + +#### Returns + +`boolean` + +#### Defined in + +[src/lib/timing-safe-equal.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/timing-safe-equal.js#L28) diff --git a/docs/api/modules/local_peers.md b/docs/api/modules/local_peers.md new file mode 100644 index 000000000..cc98b743b --- /dev/null +++ b/docs/api/modules/local_peers.md @@ -0,0 +1,86 @@ +[API](../README.md) / local-peers + +# Module: local-peers + +## Table of contents + +### Classes + +- [LocalPeers](../classes/local_peers.LocalPeers.md) +- [PeerDisconnectedError](../classes/local_peers.PeerDisconnectedError.md) +- [PeerFailedConnectionError](../classes/local_peers.PeerFailedConnectionError.md) +- [UnknownPeerError](../classes/local_peers.UnknownPeerError.md) + +### Interfaces + +- [LocalPeersEvents](../interfaces/local_peers.LocalPeersEvents.md) +- [PeerInfoBase](../interfaces/local_peers.PeerInfoBase.md) + +### Type Aliases + +- [PeerInfo](local_peers.md#peerinfo) +- [PeerInfoConnected](local_peers.md#peerinfoconnected) +- [PeerInfoConnecting](local_peers.md#peerinfoconnecting) +- [PeerInfoDisconnected](local_peers.md#peerinfodisconnected) +- [PeerInfoInternal](local_peers.md#peerinfointernal) +- [PeerState](local_peers.md#peerstate) + +## Type Aliases + +### PeerInfo + +Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](local_peers.md#peerinfoconnected) \| [`PeerInfoDisconnected`](local_peers.md#peerinfodisconnected) + +#### Defined in + +[src/local-peers.js:49](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L49) + +___ + +### PeerInfoConnected + +Ƭ **PeerInfoConnected**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`__module`\> ; `status`: ``"connected"`` } + +#### Defined in + +[src/local-peers.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L45) + +___ + +### PeerInfoConnecting + +Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } + +#### Defined in + +[src/local-peers.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L44) + +___ + +### PeerInfoDisconnected + +Ƭ **PeerInfoDisconnected**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` } + +#### Defined in + +[src/local-peers.js:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L46) + +___ + +### PeerInfoInternal + +Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](local_peers.md#peerinfoconnecting) \| [`PeerInfoConnected`](local_peers.md#peerinfoconnected) \| [`PeerInfoDisconnected`](local_peers.md#peerinfodisconnected) + +#### Defined in + +[src/local-peers.js:48](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L48) + +___ + +### PeerState + +Ƭ **PeerState**\<\>: [`PeerInfoInternal`](local_peers.md#peerinfointernal)[``"status"``] + +#### Defined in + +[src/local-peers.js:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L50) diff --git a/docs/api/modules/logger.md b/docs/api/modules/logger.md new file mode 100644 index 000000000..6ad5fa76b --- /dev/null +++ b/docs/api/modules/logger.md @@ -0,0 +1,9 @@ +[API](../README.md) / logger + +# Module: logger + +## Table of contents + +### Classes + +- [Logger](../classes/logger.Logger.md) diff --git a/docs/api/modules/mapeo_manager.md b/docs/api/modules/mapeo_manager.md new file mode 100644 index 000000000..473a71f9a --- /dev/null +++ b/docs/api/modules/mapeo_manager.md @@ -0,0 +1,63 @@ +[API](../README.md) / mapeo-manager + +# Module: mapeo-manager + +## Table of contents + +### Classes + +- [MapeoManager](../classes/mapeo_manager.MapeoManager.md) + +### Interfaces + +- [MapeoManagerEvents](../interfaces/mapeo_manager.MapeoManagerEvents.md) + +### Type Aliases + +- [PublicPeerInfo](mapeo_manager.md#publicpeerinfo) +- [ValidatedProjectKeys](mapeo_manager.md#validatedprojectkeys) + +### Variables + +- [kManagerReplicate](mapeo_manager.md#kmanagerreplicate) +- [kRPC](mapeo_manager.md#krpc) + +## Type Aliases + +### PublicPeerInfo + +Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`local-peers`](local_peers.md), ``"protomux"``\> + +#### Defined in + +[src/mapeo-manager.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L65) + +___ + +### ValidatedProjectKeys + +Ƭ **ValidatedProjectKeys**\<\>: `SetNonNullable` + +#### Defined in + +[src/mapeo-manager.js:47](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L47) + +## Variables + +### kManagerReplicate + +• `Const` **kManagerReplicate**: typeof [`kManagerReplicate`](mapeo_manager.md#kmanagerreplicate) + +#### Defined in + +[src/mapeo-manager.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L62) + +___ + +### kRPC + +• `Const` **kRPC**: typeof [`kRPC`](mapeo_manager.md#krpc) + +#### Defined in + +[src/mapeo-manager.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L61) diff --git a/docs/api/modules/mapeo_project.md b/docs/api/modules/mapeo_project.md new file mode 100644 index 000000000..e0bbe044d --- /dev/null +++ b/docs/api/modules/mapeo_project.md @@ -0,0 +1,103 @@ +[API](../README.md) / mapeo-project + +# Module: mapeo-project + +## Table of contents + +### Classes + +- [MapeoProject](../classes/mapeo_project.MapeoProject.md) + +### Type Aliases + +- [EditableProjectSettings](mapeo_project.md#editableprojectsettings) + +### Variables + +- [kBlobStore](mapeo_project.md#kblobstore) +- [kCoreManager](mapeo_project.md#kcoremanager) +- [kCoreOwnership](mapeo_project.md#kcoreownership) +- [kDataTypes](mapeo_project.md#kdatatypes) +- [kProjectLeave](mapeo_project.md#kprojectleave) +- [kProjectReplicate](mapeo_project.md#kprojectreplicate) +- [kSetOwnDeviceInfo](mapeo_project.md#ksetowndeviceinfo) + +## Type Aliases + +### EditableProjectSettings + +Ƭ **EditableProjectSettings**\<\>: `Omit`\<`ProjectSettingsValue`, ``"schemaName"``\> + +#### Defined in + +[src/mapeo-project.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L51) + +## Variables + +### kBlobStore + +• `Const` **kBlobStore**: typeof [`kBlobStore`](mapeo_project.md#kblobstore) + +#### Defined in + +[src/mapeo-project.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L58) + +___ + +### kCoreManager + +• `Const` **kCoreManager**: typeof [`kCoreManager`](mapeo_project.md#kcoremanager) + +#### Defined in + +[src/mapeo-project.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L55) + +___ + +### kCoreOwnership + +• `Const` **kCoreOwnership**: typeof [`kCoreOwnership`](mapeo_project.md#kcoreownership) + +#### Defined in + +[src/mapeo-project.js:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L56) + +___ + +### kDataTypes + +• `Const` **kDataTypes**: typeof [`kDataTypes`](mapeo_project.md#kdatatypes) + +#### Defined in + +[src/mapeo-project.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L60) + +___ + +### kProjectLeave + +• `Const` **kProjectLeave**: typeof [`kProjectLeave`](mapeo_project.md#kprojectleave) + +#### Defined in + +[src/mapeo-project.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L61) + +___ + +### kProjectReplicate + +• `Const` **kProjectReplicate**: typeof [`kProjectReplicate`](mapeo_project.md#kprojectreplicate) + +#### Defined in + +[src/mapeo-project.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L59) + +___ + +### kSetOwnDeviceInfo + +• `Const` **kSetOwnDeviceInfo**: typeof [`kSetOwnDeviceInfo`](mapeo_project.md#ksetowndeviceinfo) + +#### Defined in + +[src/mapeo-project.js:57](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L57) diff --git a/docs/api/modules/member_api.md b/docs/api/modules/member_api.md new file mode 100644 index 000000000..72eab4060 --- /dev/null +++ b/docs/api/modules/member_api.md @@ -0,0 +1,74 @@ +[API](../README.md) / member-api + +# Module: member-api + +## Table of contents + +### References + +- [Invite](member_api.md#invite) + +### Classes + +- [MemberApi](../classes/member_api.MemberApi.md) + +### Interfaces + +- [InviteResponse](../interfaces/member_api.InviteResponse.md) +- [MemberInfo](../interfaces/member_api.MemberInfo.md) + +### Type Aliases + +- [DeviceInfoDataType](member_api.md#deviceinfodatatype) +- [ProjectDataType](member_api.md#projectdatatype) + +### Variables + +- [InviteResponse](member_api.md#inviteresponse) + +## References + +### Invite + +Renames and re-exports [InviteRpcMessage](invite_api.md#inviterpcmessage) + +## Type Aliases + +### DeviceInfoDataType + +Ƭ **DeviceInfoDataType**\<\>: [`datatype`](datatype-1.md) + +#### Defined in + +[src/member-api.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L25) + +___ + +### ProjectDataType + +Ƭ **ProjectDataType**\<\>: [`datatype`](datatype-1.md) + +#### Defined in + +[src/member-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L26) + +## Variables + +### InviteResponse + +• **InviteResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `create` | \(`base?`: `I`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | +| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | +| `encode` | (`message`: [`InviteResponse`](../interfaces/member_api.InviteResponse.md), `writer`: `Writer`) => `Writer` | +| `fromPartial` | \(`object`: `I`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | + +#### Defined in + +[src/generated/rpc.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L18) + +[src/generated/rpc.ts:265](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L265) diff --git a/docs/api/modules/roles.md b/docs/api/modules/roles.md new file mode 100644 index 000000000..c48922c82 --- /dev/null +++ b/docs/api/modules/roles.md @@ -0,0 +1,247 @@ +[API](../README.md) / roles + +# Module: roles + +## Table of contents + +### Classes + +- [Roles](../classes/roles.Roles.md) + +### Interfaces + +- [DocCapability](../interfaces/roles.DocCapability.md) +- [Role](../interfaces/roles.Role.md) + +### Type Aliases + +- [ElementOf](roles.md#elementof) +- [RoleId](roles.md#roleid) +- [RoleIdAssignableToAnyone](roles.md#roleidassignabletoanyone) +- [RoleIdAssignableToOthers](roles.md#roleidassignabletoothers) +- [RoleIdForNewInvite](roles.md#roleidfornewinvite) + +### Variables + +- [BLOCKED\_ROLE\_ID](roles.md#blocked_role_id) +- [COORDINATOR\_ROLE\_ID](roles.md#coordinator_role_id) +- [CREATOR\_ROLE](roles.md#creator_role) +- [CREATOR\_ROLE\_ID](roles.md#creator_role_id) +- [LEFT\_ROLE\_ID](roles.md#left_role_id) +- [MEMBER\_ROLE\_ID](roles.md#member_role_id) +- [NO\_ROLE](roles.md#no_role) +- [NO\_ROLE\_ID](roles.md#no_role_id) +- [ROLES](roles.md#roles) + +### Functions + +- [isRoleIdAssignableToOthers](roles.md#isroleidassignabletoothers) +- [isRoleIdForNewInvite](roles.md#isroleidfornewinvite) + +## Type Aliases + +### ElementOf + +Ƭ **ElementOf**\<`T`\>: `T` extends `Iterable`\ ? `U` : `never` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/roles.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L15) + +___ + +### RoleId + +Ƭ **RoleId**\<\>: [`ElementOf`](roles.md#elementof)\ + +#### Defined in + +[src/roles.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L19) + +___ + +### RoleIdAssignableToAnyone + +Ƭ **RoleIdAssignableToAnyone**\<\>: [`ElementOf`](roles.md#elementof)\ + +#### Defined in + +[src/roles.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L44) + +___ + +### RoleIdAssignableToOthers + +Ƭ **RoleIdAssignableToOthers**\<\>: [`ElementOf`](roles.md#elementof)\ + +#### Defined in + +[src/roles.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L38) + +___ + +### RoleIdForNewInvite + +Ƭ **RoleIdForNewInvite**\<\>: [`ElementOf`](roles.md#elementof)\ + +#### Defined in + +[src/roles.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L32) + +## Variables + +### BLOCKED\_ROLE\_ID + +• `Const` **BLOCKED\_ROLE\_ID**: ``"9e6d29263cba36c9"`` + +#### Defined in + +[src/roles.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L10) + +___ + +### COORDINATOR\_ROLE\_ID + +• `Const` **COORDINATOR\_ROLE\_ID**: ``"f7c150f5a3a9a855"`` + +#### Defined in + +[src/roles.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L8) + +___ + +### CREATOR\_ROLE + +• `Const` **CREATOR\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"``\> + +This is currently the same as 'Coordinator' role, but defined separately +because the creator should always have ALL powers, but we could edit the +'Coordinator' powers in the future. + +#### Defined in + +[src/roles.js:80](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L80) + +___ + +### CREATOR\_ROLE\_ID + +• `Const` **CREATOR\_ROLE\_ID**: ``"a12a6702b93bd7ff"`` + +#### Defined in + +[src/roles.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L7) + +___ + +### LEFT\_ROLE\_ID + +• `Const` **LEFT\_ROLE\_ID**: ``"8ced989b1904606b"`` + +#### Defined in + +[src/roles.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L11) + +___ + +### MEMBER\_ROLE\_ID + +• `Const` **MEMBER\_ROLE\_ID**: ``"012fd2d431c0bf60"`` + +#### Defined in + +[src/roles.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L9) + +___ + +### NO\_ROLE + +• `Const` **NO\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> + +This is the role assumed for a device when no role record can be found. This +can happen when an invited device did not manage to sync with the device that +invited them, and they then try to sync with someone else. We want them to be +able to sync the auth and config store, because that way they may be able to +receive their role record, and they can get the project config so that they +can start collecting data. + +#### Defined in + +[src/roles.js:109](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L109) + +___ + +### NO\_ROLE\_ID + +• `Const` **NO\_ROLE\_ID**: ``"08e4251e36f6e7ed"`` + +#### Defined in + +[src/roles.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L12) + +___ + +### ROLES + +• `Const` **ROLES**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `012fd2d431c0bf60` | [`Role`](../interfaces/roles.Role.md)\<``"012fd2d431c0bf60"``\> | +| `08e4251e36f6e7ed` | [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> | +| `8ced989b1904606b` | [`Role`](../interfaces/roles.Role.md)\<``"8ced989b1904606b"``\> | +| `9e6d29263cba36c9` | [`Role`](../interfaces/roles.Role.md)\<``"9e6d29263cba36c9"``\> | +| `a12a6702b93bd7ff` | [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"``\> | +| `f7c150f5a3a9a855` | [`Role`](../interfaces/roles.Role.md)\<``"f7c150f5a3a9a855"``\> | + +#### Defined in + +[src/roles.js:129](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L129) + +## Functions + +### isRoleIdAssignableToOthers + +▸ **isRoleIdAssignableToOthers**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Returns + +value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Defined in + +[src/roles.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L42) + +___ + +### isRoleIdForNewInvite + +▸ **isRoleIdForNewInvite**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Returns + +value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Defined in + +[src/roles.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L36) diff --git a/docs/api/modules/schema_client.md b/docs/api/modules/schema_client.md new file mode 100644 index 000000000..fad688594 --- /dev/null +++ b/docs/api/modules/schema_client.md @@ -0,0 +1,70 @@ +[API](../README.md) / schema/client + +# Module: schema/client + +## Table of contents + +### Interfaces + +- [ProjectInfo](../interfaces/schema_client.ProjectInfo.md) + +### Type Aliases + +- [DeviceInfoParam](schema_client.md#deviceinfoparam) + +### Variables + +- [localDeviceInfoTable](schema_client.md#localdeviceinfotable) +- [projectBacklinkTable](schema_client.md#projectbacklinktable) +- [projectKeysTable](schema_client.md#projectkeystable) +- [projectSettingsTable](schema_client.md#projectsettingstable) + +## Type Aliases + +### DeviceInfoParam + +Ƭ **DeviceInfoParam**\<\>: `Omit`\<`DeviceInfoValue`, ``"schemaName"``\> + +#### Defined in + +[src/schema/client.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L42) + +## Variables + +### localDeviceInfoTable + +• `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L51) + +___ + +### projectBacklinkTable + +• `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L27) + +___ + +### projectKeysTable + +• `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L28) + +___ + +### projectSettingsTable + +• `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L23) diff --git a/docs/api/modules/schema_project.md b/docs/api/modules/schema_project.md new file mode 100644 index 000000000..192bd8044 --- /dev/null +++ b/docs/api/modules/schema_project.md @@ -0,0 +1,217 @@ +[API](../README.md) / schema/project + +# Module: schema/project + +## Table of contents + +### Variables + +- [coreOwnershipBacklinkTable](schema_project.md#coreownershipbacklinktable) +- [coreOwnershipTable](schema_project.md#coreownershiptable) +- [coresTable](schema_project.md#corestable) +- [deviceInfoBacklinkTable](schema_project.md#deviceinfobacklinktable) +- [deviceInfoTable](schema_project.md#deviceinfotable) +- [fieldBacklinkTable](schema_project.md#fieldbacklinktable) +- [fieldTable](schema_project.md#fieldtable) +- [iconBacklinkTable](schema_project.md#iconbacklinktable) +- [iconTable](schema_project.md#icontable) +- [observationBacklinkTable](schema_project.md#observationbacklinktable) +- [observationTable](schema_project.md#observationtable) +- [presetBacklinkTable](schema_project.md#presetbacklinktable) +- [presetTable](schema_project.md#presettable) +- [roleBacklinkTable](schema_project.md#rolebacklinktable) +- [roleTable](schema_project.md#roletable) +- [trackBacklinkTable](schema_project.md#trackbacklinktable) +- [trackTable](schema_project.md#tracktable) +- [translationBacklinkTable](schema_project.md#translationbacklinktable) +- [translationTable](schema_project.md#translationtable) + +## Variables + +### coreOwnershipBacklinkTable + +• `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L36) + +___ + +### coreOwnershipTable + +• `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L20) + +___ + +### coresTable + +• `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L41) + +___ + +### deviceInfoBacklinkTable + +• `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L38) + +___ + +### deviceInfoTable + +• `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L25) + +___ + +### fieldBacklinkTable + +• `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L35) + +___ + +### fieldTable + +• `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L19) + +___ + +### iconBacklinkTable + +• `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L39) + +___ + +### iconTable + +• `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L29) + +___ + +### observationBacklinkTable + +• `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L32) + +___ + +### observationTable + +• `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L13) + +___ + +### presetBacklinkTable + +• `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L34) + +___ + +### presetTable + +• `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L18) + +___ + +### roleBacklinkTable + +• `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L37) + +___ + +### roleTable + +• `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L24) + +___ + +### trackBacklinkTable + +• `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L33) + +___ + +### trackTable + +• `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L17) + +___ + +### translationBacklinkTable + +• `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L31) + +___ + +### translationTable + +• `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L9) diff --git a/docs/api/modules/schema_schema_to_drizzle.md b/docs/api/modules/schema_schema_to_drizzle.md new file mode 100644 index 000000000..ff724f3ac --- /dev/null +++ b/docs/api/modules/schema_schema_to_drizzle.md @@ -0,0 +1,54 @@ +[API](../README.md) / schema/schema-to-drizzle + +# Module: schema/schema-to-drizzle + +## Table of contents + +### References + +- [MapeoDocMap](schema_schema_to_drizzle.md#mapeodocmap) + +### Functions + +- [jsonSchemaToDrizzleColumns](schema_schema_to_drizzle.md#jsonschematodrizzlecolumns) + +## References + +### MapeoDocMap + +Re-exports [MapeoDocMap](datatype.md#mapeodocmap) + +## Functions + +### jsonSchemaToDrizzleColumns + +▸ **jsonSchemaToDrizzleColumns**\<`TSchema`, `TSchemaName`, `TObjectType`\>(`schema`): [`SchemaToDrizzleColumns`](schema_types.md#schematodrizzlecolumns)\<`TSchema`, `TObjectType`, `TSchema`[``"properties"``]\> + +Convert a JSONSchema definition to a Drizzle Columns Map (the parameter for +`sqliteTable()`). + +**NOTE**: The return of this function is _not_ type-checked (it is coerced with +`as`, because it's not possible to type-check what this function is doing), but +the return type _should_ be correct when using this function. + +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `TSchema` | extends [`JSONSchema7WithProps`](schema_types.md#jsonschema7withprops) | NB: The inline typescript checker often marks this next line as an error, but this seems to be a bug with JSDoc parsing - running `tsc` does not show this as an error. | +| `TSchemaName` | extends `undefined` \| ``null`` \| `string` \| `number` \| `boolean` \| readonly (``null`` \| `string` \| `number` \| `boolean` \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| any \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| `ReadonlyObjectDeep`\<`JSONSchema7Object`\>)[] \| `ReadonlyObjectDeep`\<`JSONSchema7Object`\> | | +| `TObjectType` | extends `any` | | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `schema` | `TSchema` | + +#### Returns + +[`SchemaToDrizzleColumns`](schema_types.md#schematodrizzlecolumns)\<`TSchema`, `TObjectType`, `TSchema`[``"properties"``]\> + +#### Defined in + +[src/schema/schema-to-drizzle.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/schema-to-drizzle.js#L26) diff --git a/docs/api/modules/schema_types.md b/docs/api/modules/schema_types.md new file mode 100644 index 000000000..6931a921f --- /dev/null +++ b/docs/api/modules/schema_types.md @@ -0,0 +1,92 @@ +[API](../README.md) / schema/types + +# Module: schema/types + +## Table of contents + +### Type Aliases + +- [JSONSchema7](schema_types.md#jsonschema7) +- [JSONSchema7WithProps](schema_types.md#jsonschema7withprops) +- [NonEmptyArray](schema_types.md#nonemptyarray) +- [OptionalToNull](schema_types.md#optionaltonull) +- [SchemaToDrizzleColumns](schema_types.md#schematodrizzlecolumns) + +## Type Aliases + +### JSONSchema7 + +Ƭ **JSONSchema7**: `ReadonlyDeep`\<`JSONSchema7Writable`\> + +#### Defined in + +[src/schema/types.ts:95](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L95) + +___ + +### JSONSchema7WithProps + +Ƭ **JSONSchema7WithProps**: `Omit`\<[`JSONSchema7`](schema_types.md#jsonschema7), ``"properties"``\> & \{ `properties`: `JsonSchema7Properties` } + +#### Defined in + +[src/schema/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L97) + +___ + +### NonEmptyArray + +Ƭ **NonEmptyArray**\<`T`\>: [`T`, ...T[]] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/schema/types.ts:153](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L153) + +___ + +### OptionalToNull + +Ƭ **OptionalToNull**\<`T`\>: \{ [K in keyof T]-?: undefined extends T[K] ? T[K] \| null : T[K] } + +Convert optional properties to nullable + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Object` | + +#### Defined in + +[src/schema/types.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L8) + +___ + +### SchemaToDrizzleColumns + +Ƭ **SchemaToDrizzleColumns**\<`T`, `TObjectType`, `U`\>: \{ [K in keyof U]: K extends string ? U[K]["type"] extends "string" ? TextBuilder\, IsRequired\, HasDefault\\> : U[K]["type"] extends "boolean" ? BooleanBuilder\, HasDefault\\> : U[K]["type"] extends "number" ? RealBuilder\, HasDefault\\> : U[K]["type"] extends "integer" ? IntegerBuilder\, HasDefault\\> : U[K]["type"] extends "array" \| "object" ? JsonBuilder\, HasDefault\<(...)[(...)]\>\> : never : never } & \{ `forks`: `JsonBuilder`\<``"forks"``, `string`[], ``true``, ``false``\> } + +Convert a JSONSchema to a Drizzle Columns map (e.g. parameter for +`sqliteTable()`). All top-level properties map to SQLite columns, with +`required` properties marked as `NOT NULL`, and JSONSchema `default` will map +to SQLite defaults. Any properties that are of type `object` or `array` in +the JSONSchema will be mapped to a text field, which drizzle will parse and +stringify. Types for parsed JSON will be derived from MapeoDoc types. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`JSONSchema7WithProps`](schema_types.md#jsonschema7withprops) | +| `TObjectType` | extends \{ [K in keyof U]?: any } | +| `U` | extends `JsonSchema7Properties` = `T`[``"properties"``] | + +#### Defined in + +[src/schema/types.ts:133](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L133) diff --git a/docs/api/modules/schema_utils.md b/docs/api/modules/schema_utils.md new file mode 100644 index 000000000..fe04e6cb8 --- /dev/null +++ b/docs/api/modules/schema_utils.md @@ -0,0 +1,117 @@ +[API](../README.md) / schema/utils + +# Module: schema/utils + +## Table of contents + +### Type Aliases + +- [SqliteTable](schema_utils.md#sqlitetable) + +### Variables + +- [BACKLINK\_TABLE\_POSTFIX](schema_utils.md#backlink_table_postfix) + +### Functions + +- [backlinkTable](schema_utils.md#backlinktable) +- [customJson](schema_utils.md#customjson) +- [getBacklinkTableName](schema_utils.md#getbacklinktablename) + +## Type Aliases + +### SqliteTable + +Ƭ **SqliteTable**\<`TName`\>: `SQLiteTableWithColumns` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TName` | extends `string` = `string` | + +#### Defined in + +[src/schema/utils.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L15) + +## Variables + +### BACKLINK\_TABLE\_POSTFIX + +• `Const` **BACKLINK\_TABLE\_POSTFIX**: ``"_backlink"`` + +**`Template`** + +#### Defined in + +[src/schema/utils.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L18) + +## Functions + +### backlinkTable + +▸ **backlinkTable**(`tableSchema`): `SQLiteTableWithColumns`\<{}\> + +Table for storing backlinks, used for indexing. There needs to be one for +each indexed document type + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tableSchema` | [`SqliteTable`](schema_utils.md#sqlitetable)\<`string`\> | + +#### Returns + +`SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/utils.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L25) + +___ + +### customJson + +▸ **customJson**\<`TName`\>(`dbName`, `fieldConfig?`): `SQLiteCustomColumnBuilder`\<{}\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TName` | extends `string` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbName` | `TName` | +| `fieldConfig?` | `unknown` | + +#### Returns + +`SQLiteCustomColumnBuilder`\<{}\> + +#### Defined in + +[src/schema/utils.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L39) + +___ + +### getBacklinkTableName + +▸ **getBacklinkTableName**(`tableName`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tableName` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/schema/utils.js:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L35) diff --git a/docs/api/modules/sync_core_sync_state.md b/docs/api/modules/sync_core_sync_state.md new file mode 100644 index 000000000..92faf6a40 --- /dev/null +++ b/docs/api/modules/sync_core_sync_state.md @@ -0,0 +1,78 @@ +[API](../README.md) / sync/core-sync-state + +# Module: sync/core-sync-state + +## Table of contents + +### Classes + +- [CoreSyncState](../classes/sync_core_sync_state.CoreSyncState.md) + +### Interfaces + +- [CoreState](../interfaces/sync_core_sync_state.CoreState.md) +- [DerivedState](../interfaces/sync_core_sync_state.DerivedState.md) +- [InternalState](../interfaces/sync_core_sync_state.InternalState.md) + +### Type Aliases + +- [Bitfield](sync_core_sync_state.md#bitfield) +- [PeerCoreState](sync_core_sync_state.md#peercorestate) +- [PeerId](sync_core_sync_state.md#peerid) + +### Functions + +- [bitCount32](sync_core_sync_state.md#bitcount32) + +## Type Aliases + +### Bitfield + +Ƭ **Bitfield**\<\>: [`default`](../classes/core_manager_remote_bitfield.default.md) + +#### Defined in + +[src/sync/core-sync-state.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L7) + +___ + +### PeerCoreState + +Ƭ **PeerCoreState**\<\>: [`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) & \{ `status`: ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` } + +#### Defined in + +[src/sync/core-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L28) + +___ + +### PeerId + +Ƭ **PeerId**\<\>: `string` + +#### Defined in + +[src/sync/core-sync-state.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L10) + +## Functions + +### bitCount32 + +▸ **bitCount32**(`n`): `number` + +Apologies for the obscure code. From +https://stackoverflow.com/a/109025/903300 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/sync/core-sync-state.js:431](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L431) diff --git a/docs/api/modules/sync_namespace_sync_state.md b/docs/api/modules/sync_namespace_sync_state.md new file mode 100644 index 000000000..4b474ede1 --- /dev/null +++ b/docs/api/modules/sync_namespace_sync_state.md @@ -0,0 +1,57 @@ +[API](../README.md) / sync/namespace-sync-state + +# Module: sync/namespace-sync-state + +## Table of contents + +### Classes + +- [NamespaceSyncState](../classes/sync_namespace_sync_state.NamespaceSyncState.md) + +### Type Aliases + +- [SyncState](sync_namespace_sync_state.md#syncstate) + +### Functions + +- [createState](sync_namespace_sync_state.md#createstate) + +## Type Aliases + +### SyncState + +Ƭ **SyncState**\<\>: `Omit`\<[`sync/core-sync-state`](sync_core_sync_state.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } + +#### Defined in + +[src/sync/namespace-sync-state.js:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L5) + +## Functions + +### createState + +▸ **createState**(): [`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) + +#### Returns + +[`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) + +#### Defined in + +[src/sync/namespace-sync-state.js:136](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L136) + +▸ **createState**(`status`): [`PeerCoreState`](sync_core_sync_state.md#peercorestate) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `status` | ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` | + +#### Returns + +[`PeerCoreState`](sync_core_sync_state.md#peercorestate) + +#### Defined in + +[src/sync/namespace-sync-state.js:141](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L141) diff --git a/docs/api/modules/sync_peer_sync_controller.md b/docs/api/modules/sync_peer_sync_controller.md new file mode 100644 index 000000000..c63c60535 --- /dev/null +++ b/docs/api/modules/sync_peer_sync_controller.md @@ -0,0 +1,80 @@ +[API](../README.md) / sync/peer-sync-controller + +# Module: sync/peer-sync-controller + +## Table of contents + +### References + +- [Namespace](sync_peer_sync_controller.md#namespace) + +### Classes + +- [PeerSyncController](../classes/sync_peer_sync_controller.PeerSyncController.md) + +### Type Aliases + +- [PeerState](sync_peer_sync_controller.md#peerstate) +- [SyncCapability](sync_peer_sync_controller.md#synccapability) +- [SyncStatus](sync_peer_sync_controller.md#syncstatus) + +### Variables + +- [DATA\_NAMESPACES](sync_peer_sync_controller.md#data_namespaces) +- [PRESYNC\_NAMESPACES](sync_peer_sync_controller.md#presync_namespaces) + +## References + +### Namespace + +Re-exports [Namespace](core_manager_core_index.md#namespace) + +## Type Aliases + +### PeerState + +Ƭ **PeerState**\<\>: \{ [namespace in Namespace]?: sync/core-sync-state } + +#### Defined in + +[src/sync/peer-sync-controller.js:280](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L280) + +___ + +### SyncCapability + +Ƭ **SyncCapability**\<\>: [`roles`](roles.md)[``"sync"``][[`Namespace`](sync_peer_sync_controller.md#namespace)] \| ``"unknown"`` + +#### Defined in + +[src/sync/peer-sync-controller.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L10) + +___ + +### SyncStatus + +Ƭ **SyncStatus**\<\>: `Record`\<[`Namespace`](sync_peer_sync_controller.md#namespace), ``"unknown"`` \| ``"syncing"`` \| ``"synced"``\> + +#### Defined in + +[src/sync/peer-sync-controller.js:283](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L283) + +## Variables + +### DATA\_NAMESPACES + +• `Const` **DATA\_NAMESPACES**: (``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``)[] + +#### Defined in + +[src/sync/peer-sync-controller.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L15) + +___ + +### PRESYNC\_NAMESPACES + +• `Const` **PRESYNC\_NAMESPACES**: (``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``)[] + +#### Defined in + +[src/sync/peer-sync-controller.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L14) diff --git a/docs/api/modules/sync_sync_api.md b/docs/api/modules/sync_sync_api.md new file mode 100644 index 000000000..74ac0d5da --- /dev/null +++ b/docs/api/modules/sync_sync_api.md @@ -0,0 +1,54 @@ +[API](../README.md) / sync/sync-api + +# Module: sync/sync-api + +## Table of contents + +### Classes + +- [SyncApi](../classes/sync_sync_api.SyncApi.md) + +### Interfaces + +- [State](../interfaces/sync_sync_api.State.md) +- [SyncEvents](../interfaces/sync_sync_api.SyncEvents.md) +- [SyncTypeState](../interfaces/sync_sync_api.SyncTypeState.md) + +### Type Aliases + +- [SyncType](sync_sync_api.md#synctype) + +### Variables + +- [kHandleDiscoveryKey](sync_sync_api.md#khandlediscoverykey) +- [kSyncState](sync_sync_api.md#ksyncstate) + +## Type Aliases + +### SyncType + +Ƭ **SyncType**\<\>: ``"initial"`` \| ``"full"`` + +#### Defined in + +[src/sync/sync-api.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L16) + +## Variables + +### kHandleDiscoveryKey + +• `Const` **kHandleDiscoveryKey**: typeof [`kHandleDiscoveryKey`](sync_sync_api.md#khandlediscoverykey) + +#### Defined in + +[src/sync/sync-api.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L12) + +___ + +### kSyncState + +• `Const` **kSyncState**: typeof [`kSyncState`](sync_sync_api.md#ksyncstate) + +#### Defined in + +[src/sync/sync-api.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L13) diff --git a/docs/api/modules/sync_sync_state.md b/docs/api/modules/sync_sync_state.md new file mode 100644 index 000000000..9da2e2f60 --- /dev/null +++ b/docs/api/modules/sync_sync_state.md @@ -0,0 +1,23 @@ +[API](../README.md) / sync/sync-state + +# Module: sync/sync-state + +## Table of contents + +### Classes + +- [SyncState](../classes/sync_sync_state.SyncState.md) + +### Type Aliases + +- [State](sync_sync_state.md#state) + +## Type Aliases + +### State + +Ƭ **State**\<\>: `Record`\<[`core-manager`](core_manager.md), [`sync/namespace-sync-state`](sync_namespace_sync_state.md)\> + +#### Defined in + +[src/sync/sync-state.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L12) diff --git a/docs/api/modules/types.md b/docs/api/modules/types.md new file mode 100644 index 000000000..9144a0f4d --- /dev/null +++ b/docs/api/modules/types.md @@ -0,0 +1,241 @@ +[API](../README.md) / types + +# Module: types + +## Table of contents + +### References + +- [BlobId](types.md#blobid) +- [BlobType](types.md#blobtype) +- [CoreOwnershipWithSignatures](types.md#coreownershipwithsignatures) +- [MapeoDocMap](types.md#mapeodocmap) +- [MapeoValueMap](types.md#mapeovaluemap) + +### Type Aliases + +- [BlobFilter](types.md#blobfilter) +- [BlobVariant](types.md#blobvariant) +- [CoreOwnershipWithSignaturesValue](types.md#coreownershipwithsignaturesvalue) +- [CoreStorage](types.md#corestorage) +- [DefaultEmitterEvents](types.md#defaultemitterevents) +- [IdentityKeyPair](types.md#identitykeypair) +- [KeyPair](types.md#keypair) +- [MapBuffers](types.md#mapbuffers) +- [NullableToOptional](types.md#nullabletooptional) +- [PublicKey](types.md#publickey) +- [ReplicationStream](types.md#replicationstream) +- [SecretKey](types.md#secretkey) + +## References + +### BlobId + +Re-exports [BlobId](blob_api.md#blobid) + +___ + +### BlobType + +Re-exports [BlobType](blob_api.md#blobtype) + +___ + +### CoreOwnershipWithSignatures + +Re-exports [CoreOwnershipWithSignatures](core_ownership.md#coreownershipwithsignatures) + +___ + +### MapeoDocMap + +Re-exports [MapeoDocMap](datatype.md#mapeodocmap) + +___ + +### MapeoValueMap + +Re-exports [MapeoValueMap](datatype.md#mapeovaluemap) + +## Type Aliases + +### BlobFilter + +Ƭ **BlobFilter**: `RequireAtLeastOne`\<\{ [KeyType in BlobType]: ArrayAtLeastOne\\> }\> + +#### Defined in + +[src/types.ts:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L42) + +___ + +### BlobVariant + +Ƭ **BlobVariant**\<`TBlobType`\>: `TupleToUnion`\<`SupportedBlobVariants`[`TBlobType`]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TBlobType` | extends [`BlobType`](blob_api.md#blobtype) | + +#### Defined in + +[src/types.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L18) + +___ + +### CoreOwnershipWithSignaturesValue + +Ƭ **CoreOwnershipWithSignaturesValue**: `Omit`\<[`CoreOwnershipWithSignatures`](core_ownership.md#coreownershipwithsignatures), `Exclude`\\> + +#### Defined in + +[src/types.ts:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L59) + +___ + +### CoreStorage + +Ƭ **CoreStorage**: (`name`: `string`) => `RandomAccessStorage` + +#### Type declaration + +▸ (`name`): `RandomAccessStorage` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +##### Returns + +`RandomAccessStorage` + +#### Defined in + +[src/types.ts:114](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L114) + +___ + +### DefaultEmitterEvents + +Ƭ **DefaultEmitterEvents**\<`L`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `L` | extends `ListenerSignature`\<`L`\> = `DefaultListener` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `newListener` | (`event`: keyof `L`, `listener`: `L`[keyof `L`]) => `void` | +| `removeListener` | (`event`: keyof `L`, `listener`: `L`[keyof `L`]) => `void` | + +#### Defined in + +[src/types.ts:116](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L116) + +___ + +### IdentityKeyPair + +Ƭ **IdentityKeyPair**: [`KeyPair`](types.md#keypair) + +#### Defined in + +[src/types.ts:106](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L106) + +___ + +### KeyPair + +Ƭ **KeyPair**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `publicKey` | [`PublicKey`](types.md#publickey) | +| `secretKey` | [`SecretKey`](types.md#secretkey) | + +#### Defined in + +[src/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L97) + +___ + +### MapBuffers + +Ƭ **MapBuffers**\<`T`\>: \{ [K in keyof T]: T[K] extends Buffer ? string : T[K] } + +Replace an object's `Buffer` values with `string`s. Useful for serialization. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types.ts:86](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L86) + +___ + +### NullableToOptional + +Ƭ **NullableToOptional**\<`T`\>: `Simplify`\<`RemoveNull`\<`NullToOptional`\<`T`\>\>\> + +Make any properties whose value include `null` optional, and remove `null` +from the type. This converts the types returned from SQLite (which have all +top-level optional props set to `null`) to the original types in +@mapeo/schema + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types.ts:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L96) + +___ + +### PublicKey + +Ƭ **PublicKey**: `Buffer` + +32 byte buffer + +#### Defined in + +[src/types.ts:103](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L103) + +___ + +### ReplicationStream + +Ƭ **ReplicationStream**: `Duplex` & \{ `noiseStream`: `ProtocolStream` } + +#### Defined in + +[src/types.ts:112](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L112) + +___ + +### SecretKey + +Ƭ **SecretKey**: `Buffer` + +32 byte buffer + +#### Defined in + +[src/types.ts:105](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L105) diff --git a/docs/api/modules/utils.md b/docs/api/modules/utils.md new file mode 100644 index 000000000..403b20801 --- /dev/null +++ b/docs/api/modules/utils.md @@ -0,0 +1,416 @@ +[API](../README.md) / utils + +# Module: utils + +## Table of contents + +### Classes + +- [ExhaustivenessError](../classes/utils.ExhaustivenessError.md) + +### Type Aliases + +- [DestroyedNoiseStream](utils.md#destroyednoisestream) +- [NoiseStream](utils.md#noisestream) +- [OpenedNoiseStream](utils.md#openednoisestream) + +### Functions + +- [assert](utils.md#assert) +- [createMap](utils.md#createmap) +- [deNullify](utils.md#denullify) +- [getDeviceId](utils.md#getdeviceid) +- [idToKey](utils.md#idtokey) +- [keyToId](utils.md#keytoid) +- [noop](utils.md#noop) +- [openedNoiseSecretStream](utils.md#openednoisesecretstream) +- [parseVersion](utils.md#parseversion) +- [projectIdToNonce](utils.md#projectidtononce) +- [projectKeyToId](utils.md#projectkeytoid) +- [projectKeyToPublicId](utils.md#projectkeytopublicid) +- [setHas](utils.md#sethas) +- [valueOf](utils.md#valueof) + +## Type Aliases + +### DestroyedNoiseStream + +Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](utils.md#noisestream) & \{ `destroyed`: ``true`` } + +#### Defined in + +[src/utils.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L42) + +___ + +### NoiseStream + +Ƭ **NoiseStream**\<\>: `__module` + +#### Defined in + +[src/utils.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L41) + +___ + +### OpenedNoiseStream + +Ƭ **OpenedNoiseStream**\<`T`\>: `__module` & \{ `handshake`: `Buffer` ; `publicKey`: `Buffer` ; `remotePublicKey`: `Buffer` } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Duplex` \| `Duplex` = `Duplex` \| `Duplex` | + +#### Defined in + +[src/utils.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L45) + +## Functions + +### assert + +▸ **assert**(`condition`, `message`): asserts condition + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `condition` | `unknown` | +| `message` | `string` | + +#### Returns + +asserts condition + +#### Defined in + +[src/utils.js:79](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L79) + +___ + +### createMap + +▸ **createMap**\<`K`, `V`\>(`keys`, `value`): `Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> + +Small helper to create a typed map + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends `string` | +| `V` | extends `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `keys` | readonly `K`[] | +| `value` | `V` | + +#### Returns + +`Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> + +#### Defined in + +[src/utils.js:187](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L187) + +___ + +### deNullify + +▸ **deNullify**\<`T`\>(`obj`): \{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } + +When reading from SQLite, any optional properties are set to `null`. This +converts `null` back to `undefined` to match the input types (e.g. the types +defined in @mapeo/schema) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Object` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `T` | + +#### Returns + +\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } + +#### Defined in + +[src/utils.js:114](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L114) + +___ + +### getDeviceId + +▸ **getDeviceId**(`keyManager`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `keyManager` | `KeyManager` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L175) + +___ + +### idToKey + +▸ **idToKey**(`id`): `Buffer` \| `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` \| `Buffer` | + +#### Returns + +`Buffer` \| `Uint8Array` + +#### Defined in + +[src/utils.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L8) + +___ + +### keyToId + +▸ **keyToId**(`key`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L21) + +___ + +### noop + +▸ **noop**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/utils.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L72) + +___ + +### openedNoiseSecretStream + +▸ **openedNoiseSecretStream**(`stream`): `Promise`\<[`DestroyedNoiseStream`](utils.md#destroyednoisestream) \| [`OpenedNoiseStream`](utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> + +Utility to await a NoiseSecretStream to open, that returns a stream with the +correct types for publicKey and remotePublicKey (which can be null before +stream is opened) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | `NoiseSecretStream`\<`any`\> | + +#### Returns + +`Promise`\<[`DestroyedNoiseStream`](utils.md#destroyednoisestream) \| [`OpenedNoiseStream`](utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> + +#### Defined in + +[src/utils.js:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L56) + +___ + +### parseVersion + +▸ **parseVersion**(`version`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `version` | `string` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `blockIndex` | `number` | +| `coreId` | `string` | + +#### Defined in + +[src/utils.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L33) + +___ + +### projectIdToNonce + +▸ **projectIdToNonce**(`projectId`): `Buffer` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `projectId` | `string` | Project internal ID | + +#### Returns + +`Buffer` + +24-byte nonce (same length as sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES) + +#### Defined in + +[src/utils.js:167](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L167) + +___ + +### projectKeyToId + +▸ **projectKeyToId**(`projectKey`): `string` + +Create an internal ID from a project key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectKey` | `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:150](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L150) + +___ + +### projectKeyToPublicId + +▸ **projectKeyToPublicId**(`projectKey`): `string` + +Create a public ID from a project key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectKey` | `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:159](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L159) + +___ + +### setHas + +▸ **setHas**\<`T`\>(`set`): (`value`: `unknown`) => value is T + +Return a function that itself returns whether a value is part of the set. + +Similar to binding `Set.prototype.has`, but (1) is shorter (2) refines the type. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `set` | `Readonly`\<`Set`\<`T`\>\> | + +#### Returns + +`fn` + +▸ (`value`): value is T + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +##### Returns + +value is T + +**`Example`** + +```ts +const mySet = new Set([1, 2, 3]) +const isInMySet = setHas(mySet) + +console.log(isInMySet(2)) +// => true +``` + +#### Defined in + +[src/utils.js:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L97) + +___ + +### valueOf + +▸ **valueOf**\<`T`\>(`doc`): `Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `MapeoDoc` & \{ `forks?`: `string`[] } | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | `T` | + +#### Returns + +`Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> + +#### Defined in + +[src/utils.js:128](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L128) diff --git a/docs/api/modules/utils_types.md b/docs/api/modules/utils_types.md new file mode 100644 index 000000000..0adcb7e5e --- /dev/null +++ b/docs/api/modules/utils_types.md @@ -0,0 +1,60 @@ +[API](../README.md) / utils\_types + +# Module: utils\_types + +## Table of contents + +### Type Aliases + +- [TypedEventArgs](utils_types.md#typedeventargs) +- [TypedEvents](utils_types.md#typedevents) +- [TypedEventsFor](utils_types.md#typedeventsfor) + +## Type Aliases + +### TypedEventArgs + +Ƭ **TypedEventArgs**\<`Emitter`, `Event`\>: `Parameters`\<[`TypedEvents`](utils_types.md#typedevents)\<`Emitter`\>[`Event`]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Emitter` | extends `TypedEmitter`\<`any`\> | +| `Event` | extends [`TypedEventsFor`](utils_types.md#typedeventsfor)\<`Emitter`\> | + +#### Defined in + +[src/utils_types.d.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L11) + +___ + +### TypedEvents + +Ƭ **TypedEvents**\<`T`\>: `T` extends `TypedEmitter`\ ? `Result` : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `TypedEmitter`\<`any`\> | + +#### Defined in + +[src/utils_types.d.ts:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L3) + +___ + +### TypedEventsFor + +Ƭ **TypedEventsFor**\<`T`\>: keyof [`TypedEvents`](utils_types.md#typedevents)\<`T`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `TypedEmitter`\<`any`\> | + +#### Defined in + +[src/utils_types.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L9) diff --git a/package-lock.json b/package-lock.json index 7ed3a6b62..fd9d8e1a6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -98,6 +98,7 @@ "tempy": "^3.1.0", "ts-proto": "^1.156.7", "typedoc": "^0.25.13", + "typedoc-plugin-markdown": "^3.17.1", "typescript": "^5.4.5" } }, @@ -8849,8 +8850,9 @@ } }, "node_modules/typedoc-plugin-markdown": { - "version": "3.15.4", - "license": "MIT", + "version": "3.17.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", + "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", "dependencies": { "handlebars": "^4.7.7" }, diff --git a/package.json b/package.json index ddfc10a58..1c9ac1648 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "build:types": "tsc -p tsconfig.npm.json && cpy 'src/**/*.d.ts' dist", "bench": "nanobench benchmarks/*.js", "type": "tsc", - "doc": "typedoc", + "doc": "rimraf docs/api && typedoc --plugin typedoc-plugin-markdown", "protobuf": "node ./scripts/build-messages.js", "db:generate:project": "drizzle-kit generate:sqlite --schema src/schema/project.js --out drizzle/project", "db:generate:client": "drizzle-kit generate:sqlite --schema src/schema/client.js --out drizzle/client", @@ -118,6 +118,7 @@ "tempy": "^3.1.0", "ts-proto": "^1.156.7", "typedoc": "^0.25.13", + "typedoc-plugin-markdown": "^3.17.1", "typescript": "^5.4.5" }, "dependencies": { From 76cf34ae06e32c700cc5fe6bb5bfefc3c52b99e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Thu, 25 Apr 2024 14:48:38 -0300 Subject: [PATCH 03/28] ignore src/generated from doc generation --- docs/api/.nojekyll | 1 - typedoc.json | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) delete mode 100644 docs/api/.nojekyll diff --git a/docs/api/.nojekyll b/docs/api/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/docs/api/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/typedoc.json b/typedoc.json index 99b684530..b96597777 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,6 @@ { "entryPoints": ["src/**/*.js", "src/**/*.ts"], + "exclude": ["src/generated/*"], "out": "docs/api", "cleanOutputDir": false, "readme": "none", From a22b9d84487e089034c6105d1dace6de1620d2ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 15:52:16 -0300 Subject: [PATCH 04/28] add docs ci workflow for publishing --- .github/workflows/docs.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..db5a67541 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +name: Publish documentation +on: + push: + branches: + - main +jobs: + publish-documentation: + permissions: + id-token: write + pages: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + - run: npm ci + - run: npm run doc:publish + - id: upload-documentation + name: Upload Pages artifact + uses: actions/upload-pages-artifact@v2 + with: + path: docs/api/html + - id: deployment + name: Deploy documentation to GitHub Pages + uses: actions/deploy-pages@v2 From 9f99ffbd3e820bc09a15319ffe1f54a437e93df1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 15:53:27 -0300 Subject: [PATCH 05/28] add flow to PR --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index db5a67541..a4e0fd4fe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,6 +3,8 @@ on: push: branches: - main + pull_request: + jobs: publish-documentation: permissions: From faf7ea8d90ab6bfaeaba078ec281994e3e1ca20b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 15:55:18 -0300 Subject: [PATCH 06/28] odd npm doc:publish script --- package.json | 3 ++- typedoc.json | 3 +-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 1ca214b59..842638ece 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,8 @@ "build:types": "tsc -p tsconfig.npm.json && cpy 'src/**/*.d.ts' dist", "bench": "nanobench benchmarks/*.js", "type": "tsc", - "doc": "rimraf docs/api && typedoc --plugin typedoc-plugin-markdown", + "doc": "rimraf docs/api/md && typedoc --plugin typedoc-plugin-markdown --out docs/api/md", + "doc:publish": "rimraf docs/api/html && typedoc --out docs/api/html", "protobuf": "node ./scripts/build-messages.js", "db:generate:project": "drizzle-kit generate:sqlite --schema src/schema/project.js --out drizzle/project", "db:generate:client": "drizzle-kit generate:sqlite --schema src/schema/client.js --out drizzle/client", diff --git a/typedoc.json b/typedoc.json index b96597777..33eb3ba1b 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,6 @@ { - "entryPoints": ["src/**/*.js", "src/**/*.ts"], + "entryPoints": ["src/index.js"], "exclude": ["src/generated/*"], - "out": "docs/api", "cleanOutputDir": false, "readme": "none", "name": "API", From c79c83b33df4b73a05ea642b45b2cccbf249ee03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 16:03:08 -0300 Subject: [PATCH 07/28] remove old docs/api path --- .gitignore | 1 + docs/api/README.md | 62 --- docs/api/classes/blob_api.BlobApi.md | 87 ---- docs/api/classes/blob_store.BlobStore.md | 281 ----------- ...b_store_live_download.DriveLiveDownload.md | 66 --- .../blob_store_live_download.LiveDownload.md | 67 --- docs/api/classes/core_manager.CoreManager.md | 321 ------------- .../core_manager_core_index.CoreIndex.md | 161 ------- ...m_access_file_pool.RandomAccessFilePool.md | 105 ---- .../core_manager_remote_bitfield.default.md | 307 ------------ .../classes/core_ownership.CoreOwnership.md | 84 ---- docs/api/classes/datastore.DataStore.md | 251 ---------- docs/api/classes/datatype-1.DataType.md | 278 ----------- docs/api/classes/datatype.DataType.md | 280 ----------- ...iscovery_local_discovery.LocalDiscovery.md | 160 ------- docs/api/classes/icon_api.IconApi.md | 104 ---- docs/api/classes/index_writer.IndexWriter.md | 92 ---- docs/api/classes/invite_api.InviteApi.md | 129 ----- docs/api/classes/lib_hashmap.default.md | 197 -------- docs/api/classes/local_peers.LocalPeers.md | 198 -------- .../local_peers.PeerDisconnectedError.md | 59 --- .../local_peers.PeerFailedConnectionError.md | 59 --- .../classes/local_peers.UnknownPeerError.md | 59 --- docs/api/classes/logger.Logger.md | 133 ------ .../api/classes/mapeo_project.MapeoProject.md | 449 ------------------ docs/api/classes/member_api.MemberApi.md | 164 ------- docs/api/classes/roles.Roles.md | 125 ----- .../sync_core_sync_state.CoreSyncState.md | 166 ------- ...namespace_sync_state.NamespaceSyncState.md | 104 ---- ...peer_sync_controller.PeerSyncController.md | 145 ------ docs/api/classes/sync_sync_api.SyncApi.md | 156 ------ docs/api/classes/sync_sync_state.SyncState.md | 85 ---- docs/api/classes/utils.ExhaustivenessError.md | 59 --- ..._store_live_download.BlobDownloadEvents.md | 37 -- ...b_store_live_download.BlobDownloadState.md | 86 ---- docs/api/interfaces/core_manager.Events.md | 65 --- docs/api/interfaces/core_manager.HaveMsg.md | 54 --- .../interfaces/datatype-1.DataTypeEvents.md | 41 -- .../api/interfaces/datatype.DataTypeEvents.md | 41 -- ...scovery_local_discovery.DiscoveryEvents.md | 35 -- .../fastify_controller.StartOpts.md | 32 -- ...tify_plugins_blobs.BlobServerPluginOpts.md | 35 -- ...tify_plugins_icons.IconServerPluginOpts.md | 35 -- .../fastify_plugins_maps.MapsPluginContext.md | 29 -- .../fastify_plugins_maps.MapsPluginOpts.md | 32 -- ...fallback_map.FallbackMapPluginDecorator.md | 54 --- ...llback_map.OfflineFallbackMapPluginOpts.md | 43 -- ...s_static_maps.StaticMapsPluginDecorator.md | 61 --- ...s_maps_static_maps.StaticMapsPluginOpts.md | 32 -- .../generated_extensions.HaveExtension.md | 54 --- .../generated_extensions.ProjectExtension.md | 76 --- .../generated_keys.EncryptionKeys.md | 65 --- .../interfaces/generated_keys.ProjectKeys.md | 43 -- .../interfaces/generated_rpc.DeviceInfo.md | 32 -- docs/api/interfaces/icon_api.BitmapOpts.md | 43 -- docs/api/interfaces/icon_api.SvgOpts.md | 32 -- .../interfaces/invite_api.InviteApiEvents.md | 61 --- .../api/interfaces/invite_api.InviteCancel.md | 21 - .../interfaces/invite_api.InviteRpcMessage.md | 76 --- .../invite_api.ProjectJoinDetails.md | 43 -- .../local_peers.LocalPeersEvents.md | 204 -------- .../interfaces/local_peers.PeerInfoBase.md | 43 -- .../mapeo_manager.MapeoManagerEvents.md | 37 -- .../interfaces/member_api.InviteResponse.md | 32 -- docs/api/interfaces/member_api.MemberInfo.md | 54 --- docs/api/interfaces/roles.DocCapability.md | 62 --- docs/api/interfaces/roles.Role.md | 71 --- .../interfaces/schema_client.ProjectInfo.md | 21 - .../sync_core_sync_state.CoreState.md | 62 --- .../sync_core_sync_state.DerivedState.md | 49 -- .../sync_core_sync_state.InternalState.md | 67 --- docs/api/interfaces/sync_sync_api.State.md | 49 -- .../interfaces/sync_sync_api.SyncEvents.md | 35 -- .../interfaces/sync_sync_api.SyncTypeState.md | 88 ---- docs/api/md/.nojekyll | 1 + docs/api/md/README.md | 79 +++ .../classes/FastifyController.md} | 26 +- .../classes/MapeoManager.md} | 108 +++-- docs/api/modules/blob_api.md | 34 -- docs/api/modules/blob_store.md | 55 --- docs/api/modules/blob_store_live_download.md | 58 --- docs/api/modules/config_import.md | 72 --- docs/api/modules/constants.md | 19 - docs/api/modules/core_manager.md | 70 --- docs/api/modules/core_manager_bitfield_rle.md | 96 ---- docs/api/modules/core_manager_compat.md | 19 - docs/api/modules/core_manager_core_index.md | 42 -- .../core_manager_random_access_file_pool.md | 9 - .../modules/core_manager_remote_bitfield.md | 23 - docs/api/modules/core_ownership.md | 86 ---- docs/api/modules/datastore.md | 69 --- docs/api/modules/datatype-1.md | 133 ------ docs/api/modules/datatype.md | 142 ------ docs/api/modules/discovery_local_discovery.md | 59 --- docs/api/modules/fastify_controller.md | 13 - docs/api/modules/fastify_plugins_blobs.md | 44 -- docs/api/modules/fastify_plugins_constants.md | 30 -- docs/api/modules/fastify_plugins_icons.md | 34 -- docs/api/modules/fastify_plugins_maps.md | 60 --- ...stify_plugins_maps_offline_fallback_map.md | 49 -- .../fastify_plugins_maps_static_maps.md | 49 -- docs/api/modules/fastify_plugins_utils.md | 73 --- docs/api/modules/generated_extensions.md | 142 ------ docs/api/modules/generated_keys.md | 57 --- docs/api/modules/generated_rpc.md | 225 --------- docs/api/modules/icon_api.md | 116 ----- docs/api/modules/index.md | 43 -- docs/api/modules/index_writer.md | 47 -- docs/api/modules/invite_api.md | 121 ----- docs/api/modules/lib_hashmap.md | 23 - docs/api/modules/lib_ponyfills.md | 33 -- docs/api/modules/lib_string.md | 31 -- docs/api/modules/lib_timing_safe_equal.md | 43 -- docs/api/modules/local_peers.md | 86 ---- docs/api/modules/logger.md | 9 - docs/api/modules/mapeo_manager.md | 63 --- docs/api/modules/mapeo_project.md | 103 ---- docs/api/modules/member_api.md | 74 --- docs/api/modules/roles.md | 247 ---------- docs/api/modules/schema_client.md | 70 --- docs/api/modules/schema_project.md | 217 --------- docs/api/modules/schema_schema_to_drizzle.md | 54 --- docs/api/modules/schema_types.md | 92 ---- docs/api/modules/schema_utils.md | 117 ----- docs/api/modules/sync_core_sync_state.md | 78 --- docs/api/modules/sync_namespace_sync_state.md | 57 --- docs/api/modules/sync_peer_sync_controller.md | 80 ---- docs/api/modules/sync_sync_api.md | 54 --- docs/api/modules/sync_sync_state.md | 23 - docs/api/modules/types.md | 241 ---------- docs/api/modules/utils.md | 416 ---------------- docs/api/modules/utils_types.md | 60 --- 132 files changed, 146 insertions(+), 11554 deletions(-) delete mode 100644 docs/api/README.md delete mode 100644 docs/api/classes/blob_api.BlobApi.md delete mode 100644 docs/api/classes/blob_store.BlobStore.md delete mode 100644 docs/api/classes/blob_store_live_download.DriveLiveDownload.md delete mode 100644 docs/api/classes/blob_store_live_download.LiveDownload.md delete mode 100644 docs/api/classes/core_manager.CoreManager.md delete mode 100644 docs/api/classes/core_manager_core_index.CoreIndex.md delete mode 100644 docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md delete mode 100644 docs/api/classes/core_manager_remote_bitfield.default.md delete mode 100644 docs/api/classes/core_ownership.CoreOwnership.md delete mode 100644 docs/api/classes/datastore.DataStore.md delete mode 100644 docs/api/classes/datatype-1.DataType.md delete mode 100644 docs/api/classes/datatype.DataType.md delete mode 100644 docs/api/classes/discovery_local_discovery.LocalDiscovery.md delete mode 100644 docs/api/classes/icon_api.IconApi.md delete mode 100644 docs/api/classes/index_writer.IndexWriter.md delete mode 100644 docs/api/classes/invite_api.InviteApi.md delete mode 100644 docs/api/classes/lib_hashmap.default.md delete mode 100644 docs/api/classes/local_peers.LocalPeers.md delete mode 100644 docs/api/classes/local_peers.PeerDisconnectedError.md delete mode 100644 docs/api/classes/local_peers.PeerFailedConnectionError.md delete mode 100644 docs/api/classes/local_peers.UnknownPeerError.md delete mode 100644 docs/api/classes/logger.Logger.md delete mode 100644 docs/api/classes/mapeo_project.MapeoProject.md delete mode 100644 docs/api/classes/member_api.MemberApi.md delete mode 100644 docs/api/classes/roles.Roles.md delete mode 100644 docs/api/classes/sync_core_sync_state.CoreSyncState.md delete mode 100644 docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md delete mode 100644 docs/api/classes/sync_peer_sync_controller.PeerSyncController.md delete mode 100644 docs/api/classes/sync_sync_api.SyncApi.md delete mode 100644 docs/api/classes/sync_sync_state.SyncState.md delete mode 100644 docs/api/classes/utils.ExhaustivenessError.md delete mode 100644 docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md delete mode 100644 docs/api/interfaces/blob_store_live_download.BlobDownloadState.md delete mode 100644 docs/api/interfaces/core_manager.Events.md delete mode 100644 docs/api/interfaces/core_manager.HaveMsg.md delete mode 100644 docs/api/interfaces/datatype-1.DataTypeEvents.md delete mode 100644 docs/api/interfaces/datatype.DataTypeEvents.md delete mode 100644 docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md delete mode 100644 docs/api/interfaces/fastify_controller.StartOpts.md delete mode 100644 docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md delete mode 100644 docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md delete mode 100644 docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md delete mode 100644 docs/api/interfaces/generated_extensions.HaveExtension.md delete mode 100644 docs/api/interfaces/generated_extensions.ProjectExtension.md delete mode 100644 docs/api/interfaces/generated_keys.EncryptionKeys.md delete mode 100644 docs/api/interfaces/generated_keys.ProjectKeys.md delete mode 100644 docs/api/interfaces/generated_rpc.DeviceInfo.md delete mode 100644 docs/api/interfaces/icon_api.BitmapOpts.md delete mode 100644 docs/api/interfaces/icon_api.SvgOpts.md delete mode 100644 docs/api/interfaces/invite_api.InviteApiEvents.md delete mode 100644 docs/api/interfaces/invite_api.InviteCancel.md delete mode 100644 docs/api/interfaces/invite_api.InviteRpcMessage.md delete mode 100644 docs/api/interfaces/invite_api.ProjectJoinDetails.md delete mode 100644 docs/api/interfaces/local_peers.LocalPeersEvents.md delete mode 100644 docs/api/interfaces/local_peers.PeerInfoBase.md delete mode 100644 docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md delete mode 100644 docs/api/interfaces/member_api.InviteResponse.md delete mode 100644 docs/api/interfaces/member_api.MemberInfo.md delete mode 100644 docs/api/interfaces/roles.DocCapability.md delete mode 100644 docs/api/interfaces/roles.Role.md delete mode 100644 docs/api/interfaces/schema_client.ProjectInfo.md delete mode 100644 docs/api/interfaces/sync_core_sync_state.CoreState.md delete mode 100644 docs/api/interfaces/sync_core_sync_state.DerivedState.md delete mode 100644 docs/api/interfaces/sync_core_sync_state.InternalState.md delete mode 100644 docs/api/interfaces/sync_sync_api.State.md delete mode 100644 docs/api/interfaces/sync_sync_api.SyncEvents.md delete mode 100644 docs/api/interfaces/sync_sync_api.SyncTypeState.md create mode 100644 docs/api/md/.nojekyll create mode 100644 docs/api/md/README.md rename docs/api/{classes/fastify_controller.FastifyController.md => md/classes/FastifyController.md} (55%) rename docs/api/{classes/mapeo_manager.MapeoManager.md => md/classes/MapeoManager.md} (61%) delete mode 100644 docs/api/modules/blob_api.md delete mode 100644 docs/api/modules/blob_store.md delete mode 100644 docs/api/modules/blob_store_live_download.md delete mode 100644 docs/api/modules/config_import.md delete mode 100644 docs/api/modules/constants.md delete mode 100644 docs/api/modules/core_manager.md delete mode 100644 docs/api/modules/core_manager_bitfield_rle.md delete mode 100644 docs/api/modules/core_manager_compat.md delete mode 100644 docs/api/modules/core_manager_core_index.md delete mode 100644 docs/api/modules/core_manager_random_access_file_pool.md delete mode 100644 docs/api/modules/core_manager_remote_bitfield.md delete mode 100644 docs/api/modules/core_ownership.md delete mode 100644 docs/api/modules/datastore.md delete mode 100644 docs/api/modules/datatype-1.md delete mode 100644 docs/api/modules/datatype.md delete mode 100644 docs/api/modules/discovery_local_discovery.md delete mode 100644 docs/api/modules/fastify_controller.md delete mode 100644 docs/api/modules/fastify_plugins_blobs.md delete mode 100644 docs/api/modules/fastify_plugins_constants.md delete mode 100644 docs/api/modules/fastify_plugins_icons.md delete mode 100644 docs/api/modules/fastify_plugins_maps.md delete mode 100644 docs/api/modules/fastify_plugins_maps_offline_fallback_map.md delete mode 100644 docs/api/modules/fastify_plugins_maps_static_maps.md delete mode 100644 docs/api/modules/fastify_plugins_utils.md delete mode 100644 docs/api/modules/generated_extensions.md delete mode 100644 docs/api/modules/generated_keys.md delete mode 100644 docs/api/modules/generated_rpc.md delete mode 100644 docs/api/modules/icon_api.md delete mode 100644 docs/api/modules/index.md delete mode 100644 docs/api/modules/index_writer.md delete mode 100644 docs/api/modules/invite_api.md delete mode 100644 docs/api/modules/lib_hashmap.md delete mode 100644 docs/api/modules/lib_ponyfills.md delete mode 100644 docs/api/modules/lib_string.md delete mode 100644 docs/api/modules/lib_timing_safe_equal.md delete mode 100644 docs/api/modules/local_peers.md delete mode 100644 docs/api/modules/logger.md delete mode 100644 docs/api/modules/mapeo_manager.md delete mode 100644 docs/api/modules/mapeo_project.md delete mode 100644 docs/api/modules/member_api.md delete mode 100644 docs/api/modules/roles.md delete mode 100644 docs/api/modules/schema_client.md delete mode 100644 docs/api/modules/schema_project.md delete mode 100644 docs/api/modules/schema_schema_to_drizzle.md delete mode 100644 docs/api/modules/schema_types.md delete mode 100644 docs/api/modules/schema_utils.md delete mode 100644 docs/api/modules/sync_core_sync_state.md delete mode 100644 docs/api/modules/sync_namespace_sync_state.md delete mode 100644 docs/api/modules/sync_peer_sync_controller.md delete mode 100644 docs/api/modules/sync_sync_api.md delete mode 100644 docs/api/modules/sync_sync_state.md delete mode 100644 docs/api/modules/types.md delete mode 100644 docs/api/modules/utils.md delete mode 100644 docs/api/modules/utils_types.md diff --git a/.gitignore b/.gitignore index 12b7a8dcc..090581c4c 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ proto/build /dist !/drizzle/**/*.sql .eslintcache +!/docs/html/* diff --git a/docs/api/README.md b/docs/api/README.md deleted file mode 100644 index 6d371a183..000000000 --- a/docs/api/README.md +++ /dev/null @@ -1,62 +0,0 @@ -API - -# API - -## Table of contents - -### Modules - -- [blob-api](modules/blob_api.md) -- [blob-store](modules/blob_store.md) -- [blob-store/live-download](modules/blob_store_live_download.md) -- [config-import](modules/config_import.md) -- [constants](modules/constants.md) -- [core-manager](modules/core_manager.md) -- [core-manager/bitfield-rle](modules/core_manager_bitfield_rle.md) -- [core-manager/compat](modules/core_manager_compat.md) -- [core-manager/core-index](modules/core_manager_core_index.md) -- [core-manager/random-access-file-pool](modules/core_manager_random_access_file_pool.md) -- [core-manager/remote-bitfield](modules/core_manager_remote_bitfield.md) -- [core-ownership](modules/core_ownership.md) -- [datastore](modules/datastore.md) -- [datatype](modules/datatype.md) -- [datatype](modules/datatype-1.md) -- [discovery/local-discovery](modules/discovery_local_discovery.md) -- [fastify-controller](modules/fastify_controller.md) -- [fastify-plugins/blobs](modules/fastify_plugins_blobs.md) -- [fastify-plugins/constants](modules/fastify_plugins_constants.md) -- [fastify-plugins/icons](modules/fastify_plugins_icons.md) -- [fastify-plugins/maps](modules/fastify_plugins_maps.md) -- [fastify-plugins/maps/offline-fallback-map](modules/fastify_plugins_maps_offline_fallback_map.md) -- [fastify-plugins/maps/static-maps](modules/fastify_plugins_maps_static_maps.md) -- [fastify-plugins/utils](modules/fastify_plugins_utils.md) -- [generated/extensions](modules/generated_extensions.md) -- [generated/keys](modules/generated_keys.md) -- [generated/rpc](modules/generated_rpc.md) -- [icon-api](modules/icon_api.md) -- [index](modules/index.md) -- [index-writer](modules/index_writer.md) -- [invite-api](modules/invite_api.md) -- [lib/hashmap](modules/lib_hashmap.md) -- [lib/ponyfills](modules/lib_ponyfills.md) -- [lib/string](modules/lib_string.md) -- [lib/timing-safe-equal](modules/lib_timing_safe_equal.md) -- [local-peers](modules/local_peers.md) -- [logger](modules/logger.md) -- [mapeo-manager](modules/mapeo_manager.md) -- [mapeo-project](modules/mapeo_project.md) -- [member-api](modules/member_api.md) -- [roles](modules/roles.md) -- [schema/client](modules/schema_client.md) -- [schema/project](modules/schema_project.md) -- [schema/schema-to-drizzle](modules/schema_schema_to_drizzle.md) -- [schema/types](modules/schema_types.md) -- [schema/utils](modules/schema_utils.md) -- [sync/core-sync-state](modules/sync_core_sync_state.md) -- [sync/namespace-sync-state](modules/sync_namespace_sync_state.md) -- [sync/peer-sync-controller](modules/sync_peer_sync_controller.md) -- [sync/sync-api](modules/sync_sync_api.md) -- [sync/sync-state](modules/sync_sync_state.md) -- [types](modules/types.md) -- [utils](modules/utils.md) -- [utils\_types](modules/utils_types.md) diff --git a/docs/api/classes/blob_api.BlobApi.md b/docs/api/classes/blob_api.BlobApi.md deleted file mode 100644 index d6ef80cfa..000000000 --- a/docs/api/classes/blob_api.BlobApi.md +++ /dev/null @@ -1,87 +0,0 @@ -[API](../README.md) / [blob-api](../modules/blob_api.md) / BlobApi - -# Class: BlobApi - -[blob-api](../modules/blob_api.md).BlobApi - -## Table of contents - -### Constructors - -- [constructor](blob_api.BlobApi.md#constructor) - -### Methods - -- [create](blob_api.BlobApi.md#create) -- [getUrl](blob_api.BlobApi.md#geturl) - -## Constructors - -### constructor - -• **new BlobApi**(`options`): [`BlobApi`](blob_api.BlobApi.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.blobStore` | [`BlobStore`](blob_store.BlobStore.md) | -| `options.getMediaBaseUrl` | () => `Promise`\<`string`\> | - -#### Returns - -[`BlobApi`](blob_api.BlobApi.md) - -#### Defined in - -[src/blob-api.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L18) - -## Methods - -### create - -▸ **create**(`filepaths`, `metadata`): `Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> - -Write blobs for provided variants of a file - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `filepaths` | `Object` | -| `filepaths.original` | `string` | -| `filepaths.preview?` | `string` | -| `filepaths.thumbnail?` | `string` | -| `metadata` | `Object` | -| `metadata.mimeType` | `string` | - -#### Returns - -`Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> - -#### Defined in - -[src/blob-api.js:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L46) - -___ - -### getUrl - -▸ **getUrl**(`blobId`): `Promise`\<`string`\> - -Get a url for a blob based on its BlobId - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/blob-api.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-api.js#L28) diff --git a/docs/api/classes/blob_store.BlobStore.md b/docs/api/classes/blob_store.BlobStore.md deleted file mode 100644 index 6853471fe..000000000 --- a/docs/api/classes/blob_store.BlobStore.md +++ /dev/null @@ -1,281 +0,0 @@ -[API](../README.md) / [blob-store](../modules/blob_store.md) / BlobStore - -# Class: BlobStore - -[blob-store](../modules/blob_store.md).BlobStore - -## Table of contents - -### Constructors - -- [constructor](blob_store.BlobStore.md#constructor) - -### Accessors - -- [writerDriveId](blob_store.BlobStore.md#writerdriveid) - -### Methods - -- [clear](blob_store.BlobStore.md#clear) -- [createEntryReadStream](blob_store.BlobStore.md#createentryreadstream) -- [createReadStream](blob_store.BlobStore.md#createreadstream) -- [createWriteStream](blob_store.BlobStore.md#createwritestream) -- [download](blob_store.BlobStore.md#download) -- [entry](blob_store.BlobStore.md#entry) -- [get](blob_store.BlobStore.md#get) -- [getEntryBlob](blob_store.BlobStore.md#getentryblob) -- [put](blob_store.BlobStore.md#put) - -## Constructors - -### constructor - -• **new BlobStore**(`options`): [`BlobStore`](blob_store.BlobStore.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | - -#### Returns - -[`BlobStore`](blob_store.BlobStore.md) - -#### Defined in - -[src/blob-store/index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L45) - -## Accessors - -### writerDriveId - -• `get` **writerDriveId**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/blob-store/index.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L77) - -## Methods - -### clear - -▸ **clear**(`blobId`, `options?`): `Promise`\<``null`` \| \{ `blocks`: `number` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | -| `options?` | `Object` | | -| `options.diff` | `undefined` \| `boolean` | Enable to return an object with a `block` property with number of bytes removed | - -#### Returns - -`Promise`\<``null`` \| \{ `blocks`: `number` }\> - -#### Defined in - -[src/blob-store/index.js:234](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L234) - -___ - -### createEntryReadStream - -▸ **createEntryReadStream**(`driveId`, `entry`, `options?`): `Promise`\<`BlobReadStream`\> - -Optimization for creating the blobs read stream when you have -previously read the entry from Hyperdrive using `drive.entry` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `driveId` | `string` | Hyperdrive drive discovery id | -| `entry` | `HyperdriveEntry` | Hyperdrive entry | -| `options?` | `Object` | | -| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | - -#### Returns - -`Promise`\<`BlobReadStream`\> - -#### Defined in - -[src/blob-store/index.js:150](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L150) - -___ - -### createReadStream - -▸ **createReadStream**(`blobId`, `options?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | -| `options?` | `Object` | | -| `options.timeout` | `undefined` \| `number` | Optional timeout to wait for a blob to download | -| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | - -#### Returns - -`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> - -#### Defined in - -[src/blob-store/index.js:130](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L130) - -___ - -### createWriteStream - -▸ **createWriteStream**(`blobId`, `options?`): `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blobId` | `Omit`\<[`BlobId`](../modules/blob_api.md#blobid), ``"driveId"``\> | | -| `options?` | `Object` | | -| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | - -#### Returns - -`Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } - -#### Defined in - -[src/blob-store/index.js:201](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L201) - -___ - -### download - -▸ **download**(`filter?`, `options?`): [`LiveDownload`](blob_store_live_download.LiveDownload.md) - -Download blobs from all drives, optionally filtering particular blob types -or blob variants. Download will be 'live' and will continue downloading new -data as it becomes available from any replicating drive. - -If no filter is specified, all blobs will be downloaded. If a filter is -specified, then _only_ blobs that match the filter will be downloaded. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | [`BlobFilter`](../modules/types.md#blobfilter) | Filter blob types and/or variants to download. Filter is { [BlobType]: BlobVariants[] }. At least one blob variant must be specified for each blob type. | -| `options` | `Object` | | -| `options.signal` | `undefined` \| `AbortSignal` | Optional AbortSignal to cancel in-progress download | - -#### Returns - -[`LiveDownload`](blob_store_live_download.LiveDownload.md) - -EventEmitter with `.state` propery, emits `state` with new state when it updates - -#### Defined in - -[src/blob-store/index.js:117](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L117) - -___ - -### entry - -▸ **entry**(`blobId`, `options?`): `Promise`\<``null`` \| `HyperdriveEntry`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | | -| `options?` | `Object` | | -| `options.follow` | `undefined` \| `boolean` | Set to `true` to follow symlinks (16 max or throws an error) | -| `options.timeout` | `undefined` | Optional timeout to wait for a blob to download | -| `options.wait` | `undefined` \| ``false`` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | - -#### Returns - -`Promise`\<``null`` \| `HyperdriveEntry`\> - -#### Defined in - -[src/blob-store/index.js:217](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L217) - -___ - -### get - -▸ **get**(`blobId`, `opts?`): `Promise`\<`Buffer`\> - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `blobId` | [`BlobId`](../modules/blob_api.md#blobid) | `undefined` | | -| `opts` | `Object` | `{}` | | -| `opts.timeout` | `undefined` | `undefined` | Optional timeout to wait for a blob to download | -| `opts.wait` | `undefined` \| ``false`` | `false` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | - -#### Returns - -`Promise`\<`Buffer`\> - -#### Defined in - -[src/blob-store/index.js:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L96) - -___ - -### getEntryBlob - -▸ **getEntryBlob**(`driveId`, `entry`, `opts?`): `Promise`\<``null`` \| `Buffer`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `driveId` | `string` | Hyperdrive drive id | -| `entry` | `HyperdriveEntry` | Hyperdrive entry | -| `opts?` | `Object` | | -| `opts.length` | `undefined` \| `number` | | - -#### Returns - -`Promise`\<``null`` \| `Buffer`\> - -#### Defined in - -[src/blob-store/index.js:170](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L170) - -___ - -### put - -▸ **put**(`blobId`, `blob`, `options?`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blobId` | `Omit`\<[`BlobId`](../modules/blob_api.md#blobid), ``"driveId"``\> | | -| `blob` | `Buffer` | | -| `options?` | `Object` | | -| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | - -#### Returns - -`Promise`\<`string`\> - -discovery key as hex string of hyperdrive where blob is stored - -#### Defined in - -[src/blob-store/index.js:190](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L190) diff --git a/docs/api/classes/blob_store_live_download.DriveLiveDownload.md b/docs/api/classes/blob_store_live_download.DriveLiveDownload.md deleted file mode 100644 index 966924598..000000000 --- a/docs/api/classes/blob_store_live_download.DriveLiveDownload.md +++ /dev/null @@ -1,66 +0,0 @@ -[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / DriveLiveDownload - -# Class: DriveLiveDownload - -[blob-store/live-download](../modules/blob_store_live_download.md).DriveLiveDownload - -LiveDownload class - -## Hierarchy - -- `TypedEmitter` - - ↳ **`DriveLiveDownload`** - -## Table of contents - -### Constructors - -- [constructor](blob_store_live_download.DriveLiveDownload.md#constructor) - -### Accessors - -- [state](blob_store_live_download.DriveLiveDownload.md#state) - -## Constructors - -### constructor - -• **new DriveLiveDownload**(`drive`, `options?`): [`DriveLiveDownload`](blob_store_live_download.DriveLiveDownload.md) - -Like drive.download() but 'live', - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `drive` | `Hyperdrive` | | -| `options` | `Object` | | -| `options.filter` | `undefined` \| [`BlobFilter`](../modules/types.md#blobfilter) | Filter blobs of specific types and/or sizes to download | -| `options.signal` | `undefined` \| `AbortSignal` | | - -#### Returns - -[`DriveLiveDownload`](blob_store_live_download.DriveLiveDownload.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/blob-store/live-download.js:107](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L107) - -## Accessors - -### state - -• `get` **state**(): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) - -#### Returns - -[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) - -#### Defined in - -[src/blob-store/live-download.js:129](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L129) diff --git a/docs/api/classes/blob_store_live_download.LiveDownload.md b/docs/api/classes/blob_store_live_download.LiveDownload.md deleted file mode 100644 index a1c998405..000000000 --- a/docs/api/classes/blob_store_live_download.LiveDownload.md +++ /dev/null @@ -1,67 +0,0 @@ -[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / LiveDownload - -# Class: LiveDownload - -[blob-store/live-download](../modules/blob_store_live_download.md).LiveDownload - -LiveDownload class - -## Hierarchy - -- `TypedEmitter` - - ↳ **`LiveDownload`** - -## Table of contents - -### Constructors - -- [constructor](blob_store_live_download.LiveDownload.md#constructor) - -### Accessors - -- [state](blob_store_live_download.LiveDownload.md#state) - -## Constructors - -### constructor - -• **new LiveDownload**(`drives`, `emitter`, `options`): [`LiveDownload`](blob_store_live_download.LiveDownload.md) - -Like drive.download() but 'live', and for multiple drives - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `drives` | `Iterable`\<`Hyperdrive`\> | | -| `emitter` | [`InternalDriveEmitter`](../modules/blob_store.md#internaldriveemitter) | | -| `options` | `Object` | | -| `options.filter` | `undefined` \| [`BlobFilter`](../modules/types.md#blobfilter) | Filter blobs of specific types and/or sizes to download | -| `options.signal` | `undefined` \| `AbortSignal` | | - -#### Returns - -[`LiveDownload`](blob_store_live_download.LiveDownload.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/blob-store/live-download.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L42) - -## Accessors - -### state - -• `get` **state**(): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) - -#### Returns - -[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) - -#### Defined in - -[src/blob-store/live-download.js:78](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L78) diff --git a/docs/api/classes/core_manager.CoreManager.md b/docs/api/classes/core_manager.CoreManager.md deleted file mode 100644 index 1db06f168..000000000 --- a/docs/api/classes/core_manager.CoreManager.md +++ /dev/null @@ -1,321 +0,0 @@ -[API](../README.md) / [core-manager](../modules/core_manager.md) / CoreManager - -# Class: CoreManager - -[core-manager](../modules/core_manager.md).CoreManager - -## Hierarchy - -- `TypedEmitter` - - ↳ **`CoreManager`** - -## Table of contents - -### Constructors - -- [constructor](core_manager.CoreManager.md#constructor) - -### Accessors - -- [creatorCore](core_manager.CoreManager.md#creatorcore) -- [deviceId](core_manager.CoreManager.md#deviceid) -- [namespaces](core_manager.CoreManager.md#namespaces) - -### Methods - -- [[kCoreManagerReplicate]](core_manager.CoreManager.md#[kcoremanagerreplicate]) -- [addCore](core_manager.CoreManager.md#addcore) -- [close](core_manager.CoreManager.md#close) -- [deleteOthersData](core_manager.CoreManager.md#deleteothersdata) -- [getCoreByDiscoveryKey](core_manager.CoreManager.md#getcorebydiscoverykey) -- [getCoreByKey](core_manager.CoreManager.md#getcorebykey) -- [getCores](core_manager.CoreManager.md#getcores) -- [getWriterCore](core_manager.CoreManager.md#getwritercore) -- [ready](core_manager.CoreManager.md#ready) -- [requestCoreKey](core_manager.CoreManager.md#requestcorekey) - -## Constructors - -### constructor - -• **new CoreManager**(`options`): [`CoreManager`](core_manager.CoreManager.md) - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `options` | `Object` | `undefined` | | -| `options.autoDownload` | `undefined` \| `boolean` | `true` | Immediately start downloading cores - should only be set to false for tests | -| `options.db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | `undefined` | Drizzle better-sqlite3 database instance | -| `options.encryptionKeys` | `undefined` \| `Partial`\<`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `Buffer`\>\> | `{}` | Encryption keys for each namespace | -| `options.keyManager` | `KeyManager` | `undefined` | mapeo/crypto KeyManager instance | -| `options.logger` | `undefined` \| [`Logger`](logger.Logger.md) | `undefined` | | -| `options.projectKey` | `Buffer` | `undefined` | 32-byte public key of the project creator core | -| `options.projectSecretKey` | `undefined` \| `Buffer` | `undefined` | 32-byte secret key of the project creator core | -| `options.storage` | `HypercoreStorage` | `undefined` | Folder to store all hypercore data | - -#### Returns - -[`CoreManager`](core_manager.CoreManager.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/core-manager/index.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L70) - -## Accessors - -### creatorCore - -• `get` **creatorCore**(): `Hypercore`\<``"binary"``, `Buffer`\> - -#### Returns - -`Hypercore`\<``"binary"``, `Buffer`\> - -#### Defined in - -[src/core-manager/index.js:189](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L189) - -___ - -### deviceId - -• `get` **deviceId**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/core-manager/index.js:185](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L185) - -___ - -### namespaces - -• `get` **namespaces**(): readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] - -#### Returns - -readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] - -#### Defined in - -[src/core-manager/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L55) - -## Methods - -### [kCoreManagerReplicate] - -▸ **[kCoreManagerReplicate]**(`stream`): `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> - -ONLY FOR TESTING -Replicate all cores in core manager - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stream` | `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | - -#### Returns - -`Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> - -#### Defined in - -[src/core-manager/index.js:460](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L460) - -___ - -### addCore - -▸ **addCore**(`key`, `namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Add a core to the manager (will be persisted across restarts) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `Buffer` | 32-byte public key of core to add | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | - -#### Returns - -[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/index.js:266](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L266) - -___ - -### close - -▸ **close**(): `Promise`\<`void`\> - -Close all open cores and end any replication streams -TODO: gracefully close replication streams - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/core-manager/index.js:248](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L248) - -___ - -### deleteOthersData - -▸ **deleteOthersData**(`namespace`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/core-manager/index.js:479](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L479) - -___ - -### getCoreByDiscoveryKey - -▸ **getCoreByDiscoveryKey**(`discoveryKey`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Get a core by its discovery key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discoveryKey` | `Buffer` | - -#### Returns - -`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/index.js:237](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L237) - -___ - -### getCoreByKey - -▸ **getCoreByKey**(`key`): `undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> - -Get a core by its public key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `Buffer` | - -#### Returns - -`undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> - -#### Defined in - -[src/core-manager/index.js:226](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L226) - -___ - -### getCores - -▸ **getCores**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] - -Get an array of all cores in the given namespace - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] - -#### Defined in - -[src/core-manager/index.js:216](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L216) - -___ - -### getWriterCore - -▸ **getWriterCore**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Get the writer core for the given namespace - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/index.js:207](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L207) - -___ - -### ready - -▸ **ready**(): `Promise`\<`void`\> - -Resolves when all cores have finished loading - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/core-manager/index.js:198](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L198) - -___ - -### requestCoreKey - -▸ **requestCoreKey**(`peerKey`, `discoveryKey`): `void` - -Send an extension message over the project creator core replication stream -requesting a core key for the given discovery key. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerKey` | `Buffer` | -| `discoveryKey` | `Buffer` | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/index.js:345](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L345) diff --git a/docs/api/classes/core_manager_core_index.CoreIndex.md b/docs/api/classes/core_manager_core_index.CoreIndex.md deleted file mode 100644 index 9757b89e7..000000000 --- a/docs/api/classes/core_manager_core_index.CoreIndex.md +++ /dev/null @@ -1,161 +0,0 @@ -[API](../README.md) / [core-manager/core-index](../modules/core_manager_core_index.md) / CoreIndex - -# Class: CoreIndex - -[core-manager/core-index](../modules/core_manager_core_index.md).CoreIndex - -An in-memory index of open cores. - -## Table of contents - -### Constructors - -- [constructor](core_manager_core_index.CoreIndex.md#constructor) - -### Methods - -- [[iterator]](core_manager_core_index.CoreIndex.md#[iterator]) -- [add](core_manager_core_index.CoreIndex.md#add) -- [getByCoreKey](core_manager_core_index.CoreIndex.md#getbycorekey) -- [getByDiscoveryId](core_manager_core_index.CoreIndex.md#getbydiscoveryid) -- [getByNamespace](core_manager_core_index.CoreIndex.md#getbynamespace) -- [getWriter](core_manager_core_index.CoreIndex.md#getwriter) - -## Constructors - -### constructor - -• **new CoreIndex**(): [`CoreIndex`](core_manager_core_index.CoreIndex.md) - -#### Returns - -[`CoreIndex`](core_manager_core_index.CoreIndex.md) - -## Methods - -### [iterator] - -▸ **[iterator]**(): `IterableIterator`\<[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)\> - -#### Returns - -`IterableIterator`\<[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)\> - -#### Defined in - -[src/core-manager/core-index.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L15) - -___ - -### add - -▸ **add**(`options`): `void` - -NB. Need to pass key here because `core.key` is not populated until the -core is ready, but we know it beforehand. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `options` | `Object` | `undefined` | | -| `options.core` | `Hypercore`\<``"binary"``, `Buffer`\> | `undefined` | Hypercore instance | -| `options.key` | `Buffer` | `undefined` | Buffer containing public key of this core | -| `options.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | `undefined` | | -| `options.writer` | `undefined` \| `boolean` | `false` | Is this a writer core? | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/core-index.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L29) - -___ - -### getByCoreKey - -▸ **getByCoreKey**(`coreKey`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Get a core by its public key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coreKey` | `Buffer` | - -#### Returns - -`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/core-index.js:83](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L83) - -___ - -### getByDiscoveryId - -▸ **getByDiscoveryId**(`discoveryId`): `undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Get a core by its discoveryId (discover key as hex string) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discoveryId` | `string` | - -#### Returns - -`undefined` \| [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/core-index.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L73) - -___ - -### getByNamespace - -▸ **getByNamespace**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] - -Get all known cores in a namespace - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -[`CoreRecord`](../modules/core_manager_core_index.md#corerecord)[] - -#### Defined in - -[src/core-manager/core-index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L45) - -___ - -### getWriter - -▸ **getWriter**(`namespace`): [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -Get the write core for the given namespace - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -[`CoreRecord`](../modules/core_manager_core_index.md#corerecord) - -#### Defined in - -[src/core-manager/core-index.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/core-index.js#L59) diff --git a/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md b/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md deleted file mode 100644 index 193beb470..000000000 --- a/docs/api/classes/core_manager_random_access_file_pool.RandomAccessFilePool.md +++ /dev/null @@ -1,105 +0,0 @@ -[API](../README.md) / [core-manager/random-access-file-pool](../modules/core_manager_random_access_file_pool.md) / RandomAccessFilePool - -# Class: RandomAccessFilePool - -[core-manager/random-access-file-pool](../modules/core_manager_random_access_file_pool.md).RandomAccessFilePool - -File descriptor pool for random-access-storage to limit the number of file -descriptors used. Important particularly for Android where the hard limit for -the app is 1024. - -## Table of contents - -### Constructors - -- [constructor](core_manager_random_access_file_pool.RandomAccessFilePool.md#constructor) - -### Properties - -- [active](core_manager_random_access_file_pool.RandomAccessFilePool.md#active) -- [maxSize](core_manager_random_access_file_pool.RandomAccessFilePool.md#maxsize) - -### Methods - -- [\_onactive](core_manager_random_access_file_pool.RandomAccessFilePool.md#_onactive) -- [\_oninactive](core_manager_random_access_file_pool.RandomAccessFilePool.md#_oninactive) - -## Constructors - -### constructor - -• **new RandomAccessFilePool**(`maxSize`): [`RandomAccessFilePool`](core_manager_random_access_file_pool.RandomAccessFilePool.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `maxSize` | `number` | max number of file descriptors to use | - -#### Returns - -[`RandomAccessFilePool`](core_manager_random_access_file_pool.RandomAccessFilePool.md) - -#### Defined in - -[src/core-manager/random-access-file-pool.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L8) - -## Properties - -### active - -• **active**: `Set`\<`RandomAccessFile`\> - -#### Defined in - -[src/core-manager/random-access-file-pool.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L11) - -___ - -### maxSize - -• **maxSize**: `number` - -#### Defined in - -[src/core-manager/random-access-file-pool.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L9) - -## Methods - -### \_onactive - -▸ **_onactive**(`file`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | `RandomAccessFile` | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/random-access-file-pool.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L15) - -___ - -### \_oninactive - -▸ **_oninactive**(`file`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | `RandomAccessFile` | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/random-access-file-pool.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/random-access-file-pool.js#L27) diff --git a/docs/api/classes/core_manager_remote_bitfield.default.md b/docs/api/classes/core_manager_remote_bitfield.default.md deleted file mode 100644 index 7d5f6cdcc..000000000 --- a/docs/api/classes/core_manager_remote_bitfield.default.md +++ /dev/null @@ -1,307 +0,0 @@ -[API](../README.md) / [core-manager/remote-bitfield](../modules/core_manager_remote_bitfield.md) / default - -# Class: default - -[core-manager/remote-bitfield](../modules/core_manager_remote_bitfield.md).default - -## Table of contents - -### Constructors - -- [constructor](core_manager_remote_bitfield.default.md#constructor) - -### Properties - -- [\_maxSegments](core_manager_remote_bitfield.default.md#_maxsegments) -- [\_pages](core_manager_remote_bitfield.default.md#_pages) -- [\_segments](core_manager_remote_bitfield.default.md#_segments) - -### Methods - -- [findFirst](core_manager_remote_bitfield.default.md#findfirst) -- [findLast](core_manager_remote_bitfield.default.md#findlast) -- [firstSet](core_manager_remote_bitfield.default.md#firstset) -- [firstUnset](core_manager_remote_bitfield.default.md#firstunset) -- [get](core_manager_remote_bitfield.default.md#get) -- [getBitfield](core_manager_remote_bitfield.default.md#getbitfield) -- [insert](core_manager_remote_bitfield.default.md#insert) -- [lastSet](core_manager_remote_bitfield.default.md#lastset) -- [lastUnset](core_manager_remote_bitfield.default.md#lastunset) -- [set](core_manager_remote_bitfield.default.md#set) -- [setRange](core_manager_remote_bitfield.default.md#setrange) - -## Constructors - -### constructor - -• **new default**(): [`default`](core_manager_remote_bitfield.default.md) - -#### Returns - -[`default`](core_manager_remote_bitfield.default.md) - -#### Defined in - -[src/core-manager/remote-bitfield.js:207](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L207) - -## Properties - -### \_maxSegments - -• **\_maxSegments**: `number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:212](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L212) - -[src/core-manager/remote-bitfield.js:253](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L253) - -[src/core-manager/remote-bitfield.js:281](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L281) - -[src/core-manager/remote-bitfield.js:394](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L394) - -___ - -### \_pages - -• **\_pages**: `BigSparseArray`\<`RemoteBitfieldPage`\> - -#### Defined in - -[src/core-manager/remote-bitfield.js:209](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L209) - -___ - -### \_segments - -• **\_segments**: `BigSparseArray`\<`RemoteBitfieldSegment`\> - -#### Defined in - -[src/core-manager/remote-bitfield.js:211](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L211) - -## Methods - -### findFirst - -▸ **findFirst**(`val`, `position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `val` | `boolean` | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:304](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L304) - -___ - -### findLast - -▸ **findLast**(`val`, `position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `val` | `boolean` | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:340](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L340) - -___ - -### firstSet - -▸ **firstSet**(`position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:327](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L327) - -___ - -### firstUnset - -▸ **firstUnset**(`position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:333](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L333) - -___ - -### get - -▸ **get**(`index`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`boolean` - -#### Defined in - -[src/core-manager/remote-bitfield.js:218](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L218) - -___ - -### getBitfield - -▸ **getBitfield**(`index`): ``null`` \| `RemoteBitfieldPage` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -``null`` \| `RemoteBitfieldPage` - -#### Defined in - -[src/core-manager/remote-bitfield.js:230](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L230) - -___ - -### insert - -▸ **insert**(`start`, `bitfield`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start` | `number` | -| `bitfield` | `Uint32Array` | - -#### Returns - -`boolean` - -#### Defined in - -[src/core-manager/remote-bitfield.js:378](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L378) - -___ - -### lastSet - -▸ **lastSet**(`position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:364](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L364) - -___ - -### lastUnset - -▸ **lastUnset**(`position`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/remote-bitfield.js:370](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L370) - -___ - -### set - -▸ **set**(`index`, `val`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `val` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/remote-bitfield.js:242](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L242) - -___ - -### setRange - -▸ **setRange**(`start`, `length`, `val`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `start` | `number` | -| `length` | `number` | -| `val` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[src/core-manager/remote-bitfield.js:269](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L269) diff --git a/docs/api/classes/core_ownership.CoreOwnership.md b/docs/api/classes/core_ownership.CoreOwnership.md deleted file mode 100644 index be30c1010..000000000 --- a/docs/api/classes/core_ownership.CoreOwnership.md +++ /dev/null @@ -1,84 +0,0 @@ -[API](../README.md) / [core-ownership](../modules/core_ownership.md) / CoreOwnership - -# Class: CoreOwnership - -[core-ownership](../modules/core_ownership.md).CoreOwnership - -## Table of contents - -### Constructors - -- [constructor](core_ownership.CoreOwnership.md#constructor) - -### Methods - -- [getCoreId](core_ownership.CoreOwnership.md#getcoreid) -- [getOwner](core_ownership.CoreOwnership.md#getowner) - -## Constructors - -### constructor - -• **new CoreOwnership**(`opts`): [`CoreOwnership`](core_ownership.CoreOwnership.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.coreKeypairs` | `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`KeyPair`](../modules/types.md#keypair)\> | -| `opts.dataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | -| `opts.identityKeypair` | [`KeyPair`](../modules/types.md#keypair) | - -#### Returns - -[`CoreOwnership`](core_ownership.CoreOwnership.md) - -#### Defined in - -[src/core-ownership.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L33) - -## Methods - -### getCoreId - -▸ **getCoreId**(`deviceId`, `namespace`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Returns - -`Promise`\<`string`\> - -coreId of core belonging to `deviceId` for `namespace` - -#### Defined in - -[src/core-ownership.js:83](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L83) - -___ - -### getOwner - -▸ **getOwner**(`coreId`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coreId` | `string` | - -#### Returns - -`Promise`\<`string`\> - -deviceId of device that owns the core - -#### Defined in - -[src/core-ownership.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L60) diff --git a/docs/api/classes/datastore.DataStore.md b/docs/api/classes/datastore.DataStore.md deleted file mode 100644 index 728be3e71..000000000 --- a/docs/api/classes/datastore.DataStore.md +++ /dev/null @@ -1,251 +0,0 @@ -[API](../README.md) / [datastore](../modules/datastore.md) / DataStore - -# Class: DataStore\ - -[datastore](../modules/datastore.md).DataStore - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | keyof [`NamespaceSchemas`](../modules/datastore.md#namespaceschemas) | -| `TSchemaName` | [`NamespaceSchemas`](../modules/datastore.md#namespaceschemas)[`TNamespace`][`number`] | - -## Hierarchy - -- `TypedEmitter` - - ↳ **`DataStore`** - -## Table of contents - -### Constructors - -- [constructor](datastore.DataStore.md#constructor) - -### Accessors - -- [indexer](datastore.DataStore.md#indexer) -- [namespace](datastore.DataStore.md#namespace) -- [schemas](datastore.DataStore.md#schemas) -- [writerCore](datastore.DataStore.md#writercore) - -### Methods - -- [close](datastore.DataStore.md#close) -- [getIndexState](datastore.DataStore.md#getindexstate) -- [read](datastore.DataStore.md#read) -- [readRaw](datastore.DataStore.md#readraw) -- [write](datastore.DataStore.md#write) -- [writeRaw](datastore.DataStore.md#writeraw) - -## Constructors - -### constructor - -• **new DataStore**\<`TNamespace`, `TSchemaName`\>(`opts`): [`DataStore`](datastore.DataStore.md)\<`TNamespace`, `TSchemaName`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | extends ``"auth"`` \| ``"config"`` \| ``"data"`` = ``"auth"`` \| ``"config"`` \| ``"data"`` | -| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` = \{ `auth`: readonly [``"coreOwnership"``, ``"role"``] ; `config`: readonly [``"translation"``, ``"preset"``, ``"field"``, ``"projectSettings"``, ``"deviceInfo"``, ``"icon"``] ; `data`: readonly [``"observation"``, ``"track"``] }[`TNamespace`][`number`] | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.batch` | (`entries`: `Entry`\<``"binary"``\>[]) => `Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | -| `opts.namespace` | `TNamespace` | -| `opts.storage` | `StorageParam` | - -#### Returns - -[`DataStore`](datastore.DataStore.md)\<`TNamespace`, `TSchemaName`\> - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/datastore/index.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L72) - -## Accessors - -### indexer - -• `get` **indexer**(): `MultiCoreIndexer`\<``"binary"``\> - -#### Returns - -`MultiCoreIndexer`\<``"binary"``\> - -#### Defined in - -[src/datastore/index.js:94](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L94) - -___ - -### namespace - -• `get` **namespace**(): `TNamespace` - -#### Returns - -`TNamespace` - -#### Defined in - -[src/datastore/index.js:98](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L98) - -___ - -### schemas - -• `get` **schemas**(): (``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] - -#### Returns - -(``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] - -#### Defined in - -[src/datastore/index.js:102](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L102) - -___ - -### writerCore - -• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> - -#### Returns - -`Hypercore`\<``"binary"``, `Buffer`\> - -#### Defined in - -[src/datastore/index.js:107](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L107) - -## Methods - -### close - -▸ **close**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/datastore/index.js:229](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L229) - -___ - -### getIndexState - -▸ **getIndexState**(): `IndexState` - -#### Returns - -`IndexState` - -#### Defined in - -[src/datastore/index.js:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L111) - -___ - -### read - -▸ **read**(`versionId`): `Promise`\<`MapeoDoc`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` | - -#### Returns - -`Promise`\<`MapeoDoc`\> - -#### Defined in - -[src/datastore/index.js:198](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L198) - -___ - -### readRaw - -▸ **readRaw**(`versionId`): `Promise`\<`Buffer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` | - -#### Returns - -`Promise`\<`Buffer`\> - -#### Defined in - -[src/datastore/index.js:220](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L220) - -___ - -### write - -▸ **write**\<`TDoc`\>(`doc`): `Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> - -UNSAFE: Does not check links: [] refer to a valid doc - should only be used -internally. - -Write a doc, must be one of the schema types supported by the namespace of -this DataStore. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{} & `CoreOwnershipSignatures`, ``"versionId"``\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `TDoc` | - -#### Returns - -`Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> - -#### Defined in - -[src/datastore/index.js:157](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L157) - -___ - -### writeRaw - -▸ **writeRaw**(`buf`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buf` | `Buffer` | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/datastore/index.js:208](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L208) diff --git a/docs/api/classes/datatype-1.DataType.md b/docs/api/classes/datatype-1.DataType.md deleted file mode 100644 index 3a84317df..000000000 --- a/docs/api/classes/datatype-1.DataType.md +++ /dev/null @@ -1,278 +0,0 @@ -[API](../README.md) / [datatype](../modules/datatype-1.md) / DataType - -# Class: DataType\ - -[datatype](../modules/datatype-1.md).DataType - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TDataStore` | extends [`datastore`](../modules/datastore.md) | -| `TTable` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | -| `TSchemaName` | extends `TTable`[``"_"``][``"name"``] | -| `TDoc` | extends [`MapeoDocMap`](../modules/datatype.md#mapeodocmap)[`TSchemaName`] | -| `TValue` | extends [`MapeoValueMap`](../modules/datatype.md#mapeovaluemap)[`TSchemaName`] | - -## Hierarchy - -- `TypedEmitter`\<[`DataTypeEvents`](../interfaces/datatype-1.DataTypeEvents.md)\<`TDoc`\>\> - - ↳ **`DataType`** - -## Table of contents - -### Constructors - -- [constructor](datatype-1.DataType.md#constructor) - -### Accessors - -- [[kTable]](datatype-1.DataType.md#[ktable]) -- [writerCore](datatype-1.DataType.md#writercore) - -### Methods - -- [[kCreateWithDocId]](datatype-1.DataType.md#[kcreatewithdocid]) -- [[kSelect]](datatype-1.DataType.md#[kselect]) -- [create](datatype-1.DataType.md#create) -- [delete](datatype-1.DataType.md#delete) -- [getByDocId](datatype-1.DataType.md#getbydocid) -- [getByVersionId](datatype-1.DataType.md#getbyversionid) -- [getMany](datatype-1.DataType.md#getmany) -- [update](datatype-1.DataType.md#update) - -## Constructors - -### constructor - -• **new DataType**\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>(`«destructured»`): [`DataType`](datatype-1.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TDataStore` | extends [`DataStore`](datastore.DataStore.md)\<``"auth"`` \| ``"config"`` \| ``"data"``, ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``\> | -| `TTable` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | -| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` | -| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | -| `TValue` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `Object` | -| › `dataStore` | `TDataStore` | -| › `db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | -| › `getPermissions?` | () => `any` | -| › `table` | `TTable` | - -#### Returns - -[`DataType`](datatype-1.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> - -#### Overrides - -TypedEmitter\<DataTypeEvents\<TDoc\>\>.constructor - -#### Defined in - -[src/datatype/index.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L50) - -## Accessors - -### [kTable] - -• `get` **[kTable]**(): `TTable` - -#### Returns - -`TTable` - -#### Defined in - -[src/datatype/index.d.ts:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L62) - -___ - -### writerCore - -• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> - -#### Returns - -`Hypercore`\<``"binary"``, `Buffer`\> - -#### Defined in - -[src/datatype/index.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L64) - -## Methods - -### [kCreateWithDocId] - -▸ **[kCreateWithDocId]**(`docId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | -| `value` | [`CoreOwnershipWithSignaturesValue`](../modules/types.md#coreownershipwithsignaturesvalue) \| `Exclude`\<`TValue`, \{ `schemaName`: ``"coreOwnership"`` }\> | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L66) - -___ - -### [kSelect] - -▸ **[kSelect]**(): `Promise`\<`any`\> - -#### Returns - -`Promise`\<`any`\> - -#### Defined in - -[src/datatype/index.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L73) - -___ - -### create - -▸ **create**\<`T`\>(`value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L75) - -___ - -### delete - -▸ **delete**(`docId`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L97) - -___ - -### getByDocId - -▸ **getByDocId**(`docId`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L82) - -___ - -### getByVersionId - -▸ **getByVersionId**(`versionId`): `Promise`\<`TDoc`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` | - -#### Returns - -`Promise`\<`TDoc`\> - -#### Defined in - -[src/datatype/index.d.ts:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L84) - -___ - -### getMany - -▸ **getMany**(`opts?`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | `Object` | -| `opts.includeDeleted?` | `boolean` | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> - -#### Defined in - -[src/datatype/index.d.ts:86](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L86) - -___ - -### update - -▸ **update**\<`T`\>(`versionId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` \| `string`[] | -| `value` | `T` | - -#### Returns - -`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L90) diff --git a/docs/api/classes/datatype.DataType.md b/docs/api/classes/datatype.DataType.md deleted file mode 100644 index 326d4be22..000000000 --- a/docs/api/classes/datatype.DataType.md +++ /dev/null @@ -1,280 +0,0 @@ -[API](../README.md) / [datatype](../modules/datatype.md) / DataType - -# Class: DataType\ - -[datatype](../modules/datatype.md).DataType - -## Type parameters - -| Name | -| :------ | -| `TDataStore` | -| `TSchemaName` | -| `TTable` | -| `TDoc` | -| `TValue` | - -## Hierarchy - -- `TypedEmitter` - - ↳ **`DataType`** - -## Table of contents - -### Constructors - -- [constructor](datatype.DataType.md#constructor) - -### Accessors - -- [[kTable]](datatype.DataType.md#[ktable]) -- [writerCore](datatype.DataType.md#writercore) - -### Methods - -- [[kCreateWithDocId]](datatype.DataType.md#[kcreatewithdocid]) -- [[kSelect]](datatype.DataType.md#[kselect]) -- [create](datatype.DataType.md#create) -- [delete](datatype.DataType.md#delete) -- [getByDocId](datatype.DataType.md#getbydocid) -- [getByVersionId](datatype.DataType.md#getbyversionid) -- [getMany](datatype.DataType.md#getmany) -- [update](datatype.DataType.md#update) - -## Constructors - -### constructor - -• **new DataType**\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\>(`opts`): [`DataType`](datatype.DataType.md)\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TDataStore` | extends [`DataStore`](datastore.DataStore.md)\<``"auth"`` \| ``"config"`` \| ``"data"``, ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``\> | -| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` | -| `TTable` | extends \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } \| \{ `_`: \{ `name`: `TSchemaName` } } & `SQLiteTable`\<{}\> & \{ `forks`: `SQLiteColumn`\<{}, `object`\> } | -| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | -| `TValue` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.dataStore` | `TDataStore` | -| `opts.db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | -| `opts.getPermissions` | `undefined` \| () => `any` | -| `opts.table` | `TTable` | - -#### Returns - -[`DataType`](datatype.DataType.md)\<`TDataStore`, `TSchemaName`, `TTable`, `TDoc`, `TValue`\> - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/datatype/index.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L81) - -## Accessors - -### [kTable] - -• `get` **[kTable]**(): `TTable` - -#### Returns - -`TTable` - -#### Defined in - -[src/datatype/index.js:116](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L116) - -___ - -### writerCore - -• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> - -#### Returns - -`Hypercore`\<``"binary"``, `Buffer`\> - -#### Defined in - -[src/datatype/index.js:120](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L120) - -## Methods - -### [kCreateWithDocId] - -▸ **[kCreateWithDocId]**(`docId`, `value`, `opts?`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `docId` | `string` | `undefined` | | -| `value` | [`CoreOwnershipWithSignaturesValue`](../modules/types.md#coreownershipwithsignaturesvalue) \| `TValue` | `undefined` | | -| `opts?` | `Object` | `{}` | only used internally to skip the checkExisting check when creating a document with a random ID (collisions should be too small probability to be worth checking for) | -| `opts.checkExisting?` | `boolean` | `true` | - | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Defined in - -[src/datatype/index.js:139](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L139) - -___ - -### [kSelect] - -▸ **[kSelect]**(): `Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, ``"sync"``, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, ``"single"``, `GetSelectTableName`\<`TTable`\> extends `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, ``"not-null"``\> : {}, ``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"``\> : {}\>\>, ``"then"`` \| ``"catch"`` \| ``"finally"``\> & \{ `catch?`: `undefined` ; `finally?`: `undefined` ; `then?`: `undefined` }\> - -#### Returns - -`Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, ``"sync"``, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, ``"single"``, `GetSelectTableName`\<`TTable`\> extends `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, ``"not-null"``\> : {}, ``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"``\> : {}\>\>, ``"then"`` \| ``"catch"`` \| ``"finally"``\> & \{ `catch?`: `undefined` ; `finally?`: `undefined` ; `then?`: `undefined` }\> - -#### Defined in - -[src/datatype/index.js:242](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L242) - -___ - -### create - -▸ **create**\<`T`\>(`value`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `T` | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Defined in - -[src/datatype/index.js:128](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L128) - -___ - -### delete - -▸ **delete**(`docId`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Defined in - -[src/datatype/index.js:222](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L222) - -___ - -### getByDocId - -▸ **getByDocId**(`docId`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docId` | `string` | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Defined in - -[src/datatype/index.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L175) - -___ - -### getByVersionId - -▸ **getByVersionId**(`versionId`): `Promise`\<`MapeoDoc`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` | - -#### Returns - -`Promise`\<`MapeoDoc`\> - -#### Defined in - -[src/datatype/index.js:183](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L183) - -___ - -### getMany - -▸ **getMany**(`opts?`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in (...)]: (...) }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }[]\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `opts?` | `Object` | `{}` | -| `opts.includeDeleted?` | `boolean` | `false` | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in (...)]: (...) }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }[]\> - -#### Defined in - -[src/datatype/index.js:188](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L188) - -___ - -### update - -▸ **update**\<`T`\>(`versionId`, `value`): `Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `versionId` | `string` \| `string`[] | -| `value` | `T` | - -#### Returns - -`Promise`\<\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string as Filter\]: \{ [K in string]: (...)[(...)] }[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] }\> - -#### Defined in - -[src/datatype/index.js:202](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L202) diff --git a/docs/api/classes/discovery_local_discovery.LocalDiscovery.md b/docs/api/classes/discovery_local_discovery.LocalDiscovery.md deleted file mode 100644 index 47038652d..000000000 --- a/docs/api/classes/discovery_local_discovery.LocalDiscovery.md +++ /dev/null @@ -1,160 +0,0 @@ -[API](../README.md) / [discovery/local-discovery](../modules/discovery_local_discovery.md) / LocalDiscovery - -# Class: LocalDiscovery - -[discovery/local-discovery](../modules/discovery_local_discovery.md).LocalDiscovery - -## Hierarchy - -- `TypedEmitter` - - ↳ **`LocalDiscovery`** - -## Table of contents - -### Constructors - -- [constructor](discovery_local_discovery.LocalDiscovery.md#constructor) - -### Accessors - -- [connections](discovery_local_discovery.LocalDiscovery.md#connections) -- [publicKey](discovery_local_discovery.LocalDiscovery.md#publickey) - -### Methods - -- [address](discovery_local_discovery.LocalDiscovery.md#address) -- [connectPeer](discovery_local_discovery.LocalDiscovery.md#connectpeer) -- [start](discovery_local_discovery.LocalDiscovery.md#start) -- [stop](discovery_local_discovery.LocalDiscovery.md#stop) - -## Constructors - -### constructor - -• **new LocalDiscovery**(`opts`): [`LocalDiscovery`](discovery_local_discovery.LocalDiscovery.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.identityKeypair` | [`Keypair`](../modules/discovery_local_discovery.md#keypair) | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | - -#### Returns - -[`LocalDiscovery`](discovery_local_discovery.LocalDiscovery.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/discovery/local-discovery.js:43](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L43) - -## Accessors - -### connections - -• `get` **connections**(): `IterableIterator`\<[`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)\> - -#### Returns - -`IterableIterator`\<[`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)\> - -#### Defined in - -[src/discovery/local-discovery.js:241](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L241) - -___ - -### publicKey - -• `get` **publicKey**(): `Buffer` - -#### Returns - -`Buffer` - -#### Defined in - -[src/discovery/local-discovery.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L61) - -## Methods - -### address - -▸ **address**(): ``null`` \| `string` \| `AddressInfo` - -#### Returns - -``null`` \| `string` \| `AddressInfo` - -#### Defined in - -[src/discovery/local-discovery.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L65) - -___ - -### connectPeer - -▸ **connectPeer**(`peer`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peer` | `Object` | -| `peer.address` | `string` | -| `peer.name` | `string` | -| `peer.port` | `number` | - -#### Returns - -`void` - -#### Defined in - -[src/discovery/local-discovery.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L90) - -___ - -### start - -▸ **start**(): `Promise`\<\{ `name`: `string` ; `port`: `number` }\> - -#### Returns - -`Promise`\<\{ `name`: `string` ; `port`: `number` }\> - -#### Defined in - -[src/discovery/local-discovery.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L70) - -___ - -### stop - -▸ **stop**(`opts?`): `Promise`\<`void`\> - -Close all servers and stop multicast advertising and browsing. Will wait -for open sockets to close unless opts.force=true in which case open sockets -are force-closed after opts.timeout milliseconds - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts?` | `Object` | | -| `opts.force` | `undefined` \| `boolean` | Force-close open sockets after timeout milliseconds | -| `opts.timeout` | `undefined` \| `number` | Optional timeout when calling stop() with force=true | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/discovery/local-discovery.js:255](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L255) diff --git a/docs/api/classes/icon_api.IconApi.md b/docs/api/classes/icon_api.IconApi.md deleted file mode 100644 index ccb7a9cb8..000000000 --- a/docs/api/classes/icon_api.IconApi.md +++ /dev/null @@ -1,104 +0,0 @@ -[API](../README.md) / [icon-api](../modules/icon_api.md) / IconApi - -# Class: IconApi - -[icon-api](../modules/icon_api.md).IconApi - -## Table of contents - -### Constructors - -- [constructor](icon_api.IconApi.md#constructor) - -### Methods - -- [[kGetIconBlob]](icon_api.IconApi.md#[kgeticonblob]) -- [create](icon_api.IconApi.md#create) -- [getIconUrl](icon_api.IconApi.md#geticonurl) - -## Constructors - -### constructor - -• **new IconApi**(`opts`): [`IconApi`](icon_api.IconApi.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.getMediaBaseUrl` | () => `Promise`\<`string`\> | -| `opts.iconDataStore` | [`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\> | -| `opts.iconDataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | - -#### Returns - -[`IconApi`](icon_api.IconApi.md) - -#### Defined in - -[src/icon-api.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L40) - -## Methods - -### [kGetIconBlob] - -▸ **[kGetIconBlob]**(`iconId`, `opts`): `Promise`\<`Buffer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iconId` | `string` | -| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | - -#### Returns - -`Promise`\<`Buffer`\> - -#### Defined in - -[src/icon-api.js:80](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L80) - -___ - -### create - -▸ **create**(`icon`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `icon` | `Object` | -| `icon.name` | `string` | -| `icon.variants` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/icon-api.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L53) - -___ - -### getIconUrl - -▸ **getIconUrl**(`iconId`, `opts`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iconId` | `string` | -| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/icon-api.js:93](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L93) diff --git a/docs/api/classes/index_writer.IndexWriter.md b/docs/api/classes/index_writer.IndexWriter.md deleted file mode 100644 index f681212b6..000000000 --- a/docs/api/classes/index_writer.IndexWriter.md +++ /dev/null @@ -1,92 +0,0 @@ -[API](../README.md) / [index-writer](../modules/index_writer.md) / IndexWriter - -# Class: IndexWriter\ - -[index-writer](../modules/index_writer.md).IndexWriter - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TTables` | [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | - -## Table of contents - -### Constructors - -- [constructor](index_writer.IndexWriter.md#constructor) - -### Accessors - -- [schemas](index_writer.IndexWriter.md#schemas) - -### Methods - -- [batch](index_writer.IndexWriter.md#batch) - -## Constructors - -### constructor - -• **new IndexWriter**\<`TTables`\>(`opts`): [`IndexWriter`](index_writer.IndexWriter.md)\<`TTables`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTables` | extends [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) = [`MapeoDocTables`](../modules/index_writer.md#mapeodoctables) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.getWinner` | `undefined` \| \(`docA`: `T`, `docB`: `U`) => `T` \| `U` | custom function to determine the "winner" of two forked documents. Defaults to choosing the document with the most recent `updatedAt` | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | | -| `opts.mapDoc` | `undefined` \| (`doc`: `MapeoDocInternal`, `version`: `VersionIdObject`) => `MapeoDoc` | optionally transform a document prior to indexing. Can also validate, if an error is thrown then the document will not be indexed | -| `opts.sqlite` | `Database` | | -| `opts.tables` | `TTables`[] | | - -#### Returns - -[`IndexWriter`](index_writer.IndexWriter.md)\<`TTables`\> - -#### Defined in - -[src/index-writer/index.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L38) - -## Accessors - -### schemas - -• `get` **schemas**(): `TTables`[``"_"``][``"name"``][] - -#### Returns - -`TTables`[``"_"``][``"name"``][] - -#### Defined in - -[src/index-writer/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L55) - -## Methods - -### batch - -▸ **batch**(`entries`): `Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entries` | `Entry`\<``"binary"``\>[] | - -#### Returns - -`Promise`\<[`IndexedDocIds`](../modules/index_writer.md#indexeddocids)\> - -map of indexed docIds by schemaName - -#### Defined in - -[src/index-writer/index.js:63](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L63) diff --git a/docs/api/classes/invite_api.InviteApi.md b/docs/api/classes/invite_api.InviteApi.md deleted file mode 100644 index 59d59ec70..000000000 --- a/docs/api/classes/invite_api.InviteApi.md +++ /dev/null @@ -1,129 +0,0 @@ -[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteApi - -# Class: InviteApi - -[invite-api](../modules/invite_api.md).InviteApi - -## Hierarchy - -- `TypedEmitter` - - ↳ **`InviteApi`** - -## Table of contents - -### Constructors - -- [constructor](invite_api.InviteApi.md#constructor) - -### Properties - -- [rpc](invite_api.InviteApi.md#rpc) - -### Methods - -- [accept](invite_api.InviteApi.md#accept) -- [getPending](invite_api.InviteApi.md#getpending) -- [reject](invite_api.InviteApi.md#reject) - -## Constructors - -### constructor - -• **new InviteApi**(`options`): [`InviteApi`](invite_api.InviteApi.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.logger` | `undefined` \| [`Logger`](logger.Logger.md) | -| `options.queries` | `Object` | -| `options.queries.addProject` | (`projectDetails`: `Pick`\<[`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` }) => `Promise`\<`unknown`\> | -| `options.queries.isMember` | (`projectId`: `string`) => `boolean` | -| `options.rpc` | [`LocalPeers`](local_peers.LocalPeers.md) | - -#### Returns - -[`InviteApi`](invite_api.InviteApi.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/invite-api.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L175) - -## Properties - -### rpc - -• **rpc**: [`LocalPeers`](local_peers.LocalPeers.md) - -#### Defined in - -[src/invite-api.js:180](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L180) - -## Methods - -### accept - -▸ **accept**(`invite`): `Promise`\<`string`\> - -Attempt to accept the invite. - -This can fail if the invitor has canceled the invite or if you cannot -connect to the invitor's device. - -If the invite is accepted and you had other invites to the same project, -those invites are removed, and the invitors are told that you're already -part of this project. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `invite` | `Pick`\<[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, ``"inviteId"``\> | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/invite-api.js:286](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L286) - -___ - -### getPending - -▸ **getPending**(): [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>[] - -#### Returns - -[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>[] - -#### Defined in - -[src/invite-api.js:267](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L267) - -___ - -### reject - -▸ **reject**(`invite`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `invite` | `Pick`\<[`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, ``"inviteId"``\> | - -#### Returns - -`void` - -#### Defined in - -[src/invite-api.js:416](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L416) diff --git a/docs/api/classes/lib_hashmap.default.md b/docs/api/classes/lib_hashmap.default.md deleted file mode 100644 index 507eaebfa..000000000 --- a/docs/api/classes/lib_hashmap.default.md +++ /dev/null @@ -1,197 +0,0 @@ -[API](../README.md) / [lib/hashmap](../modules/lib_hashmap.md) / default - -# Class: default\ - -[lib/hashmap](../modules/lib_hashmap.md).default - -`Map` uses same-value-zero equality for keys, which makes it more difficult -to use reference types like buffers. - -`HashMap` is very similar to `Map`, but accepts a hash function for keys. -This function should return a primitive, such as a number or string, which -will be used as the key. - -It doesn't contain all the functionality of `Map` because we don't need it, -but it should be fairly easy to update as needed. - -**`Example`** - -```ts -const join = (arr) => arr.join(' ') - -const map = new HashMap(join) - -map.set([1, 2], 3) -map.get([1, 2]) -// => 3 -``` - -## Type parameters - -| Name | -| :------ | -| `K` | -| `V` | - -## Table of contents - -### Constructors - -- [constructor](lib_hashmap.default.md#constructor) - -### Accessors - -- [size](lib_hashmap.default.md#size) - -### Methods - -- [delete](lib_hashmap.default.md#delete) -- [get](lib_hashmap.default.md#get) -- [has](lib_hashmap.default.md#has) -- [set](lib_hashmap.default.md#set) -- [values](lib_hashmap.default.md#values) - -## Constructors - -### constructor - -• **new default**\<`K`, `V`\>(`hash`, `iterable?`): [`default`](lib_hashmap.default.md)\<`K`, `V`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | `K` | -| `V` | extends `unknown` | - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `hash` | (`key`: `K`) => [`Primitive`](../modules/lib_hashmap.md#primitive) | `undefined` | -| `iterable?` | `Iterable`\<[`K`, `V`]\> | `[]` | - -#### Returns - -[`default`](lib_hashmap.default.md)\<`K`, `V`\> - -#### Defined in - -[src/lib/hashmap.js:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L37) - -## Accessors - -### size - -• `get` **size**(): `number` - -#### Returns - -`number` - -#### Defined in - -[src/lib/hashmap.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L45) - -## Methods - -### delete - -▸ **delete**(`key`): `boolean` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `K` | The key to remove. | - -#### Returns - -`boolean` - -`true` if the key was present and removed, `false` otherwise. - -#### Defined in - -[src/lib/hashmap.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L53) - -___ - -### get - -▸ **get**(`key`): `undefined` \| `V` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `K` | The key to look up. | - -#### Returns - -`undefined` \| `V` - -The element associated with `key`, or `undefined` if it's not present. - -#### Defined in - -[src/lib/hashmap.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L62) - -___ - -### has - -▸ **has**(`key`): `boolean` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `K` | The key to look up. | - -#### Returns - -`boolean` - -`true` if `key` is present in the map, `false` otherwise. - -#### Defined in - -[src/lib/hashmap.js:71](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L71) - -___ - -### set - -▸ **set**(`key`, `value`): [`default`](lib_hashmap.default.md)\<`K`, `V`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `K` | The key to update. | -| `value` | `V` | The value to add at `key`. | - -#### Returns - -[`default`](lib_hashmap.default.md)\<`K`, `V`\> - -The map. - -#### Defined in - -[src/lib/hashmap.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L81) - -___ - -### values - -▸ **values**(): `IterableIterator`\<`V`\> - -#### Returns - -`IterableIterator`\<`V`\> - -#### Defined in - -[src/lib/hashmap.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L90) diff --git a/docs/api/classes/local_peers.LocalPeers.md b/docs/api/classes/local_peers.LocalPeers.md deleted file mode 100644 index ccbb72418..000000000 --- a/docs/api/classes/local_peers.LocalPeers.md +++ /dev/null @@ -1,198 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / LocalPeers - -# Class: LocalPeers - -[local-peers](../modules/local_peers.md).LocalPeers - -## Hierarchy - -- `TypedEmitter` - - ↳ **`LocalPeers`** - -## Table of contents - -### Constructors - -- [constructor](local_peers.LocalPeers.md#constructor) - -### Accessors - -- [peers](local_peers.LocalPeers.md#peers) - -### Methods - -- [connect](local_peers.LocalPeers.md#connect) -- [sendDeviceInfo](local_peers.LocalPeers.md#senddeviceinfo) -- [sendInvite](local_peers.LocalPeers.md#sendinvite) -- [sendInviteCancel](local_peers.LocalPeers.md#sendinvitecancel) -- [sendInviteResponse](local_peers.LocalPeers.md#sendinviteresponse) -- [sendProjectJoinDetails](local_peers.LocalPeers.md#sendprojectjoindetails) - -## Constructors - -### constructor - -• **new LocalPeers**(`opts?`): [`LocalPeers`](local_peers.LocalPeers.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts?` | `Object` | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | - -#### Returns - -[`LocalPeers`](local_peers.LocalPeers.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/local-peers.js:236](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L236) - -## Accessors - -### peers - -• `get` **peers**(): ([`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] - -#### Returns - -([`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] - -#### Defined in - -[src/local-peers.js:241](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L241) - -## Methods - -### connect - -▸ **connect**(`stream`): [`ReplicationStream`](../modules/types.md#replicationstream) - -Connect to a peer over an existing NoiseSecretStream - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `stream` | `NoiseSecretStream`\<`any`\> | a NoiseSecretStream from @hyperswarm/secret-stream | - -#### Returns - -[`ReplicationStream`](../modules/types.md#replicationstream) - -#### Defined in - -[src/local-peers.js:310](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L310) - -___ - -### sendDeviceInfo - -▸ **sendDeviceInfo**(`deviceId`, `deviceInfo`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deviceId` | `string` | id of the peer you want to send to (publicKey of peer as hex string) | -| `deviceInfo` | [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | device info to send | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:298](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L298) - -___ - -### sendInvite - -▸ **sendInvite**(`deviceId`, `invite`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `invite` | [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:254](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L254) - -___ - -### sendInviteCancel - -▸ **sendInviteCancel**(`deviceId`, `inviteCancel`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `inviteCancel` | [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:265](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L265) - -___ - -### sendInviteResponse - -▸ **sendInviteResponse**(`deviceId`, `inviteResponse`): `Promise`\<`void`\> - -Respond to an invite from a peer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deviceId` | `string` | id of the peer you want to respond to (publicKey of peer as hex string) | -| `inviteResponse` | [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:277](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L277) - -___ - -### sendProjectJoinDetails - -▸ **sendProjectJoinDetails**(`deviceId`, `details`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `details` | [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:287](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L287) diff --git a/docs/api/classes/local_peers.PeerDisconnectedError.md b/docs/api/classes/local_peers.PeerDisconnectedError.md deleted file mode 100644 index e26b271b1..000000000 --- a/docs/api/classes/local_peers.PeerDisconnectedError.md +++ /dev/null @@ -1,59 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerDisconnectedError - -# Class: PeerDisconnectedError - -[local-peers](../modules/local_peers.md).PeerDisconnectedError - -## Hierarchy - -- `Error` - - ↳ **`PeerDisconnectedError`** - -## Table of contents - -### Constructors - -- [constructor](local_peers.PeerDisconnectedError.md#constructor) - -### Properties - -- [name](local_peers.PeerDisconnectedError.md#name) - -## Constructors - -### constructor - -• **new PeerDisconnectedError**(`message?`): [`PeerDisconnectedError`](local_peers.PeerDisconnectedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`PeerDisconnectedError`](local_peers.PeerDisconnectedError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/local-peers.js:597](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L597) - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -[src/local-peers.js:599](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L599) diff --git a/docs/api/classes/local_peers.PeerFailedConnectionError.md b/docs/api/classes/local_peers.PeerFailedConnectionError.md deleted file mode 100644 index 4ceae4883..000000000 --- a/docs/api/classes/local_peers.PeerFailedConnectionError.md +++ /dev/null @@ -1,59 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerFailedConnectionError - -# Class: PeerFailedConnectionError - -[local-peers](../modules/local_peers.md).PeerFailedConnectionError - -## Hierarchy - -- `Error` - - ↳ **`PeerFailedConnectionError`** - -## Table of contents - -### Constructors - -- [constructor](local_peers.PeerFailedConnectionError.md#constructor) - -### Properties - -- [name](local_peers.PeerFailedConnectionError.md#name) - -## Constructors - -### constructor - -• **new PeerFailedConnectionError**(`message?`): [`PeerFailedConnectionError`](local_peers.PeerFailedConnectionError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`PeerFailedConnectionError`](local_peers.PeerFailedConnectionError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/local-peers.js:605](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L605) - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -[src/local-peers.js:607](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L607) diff --git a/docs/api/classes/local_peers.UnknownPeerError.md b/docs/api/classes/local_peers.UnknownPeerError.md deleted file mode 100644 index 838a8e68f..000000000 --- a/docs/api/classes/local_peers.UnknownPeerError.md +++ /dev/null @@ -1,59 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / UnknownPeerError - -# Class: UnknownPeerError - -[local-peers](../modules/local_peers.md).UnknownPeerError - -## Hierarchy - -- `Error` - - ↳ **`UnknownPeerError`** - -## Table of contents - -### Constructors - -- [constructor](local_peers.UnknownPeerError.md#constructor) - -### Properties - -- [name](local_peers.UnknownPeerError.md#name) - -## Constructors - -### constructor - -• **new UnknownPeerError**(`message?`): [`UnknownPeerError`](local_peers.UnknownPeerError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`UnknownPeerError`](local_peers.UnknownPeerError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/local-peers.js:589](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L589) - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -[src/local-peers.js:591](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L591) diff --git a/docs/api/classes/logger.Logger.md b/docs/api/classes/logger.Logger.md deleted file mode 100644 index 08fcf6a19..000000000 --- a/docs/api/classes/logger.Logger.md +++ /dev/null @@ -1,133 +0,0 @@ -[API](../README.md) / [logger](../modules/logger.md) / Logger - -# Class: Logger - -[logger](../modules/logger.md).Logger - -## Table of contents - -### Constructors - -- [constructor](logger.Logger.md#constructor) - -### Properties - -- [deviceId](logger.Logger.md#deviceid) - -### Accessors - -- [enabled](logger.Logger.md#enabled) - -### Methods - -- [extend](logger.Logger.md#extend) -- [log](logger.Logger.md#log) -- [create](logger.Logger.md#create) - -## Constructors - -### constructor - -• **new Logger**(`opts`): [`Logger`](logger.Logger.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.baseLogger` | `undefined` \| `Debugger` | -| `opts.deviceId` | `string` | -| `opts.ns` | `undefined` \| `string` | - -#### Returns - -[`Logger`](logger.Logger.md) - -#### Defined in - -[src/logger.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L72) - -## Properties - -### deviceId - -• **deviceId**: `string` - -#### Defined in - -[src/logger.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L73) - -## Accessors - -### enabled - -• `get` **enabled**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/logger.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L77) - -## Methods - -### extend - -▸ **extend**(`ns`): [`Logger`](logger.Logger.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ns` | `string` | - -#### Returns - -[`Logger`](logger.Logger.md) - -#### Defined in - -[src/logger.js:91](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L91) - -___ - -### log - -▸ **log**(`...args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [formatter: any, ...args: any[]] | - -#### Returns - -`void` - -#### Defined in - -[src/logger.js:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L84) - -___ - -### create - -▸ **create**(`ns`, `logger?`): [`Logger`](logger.Logger.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ns` | `string` | -| `logger?` | [`Logger`](logger.Logger.md) | - -#### Returns - -[`Logger`](logger.Logger.md) - -#### Defined in - -[src/logger.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/logger.js#L59) diff --git a/docs/api/classes/mapeo_project.MapeoProject.md b/docs/api/classes/mapeo_project.MapeoProject.md deleted file mode 100644 index c82aeebf4..000000000 --- a/docs/api/classes/mapeo_project.MapeoProject.md +++ /dev/null @@ -1,449 +0,0 @@ -[API](../README.md) / [mapeo-project](../modules/mapeo_project.md) / MapeoProject - -# Class: MapeoProject - -[mapeo-project](../modules/mapeo_project.md).MapeoProject - -## Hierarchy - -- `TypedEmitter` - - ↳ **`MapeoProject`** - -## Table of contents - -### Constructors - -- [constructor](mapeo_project.MapeoProject.md#constructor) - -### Properties - -- [$blobs](mapeo_project.MapeoProject.md#$blobs) -- [EMPTY\_PROJECT\_SETTINGS](mapeo_project.MapeoProject.md#empty_project_settings) - -### Accessors - -- [$icons](mapeo_project.MapeoProject.md#$icons) -- [$member](mapeo_project.MapeoProject.md#$member) -- [$sync](mapeo_project.MapeoProject.md#$sync) -- [[kBlobStore]](mapeo_project.MapeoProject.md#[kblobstore]) -- [[kCoreManager]](mapeo_project.MapeoProject.md#[kcoremanager]) -- [[kCoreOwnership]](mapeo_project.MapeoProject.md#[kcoreownership]) -- [[kDataTypes]](mapeo_project.MapeoProject.md#[kdatatypes]) -- [deviceId](mapeo_project.MapeoProject.md#deviceid) -- [field](mapeo_project.MapeoProject.md#field) -- [observation](mapeo_project.MapeoProject.md#observation) -- [preset](mapeo_project.MapeoProject.md#preset) -- [track](mapeo_project.MapeoProject.md#track) - -### Methods - -- [$getOwnRole](mapeo_project.MapeoProject.md#$getownrole) -- [$getProjectSettings](mapeo_project.MapeoProject.md#$getprojectsettings) -- [$setProjectSettings](mapeo_project.MapeoProject.md#$setprojectsettings) -- [[kProjectLeave]](mapeo_project.MapeoProject.md#[kprojectleave]) -- [[kProjectReplicate]](mapeo_project.MapeoProject.md#[kprojectreplicate]) -- [[kSetOwnDeviceInfo]](mapeo_project.MapeoProject.md#[ksetowndeviceinfo]) -- [close](mapeo_project.MapeoProject.md#close) -- [importConfig](mapeo_project.MapeoProject.md#importconfig) -- [ready](mapeo_project.MapeoProject.md#ready) - -## Constructors - -### constructor - -• **new MapeoProject**(`opts`): [`MapeoProject`](mapeo_project.MapeoProject.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.coreStorage` | [`CoreStorage`](../modules/types.md#corestorage) | Folder to store all hypercore data | -| `opts.dbPath` | `string` | Path to store project sqlite db. Use `:memory:` for memory storage | -| `opts.encryptionKeys` | [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | Encryption keys for each namespace | -| `opts.getMediaBaseUrl` | (`mediaType`: ``"blobs"`` \| ``"icons"``) => `Promise`\<`string`\> | | -| `opts.keyManager` | `KeyManager` | mapeo/crypto KeyManager instance | -| `opts.localPeers` | [`LocalPeers`](local_peers.LocalPeers.md) | | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | | -| `opts.projectKey` | `Buffer` | 32-byte public key of the project creator core | -| `opts.projectMigrationsFolder` | `string` | path for drizzle migration folder for project | -| `opts.projectSecretKey` | `undefined` \| `Buffer` | 32-byte secret key of the project creator core | -| `opts.sharedDb` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | | -| `opts.sharedIndexWriter` | [`IndexWriter`](index_writer.IndexWriter.md)\<[`MapeoDocTables`](../modules/index_writer.md#mapeodoctables)\> | | - -#### Returns - -[`MapeoProject`](mapeo_project.MapeoProject.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/mapeo-project.js:103](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L103) - -## Properties - -### $blobs - -• **$blobs**: [`BlobApi`](blob_api.BlobApi.md) - -#### Defined in - -[src/mapeo-project.js:284](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L284) - -___ - -### EMPTY\_PROJECT\_SETTINGS - -▪ `Static` **EMPTY\_PROJECT\_SETTINGS**: `Readonly`\<{}\> = `EMPTY_PROJECT_SETTINGS` - -#### Defined in - -[src/mapeo-project.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L85) - -## Accessors - -### $icons - -• `get` **$icons**(): [`IconApi`](icon_api.IconApi.md) - -#### Returns - -[`IconApi`](icon_api.IconApi.md) - -#### Defined in - -[src/mapeo-project.js:566](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L566) - -___ - -### $member - -• `get` **$member**(): [`MemberApi`](member_api.MemberApi.md) - -#### Returns - -[`MemberApi`](member_api.MemberApi.md) - -#### Defined in - -[src/mapeo-project.js:453](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L453) - -___ - -### $sync - -• `get` **$sync**(): [`SyncApi`](sync_sync_api.SyncApi.md) - -#### Returns - -[`SyncApi`](sync_sync_api.SyncApi.md) - -#### Defined in - -[src/mapeo-project.js:457](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L457) - -___ - -### [kBlobStore] - -• `get` **[kBlobStore]**(): [`BlobStore`](blob_store.BlobStore.md) - -#### Returns - -[`BlobStore`](blob_store.BlobStore.md) - -#### Defined in - -[src/mapeo-project.js:373](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L373) - -___ - -### [kCoreManager] - -• `get` **[kCoreManager]**(): [`CoreManager`](core_manager.CoreManager.md) - -CoreManager instance, used for tests - -#### Returns - -[`CoreManager`](core_manager.CoreManager.md) - -#### Defined in - -[src/mapeo-project.js:355](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L355) - -___ - -### [kCoreOwnership] - -• `get` **[kCoreOwnership]**(): [`CoreOwnership`](core_ownership.CoreOwnership.md) - -CoreOwnership instance, used for tests - -#### Returns - -[`CoreOwnership`](core_ownership.CoreOwnership.md) - -#### Defined in - -[src/mapeo-project.js:362](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L362) - -___ - -### [kDataTypes] - -• `get` **[kDataTypes]**(): `Object` - -DataTypes object mappings, used for tests - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `coreOwnership` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | -| `deviceInfo` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\> | -| `field` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> | -| `icon` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | -| `observation` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> | -| `preset` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> | -| `projectSettings` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\> | -| `role` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | -| `track` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> | - -#### Defined in - -[src/mapeo-project.js:369](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L369) - -___ - -### deviceId - -• `get` **deviceId**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/mapeo-project.js:377](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L377) - -___ - -### field - -• `get` **field**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> - -#### Returns - -[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> - -#### Defined in - -[src/mapeo-project.js:449](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L449) - -___ - -### observation - -• `get` **observation**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> - -#### Returns - -[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> - -#### Defined in - -[src/mapeo-project.js:440](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L440) - -___ - -### preset - -• `get` **preset**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> - -#### Returns - -[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> - -#### Defined in - -[src/mapeo-project.js:446](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L446) - -___ - -### track - -• `get` **track**(): [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> - -#### Returns - -[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> - -#### Defined in - -[src/mapeo-project.js:443](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L443) - -## Methods - -### $getOwnRole - -▸ **$getOwnRole**(): `Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> - -#### Returns - -`Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> - -#### Defined in - -[src/mapeo-project.js:508](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L508) - -___ - -### $getProjectSettings - -▸ **$getProjectSettings**(): `Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> - -#### Returns - -`Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> - -#### Defined in - -[src/mapeo-project.js:497](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L497) - -___ - -### $setProjectSettings - -▸ **$setProjectSettings**(`settings`): `Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `settings` | `Partial`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> | - -#### Returns - -`Promise`\<[`EditableProjectSettings`](../modules/mapeo_project.md#editableprojectsettings)\> - -#### Defined in - -[src/mapeo-project.js:465](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L465) - -___ - -### [kProjectLeave] - -▸ **[kProjectLeave]**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/mapeo-project.js:570](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L570) - -___ - -### [kProjectReplicate] - -▸ **[kProjectReplicate]**(`stream`): `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> - -Replicate a project to a @hyperswarm/secret-stream. Invites will not -function because the RPC channel is not connected for project replication, -and only this project will replicate (to replicate multiple projects you -need to replicate the manager instance via manager[kManagerReplicate]) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `stream` | `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | A duplex stream, a @hyperswarm/secret-stream, or a Protomux instance | - -#### Returns - -`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & `Protomux`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> - -#### Defined in - -[src/mapeo-project.js:521](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L521) - -___ - -### [kSetOwnDeviceInfo] - -▸ **[kSetOwnDeviceInfo]**(`value`): `Promise`\<{}\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `Pick`\<{}, ``"name"`` \| ``"deviceType"``\> | - -#### Returns - -`Promise`\<{}\> - -#### Defined in - -[src/mapeo-project.js:540](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L540) - -___ - -### close - -▸ **close**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/mapeo-project.js:390](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L390) - -___ - -### importConfig - -▸ **importConfig**(`opts`): `Promise`\<`Error`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.configPath` | `string` | - -#### Returns - -`Promise`\<`Error`[]\> - -#### Defined in - -[src/mapeo-project.js:651](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L651) - -___ - -### ready - -▸ **ready**(): `Promise`\<`void`\> - -Resolves when hypercores have all loaded - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/mapeo-project.js:384](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L384) diff --git a/docs/api/classes/member_api.MemberApi.md b/docs/api/classes/member_api.MemberApi.md deleted file mode 100644 index 716f3cd75..000000000 --- a/docs/api/classes/member_api.MemberApi.md +++ /dev/null @@ -1,164 +0,0 @@ -[API](../README.md) / [member-api](../modules/member_api.md) / MemberApi - -# Class: MemberApi - -[member-api](../modules/member_api.md).MemberApi - -## Hierarchy - -- `TypedEmitter` - - ↳ **`MemberApi`** - -## Table of contents - -### Constructors - -- [constructor](member_api.MemberApi.md#constructor) - -### Methods - -- [assignRole](member_api.MemberApi.md#assignrole) -- [getById](member_api.MemberApi.md#getbyid) -- [getMany](member_api.MemberApi.md#getmany) -- [invite](member_api.MemberApi.md#invite) -- [requestCancelInvite](member_api.MemberApi.md#requestcancelinvite) - -## Constructors - -### constructor - -• **new MemberApi**(`opts`): [`MemberApi`](member_api.MemberApi.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.coreOwnership` | [`CoreOwnership`](core_ownership.CoreOwnership.md) | | -| `opts.dataTypes` | `Object` | | -| `opts.dataTypes.deviceInfo` | `Pick`\<[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\>, ``"getByDocId"`` \| ``"getMany"``\> | - | -| `opts.dataTypes.project` | `Pick`\<[`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\>, ``"getByDocId"``\> | - | -| `opts.deviceId` | `string` | public key of this device as hex string | -| `opts.encryptionKeys` | [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | | -| `opts.projectKey` | `Buffer` | | -| `opts.roles` | [`Roles`](roles.Roles.md) | | -| `opts.rpc` | [`LocalPeers`](local_peers.LocalPeers.md) | | - -#### Returns - -[`MemberApi`](member_api.MemberApi.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/member-api.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L59) - -## Methods - -### assignRole - -▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/member-api.js:308](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L308) - -___ - -### getById - -▸ **getById**(`deviceId`): `Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)\> - -#### Defined in - -[src/member-api.js:239](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L239) - -___ - -### getMany - -▸ **getMany**(): `Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)[]\> - -#### Returns - -`Promise`\<[`MemberInfo`](../interfaces/member_api.MemberInfo.md)[]\> - -#### Defined in - -[src/member-api.js:269](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L269) - -___ - -### invite - -▸ **invite**(`deviceId`, `opts`): `Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> - -Send an invite. Resolves when receiving a response. Rejects if the invite -is canceled, or if something else goes wrong. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `opts` | `Object` | -| `opts.roleDescription` | `undefined` \| `string` | -| `opts.roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | -| `opts.roleName` | `undefined` \| `string` | - -#### Returns - -`Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> - -#### Defined in - -[src/member-api.js:93](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L93) - -___ - -### requestCancelInvite - -▸ **requestCancelInvite**(`deviceId`): `void` - -Attempt to cancel an outbound invite, if it exists. - -No-op if we weren't inviting this device. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/member-api.js:231](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L231) diff --git a/docs/api/classes/roles.Roles.md b/docs/api/classes/roles.Roles.md deleted file mode 100644 index 9617f7db5..000000000 --- a/docs/api/classes/roles.Roles.md +++ /dev/null @@ -1,125 +0,0 @@ -[API](../README.md) / [roles](../modules/roles.md) / Roles - -# Class: Roles - -[roles](../modules/roles.md).Roles - -## Table of contents - -### Constructors - -- [constructor](roles.Roles.md#constructor) - -### Properties - -- [NO\_ROLE](roles.Roles.md#no_role) - -### Methods - -- [assignRole](roles.Roles.md#assignrole) -- [getAll](roles.Roles.md#getall) -- [getRole](roles.Roles.md#getrole) - -## Constructors - -### constructor - -• **new Roles**(`opts`): [`Roles`](roles.Roles.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | | -| `opts.coreOwnership` | [`CoreOwnership`](core_ownership.CoreOwnership.md) | | -| `opts.dataType` | [`DataType`](datatype-1.DataType.md)\<[`DataStore`](datastore.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | | -| `opts.deviceKey` | `Buffer` | public key of this device | -| `opts.projectKey` | `Buffer` | | - -#### Returns - -[`Roles`](roles.Roles.md) - -#### Defined in - -[src/roles.js:240](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L240) - -## Properties - -### NO\_ROLE - -▪ `Static` **NO\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> = `NO_ROLE` - -#### Defined in - -[src/roles.js:223](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L223) - -## Methods - -### assignRole - -▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> - -Assign a role to the specified `deviceId`. Devices without an assigned role -are unable to sync, except the project creator who can do anything. Only -the project creator can assign their own role. Will throw if the device's -role cannot assign the role by consulting `roleAssignment`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | -| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/roles.js:332](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L332) - -___ - -### getAll - -▸ **getAll**(): `Promise`\<`Map`\<`string`, [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> - -Get roles of all devices in the project. For your own device, if you have -not yet synced your own role record, the "no role" capabilties is -returned. The project creator will have the creator role unless a -different one has been assigned. - -#### Returns - -`Promise`\<`Map`\<`string`, [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> - -Map of deviceId to Role - -#### Defined in - -[src/roles.js:285](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L285) - -___ - -### getRole - -▸ **getRole**(`deviceId`): `Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> - -Get the role for device `deviceId`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deviceId` | `string` | - -#### Returns - -`Promise`\<[`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> - -#### Defined in - -[src/roles.js:254](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L254) diff --git a/docs/api/classes/sync_core_sync_state.CoreSyncState.md b/docs/api/classes/sync_core_sync_state.CoreSyncState.md deleted file mode 100644 index bbd49f6ce..000000000 --- a/docs/api/classes/sync_core_sync_state.CoreSyncState.md +++ /dev/null @@ -1,166 +0,0 @@ -[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / CoreSyncState - -# Class: CoreSyncState - -[sync/core-sync-state](../modules/sync_core_sync_state.md).CoreSyncState - -Track sync state for a core identified by `discoveryId`. Can start tracking -state before the core instance exists locally, via the "preHave" messages -received over the project creator core. - -Because deriving the state is expensive (it iterates through the bitfields of -all peers), this is designed to be pull-based: the onUpdate event signals -that the state is updated, but does not pass the state. The consumer can -"pull" the state when it wants it via `coreSyncState.getState()`. - -Each peer (including the local peer) has a state of: - 1. `have` - number of blocks the peer has locally - 2. `want` - number of blocks the peer wants, and at least one peer has - 3. `wanted` - number of blocks the peer has that at least one peer wants - 4. `missing` - number of blocks the peer wants but no peer has - -## Table of contents - -### Constructors - -- [constructor](sync_core_sync_state.CoreSyncState.md#constructor) - -### Methods - -- [addPeer](sync_core_sync_state.CoreSyncState.md#addpeer) -- [attachCore](sync_core_sync_state.CoreSyncState.md#attachcore) -- [getState](sync_core_sync_state.CoreSyncState.md#getstate) -- [insertPreHaves](sync_core_sync_state.CoreSyncState.md#insertprehaves) -- [setPeerWants](sync_core_sync_state.CoreSyncState.md#setpeerwants) - -## Constructors - -### constructor - -• **new CoreSyncState**(`opts`): [`CoreSyncState`](sync_core_sync_state.CoreSyncState.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | -| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | -| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | | - -#### Returns - -[`CoreSyncState`](sync_core_sync_state.CoreSyncState.md) - -#### Defined in - -[src/sync/core-sync-state.js:74](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L74) - -## Methods - -### addPeer - -▸ **addPeer**(`peerId`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/sync/core-sync-state.js:176](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L176) - -___ - -### attachCore - -▸ **attachCore**(`core`): `void` - -Attach a core. The sync state can be initialized without a core instance, -because we could receive peer want and have states via extension messages -before we have the core key that allows us to create a core instance. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `core` | `Hypercore`\<``"binary"``, `Buffer`\> | - -#### Returns - -`void` - -#### Defined in - -[src/sync/core-sync-state.js:105](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L105) - -___ - -### getState - -▸ **getState**(): [`DerivedState`](../interfaces/sync_core_sync_state.DerivedState.md) - -#### Returns - -[`DerivedState`](../interfaces/sync_core_sync_state.DerivedState.md) - -#### Defined in - -[src/sync/core-sync-state.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L85) - -___ - -### insertPreHaves - -▸ **insertPreHaves**(`peerId`, `start`, `bitfield`): `void` - -Add a pre-emptive "have" bitfield for a peer. This is used when we receive -a peer "have" via extension message - it allows us to have a state for the -peer before the peer actually starts syncing this core - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `start` | `number` | -| `bitfield` | `Uint32Array` | - -#### Returns - -`void` - -#### Defined in - -[src/sync/core-sync-state.js:147](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L147) - -___ - -### setPeerWants - -▸ **setPeerWants**(`peerId`, `ranges`): `void` - -Add a ranges of wanted blocks for a peer. By default a peer wants all -blocks in a core - calling this will change the peer to only want the -blocks/ranges that are added here - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `ranges` | \{ `length`: `number` ; `start`: `number` }[] | - -#### Returns - -`void` - -#### Defined in - -[src/sync/core-sync-state.js:165](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L165) diff --git a/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md b/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md deleted file mode 100644 index 052c53ea2..000000000 --- a/docs/api/classes/sync_namespace_sync_state.NamespaceSyncState.md +++ /dev/null @@ -1,104 +0,0 @@ -[API](../README.md) / [sync/namespace-sync-state](../modules/sync_namespace_sync_state.md) / NamespaceSyncState - -# Class: NamespaceSyncState\ - -[sync/namespace-sync-state](../modules/sync_namespace_sync_state.md).NamespaceSyncState - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | [`core-manager`](../modules/core_manager.md) | - -## Table of contents - -### Constructors - -- [constructor](sync_namespace_sync_state.NamespaceSyncState.md#constructor) - -### Accessors - -- [namespace](sync_namespace_sync_state.NamespaceSyncState.md#namespace) - -### Methods - -- [addPeer](sync_namespace_sync_state.NamespaceSyncState.md#addpeer) -- [getState](sync_namespace_sync_state.NamespaceSyncState.md#getstate) - -## Constructors - -### constructor - -• **new NamespaceSyncState**\<`TNamespace`\>(`opts`): [`NamespaceSyncState`](sync_namespace_sync_state.NamespaceSyncState.md)\<`TNamespace`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | extends ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` = ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | | -| `opts.namespace` | `TNamespace` | | -| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | -| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | | - -#### Returns - -[`NamespaceSyncState`](sync_namespace_sync_state.NamespaceSyncState.md)\<`TNamespace`\> - -#### Defined in - -[src/sync/namespace-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L28) - -## Accessors - -### namespace - -• `get` **namespace**(): `TNamespace` - -#### Returns - -`TNamespace` - -#### Defined in - -[src/sync/namespace-sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L53) - -## Methods - -### addPeer - -▸ **addPeer**(`peerId`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/sync/namespace-sync-state.js:90](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L90) - -___ - -### getState - -▸ **getState**(): [`SyncState`](../modules/sync_namespace_sync_state.md#syncstate) - -#### Returns - -[`SyncState`](../modules/sync_namespace_sync_state.md#syncstate) - -#### Defined in - -[src/sync/namespace-sync-state.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L58) diff --git a/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md b/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md deleted file mode 100644 index 0b8c96ead..000000000 --- a/docs/api/classes/sync_peer_sync_controller.PeerSyncController.md +++ /dev/null @@ -1,145 +0,0 @@ -[API](../README.md) / [sync/peer-sync-controller](../modules/sync_peer_sync_controller.md) / PeerSyncController - -# Class: PeerSyncController - -[sync/peer-sync-controller](../modules/sync_peer_sync_controller.md).PeerSyncController - -## Table of contents - -### Constructors - -- [constructor](sync_peer_sync_controller.PeerSyncController.md#constructor) - -### Accessors - -- [peerId](sync_peer_sync_controller.PeerSyncController.md#peerid) -- [peerKey](sync_peer_sync_controller.PeerSyncController.md#peerkey) -- [syncCapability](sync_peer_sync_controller.PeerSyncController.md#synccapability) - -### Methods - -- [disableDataSync](sync_peer_sync_controller.PeerSyncController.md#disabledatasync) -- [enableDataSync](sync_peer_sync_controller.PeerSyncController.md#enabledatasync) -- [handleDiscoveryKey](sync_peer_sync_controller.PeerSyncController.md#handlediscoverykey) - -## Constructors - -### constructor - -• **new PeerSyncController**(`opts`): [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | -| `opts.protomux` | `Protomux`\<[`OpenedNoiseStream`](../modules/utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | -| `opts.roles` | [`Roles`](roles.Roles.md) | -| `opts.syncState` | [`SyncState`](sync_sync_state.SyncState.md) | - -#### Returns - -[`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md) - -#### Defined in - -[src/sync/peer-sync-controller.js:47](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L47) - -## Accessors - -### peerId - -• `get` **peerId**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/sync/peer-sync-controller.js:74](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L74) - -___ - -### peerKey - -• `get` **peerKey**(): `Buffer` - -#### Returns - -`Buffer` - -#### Defined in - -[src/sync/peer-sync-controller.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L70) - -___ - -### syncCapability - -• `get` **syncCapability**(): `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/sync_peer_sync_controller.md#synccapability)\> - -#### Returns - -`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/sync_peer_sync_controller.md#synccapability)\> - -#### Defined in - -[src/sync/peer-sync-controller.js:78](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L78) - -## Methods - -### disableDataSync - -▸ **disableDataSync**(): `void` - -Disable syncing of data (in the data and blob namespaces). - -Syncing of metadata (auth, config and blobIndex namespaces) will continue -in the background without user interaction. - -#### Returns - -`void` - -#### Defined in - -[src/sync/peer-sync-controller.js:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L96) - -___ - -### enableDataSync - -▸ **enableDataSync**(): `void` - -Enable syncing of data (in the data and blob namespaces) - -#### Returns - -`void` - -#### Defined in - -[src/sync/peer-sync-controller.js:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L85) - -___ - -### handleDiscoveryKey - -▸ **handleDiscoveryKey**(`discoveryKey`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discoveryKey` | `Buffer` | - -#### Returns - -`void` - -#### Defined in - -[src/sync/peer-sync-controller.js:104](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L104) diff --git a/docs/api/classes/sync_sync_api.SyncApi.md b/docs/api/classes/sync_sync_api.SyncApi.md deleted file mode 100644 index 12a56903f..000000000 --- a/docs/api/classes/sync_sync_api.SyncApi.md +++ /dev/null @@ -1,156 +0,0 @@ -[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncApi - -# Class: SyncApi - -[sync/sync-api](../modules/sync_sync_api.md).SyncApi - -## Hierarchy - -- `TypedEmitter` - - ↳ **`SyncApi`** - -## Table of contents - -### Constructors - -- [constructor](sync_sync_api.SyncApi.md#constructor) - -### Properties - -- [[kSyncState]](sync_sync_api.SyncApi.md#[ksyncstate]) - -### Methods - -- [[kHandleDiscoveryKey]](sync_sync_api.SyncApi.md#[khandlediscoverykey]) -- [getState](sync_sync_api.SyncApi.md#getstate) -- [start](sync_sync_api.SyncApi.md#start) -- [stop](sync_sync_api.SyncApi.md#stop) -- [waitForSync](sync_sync_api.SyncApi.md#waitforsync) - -## Constructors - -### constructor - -• **new SyncApi**(`opts`): [`SyncApi`](sync_sync_api.SyncApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `opts` | `Object` | `undefined` | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | `undefined` | -| `opts.logger` | `undefined` \| [`Logger`](logger.Logger.md) | `undefined` | -| `opts.roles` | [`Roles`](roles.Roles.md) | `undefined` | -| `opts.throttleMs` | `undefined` \| `number` | `200` | - -#### Returns - -[`SyncApi`](sync_sync_api.SyncApi.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/sync/sync-api.js:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L67) - -## Properties - -### [kSyncState] - -• **[kSyncState]**: [`SyncState`](sync_sync_state.SyncState.md) - -#### Defined in - -[src/sync/sync-api.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L72) - -## Methods - -### [kHandleDiscoveryKey] - -▸ **[kHandleDiscoveryKey]**(`discoveryKey`, `protomux`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discoveryKey` | `Buffer` | -| `protomux` | `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | - -#### Returns - -`void` - -#### Defined in - -[src/sync/sync-api.js:88](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L88) - -___ - -### getState - -▸ **getState**(): [`State`](../interfaces/sync_sync_api.State.md) - -Get the current sync state (initial and full). Also emitted via the 'sync-state' event - -#### Returns - -[`State`](../interfaces/sync_sync_api.State.md) - -#### Defined in - -[src/sync/sync-api.js:119](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L119) - -___ - -### start - -▸ **start**(): `void` - -Start syncing data cores - -#### Returns - -`void` - -#### Defined in - -[src/sync/sync-api.js:136](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L136) - -___ - -### stop - -▸ **stop**(): `void` - -Stop syncing data cores (metadata cores will continue syncing in the background) - -#### Returns - -`void` - -#### Defined in - -[src/sync/sync-api.js:149](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L149) - -___ - -### waitForSync - -▸ **waitForSync**(`type`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | [`SyncType`](../modules/sync_sync_api.md#synctype) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/sync/sync-api.js:163](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L163) diff --git a/docs/api/classes/sync_sync_state.SyncState.md b/docs/api/classes/sync_sync_state.SyncState.md deleted file mode 100644 index a4f444765..000000000 --- a/docs/api/classes/sync_sync_state.SyncState.md +++ /dev/null @@ -1,85 +0,0 @@ -[API](../README.md) / [sync/sync-state](../modules/sync_sync_state.md) / SyncState - -# Class: SyncState - -[sync/sync-state](../modules/sync_sync_state.md).SyncState - -Emit sync state when it changes - -## Hierarchy - -- `TypedEmitter` - - ↳ **`SyncState`** - -## Table of contents - -### Constructors - -- [constructor](sync_sync_state.SyncState.md#constructor) - -### Methods - -- [addPeer](sync_sync_state.SyncState.md#addpeer) -- [getState](sync_sync_state.SyncState.md#getstate) - -## Constructors - -### constructor - -• **new SyncState**(`opts`): [`SyncState`](sync_sync_state.SyncState.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `opts` | `Object` | `undefined` | -| `opts.coreManager` | [`CoreManager`](core_manager.CoreManager.md) | `undefined` | -| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](sync_peer_sync_controller.PeerSyncController.md)\> | `undefined` | -| `opts.throttleMs` | `undefined` \| `number` | `200` | - -#### Returns - -[`SyncState`](sync_sync_state.SyncState.md) - -#### Overrides - -TypedEmitter.constructor - -#### Defined in - -[src/sync/sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L33) - -## Methods - -### addPeer - -▸ **addPeer**(`peerId`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/sync/sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L53) - -___ - -### getState - -▸ **getState**(): [`State`](../modules/sync_sync_state.md#state) - -#### Returns - -[`State`](../modules/sync_sync_state.md#state) - -#### Defined in - -[src/sync/sync-state.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L62) diff --git a/docs/api/classes/utils.ExhaustivenessError.md b/docs/api/classes/utils.ExhaustivenessError.md deleted file mode 100644 index bcecc32ac..000000000 --- a/docs/api/classes/utils.ExhaustivenessError.md +++ /dev/null @@ -1,59 +0,0 @@ -[API](../README.md) / [utils](../modules/utils.md) / ExhaustivenessError - -# Class: ExhaustivenessError - -[utils](../modules/utils.md).ExhaustivenessError - -## Hierarchy - -- `Error` - - ↳ **`ExhaustivenessError`** - -## Table of contents - -### Constructors - -- [constructor](utils.ExhaustivenessError.md#constructor) - -### Properties - -- [name](utils.ExhaustivenessError.md#name) - -## Constructors - -### constructor - -• **new ExhaustivenessError**(`value`): [`ExhaustivenessError`](utils.ExhaustivenessError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `never` | - -#### Returns - -[`ExhaustivenessError`](utils.ExhaustivenessError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/utils.js:63](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L63) - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -[src/utils.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L65) diff --git a/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md b/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md deleted file mode 100644 index 9ba9099a7..000000000 --- a/docs/api/interfaces/blob_store_live_download.BlobDownloadEvents.md +++ /dev/null @@ -1,37 +0,0 @@ -[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / BlobDownloadEvents - -# Interface: BlobDownloadEvents\<\> - -[blob-store/live-download](../modules/blob_store_live_download.md).BlobDownloadEvents - -## Table of contents - -### Properties - -- [state](blob_store_live_download.BlobDownloadEvents.md#state) - -## Properties - -### state - -• **state**: (`state`: [`BlobDownloadState`](blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror)) => `void` - -Emitted with the current download state whenever it changes (not emitted during initial 'checking' status) - -#### Type declaration - -▸ (`state`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `state` | [`BlobDownloadState`](blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/blob_store_live_download.md#blobdownloadstateerror) | - -##### Returns - -`void` - -#### Defined in - -[src/blob-store/live-download.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L22) diff --git a/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md b/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md deleted file mode 100644 index 266aa725c..000000000 --- a/docs/api/interfaces/blob_store_live_download.BlobDownloadState.md +++ /dev/null @@ -1,86 +0,0 @@ -[API](../README.md) / [blob-store/live-download](../modules/blob_store_live_download.md) / BlobDownloadState - -# Interface: BlobDownloadState\<\> - -[blob-store/live-download](../modules/blob_store_live_download.md).BlobDownloadState - -## Table of contents - -### Properties - -- [error](blob_store_live_download.BlobDownloadState.md#error) -- [haveBytes](blob_store_live_download.BlobDownloadState.md#havebytes) -- [haveCount](blob_store_live_download.BlobDownloadState.md#havecount) -- [status](blob_store_live_download.BlobDownloadState.md#status) -- [wantBytes](blob_store_live_download.BlobDownloadState.md#wantbytes) -- [wantCount](blob_store_live_download.BlobDownloadState.md#wantcount) - -## Properties - -### error - -• **error**: ``null`` - -If status = 'error' then this will be an Error object - -#### Defined in - -[src/blob-store/live-download.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L14) - -___ - -### haveBytes - -• **haveBytes**: `number` - -The bytes already downloaded - -#### Defined in - -[src/blob-store/live-download.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L11) - -___ - -### haveCount - -• **haveCount**: `number` - -The number of files already downloaded - -#### Defined in - -[src/blob-store/live-download.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L10) - -___ - -### status - -• **status**: ``"checking"`` \| ``"downloading"`` \| ``"downloaded"`` \| ``"aborted"`` - -#### Defined in - -[src/blob-store/live-download.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L15) - -___ - -### wantBytes - -• **wantBytes**: `number` - -The bytes pending download - -#### Defined in - -[src/blob-store/live-download.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L13) - -___ - -### wantCount - -• **wantCount**: `number` - -The number of files pending download - -#### Defined in - -[src/blob-store/live-download.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L12) diff --git a/docs/api/interfaces/core_manager.Events.md b/docs/api/interfaces/core_manager.Events.md deleted file mode 100644 index 6efcf8efd..000000000 --- a/docs/api/interfaces/core_manager.Events.md +++ /dev/null @@ -1,65 +0,0 @@ -[API](../README.md) / [core-manager](../modules/core_manager.md) / Events - -# Interface: Events\<\> - -[core-manager](../modules/core_manager.md).Events - -## Table of contents - -### Properties - -- [add-core](core_manager.Events.md#add-core) -- [peer-have](core_manager.Events.md#peer-have) - -## Properties - -### add-core - -• **add-core**: (`coreRecord`: [`CoreRecord`](../modules/core_manager_core_index.md#corerecord)) => `void` - -#### Type declaration - -▸ (`coreRecord`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `coreRecord` | [`CoreRecord`](../modules/core_manager_core_index.md#corerecord) | - -##### Returns - -`void` - -#### Defined in - -[src/core-manager/index.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L25) - -___ - -### peer-have - -• **peer-have**: (`namespace`: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `msg`: \{ `bitfield`: `Uint32Array` ; `coreDiscoveryId`: `string` ; `peerId`: `string` ; `start`: `number` }) => `void` - -#### Type declaration - -▸ (`namespace`, `msg`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | -| `msg` | `Object` | -| `msg.bitfield` | `Uint32Array` | -| `msg.coreDiscoveryId` | `string` | -| `msg.peerId` | `string` | -| `msg.start` | `number` | - -##### Returns - -`void` - -#### Defined in - -[src/core-manager/index.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L26) diff --git a/docs/api/interfaces/core_manager.HaveMsg.md b/docs/api/interfaces/core_manager.HaveMsg.md deleted file mode 100644 index f74bfa4db..000000000 --- a/docs/api/interfaces/core_manager.HaveMsg.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / [core-manager](../modules/core_manager.md) / HaveMsg - -# Interface: HaveMsg\<\> - -[core-manager](../modules/core_manager.md).HaveMsg - -## Table of contents - -### Properties - -- [bitfield](core_manager.HaveMsg.md#bitfield) -- [discoveryKey](core_manager.HaveMsg.md#discoverykey) -- [namespace](core_manager.HaveMsg.md#namespace) -- [start](core_manager.HaveMsg.md#start) - -## Properties - -### bitfield - -• **bitfield**: `Uint32Array` - -#### Defined in - -[src/core-manager/index.js:500](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L500) - -___ - -### discoveryKey - -• **discoveryKey**: `Buffer` - -#### Defined in - -[src/core-manager/index.js:498](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L498) - -___ - -### namespace - -• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` - -#### Defined in - -[src/core-manager/index.js:501](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L501) - -___ - -### start - -• **start**: `number` - -#### Defined in - -[src/core-manager/index.js:499](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L499) diff --git a/docs/api/interfaces/datatype-1.DataTypeEvents.md b/docs/api/interfaces/datatype-1.DataTypeEvents.md deleted file mode 100644 index e82fb395c..000000000 --- a/docs/api/interfaces/datatype-1.DataTypeEvents.md +++ /dev/null @@ -1,41 +0,0 @@ -[API](../README.md) / [datatype](../modules/datatype-1.md) / DataTypeEvents - -# Interface: DataTypeEvents\ - -[datatype](../modules/datatype-1.md).DataTypeEvents - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TDoc` | extends `MapeoDoc` | - -## Table of contents - -### Properties - -- [updated-docs](datatype-1.DataTypeEvents.md#updated-docs) - -## Properties - -### updated-docs - -• **updated-docs**: (`docs`: `TDoc`[]) => `void` - -#### Type declaration - -▸ (`docs`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `docs` | `TDoc`[] | - -##### Returns - -`void` - -#### Defined in - -[src/datatype/index.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L30) diff --git a/docs/api/interfaces/datatype.DataTypeEvents.md b/docs/api/interfaces/datatype.DataTypeEvents.md deleted file mode 100644 index f7bb2cabc..000000000 --- a/docs/api/interfaces/datatype.DataTypeEvents.md +++ /dev/null @@ -1,41 +0,0 @@ -[API](../README.md) / [datatype](../modules/datatype.md) / DataTypeEvents - -# Interface: DataTypeEvents\ - -[datatype](../modules/datatype.md).DataTypeEvents - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TDoc` | extends `MapeoDoc` | - -## Table of contents - -### Properties - -- [updated-docs](datatype.DataTypeEvents.md#updated-docs) - -## Properties - -### updated-docs - -• **updated-docs**: (`docs`: `TDoc`[]) => `void` - -#### Type declaration - -▸ (`docs`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `docs` | `TDoc`[] | - -##### Returns - -`void` - -#### Defined in - -[src/datatype/index.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L44) diff --git a/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md b/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md deleted file mode 100644 index a95f568bc..000000000 --- a/docs/api/interfaces/discovery_local_discovery.DiscoveryEvents.md +++ /dev/null @@ -1,35 +0,0 @@ -[API](../README.md) / [discovery/local-discovery](../modules/discovery_local_discovery.md) / DiscoveryEvents - -# Interface: DiscoveryEvents\<\> - -[discovery/local-discovery](../modules/discovery_local_discovery.md).DiscoveryEvents - -## Table of contents - -### Properties - -- [connection](discovery_local_discovery.DiscoveryEvents.md#connection) - -## Properties - -### connection - -• **connection**: (`connection`: [`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream)) => `void` - -#### Type declaration - -▸ (`connection`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `connection` | [`OpenedNoiseStream`](../modules/discovery_local_discovery.md#openednoisestream) | - -##### Returns - -`void` - -#### Defined in - -[src/discovery/local-discovery.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L20) diff --git a/docs/api/interfaces/fastify_controller.StartOpts.md b/docs/api/interfaces/fastify_controller.StartOpts.md deleted file mode 100644 index 070a44bcb..000000000 --- a/docs/api/interfaces/fastify_controller.StartOpts.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [fastify-controller](../modules/fastify_controller.md) / StartOpts - -# Interface: StartOpts\<\> - -[fastify-controller](../modules/fastify_controller.md).StartOpts - -## Table of contents - -### Properties - -- [host](fastify_controller.StartOpts.md#host) -- [port](fastify_controller.StartOpts.md#port) - -## Properties - -### host - -• **host**: `undefined` \| `string` - -#### Defined in - -[src/fastify-controller.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L7) - -___ - -### port - -• **port**: `undefined` \| `number` - -#### Defined in - -[src/fastify-controller.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L8) diff --git a/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md b/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md deleted file mode 100644 index c66225bdd..000000000 --- a/docs/api/interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md +++ /dev/null @@ -1,35 +0,0 @@ -[API](../README.md) / [fastify-plugins/blobs](../modules/fastify_plugins_blobs.md) / BlobServerPluginOpts - -# Interface: BlobServerPluginOpts\<\> - -[fastify-plugins/blobs](../modules/fastify_plugins_blobs.md).BlobServerPluginOpts - -## Table of contents - -### Properties - -- [getBlobStore](fastify_plugins_blobs.BlobServerPluginOpts.md#getblobstore) - -## Properties - -### getBlobStore - -• **getBlobStore**: (`projectPublicId`: `string`) => `Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> - -#### Type declaration - -▸ (`projectPublicId`): `Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `projectPublicId` | `string` | - -##### Returns - -`Promise`\<[`BlobStore`](../classes/blob_store.BlobStore.md)\> - -#### Defined in - -[src/fastify-plugins/blobs.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/blobs.js#L18) diff --git a/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md b/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md deleted file mode 100644 index 0134b28e2..000000000 --- a/docs/api/interfaces/fastify_plugins_icons.IconServerPluginOpts.md +++ /dev/null @@ -1,35 +0,0 @@ -[API](../README.md) / [fastify-plugins/icons](../modules/fastify_plugins_icons.md) / IconServerPluginOpts - -# Interface: IconServerPluginOpts\<\> - -[fastify-plugins/icons](../modules/fastify_plugins_icons.md).IconServerPluginOpts - -## Table of contents - -### Properties - -- [getProject](fastify_plugins_icons.IconServerPluginOpts.md#getproject) - -## Properties - -### getProject - -• **getProject**: (`projectId`: `string`) => `Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> - -#### Type declaration - -▸ (`projectId`): `Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `projectId` | `string` | - -##### Returns - -`Promise`\<[`MapeoProject`](../classes/mapeo_project.MapeoProject.md)\> - -#### Defined in - -[src/fastify-plugins/icons.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/icons.js#L51) diff --git a/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md b/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md deleted file mode 100644 index 020671638..000000000 --- a/docs/api/interfaces/fastify_plugins_maps.MapsPluginContext.md +++ /dev/null @@ -1,29 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps](../modules/fastify_plugins_maps.md) / MapsPluginContext - -# Interface: MapsPluginContext\<\> - -[fastify-plugins/maps](../modules/fastify_plugins_maps.md).MapsPluginContext - -## Table of contents - -### Properties - -- [getStyleJsonUrl](fastify_plugins_maps.MapsPluginContext.md#getstylejsonurl) - -## Properties - -### getStyleJsonUrl - -• **getStyleJsonUrl**: () => `Promise`\<`string`\> - -#### Type declaration - -▸ (): `Promise`\<`string`\> - -##### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/fastify-plugins/maps/index.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L45) diff --git a/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md deleted file mode 100644 index d69b1642c..000000000 --- a/docs/api/interfaces/fastify_plugins_maps.MapsPluginOpts.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps](../modules/fastify_plugins_maps.md) / MapsPluginOpts - -# Interface: MapsPluginOpts\<\> - -[fastify-plugins/maps](../modules/fastify_plugins_maps.md).MapsPluginOpts - -## Table of contents - -### Properties - -- [defaultOnlineStyleUrl](fastify_plugins_maps.MapsPluginOpts.md#defaultonlinestyleurl) -- [prefix](fastify_plugins_maps.MapsPluginOpts.md#prefix) - -## Properties - -### defaultOnlineStyleUrl - -• **defaultOnlineStyleUrl**: `undefined` \| `string` - -#### Defined in - -[src/fastify-plugins/maps/index.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L40) - -___ - -### prefix - -• **prefix**: `undefined` \| `string` - -#### Defined in - -[src/fastify-plugins/maps/index.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L39) diff --git a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md deleted file mode 100644 index 71abb84a9..000000000 --- a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md) / FallbackMapPluginDecorator - -# Interface: FallbackMapPluginDecorator\<\> - -[fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md).FallbackMapPluginDecorator - -## Table of contents - -### Properties - -- [getResolvedStyleJson](fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md#getresolvedstylejson) -- [getStyleJsonStats](fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md#getstylejsonstats) - -## Properties - -### getResolvedStyleJson - -• **getResolvedStyleJson**: (`serverAddress`: `string`) => `Promise`\<`any`\> - -#### Type declaration - -▸ (`serverAddress`): `Promise`\<`any`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `serverAddress` | `string` | - -##### Returns - -`Promise`\<`any`\> - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L28) - -___ - -### getStyleJsonStats - -• **getStyleJsonStats**: () => `Promise`\<`Stats`\> - -#### Type declaration - -▸ (): `Promise`\<`Stats`\> - -##### Returns - -`Promise`\<`Stats`\> - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L29) diff --git a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md deleted file mode 100644 index cd664c284..000000000 --- a/docs/api/interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md) / OfflineFallbackMapPluginOpts - -# Interface: OfflineFallbackMapPluginOpts\<\> - -[fastify-plugins/maps/offline-fallback-map](../modules/fastify_plugins_maps_offline_fallback_map.md).OfflineFallbackMapPluginOpts - -## Table of contents - -### Properties - -- [prefix](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#prefix) -- [sourcesDir](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#sourcesdir) -- [styleJsonPath](fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md#stylejsonpath) - -## Properties - -### prefix - -• **prefix**: `undefined` \| `string` - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L21) - -___ - -### sourcesDir - -• **sourcesDir**: `string` - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L23) - -___ - -### styleJsonPath - -• **styleJsonPath**: `string` - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L22) diff --git a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md deleted file mode 100644 index 4bb613441..000000000 --- a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md +++ /dev/null @@ -1,61 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md) / StaticMapsPluginDecorator - -# Interface: StaticMapsPluginDecorator\<\> - -[fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md).StaticMapsPluginDecorator - -## Table of contents - -### Properties - -- [getResolvedStyleJson](fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md#getresolvedstylejson) -- [getStyleJsonStats](fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md#getstylejsonstats) - -## Properties - -### getResolvedStyleJson - -• **getResolvedStyleJson**: (`styleId`: `string`, `serverAddress`: `string`) => `Promise`\<`string`\> - -#### Type declaration - -▸ (`styleId`, `serverAddress`): `Promise`\<`string`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `styleId` | `string` | -| `serverAddress` | `string` | - -##### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L31) - -___ - -### getStyleJsonStats - -• **getStyleJsonStats**: (`styleId`: `string`) => `Promise`\<`Stats`\> - -#### Type declaration - -▸ (`styleId`): `Promise`\<`Stats`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `styleId` | `string` | - -##### Returns - -`Promise`\<`Stats`\> - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L32) diff --git a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md b/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md deleted file mode 100644 index 07815f44e..000000000 --- a/docs/api/interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md) / StaticMapsPluginOpts - -# Interface: StaticMapsPluginOpts\<\> - -[fastify-plugins/maps/static-maps](../modules/fastify_plugins_maps_static_maps.md).StaticMapsPluginOpts - -## Table of contents - -### Properties - -- [prefix](fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md#prefix) -- [staticRootDir](fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md#staticrootdir) - -## Properties - -### prefix - -• **prefix**: `undefined` \| `string` - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L25) - -___ - -### staticRootDir - -• **staticRootDir**: `string` - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L26) diff --git a/docs/api/interfaces/generated_extensions.HaveExtension.md b/docs/api/interfaces/generated_extensions.HaveExtension.md deleted file mode 100644 index 53b8c417b..000000000 --- a/docs/api/interfaces/generated_extensions.HaveExtension.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / [generated/extensions](../modules/generated_extensions.md) / HaveExtension - -# Interface: HaveExtension - -[generated/extensions](../modules/generated_extensions.md).HaveExtension - -## Table of contents - -### Properties - -- [discoveryKey](generated_extensions.HaveExtension.md#discoverykey) -- [encodedBitfield](generated_extensions.HaveExtension.md#encodedbitfield) -- [namespace](generated_extensions.HaveExtension.md#namespace) -- [start](generated_extensions.HaveExtension.md#start) - -## Properties - -### discoveryKey - -• **discoveryKey**: `Buffer` - -#### Defined in - -[src/generated/extensions.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L15) - -___ - -### encodedBitfield - -• **encodedBitfield**: `Buffer` - -#### Defined in - -[src/generated/extensions.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L17) - -___ - -### namespace - -• **namespace**: [`HaveExtension_Namespace`](../modules/generated_extensions.md#haveextension_namespace) - -#### Defined in - -[src/generated/extensions.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L18) - -___ - -### start - -• **start**: `number` - -#### Defined in - -[src/generated/extensions.ts:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L16) diff --git a/docs/api/interfaces/generated_extensions.ProjectExtension.md b/docs/api/interfaces/generated_extensions.ProjectExtension.md deleted file mode 100644 index 893bf3114..000000000 --- a/docs/api/interfaces/generated_extensions.ProjectExtension.md +++ /dev/null @@ -1,76 +0,0 @@ -[API](../README.md) / [generated/extensions](../modules/generated_extensions.md) / ProjectExtension - -# Interface: ProjectExtension - -[generated/extensions](../modules/generated_extensions.md).ProjectExtension - -## Table of contents - -### Properties - -- [authCoreKeys](generated_extensions.ProjectExtension.md#authcorekeys) -- [blobCoreKeys](generated_extensions.ProjectExtension.md#blobcorekeys) -- [blobIndexCoreKeys](generated_extensions.ProjectExtension.md#blobindexcorekeys) -- [configCoreKeys](generated_extensions.ProjectExtension.md#configcorekeys) -- [dataCoreKeys](generated_extensions.ProjectExtension.md#datacorekeys) -- [wantCoreKeys](generated_extensions.ProjectExtension.md#wantcorekeys) - -## Properties - -### authCoreKeys - -• **authCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L7) - -___ - -### blobCoreKeys - -• **blobCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L11) - -___ - -### blobIndexCoreKeys - -• **blobIndexCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L10) - -___ - -### configCoreKeys - -• **configCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L8) - -___ - -### dataCoreKeys - -• **dataCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L9) - -___ - -### wantCoreKeys - -• **wantCoreKeys**: `Buffer`[] - -#### Defined in - -[src/generated/extensions.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L6) diff --git a/docs/api/interfaces/generated_keys.EncryptionKeys.md b/docs/api/interfaces/generated_keys.EncryptionKeys.md deleted file mode 100644 index a38943b6e..000000000 --- a/docs/api/interfaces/generated_keys.EncryptionKeys.md +++ /dev/null @@ -1,65 +0,0 @@ -[API](../README.md) / [generated/keys](../modules/generated_keys.md) / EncryptionKeys - -# Interface: EncryptionKeys - -[generated/keys](../modules/generated_keys.md).EncryptionKeys - -## Table of contents - -### Properties - -- [auth](generated_keys.EncryptionKeys.md#auth) -- [blob](generated_keys.EncryptionKeys.md#blob) -- [blobIndex](generated_keys.EncryptionKeys.md#blobindex) -- [config](generated_keys.EncryptionKeys.md#config) -- [data](generated_keys.EncryptionKeys.md#data) - -## Properties - -### auth - -• **auth**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L5) - -___ - -### blob - -• `Optional` **blob**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L9) - -___ - -### blobIndex - -• `Optional` **blobIndex**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L8) - -___ - -### config - -• `Optional` **config**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L7) - -___ - -### data - -• `Optional` **data**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L6) diff --git a/docs/api/interfaces/generated_keys.ProjectKeys.md b/docs/api/interfaces/generated_keys.ProjectKeys.md deleted file mode 100644 index 6c626f172..000000000 --- a/docs/api/interfaces/generated_keys.ProjectKeys.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / [generated/keys](../modules/generated_keys.md) / ProjectKeys - -# Interface: ProjectKeys - -[generated/keys](../modules/generated_keys.md).ProjectKeys - -## Table of contents - -### Properties - -- [encryptionKeys](generated_keys.ProjectKeys.md#encryptionkeys) -- [projectKey](generated_keys.ProjectKeys.md#projectkey) -- [projectSecretKey](generated_keys.ProjectKeys.md#projectsecretkey) - -## Properties - -### encryptionKeys - -• **encryptionKeys**: `undefined` \| [`EncryptionKeys`](generated_keys.EncryptionKeys.md) - -#### Defined in - -[src/generated/keys.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L15) - -___ - -### projectKey - -• **projectKey**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L13) - -___ - -### projectSecretKey - -• `Optional` **projectSecretKey**: `Buffer` - -#### Defined in - -[src/generated/keys.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L14) diff --git a/docs/api/interfaces/generated_rpc.DeviceInfo.md b/docs/api/interfaces/generated_rpc.DeviceInfo.md deleted file mode 100644 index af8f5327e..000000000 --- a/docs/api/interfaces/generated_rpc.DeviceInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [generated/rpc](../modules/generated_rpc.md) / DeviceInfo - -# Interface: DeviceInfo - -[generated/rpc](../modules/generated_rpc.md).DeviceInfo - -## Table of contents - -### Properties - -- [deviceType](generated_rpc.DeviceInfo.md#devicetype) -- [name](generated_rpc.DeviceInfo.md#name) - -## Properties - -### deviceType - -• `Optional` **deviceType**: [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) - -#### Defined in - -[src/generated/rpc.ts:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L72) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[src/generated/rpc.ts:71](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L71) diff --git a/docs/api/interfaces/icon_api.BitmapOpts.md b/docs/api/interfaces/icon_api.BitmapOpts.md deleted file mode 100644 index d5864b5de..000000000 --- a/docs/api/interfaces/icon_api.BitmapOpts.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / [icon-api](../modules/icon_api.md) / BitmapOpts - -# Interface: BitmapOpts\<\> - -[icon-api](../modules/icon_api.md).BitmapOpts - -## Table of contents - -### Properties - -- [mimeType](icon_api.BitmapOpts.md#mimetype) -- [pixelDensity](icon_api.BitmapOpts.md#pixeldensity) -- [size](icon_api.BitmapOpts.md#size) - -## Properties - -### mimeType - -• **mimeType**: ``"image/png"`` - -#### Defined in - -[src/icon-api.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L8) - -___ - -### pixelDensity - -• **pixelDensity**: ``1`` \| ``2`` \| ``3`` - -#### Defined in - -[src/icon-api.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L9) - -___ - -### size - -• **size**: `Size` - -#### Defined in - -[src/icon-api.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L10) diff --git a/docs/api/interfaces/icon_api.SvgOpts.md b/docs/api/interfaces/icon_api.SvgOpts.md deleted file mode 100644 index 046cfc62a..000000000 --- a/docs/api/interfaces/icon_api.SvgOpts.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [icon-api](../modules/icon_api.md) / SvgOpts - -# Interface: SvgOpts\<\> - -[icon-api](../modules/icon_api.md).SvgOpts - -## Table of contents - -### Properties - -- [mimeType](icon_api.SvgOpts.md#mimetype) -- [size](icon_api.SvgOpts.md#size) - -## Properties - -### mimeType - -• **mimeType**: ``"image/svg+xml"`` - -#### Defined in - -[src/icon-api.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L13) - -___ - -### size - -• **size**: `Size` - -#### Defined in - -[src/icon-api.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L14) diff --git a/docs/api/interfaces/invite_api.InviteApiEvents.md b/docs/api/interfaces/invite_api.InviteApiEvents.md deleted file mode 100644 index 682ccf2ba..000000000 --- a/docs/api/interfaces/invite_api.InviteApiEvents.md +++ /dev/null @@ -1,61 +0,0 @@ -[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteApiEvents - -# Interface: InviteApiEvents\<\> - -[invite-api](../modules/invite_api.md).InviteApiEvents - -## Table of contents - -### Properties - -- [invite-received](invite_api.InviteApiEvents.md#invite-received) -- [invite-removed](invite_api.InviteApiEvents.md#invite-removed) - -## Properties - -### invite-received - -• **invite-received**: (`invite`: [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>) => `void` - -#### Type declaration - -▸ (`invite`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `invite` | [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\> | - -##### Returns - -`void` - -#### Defined in - -[src/invite-api.js:154](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L154) - -___ - -### invite-removed - -• **invite-removed**: (`invite`: [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\>, `removalReason`: [`InviteRemovalReason`](../modules/invite_api.md#inviteremovalreason)) => `void` - -#### Type declaration - -▸ (`invite`, `removalReason`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `invite` | [`MapBuffers`](../modules/types.md#mapbuffers)\<[`InviteInternal`](../modules/invite_api.md#inviteinternal)\> | -| `removalReason` | [`InviteRemovalReason`](../modules/invite_api.md#inviteremovalreason) | - -##### Returns - -`void` - -#### Defined in - -[src/invite-api.js:155](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L155) diff --git a/docs/api/interfaces/invite_api.InviteCancel.md b/docs/api/interfaces/invite_api.InviteCancel.md deleted file mode 100644 index 1ee31a93b..000000000 --- a/docs/api/interfaces/invite_api.InviteCancel.md +++ /dev/null @@ -1,21 +0,0 @@ -[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteCancel - -# Interface: InviteCancel - -[invite-api](../modules/invite_api.md).InviteCancel - -## Table of contents - -### Properties - -- [inviteId](invite_api.InviteCancel.md#inviteid) - -## Properties - -### inviteId - -• **inviteId**: `Buffer` - -#### Defined in - -[src/generated/rpc.ts:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L15) diff --git a/docs/api/interfaces/invite_api.InviteRpcMessage.md b/docs/api/interfaces/invite_api.InviteRpcMessage.md deleted file mode 100644 index 7a2a16f95..000000000 --- a/docs/api/interfaces/invite_api.InviteRpcMessage.md +++ /dev/null @@ -1,76 +0,0 @@ -[API](../README.md) / [invite-api](../modules/invite_api.md) / InviteRpcMessage - -# Interface: InviteRpcMessage - -[invite-api](../modules/invite_api.md).InviteRpcMessage - -## Table of contents - -### Properties - -- [inviteId](invite_api.InviteRpcMessage.md#inviteid) -- [invitorName](invite_api.InviteRpcMessage.md#invitorname) -- [projectName](invite_api.InviteRpcMessage.md#projectname) -- [projectPublicId](invite_api.InviteRpcMessage.md#projectpublicid) -- [roleDescription](invite_api.InviteRpcMessage.md#roledescription) -- [roleName](invite_api.InviteRpcMessage.md#rolename) - -## Properties - -### inviteId - -• **inviteId**: `Buffer` - -#### Defined in - -[src/generated/rpc.ts:6](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L6) - -___ - -### invitorName - -• **invitorName**: `string` - -#### Defined in - -[src/generated/rpc.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L11) - -___ - -### projectName - -• **projectName**: `string` - -#### Defined in - -[src/generated/rpc.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L8) - -___ - -### projectPublicId - -• **projectPublicId**: `string` - -#### Defined in - -[src/generated/rpc.ts:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L7) - -___ - -### roleDescription - -• `Optional` **roleDescription**: `string` - -#### Defined in - -[src/generated/rpc.ts:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L10) - -___ - -### roleName - -• `Optional` **roleName**: `string` - -#### Defined in - -[src/generated/rpc.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L9) diff --git a/docs/api/interfaces/invite_api.ProjectJoinDetails.md b/docs/api/interfaces/invite_api.ProjectJoinDetails.md deleted file mode 100644 index df0503414..000000000 --- a/docs/api/interfaces/invite_api.ProjectJoinDetails.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / [invite-api](../modules/invite_api.md) / ProjectJoinDetails - -# Interface: ProjectJoinDetails - -[invite-api](../modules/invite_api.md).ProjectJoinDetails - -## Table of contents - -### Properties - -- [encryptionKeys](invite_api.ProjectJoinDetails.md#encryptionkeys) -- [inviteId](invite_api.ProjectJoinDetails.md#inviteid) -- [projectKey](invite_api.ProjectJoinDetails.md#projectkey) - -## Properties - -### encryptionKeys - -• **encryptionKeys**: `undefined` \| [`EncryptionKeys`](generated_keys.EncryptionKeys.md) - -#### Defined in - -[src/generated/rpc.ts:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L67) - -___ - -### inviteId - -• **inviteId**: `Buffer` - -#### Defined in - -[src/generated/rpc.ts:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L65) - -___ - -### projectKey - -• **projectKey**: `Buffer` - -#### Defined in - -[src/generated/rpc.ts:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L66) diff --git a/docs/api/interfaces/local_peers.LocalPeersEvents.md b/docs/api/interfaces/local_peers.LocalPeersEvents.md deleted file mode 100644 index a1d2645e2..000000000 --- a/docs/api/interfaces/local_peers.LocalPeersEvents.md +++ /dev/null @@ -1,204 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / LocalPeersEvents - -# Interface: LocalPeersEvents\<\> - -[local-peers](../modules/local_peers.md).LocalPeersEvents - -## Table of contents - -### Properties - -- [discovery-key](local_peers.LocalPeersEvents.md#discovery-key) -- [got-project-details](local_peers.LocalPeersEvents.md#got-project-details) -- [invite](local_peers.LocalPeersEvents.md#invite) -- [invite-cancel](local_peers.LocalPeersEvents.md#invite-cancel) -- [invite-response](local_peers.LocalPeersEvents.md#invite-response) -- [peer-add](local_peers.LocalPeersEvents.md#peer-add) -- [peers](local_peers.LocalPeersEvents.md#peers) - -## Properties - -### discovery-key - -• **discovery-key**: (`discoveryKey`: `Buffer`, `protomux`: `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\>) => `void` - -Emitted when a new hypercore is replicated (by a peer) to a peer protomux instance (passed as the second parameter) - -#### Type declaration - -▸ (`discoveryKey`, `protomux`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `discoveryKey` | `Buffer` | -| `protomux` | `Protomux`\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:215](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L215) - -___ - -### got-project-details - -• **got-project-details**: (`peerId`: `string`, `details`: [`ProjectJoinDetails`](invite_api.ProjectJoinDetails.md)) => `void` - -Emitted when project details are received - -#### Type declaration - -▸ (`peerId`, `details`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `details` | [`ProjectJoinDetails`](invite_api.ProjectJoinDetails.md) | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:214](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L214) - -___ - -### invite - -• **invite**: (`peerId`: `string`, `invite`: [`InviteRpcMessage`](invite_api.InviteRpcMessage.md)) => `void` - -Emitted when an invite is received - -#### Type declaration - -▸ (`peerId`, `invite`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `invite` | [`InviteRpcMessage`](invite_api.InviteRpcMessage.md) | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:211](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L211) - -___ - -### invite-cancel - -• **invite-cancel**: (`peerId`: `string`, `invite`: [`InviteCancel`](invite_api.InviteCancel.md)) => `void` - -Emitted when we receive a cancelation for an invite - -#### Type declaration - -▸ (`peerId`, `invite`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `invite` | [`InviteCancel`](invite_api.InviteCancel.md) | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:212](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L212) - -___ - -### invite-response - -• **invite-response**: (`peerId`: `string`, `inviteResponse`: [`InviteResponse`](member_api.InviteResponse.md)) => `void` - -Emitted when an invite response is received - -#### Type declaration - -▸ (`peerId`, `inviteResponse`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | -| `inviteResponse` | [`InviteResponse`](member_api.InviteResponse.md) | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:213](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L213) - -___ - -### peer-add - -• **peer-add**: (`peer`: [`PeerInfoConnected`](../modules/local_peers.md#peerinfoconnected)) => `void` - -Emitted when a new peer is connected - -#### Type declaration - -▸ (`peer`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peer` | [`PeerInfoConnected`](../modules/local_peers.md#peerinfoconnected) | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:210](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L210) - -___ - -### peers - -• **peers**: (`peers`: [`PeerInfo`](../modules/local_peers.md#peerinfo)[]) => `void` - -Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status - -#### Type declaration - -▸ (`peers`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peers` | [`PeerInfo`](../modules/local_peers.md#peerinfo)[] | - -##### Returns - -`void` - -#### Defined in - -[src/local-peers.js:209](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L209) diff --git a/docs/api/interfaces/local_peers.PeerInfoBase.md b/docs/api/interfaces/local_peers.PeerInfoBase.md deleted file mode 100644 index 64f33e692..000000000 --- a/docs/api/interfaces/local_peers.PeerInfoBase.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / [local-peers](../modules/local_peers.md) / PeerInfoBase - -# Interface: PeerInfoBase\<\> - -[local-peers](../modules/local_peers.md).PeerInfoBase - -## Table of contents - -### Properties - -- [deviceId](local_peers.PeerInfoBase.md#deviceid) -- [deviceType](local_peers.PeerInfoBase.md#devicetype) -- [name](local_peers.PeerInfoBase.md#name) - -## Properties - -### deviceId - -• **deviceId**: `string` - -#### Defined in - -[src/local-peers.js:40](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L40) - -___ - -### deviceType - -• **deviceType**: `undefined` \| [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) - -#### Defined in - -[src/local-peers.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L42) - -___ - -### name - -• **name**: `undefined` \| `string` - -#### Defined in - -[src/local-peers.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L41) diff --git a/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md b/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md deleted file mode 100644 index 3a0285413..000000000 --- a/docs/api/interfaces/mapeo_manager.MapeoManagerEvents.md +++ /dev/null @@ -1,37 +0,0 @@ -[API](../README.md) / [mapeo-manager](../modules/mapeo_manager.md) / MapeoManagerEvents - -# Interface: MapeoManagerEvents\<\> - -[mapeo-manager](../modules/mapeo_manager.md).MapeoManagerEvents - -## Table of contents - -### Properties - -- [local-peers](mapeo_manager.MapeoManagerEvents.md#local-peers) - -## Properties - -### local-peers - -• **local-peers**: (`peers`: [`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]) => `void` - -Emitted when the list of connected peers changes (new ones added, or connection status changes) - -#### Type declaration - -▸ (`peers`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `peers` | [`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[] | - -##### Returns - -`void` - -#### Defined in - -[src/mapeo-manager.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L70) diff --git a/docs/api/interfaces/member_api.InviteResponse.md b/docs/api/interfaces/member_api.InviteResponse.md deleted file mode 100644 index c2e85f91d..000000000 --- a/docs/api/interfaces/member_api.InviteResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -[API](../README.md) / [member-api](../modules/member_api.md) / InviteResponse - -# Interface: InviteResponse - -[member-api](../modules/member_api.md).InviteResponse - -## Table of contents - -### Properties - -- [decision](member_api.InviteResponse.md#decision) -- [inviteId](member_api.InviteResponse.md#inviteid) - -## Properties - -### decision - -• **decision**: [`InviteResponse_Decision`](../modules/generated_rpc.md#inviteresponse_decision) - -#### Defined in - -[src/generated/rpc.ts:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L20) - -___ - -### inviteId - -• **inviteId**: `Buffer` - -#### Defined in - -[src/generated/rpc.ts:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L19) diff --git a/docs/api/interfaces/member_api.MemberInfo.md b/docs/api/interfaces/member_api.MemberInfo.md deleted file mode 100644 index 923e9520f..000000000 --- a/docs/api/interfaces/member_api.MemberInfo.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / [member-api](../modules/member_api.md) / MemberInfo - -# Interface: MemberInfo\<\> - -[member-api](../modules/member_api.md).MemberInfo - -## Table of contents - -### Properties - -- [deviceId](member_api.MemberInfo.md#deviceid) -- [deviceType](member_api.MemberInfo.md#devicetype) -- [name](member_api.MemberInfo.md#name) -- [role](member_api.MemberInfo.md#role) - -## Properties - -### deviceId - -• **deviceId**: `string` - -#### Defined in - -[src/member-api.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L29) - -___ - -### deviceType - -• **deviceType**: `undefined` \| ``"UNRECOGNIZED"`` \| ``"mobile"`` \| ``"tablet"`` \| ``"desktop"`` - -#### Defined in - -[src/member-api.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L32) - -___ - -### name - -• **name**: `undefined` \| `string` - -#### Defined in - -[src/member-api.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L31) - -___ - -### role - -• **role**: [`Role`](roles.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> - -#### Defined in - -[src/member-api.js:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L30) diff --git a/docs/api/interfaces/roles.DocCapability.md b/docs/api/interfaces/roles.DocCapability.md deleted file mode 100644 index 02ecb7015..000000000 --- a/docs/api/interfaces/roles.DocCapability.md +++ /dev/null @@ -1,62 +0,0 @@ -[API](../README.md) / [roles](../modules/roles.md) / DocCapability - -# Interface: DocCapability\<\> - -[roles](../modules/roles.md).DocCapability - -## Table of contents - -### Properties - -- [readOthers](roles.DocCapability.md#readothers) -- [readOwn](roles.DocCapability.md#readown) -- [writeOthers](roles.DocCapability.md#writeothers) -- [writeOwn](roles.DocCapability.md#writeown) - -## Properties - -### readOthers - -• **readOthers**: `boolean` - -can read other's data - -#### Defined in - -[src/roles.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L59) - -___ - -### readOwn - -• **readOwn**: `boolean` - -can read own data - -#### Defined in - -[src/roles.js:57](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L57) - -___ - -### writeOthers - -• **writeOthers**: `boolean` - -can edit or delete other's data - -#### Defined in - -[src/roles.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L60) - -___ - -### writeOwn - -• **writeOwn**: `boolean` - -can write own data - -#### Defined in - -[src/roles.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L58) diff --git a/docs/api/interfaces/roles.Role.md b/docs/api/interfaces/roles.Role.md deleted file mode 100644 index 60809a25b..000000000 --- a/docs/api/interfaces/roles.Role.md +++ /dev/null @@ -1,71 +0,0 @@ -[API](../README.md) / [roles](../modules/roles.md) / Role - -# Interface: Role\ - -[roles](../modules/roles.md).Role - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`RoleId`](../modules/roles.md#roleid) = [`RoleId`](../modules/roles.md#roleid) | - -## Table of contents - -### Properties - -- [docs](roles.Role.md#docs) -- [name](roles.Role.md#name) -- [roleAssignment](roles.Role.md#roleassignment) -- [roleId](roles.Role.md#roleid) -- [sync](roles.Role.md#sync) - -## Properties - -### docs - -• **docs**: `Record`\<``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``, [`DocCapability`](roles.DocCapability.md)\> - -#### Defined in - -[src/roles.js:68](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L68) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[src/roles.js:67](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L67) - -___ - -### roleAssignment - -• **roleAssignment**: (``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``)[] - -#### Defined in - -[src/roles.js:69](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L69) - -___ - -### roleId - -• **roleId**: `T` - -#### Defined in - -[src/roles.js:66](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L66) - -___ - -### sync - -• **sync**: `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, ``"allowed"`` \| ``"blocked"``\> - -#### Defined in - -[src/roles.js:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L70) diff --git a/docs/api/interfaces/schema_client.ProjectInfo.md b/docs/api/interfaces/schema_client.ProjectInfo.md deleted file mode 100644 index 6e53aeda8..000000000 --- a/docs/api/interfaces/schema_client.ProjectInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -[API](../README.md) / [schema/client](../modules/schema_client.md) / ProjectInfo - -# Interface: ProjectInfo\<\> - -[schema/client](../modules/schema_client.md).ProjectInfo - -## Table of contents - -### Properties - -- [name](schema_client.ProjectInfo.md#name) - -## Properties - -### name - -• **name**: `undefined` \| `string` - -#### Defined in - -[src/schema/client.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L12) diff --git a/docs/api/interfaces/sync_core_sync_state.CoreState.md b/docs/api/interfaces/sync_core_sync_state.CoreState.md deleted file mode 100644 index a1a2e2f28..000000000 --- a/docs/api/interfaces/sync_core_sync_state.CoreState.md +++ /dev/null @@ -1,62 +0,0 @@ -[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / CoreState - -# Interface: CoreState\<\> - -[sync/core-sync-state](../modules/sync_core_sync_state.md).CoreState - -## Table of contents - -### Properties - -- [have](sync_core_sync_state.CoreState.md#have) -- [missing](sync_core_sync_state.CoreState.md#missing) -- [want](sync_core_sync_state.CoreState.md#want) -- [wanted](sync_core_sync_state.CoreState.md#wanted) - -## Properties - -### have - -• **have**: `number` - -blocks the peer has locally - -#### Defined in - -[src/sync/core-sync-state.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L22) - -___ - -### missing - -• **missing**: `number` - -blocks the peer wants but no peer has - -#### Defined in - -[src/sync/core-sync-state.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L25) - -___ - -### want - -• **want**: `number` - -blocks the peer wants, and at least one peer has - -#### Defined in - -[src/sync/core-sync-state.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L23) - -___ - -### wanted - -• **wanted**: `number` - -blocks the peer has that at least one peer wants - -#### Defined in - -[src/sync/core-sync-state.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L24) diff --git a/docs/api/interfaces/sync_core_sync_state.DerivedState.md b/docs/api/interfaces/sync_core_sync_state.DerivedState.md deleted file mode 100644 index 59290ed1e..000000000 --- a/docs/api/interfaces/sync_core_sync_state.DerivedState.md +++ /dev/null @@ -1,49 +0,0 @@ -[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / DerivedState - -# Interface: DerivedState\<\> - -[sync/core-sync-state](../modules/sync_core_sync_state.md).DerivedState - -## Table of contents - -### Properties - -- [coreLength](sync_core_sync_state.DerivedState.md#corelength) -- [localState](sync_core_sync_state.DerivedState.md#localstate) -- [remoteStates](sync_core_sync_state.DerivedState.md#remotestates) - -## Properties - -### coreLength - -• **coreLength**: `number` - -known (sparse) length of the core - -#### Defined in - -[src/sync/core-sync-state.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L32) - -___ - -### localState - -• **localState**: [`CoreState`](sync_core_sync_state.CoreState.md) - -local state - -#### Defined in - -[src/sync/core-sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L33) - -___ - -### remoteStates - -• **remoteStates**: `Object` - -map of state of all known peers - -#### Defined in - -[src/sync/core-sync-state.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L34) diff --git a/docs/api/interfaces/sync_core_sync_state.InternalState.md b/docs/api/interfaces/sync_core_sync_state.InternalState.md deleted file mode 100644 index 5e50e1023..000000000 --- a/docs/api/interfaces/sync_core_sync_state.InternalState.md +++ /dev/null @@ -1,67 +0,0 @@ -[API](../README.md) / [sync/core-sync-state](../modules/sync_core_sync_state.md) / InternalState - -# Interface: InternalState\<\> - -[sync/core-sync-state](../modules/sync_core_sync_state.md).InternalState - -## Table of contents - -### Properties - -- [length](sync_core_sync_state.InternalState.md#length) -- [localState](sync_core_sync_state.InternalState.md#localstate) -- [namespace](sync_core_sync_state.InternalState.md#namespace) -- [peerSyncControllers](sync_core_sync_state.InternalState.md#peersynccontrollers) -- [remoteStates](sync_core_sync_state.InternalState.md#remotestates) - -## Properties - -### length - -• **length**: `undefined` \| `number` - -Core length, e.g. how many blocks in the core (including blocks that are not downloaded) - -#### Defined in - -[src/sync/core-sync-state.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L14) - -___ - -### localState - -• **localState**: `PeerState` - -#### Defined in - -[src/sync/core-sync-state.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L15) - -___ - -### namespace - -• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` - -#### Defined in - -[src/sync/core-sync-state.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L18) - -___ - -### peerSyncControllers - -• **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/sync_peer_sync_controller.PeerSyncController.md)\> - -#### Defined in - -[src/sync/core-sync-state.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L17) - -___ - -### remoteStates - -• **remoteStates**: `Map`\<`string`, `PeerState`\> - -#### Defined in - -[src/sync/core-sync-state.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L16) diff --git a/docs/api/interfaces/sync_sync_api.State.md b/docs/api/interfaces/sync_sync_api.State.md deleted file mode 100644 index 45d7f6bc4..000000000 --- a/docs/api/interfaces/sync_sync_api.State.md +++ /dev/null @@ -1,49 +0,0 @@ -[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / State - -# Interface: State\<\> - -[sync/sync-api](../modules/sync_sync_api.md).State - -## Table of contents - -### Properties - -- [connectedPeers](sync_sync_api.State.md#connectedpeers) -- [data](sync_sync_api.State.md#data) -- [initial](sync_sync_api.State.md#initial) - -## Properties - -### connectedPeers - -• **connectedPeers**: `number` - -Number of connected peers - -#### Defined in - -[src/sync/sync-api.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L33) - -___ - -### data - -• **data**: [`SyncTypeState`](sync_sync_api.SyncTypeState.md) - -State of data sync (observations, map data, photos, audio, video etc.) - -#### Defined in - -[src/sync/sync-api.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L32) - -___ - -### initial - -• **initial**: [`SyncTypeState`](sync_sync_api.SyncTypeState.md) - -State of initial sync (sync of auth, metadata and project config) - -#### Defined in - -[src/sync/sync-api.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L31) diff --git a/docs/api/interfaces/sync_sync_api.SyncEvents.md b/docs/api/interfaces/sync_sync_api.SyncEvents.md deleted file mode 100644 index de6be6029..000000000 --- a/docs/api/interfaces/sync_sync_api.SyncEvents.md +++ /dev/null @@ -1,35 +0,0 @@ -[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncEvents - -# Interface: SyncEvents\<\> - -[sync/sync-api](../modules/sync_sync_api.md).SyncEvents - -## Table of contents - -### Properties - -- [sync-state](sync_sync_api.SyncEvents.md#sync-state) - -## Properties - -### sync-state - -• **sync-state**: (`syncState`: [`State`](sync_sync_api.State.md)) => `void` - -#### Type declaration - -▸ (`syncState`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `syncState` | [`State`](sync_sync_api.State.md) | - -##### Returns - -`void` - -#### Defined in - -[src/sync/sync-api.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L38) diff --git a/docs/api/interfaces/sync_sync_api.SyncTypeState.md b/docs/api/interfaces/sync_sync_api.SyncTypeState.md deleted file mode 100644 index 87b522949..000000000 --- a/docs/api/interfaces/sync_sync_api.SyncTypeState.md +++ /dev/null @@ -1,88 +0,0 @@ -[API](../README.md) / [sync/sync-api](../modules/sync_sync_api.md) / SyncTypeState - -# Interface: SyncTypeState\<\> - -[sync/sync-api](../modules/sync_sync_api.md).SyncTypeState - -## Table of contents - -### Properties - -- [dataToSync](sync_sync_api.SyncTypeState.md#datatosync) -- [have](sync_sync_api.SyncTypeState.md#have) -- [missing](sync_sync_api.SyncTypeState.md#missing) -- [syncing](sync_sync_api.SyncTypeState.md#syncing) -- [want](sync_sync_api.SyncTypeState.md#want) -- [wanted](sync_sync_api.SyncTypeState.md#wanted) - -## Properties - -### dataToSync - -• **dataToSync**: `boolean` - -Is there data available to sync? (want > 0 || wanted > 0) - -#### Defined in - -[src/sync/sync-api.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L25) - -___ - -### have - -• **have**: `number` - -Number of blocks we have locally - -#### Defined in - -[src/sync/sync-api.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L21) - -___ - -### missing - -• **missing**: `number` - -Number of blocks missing (we don't have them, but connected peers don't have them either) - -#### Defined in - -[src/sync/sync-api.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L24) - -___ - -### syncing - -• **syncing**: `boolean` - -Are we currently syncing? - -#### Defined in - -[src/sync/sync-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L26) - -___ - -### want - -• **want**: `number` - -Number of blocks we want from connected peers - -#### Defined in - -[src/sync/sync-api.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L22) - -___ - -### wanted - -• **wanted**: `number` - -Number of blocks that connected peers want from us - -#### Defined in - -[src/sync/sync-api.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L23) diff --git a/docs/api/md/.nojekyll b/docs/api/md/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/docs/api/md/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/api/md/README.md b/docs/api/md/README.md new file mode 100644 index 000000000..139f0af5c --- /dev/null +++ b/docs/api/md/README.md @@ -0,0 +1,79 @@ +API + +# API + +## Table of contents + +### Classes + +- [FastifyController](classes/FastifyController.md) +- [MapeoManager](classes/MapeoManager.md) + +### Functions + +- [MapeoMapsFastifyPlugin](README.md#mapeomapsfastifyplugin) +- [MapeoOfflineFallbackMapFastifyPlugin](README.md#mapeoofflinefallbackmapfastifyplugin) +- [MapeoStaticMapsFastifyPlugin](README.md#mapeostaticmapsfastifyplugin) + +## Functions + +### MapeoMapsFastifyPlugin + +▸ **MapeoMapsFastifyPlugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | `MapsPluginOpts` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/index.js#L30) + +___ + +### MapeoOfflineFallbackMapFastifyPlugin + +▸ **MapeoOfflineFallbackMapFastifyPlugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | `OfflineFallbackMapPluginOpts` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/offline-fallback-map.js#L14) + +___ + +### MapeoStaticMapsFastifyPlugin + +▸ **MapeoStaticMapsFastifyPlugin**(`instance`, `opts`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | +| `opts` | `StaticMapsPluginOpts` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/static-maps.js#L18) diff --git a/docs/api/classes/fastify_controller.FastifyController.md b/docs/api/md/classes/FastifyController.md similarity index 55% rename from docs/api/classes/fastify_controller.FastifyController.md rename to docs/api/md/classes/FastifyController.md index af79da21e..d40f4e41b 100644 --- a/docs/api/classes/fastify_controller.FastifyController.md +++ b/docs/api/md/classes/FastifyController.md @@ -1,26 +1,24 @@ -[API](../README.md) / [fastify-controller](../modules/fastify_controller.md) / FastifyController +[API](../README.md) / FastifyController # Class: FastifyController -[fastify-controller](../modules/fastify_controller.md).FastifyController - ## Table of contents ### Constructors -- [constructor](fastify_controller.FastifyController.md#constructor) +- [constructor](FastifyController.md#constructor) ### Methods -- [start](fastify_controller.FastifyController.md#start) -- [started](fastify_controller.FastifyController.md#started) -- [stop](fastify_controller.FastifyController.md#stop) +- [start](FastifyController.md#start) +- [started](FastifyController.md#started) +- [stop](FastifyController.md#stop) ## Constructors ### constructor -• **new FastifyController**(`opts`): [`FastifyController`](fastify_controller.FastifyController.md) +• **new FastifyController**(`opts`): [`FastifyController`](FastifyController.md) #### Parameters @@ -31,11 +29,11 @@ #### Returns -[`FastifyController`](fastify_controller.FastifyController.md) +[`FastifyController`](FastifyController.md) #### Defined in -[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L21) +[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L21) ## Methods @@ -47,7 +45,7 @@ | Name | Type | | :------ | :------ | -| `opts?` | [`StartOpts`](../interfaces/fastify_controller.StartOpts.md) | +| `opts?` | `StartOpts` | #### Returns @@ -55,7 +53,7 @@ #### Defined in -[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L73) +[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L73) ___ @@ -69,7 +67,7 @@ ___ #### Defined in -[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L77) +[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L77) ___ @@ -83,4 +81,4 @@ ___ #### Defined in -[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-controller.js#L81) +[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L81) diff --git a/docs/api/classes/mapeo_manager.MapeoManager.md b/docs/api/md/classes/MapeoManager.md similarity index 61% rename from docs/api/classes/mapeo_manager.MapeoManager.md rename to docs/api/md/classes/MapeoManager.md index 79da96876..59d64f436 100644 --- a/docs/api/classes/mapeo_manager.MapeoManager.md +++ b/docs/api/md/classes/MapeoManager.md @@ -1,9 +1,7 @@ -[API](../README.md) / [mapeo-manager](../modules/mapeo_manager.md) / MapeoManager +[API](../README.md) / MapeoManager # Class: MapeoManager -[mapeo-manager](../modules/mapeo_manager.md).MapeoManager - ## Hierarchy - `TypedEmitter` @@ -14,35 +12,35 @@ ### Constructors -- [constructor](mapeo_manager.MapeoManager.md#constructor) +- [constructor](MapeoManager.md#constructor) ### Accessors -- [[kRPC]](mapeo_manager.MapeoManager.md#[krpc]) -- [deviceId](mapeo_manager.MapeoManager.md#deviceid) -- [invite](mapeo_manager.MapeoManager.md#invite) +- [[kRPC]](MapeoManager.md#[krpc]) +- [deviceId](MapeoManager.md#deviceid) +- [invite](MapeoManager.md#invite) ### Methods -- [[kManagerReplicate]](mapeo_manager.MapeoManager.md#[kmanagerreplicate]) -- [addProject](mapeo_manager.MapeoManager.md#addproject) -- [connectPeer](mapeo_manager.MapeoManager.md#connectpeer) -- [createProject](mapeo_manager.MapeoManager.md#createproject) -- [getDeviceInfo](mapeo_manager.MapeoManager.md#getdeviceinfo) -- [getMapStyleJsonUrl](mapeo_manager.MapeoManager.md#getmapstylejsonurl) -- [getProject](mapeo_manager.MapeoManager.md#getproject) -- [leaveProject](mapeo_manager.MapeoManager.md#leaveproject) -- [listLocalPeers](mapeo_manager.MapeoManager.md#listlocalpeers) -- [listProjects](mapeo_manager.MapeoManager.md#listprojects) -- [setDeviceInfo](mapeo_manager.MapeoManager.md#setdeviceinfo) -- [startLocalPeerDiscoveryServer](mapeo_manager.MapeoManager.md#startlocalpeerdiscoveryserver) -- [stopLocalPeerDiscoveryServer](mapeo_manager.MapeoManager.md#stoplocalpeerdiscoveryserver) +- [[kManagerReplicate]](MapeoManager.md#[kmanagerreplicate]) +- [addProject](MapeoManager.md#addproject) +- [connectPeer](MapeoManager.md#connectpeer) +- [createProject](MapeoManager.md#createproject) +- [getDeviceInfo](MapeoManager.md#getdeviceinfo) +- [getMapStyleJsonUrl](MapeoManager.md#getmapstylejsonurl) +- [getProject](MapeoManager.md#getproject) +- [leaveProject](MapeoManager.md#leaveproject) +- [listLocalPeers](MapeoManager.md#listlocalpeers) +- [listProjects](MapeoManager.md#listprojects) +- [setDeviceInfo](MapeoManager.md#setdeviceinfo) +- [startLocalPeerDiscoveryServer](MapeoManager.md#startlocalpeerdiscoveryserver) +- [stopLocalPeerDiscoveryServer](MapeoManager.md#stoplocalpeerdiscoveryserver) ## Constructors ### constructor -• **new MapeoManager**(`opts`): [`MapeoManager`](mapeo_manager.MapeoManager.md) +• **new MapeoManager**(`opts`): [`MapeoManager`](MapeoManager.md) #### Parameters @@ -50,17 +48,17 @@ | :------ | :------ | :------ | | `opts` | `Object` | | | `opts.clientMigrationsFolder` | `string` | path for drizzle migrations folder for client database | -| `opts.coreStorage` | `string` \| [`CoreStorage`](../modules/types.md#corestorage) | Folder for hypercore storage or a function that returns a RandomAccessStorage instance | +| `opts.coreStorage` | `string` \| `CoreStorage` | Folder for hypercore storage or a function that returns a RandomAccessStorage instance | | `opts.dbFolder` | `string` | Folder for sqlite Dbs. Folder must exist. Use ':memory:' to store everything in-memory | | `opts.defaultConfigPath` | `undefined` \| `string` | | -| `opts.deviceType` | `undefined` \| [`DeviceInfo_DeviceType`](../modules/generated_rpc.md#deviceinfo_devicetype) | Device type, shared with local peers and project members | +| `opts.deviceType` | `undefined` \| `DeviceInfo_DeviceType` | Device type, shared with local peers and project members | | `opts.fastify` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | Fastify server instance | | `opts.projectMigrationsFolder` | `string` | path for drizzle migrations folder for project database | | `opts.rootKey` | `Buffer` | 16-bytes of random data that uniquely identify the device, used to derive a 32-byte master key, which is used to derive all the keypairs used for Mapeo | #### Returns -[`MapeoManager`](mapeo_manager.MapeoManager.md) +[`MapeoManager`](MapeoManager.md) #### Overrides @@ -68,23 +66,23 @@ TypedEmitter.constructor #### Defined in -[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L110) +[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L110) ## Accessors ### [kRPC] -• `get` **[kRPC]**(): [`LocalPeers`](local_peers.LocalPeers.md) +• `get` **[kRPC]**(): `LocalPeers` MapeoRPC instance, used for tests #### Returns -[`LocalPeers`](local_peers.LocalPeers.md) +`LocalPeers` #### Defined in -[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L201) +[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L201) ___ @@ -98,27 +96,27 @@ ___ #### Defined in -[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L205) +[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L205) ___ ### invite -• `get` **invite**(): [`InviteApi`](invite_api.InviteApi.md) +• `get` **invite**(): `InviteApi` #### Returns -[`InviteApi`](invite_api.InviteApi.md) +`InviteApi` #### Defined in -[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L731) +[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L731) ## Methods ### [kManagerReplicate] -▸ **[kManagerReplicate]**(`isInitiator`): [`ReplicationStream`](../modules/types.md#replicationstream) +▸ **[kManagerReplicate]**(`isInitiator`): `ReplicationStream` Create a Mapeo replication stream. This replication connects the Mapeo RPC channel and allows invites. All active projects will sync automatically to @@ -134,11 +132,11 @@ connecting RPC, use project[kProjectReplication]. #### Returns -[`ReplicationStream`](../modules/types.md#replicationstream) +`ReplicationStream` #### Defined in -[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L218) +[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L218) ___ @@ -154,7 +152,7 @@ downloaded their proof of project membership and the project config. | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `projectJoinDetails` | `Pick`\<[`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` } | `undefined` | | +| `projectJoinDetails` | `Pick`\<`ProjectJoinDetails`, ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` } | `undefined` | | | `opts?` | `Object` | `{}` | For internal use in tests, set opts.waitForSync = false to not wait for sync during addProject() | | `opts.waitForSync?` | `boolean` | `true` | - | @@ -164,7 +162,7 @@ downloaded their proof of project membership and the project config. #### Defined in -[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L542) +[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L542) ___ @@ -187,7 +185,7 @@ ___ #### Defined in -[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L746) +[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L746) ___ @@ -212,21 +210,21 @@ Project public id #### Defined in -[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L350) +[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L350) ___ ### getDeviceInfo -▸ **getDeviceInfo**(): \{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam)\> +▸ **getDeviceInfo**(): \{ `deviceId`: `string` } & `Partial`\<`DeviceInfoParam`\> #### Returns -\{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam)\> +\{ `deviceId`: `string` } & `Partial`\<`DeviceInfoParam`\> #### Defined in -[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L719) +[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L719) ___ @@ -240,13 +238,13 @@ ___ #### Defined in -[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L806) +[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L806) ___ ### getProject -▸ **getProject**(`projectPublicId`): `Promise`\<[`MapeoProject`](mapeo_project.MapeoProject.md)\> +▸ **getProject**(`projectPublicId`): `Promise`\<`MapeoProject`\> #### Parameters @@ -256,11 +254,11 @@ ___ #### Returns -`Promise`\<[`MapeoProject`](mapeo_project.MapeoProject.md)\> +`Promise`\<`MapeoProject`\> #### Defined in -[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L426) +[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L426) ___ @@ -280,21 +278,21 @@ ___ #### Defined in -[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L760) +[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L760) ___ ### listLocalPeers -▸ **listLocalPeers**(): `Promise`\<[`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]\> +▸ **listLocalPeers**(): `Promise`\<`PublicPeerInfo`[]\> #### Returns -`Promise`\<[`PublicPeerInfo`](../modules/mapeo_manager.md#publicpeerinfo)[]\> +`Promise`\<`PublicPeerInfo`[]\> #### Defined in -[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L753) +[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L753) ___ @@ -308,7 +306,7 @@ ___ #### Defined in -[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L485) +[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L485) ___ @@ -320,7 +318,7 @@ ___ | Name | Type | | :------ | :------ | -| `T` | extends [`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam) \| `ExactObject`\<[`DeviceInfoParam`](../modules/schema_client.md#deviceinfoparam), `T`\> | +| `T` | extends `DeviceInfoParam` \| `ExactObject`\<`DeviceInfoParam`, `T`\> | #### Parameters @@ -334,7 +332,7 @@ ___ #### Defined in -[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L686) +[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L686) ___ @@ -348,7 +346,7 @@ ___ #### Defined in -[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L736) +[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L736) ___ @@ -374,4 +372,4 @@ are force-closed after opts.timeout milliseconds #### Defined in -[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L741) +[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L741) diff --git a/docs/api/modules/blob_api.md b/docs/api/modules/blob_api.md deleted file mode 100644 index ca5ef434a..000000000 --- a/docs/api/modules/blob_api.md +++ /dev/null @@ -1,34 +0,0 @@ -[API](../README.md) / blob-api - -# Module: blob-api - -## Table of contents - -### Classes - -- [BlobApi](../classes/blob_api.BlobApi.md) - -### Type Aliases - -- [BlobId](blob_api.md#blobid) -- [BlobType](blob_api.md#blobtype) - -## Type Aliases - -### BlobId - -Ƭ **BlobId**: `Simplify`\<`ValueOf`\<\{ [KeyType in BlobType]: BlobIdBase\ }\>\> - -#### Defined in - -[src/types.ts:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L34) - -___ - -### BlobType - -Ƭ **BlobType**: keyof `SupportedBlobVariants` - -#### Defined in - -[src/types.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L17) diff --git a/docs/api/modules/blob_store.md b/docs/api/modules/blob_store.md deleted file mode 100644 index e562392fc..000000000 --- a/docs/api/modules/blob_store.md +++ /dev/null @@ -1,55 +0,0 @@ -[API](../README.md) / blob-store - -# Module: blob-store - -## Table of contents - -### References - -- [BlobId](blob_store.md#blobid) - -### Classes - -- [BlobStore](../classes/blob_store.BlobStore.md) - -### Type Aliases - -- [InternalDriveEmitter](blob_store.md#internaldriveemitter) - -### Variables - -- [SUPPORTED\_BLOB\_VARIANTS](blob_store.md#supported_blob_variants) - -## References - -### BlobId - -Re-exports [BlobId](blob_api.md#blobid) - -## Type Aliases - -### InternalDriveEmitter - -Ƭ **InternalDriveEmitter**\<\>: `TypedEmitter`\<\{ `add-drive`: (`drive`: `__module`) => `void` }\> - -#### Defined in - -[src/blob-store/index.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L8) - -## Variables - -### SUPPORTED\_BLOB\_VARIANTS - -• `Const` **SUPPORTED\_BLOB\_VARIANTS**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `audio` | readonly [``"original"``] | -| `photo` | readonly [``"original"``, ``"preview"``, ``"thumbnail"``] | -| `video` | readonly [``"original"``] | - -#### Defined in - -[src/blob-store/index.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/index.js#L13) diff --git a/docs/api/modules/blob_store_live_download.md b/docs/api/modules/blob_store_live_download.md deleted file mode 100644 index 73f0b2acd..000000000 --- a/docs/api/modules/blob_store_live_download.md +++ /dev/null @@ -1,58 +0,0 @@ -[API](../README.md) / blob-store/live-download - -# Module: blob-store/live-download - -## Table of contents - -### Classes - -- [DriveLiveDownload](../classes/blob_store_live_download.DriveLiveDownload.md) -- [LiveDownload](../classes/blob_store_live_download.LiveDownload.md) - -### Interfaces - -- [BlobDownloadEvents](../interfaces/blob_store_live_download.BlobDownloadEvents.md) -- [BlobDownloadState](../interfaces/blob_store_live_download.BlobDownloadState.md) - -### Type Aliases - -- [BlobDownloadStateError](blob_store_live_download.md#blobdownloadstateerror) - -### Functions - -- [combineStates](blob_store_live_download.md#combinestates) - -## Type Aliases - -### BlobDownloadStateError - -Ƭ **BlobDownloadStateError**\<\>: `Omit`\<[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md), ``"error"`` \| ``"status"``\> & \{ `error`: `Error` ; `status`: ``"error"`` } - -#### Defined in - -[src/blob-store/live-download.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L18) - -## Functions - -### combineStates - -▸ **combineStates**(`liveDownloads`, `options?`): [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) - -Reduce multiple states into one. Factored out for unit testing because I -don't trust my coding. Probably a smarter way to do this, but this works. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `liveDownloads` | `Iterable`\<\{ `state`: [`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) }\> | -| `options` | `Object` | -| `options.signal?` | `AbortSignal` | - -#### Returns - -[`BlobDownloadState`](../interfaces/blob_store_live_download.BlobDownloadState.md) \| [`BlobDownloadStateError`](blob_store_live_download.md#blobdownloadstateerror) - -#### Defined in - -[src/blob-store/live-download.js:296](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/blob-store/live-download.js#L296) diff --git a/docs/api/modules/config_import.md b/docs/api/modules/config_import.md deleted file mode 100644 index 1a20d8269..000000000 --- a/docs/api/modules/config_import.md +++ /dev/null @@ -1,72 +0,0 @@ -[API](../README.md) / config-import - -# Module: config-import - -## Table of contents - -### Type Aliases - -- [Entry](config_import.md#entry) -- [IconData](config_import.md#icondata) -- [PresetsFile](config_import.md#presetsfile) - -### Functions - -- [readConfig](config_import.md#readconfig) - -## Type Aliases - -### Entry - -Ƭ **Entry**\<\>: `yauzl.Entry` - -#### Defined in - -[src/config-import.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L12) - -___ - -### IconData - -Ƭ **IconData**\<\>: `Parameters`\<[`icon-api`](icon_api.md)[``"create"``]\>[``0``] - -#### Defined in - -[src/config-import.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L21) - -___ - -### PresetsFile - -Ƭ **PresetsFile**\<\>: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fields` | \{ `[id: string]`: `unknown`; } | -| `presets` | \{ `[id: string]`: `unknown`; } | - -#### Defined in - -[src/config-import.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L18) - -## Functions - -### readConfig - -▸ **readConfig**(`configPath`): `Promise`\<\{ `warnings`: ; `close`: () => `Promise`\<`void`\> ; `fields`: () => `Iterable`\<\{ `name`: `string` ; `value`: {} }\> ; `icons`: () => `AsyncIterable`\<\{ `name`: `string` ; `variants`: [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] }\> ; `presets`: () => `Iterable`\<\{ `fieldNames`: `string`[] ; `iconName`: `undefined` \| `string` ; `value`: {} }\> }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configPath` | `string` | - -#### Returns - -`Promise`\<\{ `warnings`: ; `close`: () => `Promise`\<`void`\> ; `fields`: () => `Iterable`\<\{ `name`: `string` ; `value`: {} }\> ; `icons`: () => `AsyncIterable`\<\{ `name`: `string` ; `variants`: [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) & \{ `blob`: `Buffer` }[] }\> ; `presets`: () => `Iterable`\<\{ `fieldNames`: `string`[] ; `iconName`: `undefined` \| `string` ; `value`: {} }\> }\> - -#### Defined in - -[src/config-import.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/config-import.js#L27) diff --git a/docs/api/modules/constants.md b/docs/api/modules/constants.md deleted file mode 100644 index 3adb1590d..000000000 --- a/docs/api/modules/constants.md +++ /dev/null @@ -1,19 +0,0 @@ -[API](../README.md) / constants - -# Module: constants - -## Table of contents - -### Variables - -- [NAMESPACES](constants.md#namespaces) - -## Variables - -### NAMESPACES - -• `Const` **NAMESPACES**: readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] - -#### Defined in - -[src/constants.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/constants.js#L3) diff --git a/docs/api/modules/core_manager.md b/docs/api/modules/core_manager.md deleted file mode 100644 index 2bf197810..000000000 --- a/docs/api/modules/core_manager.md +++ /dev/null @@ -1,70 +0,0 @@ -[API](../README.md) / core-manager - -# Module: core-manager - -## Table of contents - -### References - -- [CoreRecord](core_manager.md#corerecord) -- [Namespace](core_manager.md#namespace) - -### Classes - -- [CoreManager](../classes/core_manager.CoreManager.md) - -### Interfaces - -- [Events](../interfaces/core_manager.Events.md) -- [HaveMsg](../interfaces/core_manager.HaveMsg.md) - -### Type Aliases - -- [Core](core_manager.md#core) -- [DuplexStream](core_manager.md#duplexstream) - -### Variables - -- [kCoreManagerReplicate](core_manager.md#kcoremanagerreplicate) - -## References - -### CoreRecord - -Re-exports [CoreRecord](core_manager_core_index.md#corerecord) - -___ - -### Namespace - -Re-exports [Namespace](core_manager_core_index.md#namespace) - -## Type Aliases - -### Core - -Ƭ **Core**\<\>: `__module` - -#### Defined in - -[src/core-manager/index.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L19) - -___ - -### DuplexStream - -Ƭ **DuplexStream**\<\>: `Duplex` - -#### Defined in - -[src/core-manager/index.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L22) - -## Variables - -### kCoreManagerReplicate - -• `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](core_manager.md#kcoremanagerreplicate) - -#### Defined in - -[src/core-manager/index.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L17) diff --git a/docs/api/modules/core_manager_bitfield_rle.md b/docs/api/modules/core_manager_bitfield_rle.md deleted file mode 100644 index ea51c3da8..000000000 --- a/docs/api/modules/core_manager_bitfield_rle.md +++ /dev/null @@ -1,96 +0,0 @@ -[API](../README.md) / core-manager/bitfield-rle - -# Module: core-manager/bitfield-rle - -## Table of contents - -### Functions - -- [decode](core_manager_bitfield_rle.md#decode) -- [decodingLength](core_manager_bitfield_rle.md#decodinglength) -- [encode](core_manager_bitfield_rle.md#encode) -- [encodingLength](core_manager_bitfield_rle.md#encodinglength) - -## Functions - -### decode - -▸ **decode**(`buffer`, `offset?`): `Uint32Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buffer` | `Buffer` | -| `offset?` | `number` | - -#### Returns - -`Uint32Array` - -#### Defined in - -[src/core-manager/bitfield-rle.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L72) - -___ - -### decodingLength - -▸ **decodingLength**(`buffer`, `offset`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buffer` | `Buffer` | -| `offset` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/bitfield-rle.js:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L111) - -___ - -### encode - -▸ **encode**(`bitfield`, `buffer?`, `offset?`): `Buffer` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bitfield` | `Uint32Array` | -| `buffer?` | `Buffer` | -| `offset?` | `number` | - -#### Returns - -`Buffer` - -#### Defined in - -[src/core-manager/bitfield-rle.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L38) - -___ - -### encodingLength - -▸ **encodingLength**(`bitfield`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bitfield` | `Buffer` | - -#### Returns - -`number` - -#### Defined in - -[src/core-manager/bitfield-rle.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/bitfield-rle.js#L60) diff --git a/docs/api/modules/core_manager_compat.md b/docs/api/modules/core_manager_compat.md deleted file mode 100644 index fa149f4fc..000000000 --- a/docs/api/modules/core_manager_compat.md +++ /dev/null @@ -1,19 +0,0 @@ -[API](../README.md) / core-manager/compat - -# Module: core-manager/compat - -## Table of contents - -### Variables - -- [quickbit](core_manager_compat.md#quickbit) - -## Variables - -### quickbit - -• **quickbit**: `__module` = `universal` - -#### Defined in - -[src/core-manager/compat.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/compat.js#L8) diff --git a/docs/api/modules/core_manager_core_index.md b/docs/api/modules/core_manager_core_index.md deleted file mode 100644 index 46115eb8a..000000000 --- a/docs/api/modules/core_manager_core_index.md +++ /dev/null @@ -1,42 +0,0 @@ -[API](../README.md) / core-manager/core-index - -# Module: core-manager/core-index - -## Table of contents - -### Classes - -- [CoreIndex](../classes/core_manager_core_index.CoreIndex.md) - -### Type Aliases - -- [CoreRecord](core_manager_core_index.md#corerecord) -- [Namespace](core_manager_core_index.md#namespace) - -## Type Aliases - -### CoreRecord - -Ƭ **CoreRecord**\<\>: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `core` | [`Core`](core_manager.md#core) | -| `key` | `Buffer` | -| `namespace` | [`Namespace`](core_manager_core_index.md#namespace) | - -#### Defined in - -[src/core-manager/index.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L21) - -___ - -### Namespace - -Ƭ **Namespace**\<\>: typeof [`NAMESPACES`](constants.md#namespaces)[`number`] - -#### Defined in - -[src/core-manager/index.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/index.js#L20) diff --git a/docs/api/modules/core_manager_random_access_file_pool.md b/docs/api/modules/core_manager_random_access_file_pool.md deleted file mode 100644 index fd9417078..000000000 --- a/docs/api/modules/core_manager_random_access_file_pool.md +++ /dev/null @@ -1,9 +0,0 @@ -[API](../README.md) / core-manager/random-access-file-pool - -# Module: core-manager/random-access-file-pool - -## Table of contents - -### Classes - -- [RandomAccessFilePool](../classes/core_manager_random_access_file_pool.RandomAccessFilePool.md) diff --git a/docs/api/modules/core_manager_remote_bitfield.md b/docs/api/modules/core_manager_remote_bitfield.md deleted file mode 100644 index b69dd33e1..000000000 --- a/docs/api/modules/core_manager_remote_bitfield.md +++ /dev/null @@ -1,23 +0,0 @@ -[API](../README.md) / core-manager/remote-bitfield - -# Module: core-manager/remote-bitfield - -## Table of contents - -### Classes - -- [default](../classes/core_manager_remote_bitfield.default.md) - -### Variables - -- [BITS\_PER\_PAGE](core_manager_remote_bitfield.md#bits_per_page) - -## Variables - -### BITS\_PER\_PAGE - -• `Const` **BITS\_PER\_PAGE**: ``32768`` - -#### Defined in - -[src/core-manager/remote-bitfield.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-manager/remote-bitfield.js#L8) diff --git a/docs/api/modules/core_ownership.md b/docs/api/modules/core_ownership.md deleted file mode 100644 index 2ad1d6d3e..000000000 --- a/docs/api/modules/core_ownership.md +++ /dev/null @@ -1,86 +0,0 @@ -[API](../README.md) / core-ownership - -# Module: core-ownership - -## Table of contents - -### Classes - -- [CoreOwnership](../classes/core_ownership.CoreOwnership.md) - -### Type Aliases - -- [CoreOwnershipWithSignatures](core_ownership.md#coreownershipwithsignatures) - -### Functions - -- [getWinner](core_ownership.md#getwinner) -- [mapAndValidateCoreOwnership](core_ownership.md#mapandvalidatecoreownership) - -## Type Aliases - -### CoreOwnershipWithSignatures - -Ƭ **CoreOwnershipWithSignatures**: `Extract`\<`ReturnType`\, \{ `schemaName`: ``"coreOwnership"`` }\> - -#### Defined in - -[src/types.ts:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L55) - -## Functions - -### getWinner - -▸ **getWinner**\<`T`, `U`\>(`docA`, `docB`): `T` \| `U` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `IndexableDocument` | -| `U` | extends `IndexableDocument` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `docA` | `T` | -| `docB` | `U` | - -#### Returns - -`T` \| `U` - -T | U - -#### Defined in - -[src/core-ownership.js:184](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L184) - -___ - -### mapAndValidateCoreOwnership - -▸ **mapAndValidateCoreOwnership**(`doc`, `version`): `Object` - -- Validate that the doc is written to the core identified by doc.authCoreId -- Verify the signatures -- Remove the signatures (we don't add them to the indexer) -- Set doc.links to an empty array - this forces the indexer to treat every - document as a fork, so getWinner is called for every doc, which resolves to - the doc with the lowest index (e.g. the first) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | {} & `CoreOwnershipSignatures` | -| `version` | `VersionIdObject` | - -#### Returns - -`Object` - -#### Defined in - -[src/core-ownership.js:126](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/core-ownership.js#L126) diff --git a/docs/api/modules/datastore.md b/docs/api/modules/datastore.md deleted file mode 100644 index 9747c7e78..000000000 --- a/docs/api/modules/datastore.md +++ /dev/null @@ -1,69 +0,0 @@ -[API](../README.md) / datastore - -# Module: datastore - -## Table of contents - -### Classes - -- [DataStore](../classes/datastore.DataStore.md) - -### Type Aliases - -- [DataStoreEvents](datastore.md#datastoreevents) -- [MapeoDocTablesMap](datastore.md#mapeodoctablesmap) -- [NamespaceSchemas](datastore.md#namespaceschemas) -- [OmitUnion](datastore.md#omitunion) - -## Type Aliases - -### DataStoreEvents - -Ƭ **DataStoreEvents**\<`TSchemaName`\>: \{ [S in Exclude\]: Function } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | - -#### Defined in - -[src/datastore/index.js:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L22) - -___ - -### MapeoDocTablesMap - -Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } - -#### Defined in - -[src/datatype/index.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L23) - -___ - -### NamespaceSchemas - -Ƭ **NamespaceSchemas**\<\>: typeof `NAMESPACE_SCHEMAS` - -#### Defined in - -[src/datastore/index.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L44) - -___ - -### OmitUnion - -Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -[src/datastore/index.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datastore/index.js#L27) diff --git a/docs/api/modules/datatype-1.md b/docs/api/modules/datatype-1.md deleted file mode 100644 index f3335bbf1..000000000 --- a/docs/api/modules/datatype-1.md +++ /dev/null @@ -1,133 +0,0 @@ -[API](../README.md) / datatype - -# Module: datatype - -## Table of contents - -### References - -- [MapeoDocTables](datatype-1.md#mapeodoctables) -- [MapeoDocTablesMap](datatype-1.md#mapeodoctablesmap) - -### Classes - -- [DataType](../classes/datatype-1.DataType.md) - -### Interfaces - -- [DataTypeEvents](../interfaces/datatype-1.DataTypeEvents.md) - -### Type Aliases - -- [ExcludeSchema](datatype-1.md#excludeschema) -- [GetMapeoDocTables](datatype-1.md#getmapeodoctables) -- [MapeoDocTableName](datatype-1.md#mapeodoctablename) -- [OmitUnion](datatype-1.md#omitunion) - -### Variables - -- [kCreateWithDocId](datatype-1.md#kcreatewithdocid) -- [kSelect](datatype-1.md#kselect) -- [kTable](datatype-1.md#ktable) - -## References - -### MapeoDocTables - -Re-exports [MapeoDocTables](index_writer.md#mapeodoctables) - -___ - -### MapeoDocTablesMap - -Re-exports [MapeoDocTablesMap](datastore.md#mapeodoctablesmap) - -## Type Aliases - -### ExcludeSchema - -Ƭ **ExcludeSchema**\<`T`, `S`\>: `Exclude`\<`T`, \{ `schemaName`: `S` }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `MapeoValue` | -| `S` | extends `MapeoValue`[``"schemaName"``] | - -#### Defined in - -[src/datatype/index.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L38) - -___ - -### GetMapeoDocTables - -Ƭ **GetMapeoDocTables**\<`T`\>: `T`[keyof `T` & [`MapeoDocTableName`](datatype-1.md#mapeodoctablename)] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/datatype/index.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L18) - -___ - -### MapeoDocTableName - -Ƭ **MapeoDocTableName**: \`$\{MapeoDoc["schemaName"]}Table\` - -#### Defined in - -[src/datatype/index.d.ts:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L17) - -___ - -### OmitUnion - -Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -[src/datatype/index.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L37) - -## Variables - -### kCreateWithDocId - -• `Const` **kCreateWithDocId**: unique `symbol` - -#### Defined in - -[src/datatype/index.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L33) - -___ - -### kSelect - -• `Const` **kSelect**: unique `symbol` - -#### Defined in - -[src/datatype/index.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L34) - -___ - -### kTable - -• `Const` **kTable**: unique `symbol` - -#### Defined in - -[src/datatype/index.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L35) diff --git a/docs/api/modules/datatype.md b/docs/api/modules/datatype.md deleted file mode 100644 index 693a0002e..000000000 --- a/docs/api/modules/datatype.md +++ /dev/null @@ -1,142 +0,0 @@ -[API](../README.md) / datatype - -# Module: datatype - -## Table of contents - -### Classes - -- [DataType](../classes/datatype.DataType.md) - -### Interfaces - -- [DataTypeEvents](../interfaces/datatype.DataTypeEvents.md) - -### Type Aliases - -- [GetMapeoDocTables](datatype.md#getmapeodoctables) -- [MapeoDocMap](datatype.md#mapeodocmap) -- [MapeoDocTableName](datatype.md#mapeodoctablename) -- [MapeoDocTables](datatype.md#mapeodoctables) -- [MapeoDocTablesMap](datatype.md#mapeodoctablesmap) -- [MapeoValueMap](datatype.md#mapeovaluemap) -- [OmitUnion](datatype.md#omitunion) - -### Variables - -- [kCreateWithDocId](datatype.md#kcreatewithdocid) -- [kSelect](datatype.md#kselect) -- [kTable](datatype.md#ktable) - -## Type Aliases - -### GetMapeoDocTables - -Ƭ **GetMapeoDocTables**\<`T`\>: `T`[keyof `T` & [`MapeoDocTableName`](datatype.md#mapeodoctablename)] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/datatype/index.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L27) - -___ - -### MapeoDocMap - -Ƭ **MapeoDocMap**: \{ [K in MapeoDoc["schemaName"]]: Extract\ } - -#### Defined in - -[src/types.ts:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L46) - -___ - -### MapeoDocTableName - -Ƭ **MapeoDocTableName**\<\>: \`$\{MapeoDoc["schemaName"]}Table\` - -#### Defined in - -[src/datatype/index.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L23) - -___ - -### MapeoDocTables - -Ƭ **MapeoDocTables**\<\>: [`GetMapeoDocTables`](datatype.md#getmapeodoctables)\<[`schema/project`](schema_project.md)\> \| [`GetMapeoDocTables`](datatype.md#getmapeodoctables)\<[`schema/client`](schema_client.md)\> - -#### Defined in - -[src/datatype/index.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L31) - -___ - -### MapeoDocTablesMap - -Ƭ **MapeoDocTablesMap**\<\>: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } - -#### Defined in - -[src/datatype/index.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L34) - -___ - -### MapeoValueMap - -Ƭ **MapeoValueMap**: \{ [K in MapeoValue["schemaName"]]: Extract\ } - -#### Defined in - -[src/types.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L50) - -___ - -### OmitUnion - -Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | - -#### Defined in - -[src/datatype/index.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L39) - -## Variables - -### kCreateWithDocId - -• `Const` **kCreateWithDocId**: typeof [`kCreateWithDocId`](datatype.md#kcreatewithdocid) - -#### Defined in - -[src/datatype/index.js:53](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L53) - -___ - -### kSelect - -• `Const` **kSelect**: typeof [`kSelect`](datatype.md#kselect) - -#### Defined in - -[src/datatype/index.js:54](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L54) - -___ - -### kTable - -• `Const` **kTable**: typeof [`kTable`](datatype.md#ktable) - -#### Defined in - -[src/datatype/index.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.js#L55) diff --git a/docs/api/modules/discovery_local_discovery.md b/docs/api/modules/discovery_local_discovery.md deleted file mode 100644 index 9a5c3c73a..000000000 --- a/docs/api/modules/discovery_local_discovery.md +++ /dev/null @@ -1,59 +0,0 @@ -[API](../README.md) / discovery/local-discovery - -# Module: discovery/local-discovery - -## Table of contents - -### Classes - -- [LocalDiscovery](../classes/discovery_local_discovery.LocalDiscovery.md) - -### Interfaces - -- [DiscoveryEvents](../interfaces/discovery_local_discovery.DiscoveryEvents.md) - -### Type Aliases - -- [Keypair](discovery_local_discovery.md#keypair) -- [OpenedNoiseStream](discovery_local_discovery.md#openednoisestream) - -### Variables - -- [ERR\_DUPLICATE](discovery_local_discovery.md#err_duplicate) - -## Type Aliases - -### Keypair - -Ƭ **Keypair**\<\>: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `publicKey` | `Buffer` | -| `secretKey` | `Buffer` | - -#### Defined in - -[src/discovery/local-discovery.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L13) - -___ - -### OpenedNoiseStream - -Ƭ **OpenedNoiseStream**\<\>: [`utils`](utils.md) - -#### Defined in - -[src/discovery/local-discovery.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L14) - -## Variables - -### ERR\_DUPLICATE - -• `Const` **ERR\_DUPLICATE**: ``"Duplicate connection"`` - -#### Defined in - -[src/discovery/local-discovery.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/discovery/local-discovery.js#L16) diff --git a/docs/api/modules/fastify_controller.md b/docs/api/modules/fastify_controller.md deleted file mode 100644 index 5c4162987..000000000 --- a/docs/api/modules/fastify_controller.md +++ /dev/null @@ -1,13 +0,0 @@ -[API](../README.md) / fastify-controller - -# Module: fastify-controller - -## Table of contents - -### Classes - -- [FastifyController](../classes/fastify_controller.FastifyController.md) - -### Interfaces - -- [StartOpts](../interfaces/fastify_controller.StartOpts.md) diff --git a/docs/api/modules/fastify_plugins_blobs.md b/docs/api/modules/fastify_plugins_blobs.md deleted file mode 100644 index 78c602e52..000000000 --- a/docs/api/modules/fastify_plugins_blobs.md +++ /dev/null @@ -1,44 +0,0 @@ -[API](../README.md) / fastify-plugins/blobs - -# Module: fastify-plugins/blobs - -## Table of contents - -### References - -- [BlobId](fastify_plugins_blobs.md#blobid) - -### Interfaces - -- [BlobServerPluginOpts](../interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md) - -### Functions - -- [default](fastify_plugins_blobs.md#default) - -## References - -### BlobId - -Re-exports [BlobId](blob_api.md#blobid) - -## Functions - -### default - -▸ **default**(`instance`, `opts`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | `RegisterOptions` & [`BlobServerPluginOpts`](../interfaces/fastify_plugins_blobs.BlobServerPluginOpts.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/blobs.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/blobs.js#L8) diff --git a/docs/api/modules/fastify_plugins_constants.md b/docs/api/modules/fastify_plugins_constants.md deleted file mode 100644 index ac8bf3fb4..000000000 --- a/docs/api/modules/fastify_plugins_constants.md +++ /dev/null @@ -1,30 +0,0 @@ -[API](../README.md) / fastify-plugins/constants - -# Module: fastify-plugins/constants - -## Table of contents - -### Variables - -- [HEX\_REGEX\_32\_BYTES](fastify_plugins_constants.md#hex_regex_32_bytes) -- [Z\_BASE\_32\_REGEX\_32\_BYTES](fastify_plugins_constants.md#z_base_32_regex_32_bytes) - -## Variables - -### HEX\_REGEX\_32\_BYTES - -• `Const` **HEX\_REGEX\_32\_BYTES**: ``"^[0-9a-fA-F]{64}$"`` - -#### Defined in - -[src/fastify-plugins/constants.js:2](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/constants.js#L2) - -___ - -### Z\_BASE\_32\_REGEX\_32\_BYTES - -• `Const` **Z\_BASE\_32\_REGEX\_32\_BYTES**: ``"^[0-9a-zA-Z]{52}$"`` - -#### Defined in - -[src/fastify-plugins/constants.js:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/constants.js#L5) diff --git a/docs/api/modules/fastify_plugins_icons.md b/docs/api/modules/fastify_plugins_icons.md deleted file mode 100644 index d47751cf9..000000000 --- a/docs/api/modules/fastify_plugins_icons.md +++ /dev/null @@ -1,34 +0,0 @@ -[API](../README.md) / fastify-plugins/icons - -# Module: fastify-plugins/icons - -## Table of contents - -### Interfaces - -- [IconServerPluginOpts](../interfaces/fastify_plugins_icons.IconServerPluginOpts.md) - -### Functions - -- [default](fastify_plugins_icons.md#default) - -## Functions - -### default - -▸ **default**(`instance`, `opts`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | `RegisterOptions` & [`IconServerPluginOpts`](../interfaces/fastify_plugins_icons.IconServerPluginOpts.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/icons.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/icons.js#L8) diff --git a/docs/api/modules/fastify_plugins_maps.md b/docs/api/modules/fastify_plugins_maps.md deleted file mode 100644 index b7f06b4b5..000000000 --- a/docs/api/modules/fastify_plugins_maps.md +++ /dev/null @@ -1,60 +0,0 @@ -[API](../README.md) / fastify-plugins/maps - -# Module: fastify-plugins/maps - -## Table of contents - -### Interfaces - -- [MapsPluginContext](../interfaces/fastify_plugins_maps.MapsPluginContext.md) -- [MapsPluginOpts](../interfaces/fastify_plugins_maps.MapsPluginOpts.md) - -### Variables - -- [DEFAULT\_MAPBOX\_STYLE\_URL](fastify_plugins_maps.md#default_mapbox_style_url) -- [PLUGIN\_NAME](fastify_plugins_maps.md#plugin_name) - -### Functions - -- [plugin](fastify_plugins_maps.md#plugin) - -## Variables - -### DEFAULT\_MAPBOX\_STYLE\_URL - -• `Const` **DEFAULT\_MAPBOX\_STYLE\_URL**: ``"https://api.mapbox.com/styles/v1/mapbox/outdoors-v12"`` - -#### Defined in - -[src/fastify-plugins/maps/index.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L14) - -___ - -### PLUGIN\_NAME - -• `Const` **PLUGIN\_NAME**: ``"mapeo-maps"`` - -#### Defined in - -[src/fastify-plugins/maps/index.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L13) - -## Functions - -### plugin - -▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | [`MapsPluginOpts`](../interfaces/fastify_plugins_maps.MapsPluginOpts.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/index.js#L30) diff --git a/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md b/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md deleted file mode 100644 index 3c52d9cfa..000000000 --- a/docs/api/modules/fastify_plugins_maps_offline_fallback_map.md +++ /dev/null @@ -1,49 +0,0 @@ -[API](../README.md) / fastify-plugins/maps/offline-fallback-map - -# Module: fastify-plugins/maps/offline-fallback-map - -## Table of contents - -### Interfaces - -- [FallbackMapPluginDecorator](../interfaces/fastify_plugins_maps_offline_fallback_map.FallbackMapPluginDecorator.md) -- [OfflineFallbackMapPluginOpts](../interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md) - -### Variables - -- [PLUGIN\_NAME](fastify_plugins_maps_offline_fallback_map.md#plugin_name) - -### Functions - -- [plugin](fastify_plugins_maps_offline_fallback_map.md#plugin) - -## Variables - -### PLUGIN\_NAME - -• `Const` **PLUGIN\_NAME**: ``"mapeo-static-maps"`` - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L12) - -## Functions - -### plugin - -▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | [`OfflineFallbackMapPluginOpts`](../interfaces/fastify_plugins_maps_offline_fallback_map.OfflineFallbackMapPluginOpts.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/offline-fallback-map.js#L14) diff --git a/docs/api/modules/fastify_plugins_maps_static_maps.md b/docs/api/modules/fastify_plugins_maps_static_maps.md deleted file mode 100644 index 2d005bfe4..000000000 --- a/docs/api/modules/fastify_plugins_maps_static_maps.md +++ /dev/null @@ -1,49 +0,0 @@ -[API](../README.md) / fastify-plugins/maps/static-maps - -# Module: fastify-plugins/maps/static-maps - -## Table of contents - -### Interfaces - -- [StaticMapsPluginDecorator](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginDecorator.md) -- [StaticMapsPluginOpts](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md) - -### Variables - -- [PLUGIN\_NAME](fastify_plugins_maps_static_maps.md#plugin_name) - -### Functions - -- [plugin](fastify_plugins_maps_static_maps.md#plugin) - -## Variables - -### PLUGIN\_NAME - -• `Const` **PLUGIN\_NAME**: ``"mapeo-static-maps"`` - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L16) - -## Functions - -### plugin - -▸ **plugin**(`instance`, `opts`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | [`StaticMapsPluginOpts`](../interfaces/fastify_plugins_maps_static_maps.StaticMapsPluginOpts.md) | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/maps/static-maps.js#L18) diff --git a/docs/api/modules/fastify_plugins_utils.md b/docs/api/modules/fastify_plugins_utils.md deleted file mode 100644 index c96dc708c..000000000 --- a/docs/api/modules/fastify_plugins_utils.md +++ /dev/null @@ -1,73 +0,0 @@ -[API](../README.md) / fastify-plugins/utils - -# Module: fastify-plugins/utils - -## Table of contents - -### Variables - -- [NotFoundError](fastify_plugins_utils.md#notfounderror) - -### Functions - -- [createStyleJsonResponseHeaders](fastify_plugins_utils.md#createstylejsonresponseheaders) -- [getFastifyServerAddress](fastify_plugins_utils.md#getfastifyserveraddress) - -## Variables - -### NotFoundError - -• `Const` **NotFoundError**: `FastifyErrorConstructor`\<{}, [any?, any?, any?]\> - -#### Defined in - -[src/fastify-plugins/utils.js:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L4) - -## Functions - -### createStyleJsonResponseHeaders - -▸ **createStyleJsonResponseHeaders**(`lastModified`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lastModified` | `Readonly`\<`Date`\> | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `Access-Control-Allow-Headers` | `string` | -| `Access-Control-Allow-Origin` | `string` | -| `Cache-Control` | `string` | -| `Last-Modified` | `string` | - -#### Defined in - -[src/fastify-plugins/utils.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L44) - -___ - -### getFastifyServerAddress - -▸ **getFastifyServerAddress**(`server`, `options?`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `server` | `Server`\ | -| `options?` | `Object` | -| `options.timeout?` | `number` | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/fastify-plugins/utils.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/fastify-plugins/utils.js#L15) diff --git a/docs/api/modules/generated_extensions.md b/docs/api/modules/generated_extensions.md deleted file mode 100644 index c08c8a048..000000000 --- a/docs/api/modules/generated_extensions.md +++ /dev/null @@ -1,142 +0,0 @@ -[API](../README.md) / generated/extensions - -# Module: generated/extensions - -## Table of contents - -### Interfaces - -- [HaveExtension](../interfaces/generated_extensions.HaveExtension.md) -- [ProjectExtension](../interfaces/generated_extensions.ProjectExtension.md) - -### Type Aliases - -- [HaveExtension\_Namespace](generated_extensions.md#haveextension_namespace) - -### Variables - -- [HaveExtension](generated_extensions.md#haveextension) -- [HaveExtension\_Namespace](generated_extensions.md#haveextension_namespace-1) -- [ProjectExtension](generated_extensions.md#projectextension) - -### Functions - -- [haveExtension\_NamespaceFromJSON](generated_extensions.md#haveextension_namespacefromjson) -- [haveExtension\_NamespaceToNumber](generated_extensions.md#haveextension_namespacetonumber) - -## Type Aliases - -### HaveExtension\_Namespace - -Ƭ **HaveExtension\_Namespace**: typeof [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace-1)[keyof typeof [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace-1)] - -#### Defined in - -[src/generated/extensions.ts:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L21) - -[src/generated/extensions.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L30) - -## Variables - -### HaveExtension - -• **HaveExtension**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | -| `encode` | (`message`: [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`HaveExtension`](../interfaces/generated_extensions.HaveExtension.md) | - -#### Defined in - -[src/generated/extensions.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L14) - -[src/generated/extensions.ts:190](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L190) - -___ - -### HaveExtension\_Namespace - -• `Const` **HaveExtension\_Namespace**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | -| `auth` | ``"auth"`` | -| `blob` | ``"blob"`` | -| `blobIndex` | ``"blobIndex"`` | -| `config` | ``"config"`` | -| `data` | ``"data"`` | - -#### Defined in - -[src/generated/extensions.ts:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L21) - -[src/generated/extensions.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L30) - -___ - -### ProjectExtension - -• **ProjectExtension**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | -| `encode` | (`message`: [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`ProjectExtension`](../interfaces/generated_extensions.ProjectExtension.md) | - -#### Defined in - -[src/generated/extensions.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L5) - -[src/generated/extensions.ts:85](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L85) - -## Functions - -### haveExtension\_NamespaceFromJSON - -▸ **haveExtension_NamespaceFromJSON**(`object`): [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `any` | - -#### Returns - -[`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) - -#### Defined in - -[src/generated/extensions.ts:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L32) - -___ - -### haveExtension\_NamespaceToNumber - -▸ **haveExtension_NamespaceToNumber**(`object`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | [`HaveExtension_Namespace`](generated_extensions.md#haveextension_namespace) | - -#### Returns - -`number` - -#### Defined in - -[src/generated/extensions.ts:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/extensions.ts#L56) diff --git a/docs/api/modules/generated_keys.md b/docs/api/modules/generated_keys.md deleted file mode 100644 index 669017786..000000000 --- a/docs/api/modules/generated_keys.md +++ /dev/null @@ -1,57 +0,0 @@ -[API](../README.md) / generated/keys - -# Module: generated/keys - -## Table of contents - -### Interfaces - -- [EncryptionKeys](../interfaces/generated_keys.EncryptionKeys.md) -- [ProjectKeys](../interfaces/generated_keys.ProjectKeys.md) - -### Variables - -- [EncryptionKeys](generated_keys.md#encryptionkeys) -- [ProjectKeys](generated_keys.md#projectkeys) - -## Variables - -### EncryptionKeys - -• **EncryptionKeys**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | -| `encode` | (`message`: [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`EncryptionKeys`](../interfaces/generated_keys.EncryptionKeys.md) | - -#### Defined in - -[src/generated/keys.ts:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L4) - -[src/generated/keys.ts:22](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L22) - -___ - -### ProjectKeys - -• **ProjectKeys**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | -| `encode` | (`message`: [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`ProjectKeys`](../interfaces/generated_keys.ProjectKeys.md) | - -#### Defined in - -[src/generated/keys.ts:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L12) - -[src/generated/keys.ts:111](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/keys.ts#L111) diff --git a/docs/api/modules/generated_rpc.md b/docs/api/modules/generated_rpc.md deleted file mode 100644 index d4fdbf2eb..000000000 --- a/docs/api/modules/generated_rpc.md +++ /dev/null @@ -1,225 +0,0 @@ -[API](../README.md) / generated/rpc - -# Module: generated/rpc - -## Table of contents - -### References - -- [Invite](generated_rpc.md#invite) -- [InviteCancel](generated_rpc.md#invitecancel) -- [InviteResponse](generated_rpc.md#inviteresponse) -- [ProjectJoinDetails](generated_rpc.md#projectjoindetails) - -### Interfaces - -- [DeviceInfo](../interfaces/generated_rpc.DeviceInfo.md) - -### Type Aliases - -- [DeviceInfo\_DeviceType](generated_rpc.md#deviceinfo_devicetype) -- [InviteResponse\_Decision](generated_rpc.md#inviteresponse_decision) - -### Variables - -- [DeviceInfo](generated_rpc.md#deviceinfo) -- [DeviceInfo\_DeviceType](generated_rpc.md#deviceinfo_devicetype-1) -- [InviteResponse\_Decision](generated_rpc.md#inviteresponse_decision-1) - -### Functions - -- [deviceInfo\_DeviceTypeFromJSON](generated_rpc.md#deviceinfo_devicetypefromjson) -- [deviceInfo\_DeviceTypeToNumber](generated_rpc.md#deviceinfo_devicetypetonumber) -- [inviteResponse\_DecisionFromJSON](generated_rpc.md#inviteresponse_decisionfromjson) -- [inviteResponse\_DecisionToNumber](generated_rpc.md#inviteresponse_decisiontonumber) - -## References - -### Invite - -Renames and re-exports [InviteRpcMessage](invite_api.md#inviterpcmessage) - -___ - -### InviteCancel - -Re-exports [InviteCancel](invite_api.md#invitecancel) - -___ - -### InviteResponse - -Re-exports [InviteResponse](member_api.md#inviteresponse) - -___ - -### ProjectJoinDetails - -Re-exports [ProjectJoinDetails](invite_api.md#projectjoindetails) - -## Type Aliases - -### DeviceInfo\_DeviceType - -Ƭ **DeviceInfo\_DeviceType**: typeof [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype-1)[keyof typeof [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype-1)] - -#### Defined in - -[src/generated/rpc.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L75) - -[src/generated/rpc.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L82) - -___ - -### InviteResponse\_Decision - -Ƭ **InviteResponse\_Decision**: typeof [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision-1)[keyof typeof [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision-1)] - -#### Defined in - -[src/generated/rpc.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L23) - -[src/generated/rpc.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L30) - -## Variables - -### DeviceInfo - -• **DeviceInfo**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | -| `encode` | (`message`: [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`DeviceInfo`](../interfaces/generated_rpc.DeviceInfo.md) | - -#### Defined in - -[src/generated/rpc.ts:70](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L70) - -[src/generated/rpc.ts:390](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L390) - -___ - -### DeviceInfo\_DeviceType - -• `Const` **DeviceInfo\_DeviceType**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | -| `desktop` | ``"desktop"`` | -| `mobile` | ``"mobile"`` | -| `tablet` | ``"tablet"`` | - -#### Defined in - -[src/generated/rpc.ts:75](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L75) - -[src/generated/rpc.ts:82](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L82) - -___ - -### InviteResponse\_Decision - -• `Const` **InviteResponse\_Decision**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ACCEPT` | ``"ACCEPT"`` | -| `ALREADY` | ``"ALREADY"`` | -| `REJECT` | ``"REJECT"`` | -| `UNRECOGNIZED` | ``"UNRECOGNIZED"`` | - -#### Defined in - -[src/generated/rpc.ts:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L23) - -[src/generated/rpc.ts:30](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L30) - -## Functions - -### deviceInfo\_DeviceTypeFromJSON - -▸ **deviceInfo_DeviceTypeFromJSON**(`object`): [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `any` | - -#### Returns - -[`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) - -#### Defined in - -[src/generated/rpc.ts:84](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L84) - -___ - -### deviceInfo\_DeviceTypeToNumber - -▸ **deviceInfo_DeviceTypeToNumber**(`object`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | [`DeviceInfo_DeviceType`](generated_rpc.md#deviceinfo_devicetype) | - -#### Returns - -`number` - -#### Defined in - -[src/generated/rpc.ts:102](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L102) - -___ - -### inviteResponse\_DecisionFromJSON - -▸ **inviteResponse_DecisionFromJSON**(`object`): [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `any` | - -#### Returns - -[`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) - -#### Defined in - -[src/generated/rpc.ts:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L32) - -___ - -### inviteResponse\_DecisionToNumber - -▸ **inviteResponse_DecisionToNumber**(`object`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | [`InviteResponse_Decision`](generated_rpc.md#inviteresponse_decision) | - -#### Returns - -`number` - -#### Defined in - -[src/generated/rpc.ts:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L50) diff --git a/docs/api/modules/icon_api.md b/docs/api/modules/icon_api.md deleted file mode 100644 index c3d480f0f..000000000 --- a/docs/api/modules/icon_api.md +++ /dev/null @@ -1,116 +0,0 @@ -[API](../README.md) / icon-api - -# Module: icon-api - -## Table of contents - -### Classes - -- [IconApi](../classes/icon_api.IconApi.md) - -### Interfaces - -- [BitmapOpts](../interfaces/icon_api.BitmapOpts.md) -- [SvgOpts](../interfaces/icon_api.SvgOpts.md) - -### Type Aliases - -- [IconVariant](icon_api.md#iconvariant) -- [IconVariants](icon_api.md#iconvariants) - -### Variables - -- [kGetIconBlob](icon_api.md#kgeticonblob) - -### Functions - -- [constructIconPath](icon_api.md#constructiconpath) -- [getBestVariant](icon_api.md#getbestvariant) - -## Type Aliases - -### IconVariant - -Ƭ **IconVariant**\<\>: `any`[][`number`] - -#### Defined in - -[src/icon-api.js:4](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L4) - -___ - -### IconVariants - -Ƭ **IconVariants**\<\>: `IconValue`[``"variants"``] - -#### Defined in - -[src/icon-api.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L3) - -## Variables - -### kGetIconBlob - -• `Const` **kGetIconBlob**: typeof [`kGetIconBlob`](icon_api.md#kgeticonblob) - -#### Defined in - -[src/icon-api.js:1](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L1) - -## Functions - -### constructIconPath - -▸ **constructIconPath**(`opts`): `string` - -General purpose path builder for an icon - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `opts` | `Object` | -| `opts.extension` | `string` | -| `opts.iconId` | `string` | -| `opts.pixelDensity` | `undefined` \| `number` | -| `opts.size` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/icon-api.js:258](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L258) - -___ - -### getBestVariant - -▸ **getBestVariant**(`variants`, `opts`): {} \| {} - -Given a list of icon variants returns the variant that most closely matches the desired parameters. -Rules, in order of precedence: - -1. Matching mime type (throw if no matches) -2. Matching size. If no exact match: - 1. If smaller ones exist, prefer closest smaller size. - 2. Otherwise prefer closest larger size. -3. Matching pixel density (when asking for PNGs). If no exact match: - 1. If smaller ones exist, prefer closest smaller density. - 2. Otherwise prefer closest larger density. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `variants` | ({} \| {})[] | -| `opts` | [`BitmapOpts`](../interfaces/icon_api.BitmapOpts.md) \| [`SvgOpts`](../interfaces/icon_api.SvgOpts.md) | - -#### Returns - -{} \| {} - -#### Defined in - -[src/icon-api.js:146](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/icon-api.js#L146) diff --git a/docs/api/modules/index.md b/docs/api/modules/index.md deleted file mode 100644 index 974d49488..000000000 --- a/docs/api/modules/index.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / index - -# Module: index - -## Table of contents - -### References - -- [FastifyController](index.md#fastifycontroller) -- [MapeoManager](index.md#mapeomanager) -- [MapeoMapsFastifyPlugin](index.md#mapeomapsfastifyplugin) -- [MapeoOfflineFallbackMapFastifyPlugin](index.md#mapeoofflinefallbackmapfastifyplugin) -- [MapeoStaticMapsFastifyPlugin](index.md#mapeostaticmapsfastifyplugin) - -## References - -### FastifyController - -Re-exports [FastifyController](../classes/fastify_controller.FastifyController.md) - -___ - -### MapeoManager - -Re-exports [MapeoManager](../classes/mapeo_manager.MapeoManager.md) - -___ - -### MapeoMapsFastifyPlugin - -Renames and re-exports [plugin](fastify_plugins_maps.md#plugin) - -___ - -### MapeoOfflineFallbackMapFastifyPlugin - -Renames and re-exports [plugin](fastify_plugins_maps_offline_fallback_map.md#plugin) - -___ - -### MapeoStaticMapsFastifyPlugin - -Renames and re-exports [plugin](fastify_plugins_maps_static_maps.md#plugin) diff --git a/docs/api/modules/index_writer.md b/docs/api/modules/index_writer.md deleted file mode 100644 index c6986475e..000000000 --- a/docs/api/modules/index_writer.md +++ /dev/null @@ -1,47 +0,0 @@ -[API](../README.md) / index-writer - -# Module: index-writer - -## Table of contents - -### Classes - -- [IndexWriter](../classes/index_writer.IndexWriter.md) - -### Type Aliases - -- [IndexedDocIds](index_writer.md#indexeddocids) -- [MapeoDocInternal](index_writer.md#mapeodocinternal) -- [MapeoDocTables](index_writer.md#mapeodoctables) - -## Type Aliases - -### IndexedDocIds - -Ƭ **IndexedDocIds**\<\>: \{ [K in MapeoDoc["schemaName"]]?: string[] } - -#### Defined in - -[src/index-writer/index.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L15) - -___ - -### MapeoDocInternal - -Ƭ **MapeoDocInternal**\<\>: `ReturnType`\<`decode`\> - -#### Defined in - -[src/index-writer/index.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/index-writer/index.js#L18) - -___ - -### MapeoDocTables - -Ƭ **MapeoDocTables**: [`GetMapeoDocTables`](datatype-1.md#getmapeodoctables)\<[`schema/project`](schema_project.md)\> \| [`GetMapeoDocTables`](datatype-1.md#getmapeodoctables)\<[`schema/client`](schema_client.md)\> - -Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables) - -#### Defined in - -[src/datatype/index.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/datatype/index.d.ts#L20) diff --git a/docs/api/modules/invite_api.md b/docs/api/modules/invite_api.md deleted file mode 100644 index 2c367044b..000000000 --- a/docs/api/modules/invite_api.md +++ /dev/null @@ -1,121 +0,0 @@ -[API](../README.md) / invite-api - -# Module: invite-api - -## Table of contents - -### Classes - -- [InviteApi](../classes/invite_api.InviteApi.md) - -### Interfaces - -- [InviteApiEvents](../interfaces/invite_api.InviteApiEvents.md) -- [InviteCancel](../interfaces/invite_api.InviteCancel.md) -- [InviteRpcMessage](../interfaces/invite_api.InviteRpcMessage.md) -- [ProjectJoinDetails](../interfaces/invite_api.ProjectJoinDetails.md) - -### Type Aliases - -- [Invite](invite_api.md#invite) -- [InviteInternal](invite_api.md#inviteinternal) -- [InviteRemovalReason](invite_api.md#inviteremovalreason) - -### Variables - -- [InviteCancel](invite_api.md#invitecancel) -- [InviteRpcMessage](invite_api.md#inviterpcmessage) -- [ProjectJoinDetails](invite_api.md#projectjoindetails) - -## Type Aliases - -### Invite - -Ƭ **Invite**\<\>: [`types`](types.md) - -#### Defined in - -[src/invite-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L26) - -___ - -### InviteInternal - -Ƭ **InviteInternal**\<\>: [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) & \{ `receivedAt`: `number` } - -#### Defined in - -[src/invite-api.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L23) - -___ - -### InviteRemovalReason - -Ƭ **InviteRemovalReason**\<\>: ``"accepted"`` \| ``"rejected"`` \| ``"canceled"`` \| ``"accepted other"`` \| ``"connection error"`` \| ``"internal error"`` - -#### Defined in - -[src/invite-api.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/invite-api.js#L36) - -## Variables - -### InviteCancel - -• **InviteCancel**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | -| `encode` | (`message`: [`InviteCancel`](../interfaces/invite_api.InviteCancel.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`InviteCancel`](../interfaces/invite_api.InviteCancel.md) | - -#### Defined in - -[src/generated/rpc.ts:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L14) - -[src/generated/rpc.ts:220](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L220) - -___ - -### InviteRpcMessage - -• **InviteRpcMessage**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | -| `encode` | (`message`: [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`InviteRpcMessage`](../interfaces/invite_api.InviteRpcMessage.md) | - -#### Defined in - -[src/generated/rpc.ts:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L5) - -[src/generated/rpc.ts:120](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L120) - -___ - -### ProjectJoinDetails - -• **ProjectJoinDetails**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | -| `encode` | (`message`: [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`ProjectJoinDetails`](../interfaces/invite_api.ProjectJoinDetails.md) | - -#### Defined in - -[src/generated/rpc.ts:64](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L64) - -[src/generated/rpc.ts:321](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L321) diff --git a/docs/api/modules/lib_hashmap.md b/docs/api/modules/lib_hashmap.md deleted file mode 100644 index 6b9f1c73d..000000000 --- a/docs/api/modules/lib_hashmap.md +++ /dev/null @@ -1,23 +0,0 @@ -[API](../README.md) / lib/hashmap - -# Module: lib/hashmap - -## Table of contents - -### Classes - -- [default](../classes/lib_hashmap.default.md) - -### Type Aliases - -- [Primitive](lib_hashmap.md#primitive) - -## Type Aliases - -### Primitive - -Ƭ **Primitive**\<\>: `string` \| `number` \| `bigint` \| `boolean` \| `undefined` \| `symbol` \| ``null`` - -#### Defined in - -[src/lib/hashmap.js:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/hashmap.js#L3) diff --git a/docs/api/modules/lib_ponyfills.md b/docs/api/modules/lib_ponyfills.md deleted file mode 100644 index 9593f5238..000000000 --- a/docs/api/modules/lib_ponyfills.md +++ /dev/null @@ -1,33 +0,0 @@ -[API](../README.md) / lib/ponyfills - -# Module: lib/ponyfills - -## Table of contents - -### Functions - -- [abortSignalAny](lib_ponyfills.md#abortsignalany) - -## Functions - -### abortSignalAny - -▸ **abortSignalAny**(`iterable`): `AbortSignal` - -Ponyfill of `AbortSignal.any()`. - -[0]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any_static - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iterable` | `Iterable`\<`AbortSignal`\> | - -#### Returns - -`AbortSignal` - -#### Defined in - -[src/lib/ponyfills.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/ponyfills.js#L11) diff --git a/docs/api/modules/lib_string.md b/docs/api/modules/lib_string.md deleted file mode 100644 index 2dd1b510e..000000000 --- a/docs/api/modules/lib_string.md +++ /dev/null @@ -1,31 +0,0 @@ -[API](../README.md) / lib/string - -# Module: lib/string - -## Table of contents - -### Functions - -- [isBlank](lib_string.md#isblank) - -## Functions - -### isBlank - -▸ **isBlank**(`str`): `boolean` - -Returns `true` if the string is empty or only contains whitespace, `false` otherwise. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/lib/string.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/string.js#L9) diff --git a/docs/api/modules/lib_timing_safe_equal.md b/docs/api/modules/lib_timing_safe_equal.md deleted file mode 100644 index cddfd4b8c..000000000 --- a/docs/api/modules/lib_timing_safe_equal.md +++ /dev/null @@ -1,43 +0,0 @@ -[API](../README.md) / lib/timing-safe-equal - -# Module: lib/timing-safe-equal - -## Table of contents - -### Functions - -- [default](lib_timing_safe_equal.md#default) - -## Functions - -### default - -▸ **default**\<`T`\>(`a`, `b`): `boolean` - -Compare two values in constant time. - -Useful when you want to avoid leaking data. - -Like `crypto.timingSafeEqual`, but works with strings and doesn't throw if -lengths differ. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `string` \| `ArrayBufferView` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `T` | -| `b` | `T` | - -#### Returns - -`boolean` - -#### Defined in - -[src/lib/timing-safe-equal.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/lib/timing-safe-equal.js#L28) diff --git a/docs/api/modules/local_peers.md b/docs/api/modules/local_peers.md deleted file mode 100644 index cc98b743b..000000000 --- a/docs/api/modules/local_peers.md +++ /dev/null @@ -1,86 +0,0 @@ -[API](../README.md) / local-peers - -# Module: local-peers - -## Table of contents - -### Classes - -- [LocalPeers](../classes/local_peers.LocalPeers.md) -- [PeerDisconnectedError](../classes/local_peers.PeerDisconnectedError.md) -- [PeerFailedConnectionError](../classes/local_peers.PeerFailedConnectionError.md) -- [UnknownPeerError](../classes/local_peers.UnknownPeerError.md) - -### Interfaces - -- [LocalPeersEvents](../interfaces/local_peers.LocalPeersEvents.md) -- [PeerInfoBase](../interfaces/local_peers.PeerInfoBase.md) - -### Type Aliases - -- [PeerInfo](local_peers.md#peerinfo) -- [PeerInfoConnected](local_peers.md#peerinfoconnected) -- [PeerInfoConnecting](local_peers.md#peerinfoconnecting) -- [PeerInfoDisconnected](local_peers.md#peerinfodisconnected) -- [PeerInfoInternal](local_peers.md#peerinfointernal) -- [PeerState](local_peers.md#peerstate) - -## Type Aliases - -### PeerInfo - -Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](local_peers.md#peerinfoconnected) \| [`PeerInfoDisconnected`](local_peers.md#peerinfodisconnected) - -#### Defined in - -[src/local-peers.js:49](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L49) - -___ - -### PeerInfoConnected - -Ƭ **PeerInfoConnected**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: `Protomux`\<`__module`\> ; `status`: ``"connected"`` } - -#### Defined in - -[src/local-peers.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L45) - -___ - -### PeerInfoConnecting - -Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } - -#### Defined in - -[src/local-peers.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L44) - -___ - -### PeerInfoDisconnected - -Ƭ **PeerInfoDisconnected**\<\>: [`PeerInfoBase`](../interfaces/local_peers.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` } - -#### Defined in - -[src/local-peers.js:46](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L46) - -___ - -### PeerInfoInternal - -Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](local_peers.md#peerinfoconnecting) \| [`PeerInfoConnected`](local_peers.md#peerinfoconnected) \| [`PeerInfoDisconnected`](local_peers.md#peerinfodisconnected) - -#### Defined in - -[src/local-peers.js:48](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L48) - -___ - -### PeerState - -Ƭ **PeerState**\<\>: [`PeerInfoInternal`](local_peers.md#peerinfointernal)[``"status"``] - -#### Defined in - -[src/local-peers.js:50](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/local-peers.js#L50) diff --git a/docs/api/modules/logger.md b/docs/api/modules/logger.md deleted file mode 100644 index 6ad5fa76b..000000000 --- a/docs/api/modules/logger.md +++ /dev/null @@ -1,9 +0,0 @@ -[API](../README.md) / logger - -# Module: logger - -## Table of contents - -### Classes - -- [Logger](../classes/logger.Logger.md) diff --git a/docs/api/modules/mapeo_manager.md b/docs/api/modules/mapeo_manager.md deleted file mode 100644 index 473a71f9a..000000000 --- a/docs/api/modules/mapeo_manager.md +++ /dev/null @@ -1,63 +0,0 @@ -[API](../README.md) / mapeo-manager - -# Module: mapeo-manager - -## Table of contents - -### Classes - -- [MapeoManager](../classes/mapeo_manager.MapeoManager.md) - -### Interfaces - -- [MapeoManagerEvents](../interfaces/mapeo_manager.MapeoManagerEvents.md) - -### Type Aliases - -- [PublicPeerInfo](mapeo_manager.md#publicpeerinfo) -- [ValidatedProjectKeys](mapeo_manager.md#validatedprojectkeys) - -### Variables - -- [kManagerReplicate](mapeo_manager.md#kmanagerreplicate) -- [kRPC](mapeo_manager.md#krpc) - -## Type Aliases - -### PublicPeerInfo - -Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`local-peers`](local_peers.md), ``"protomux"``\> - -#### Defined in - -[src/mapeo-manager.js:65](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L65) - -___ - -### ValidatedProjectKeys - -Ƭ **ValidatedProjectKeys**\<\>: `SetNonNullable` - -#### Defined in - -[src/mapeo-manager.js:47](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L47) - -## Variables - -### kManagerReplicate - -• `Const` **kManagerReplicate**: typeof [`kManagerReplicate`](mapeo_manager.md#kmanagerreplicate) - -#### Defined in - -[src/mapeo-manager.js:62](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L62) - -___ - -### kRPC - -• `Const` **kRPC**: typeof [`kRPC`](mapeo_manager.md#krpc) - -#### Defined in - -[src/mapeo-manager.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-manager.js#L61) diff --git a/docs/api/modules/mapeo_project.md b/docs/api/modules/mapeo_project.md deleted file mode 100644 index e0bbe044d..000000000 --- a/docs/api/modules/mapeo_project.md +++ /dev/null @@ -1,103 +0,0 @@ -[API](../README.md) / mapeo-project - -# Module: mapeo-project - -## Table of contents - -### Classes - -- [MapeoProject](../classes/mapeo_project.MapeoProject.md) - -### Type Aliases - -- [EditableProjectSettings](mapeo_project.md#editableprojectsettings) - -### Variables - -- [kBlobStore](mapeo_project.md#kblobstore) -- [kCoreManager](mapeo_project.md#kcoremanager) -- [kCoreOwnership](mapeo_project.md#kcoreownership) -- [kDataTypes](mapeo_project.md#kdatatypes) -- [kProjectLeave](mapeo_project.md#kprojectleave) -- [kProjectReplicate](mapeo_project.md#kprojectreplicate) -- [kSetOwnDeviceInfo](mapeo_project.md#ksetowndeviceinfo) - -## Type Aliases - -### EditableProjectSettings - -Ƭ **EditableProjectSettings**\<\>: `Omit`\<`ProjectSettingsValue`, ``"schemaName"``\> - -#### Defined in - -[src/mapeo-project.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L51) - -## Variables - -### kBlobStore - -• `Const` **kBlobStore**: typeof [`kBlobStore`](mapeo_project.md#kblobstore) - -#### Defined in - -[src/mapeo-project.js:58](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L58) - -___ - -### kCoreManager - -• `Const` **kCoreManager**: typeof [`kCoreManager`](mapeo_project.md#kcoremanager) - -#### Defined in - -[src/mapeo-project.js:55](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L55) - -___ - -### kCoreOwnership - -• `Const` **kCoreOwnership**: typeof [`kCoreOwnership`](mapeo_project.md#kcoreownership) - -#### Defined in - -[src/mapeo-project.js:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L56) - -___ - -### kDataTypes - -• `Const` **kDataTypes**: typeof [`kDataTypes`](mapeo_project.md#kdatatypes) - -#### Defined in - -[src/mapeo-project.js:60](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L60) - -___ - -### kProjectLeave - -• `Const` **kProjectLeave**: typeof [`kProjectLeave`](mapeo_project.md#kprojectleave) - -#### Defined in - -[src/mapeo-project.js:61](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L61) - -___ - -### kProjectReplicate - -• `Const` **kProjectReplicate**: typeof [`kProjectReplicate`](mapeo_project.md#kprojectreplicate) - -#### Defined in - -[src/mapeo-project.js:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L59) - -___ - -### kSetOwnDeviceInfo - -• `Const` **kSetOwnDeviceInfo**: typeof [`kSetOwnDeviceInfo`](mapeo_project.md#ksetowndeviceinfo) - -#### Defined in - -[src/mapeo-project.js:57](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/mapeo-project.js#L57) diff --git a/docs/api/modules/member_api.md b/docs/api/modules/member_api.md deleted file mode 100644 index 72eab4060..000000000 --- a/docs/api/modules/member_api.md +++ /dev/null @@ -1,74 +0,0 @@ -[API](../README.md) / member-api - -# Module: member-api - -## Table of contents - -### References - -- [Invite](member_api.md#invite) - -### Classes - -- [MemberApi](../classes/member_api.MemberApi.md) - -### Interfaces - -- [InviteResponse](../interfaces/member_api.InviteResponse.md) -- [MemberInfo](../interfaces/member_api.MemberInfo.md) - -### Type Aliases - -- [DeviceInfoDataType](member_api.md#deviceinfodatatype) -- [ProjectDataType](member_api.md#projectdatatype) - -### Variables - -- [InviteResponse](member_api.md#inviteresponse) - -## References - -### Invite - -Renames and re-exports [InviteRpcMessage](invite_api.md#inviterpcmessage) - -## Type Aliases - -### DeviceInfoDataType - -Ƭ **DeviceInfoDataType**\<\>: [`datatype`](datatype-1.md) - -#### Defined in - -[src/member-api.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L25) - -___ - -### ProjectDataType - -Ƭ **ProjectDataType**\<\>: [`datatype`](datatype-1.md) - -#### Defined in - -[src/member-api.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/member-api.js#L26) - -## Variables - -### InviteResponse - -• **InviteResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `create` | \(`base?`: `I`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | -| `decode` | (`input`: `Uint8Array` \| `Reader`, `length?`: `number`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | -| `encode` | (`message`: [`InviteResponse`](../interfaces/member_api.InviteResponse.md), `writer`: `Writer`) => `Writer` | -| `fromPartial` | \(`object`: `I`) => [`InviteResponse`](../interfaces/member_api.InviteResponse.md) | - -#### Defined in - -[src/generated/rpc.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L18) - -[src/generated/rpc.ts:265](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/generated/rpc.ts#L265) diff --git a/docs/api/modules/roles.md b/docs/api/modules/roles.md deleted file mode 100644 index c48922c82..000000000 --- a/docs/api/modules/roles.md +++ /dev/null @@ -1,247 +0,0 @@ -[API](../README.md) / roles - -# Module: roles - -## Table of contents - -### Classes - -- [Roles](../classes/roles.Roles.md) - -### Interfaces - -- [DocCapability](../interfaces/roles.DocCapability.md) -- [Role](../interfaces/roles.Role.md) - -### Type Aliases - -- [ElementOf](roles.md#elementof) -- [RoleId](roles.md#roleid) -- [RoleIdAssignableToAnyone](roles.md#roleidassignabletoanyone) -- [RoleIdAssignableToOthers](roles.md#roleidassignabletoothers) -- [RoleIdForNewInvite](roles.md#roleidfornewinvite) - -### Variables - -- [BLOCKED\_ROLE\_ID](roles.md#blocked_role_id) -- [COORDINATOR\_ROLE\_ID](roles.md#coordinator_role_id) -- [CREATOR\_ROLE](roles.md#creator_role) -- [CREATOR\_ROLE\_ID](roles.md#creator_role_id) -- [LEFT\_ROLE\_ID](roles.md#left_role_id) -- [MEMBER\_ROLE\_ID](roles.md#member_role_id) -- [NO\_ROLE](roles.md#no_role) -- [NO\_ROLE\_ID](roles.md#no_role_id) -- [ROLES](roles.md#roles) - -### Functions - -- [isRoleIdAssignableToOthers](roles.md#isroleidassignabletoothers) -- [isRoleIdForNewInvite](roles.md#isroleidfornewinvite) - -## Type Aliases - -### ElementOf - -Ƭ **ElementOf**\<`T`\>: `T` extends `Iterable`\ ? `U` : `never` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/roles.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L15) - -___ - -### RoleId - -Ƭ **RoleId**\<\>: [`ElementOf`](roles.md#elementof)\ - -#### Defined in - -[src/roles.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L19) - -___ - -### RoleIdAssignableToAnyone - -Ƭ **RoleIdAssignableToAnyone**\<\>: [`ElementOf`](roles.md#elementof)\ - -#### Defined in - -[src/roles.js:44](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L44) - -___ - -### RoleIdAssignableToOthers - -Ƭ **RoleIdAssignableToOthers**\<\>: [`ElementOf`](roles.md#elementof)\ - -#### Defined in - -[src/roles.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L38) - -___ - -### RoleIdForNewInvite - -Ƭ **RoleIdForNewInvite**\<\>: [`ElementOf`](roles.md#elementof)\ - -#### Defined in - -[src/roles.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L32) - -## Variables - -### BLOCKED\_ROLE\_ID - -• `Const` **BLOCKED\_ROLE\_ID**: ``"9e6d29263cba36c9"`` - -#### Defined in - -[src/roles.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L10) - -___ - -### COORDINATOR\_ROLE\_ID - -• `Const` **COORDINATOR\_ROLE\_ID**: ``"f7c150f5a3a9a855"`` - -#### Defined in - -[src/roles.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L8) - -___ - -### CREATOR\_ROLE - -• `Const` **CREATOR\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"``\> - -This is currently the same as 'Coordinator' role, but defined separately -because the creator should always have ALL powers, but we could edit the -'Coordinator' powers in the future. - -#### Defined in - -[src/roles.js:80](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L80) - -___ - -### CREATOR\_ROLE\_ID - -• `Const` **CREATOR\_ROLE\_ID**: ``"a12a6702b93bd7ff"`` - -#### Defined in - -[src/roles.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L7) - -___ - -### LEFT\_ROLE\_ID - -• `Const` **LEFT\_ROLE\_ID**: ``"8ced989b1904606b"`` - -#### Defined in - -[src/roles.js:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L11) - -___ - -### MEMBER\_ROLE\_ID - -• `Const` **MEMBER\_ROLE\_ID**: ``"012fd2d431c0bf60"`` - -#### Defined in - -[src/roles.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L9) - -___ - -### NO\_ROLE - -• `Const` **NO\_ROLE**: [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> - -This is the role assumed for a device when no role record can be found. This -can happen when an invited device did not manage to sync with the device that -invited them, and they then try to sync with someone else. We want them to be -able to sync the auth and config store, because that way they may be able to -receive their role record, and they can get the project config so that they -can start collecting data. - -#### Defined in - -[src/roles.js:109](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L109) - -___ - -### NO\_ROLE\_ID - -• `Const` **NO\_ROLE\_ID**: ``"08e4251e36f6e7ed"`` - -#### Defined in - -[src/roles.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L12) - -___ - -### ROLES - -• `Const` **ROLES**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `012fd2d431c0bf60` | [`Role`](../interfaces/roles.Role.md)\<``"012fd2d431c0bf60"``\> | -| `08e4251e36f6e7ed` | [`Role`](../interfaces/roles.Role.md)\<``"08e4251e36f6e7ed"``\> | -| `8ced989b1904606b` | [`Role`](../interfaces/roles.Role.md)\<``"8ced989b1904606b"``\> | -| `9e6d29263cba36c9` | [`Role`](../interfaces/roles.Role.md)\<``"9e6d29263cba36c9"``\> | -| `a12a6702b93bd7ff` | [`Role`](../interfaces/roles.Role.md)\<``"a12a6702b93bd7ff"``\> | -| `f7c150f5a3a9a855` | [`Role`](../interfaces/roles.Role.md)\<``"f7c150f5a3a9a855"``\> | - -#### Defined in - -[src/roles.js:129](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L129) - -## Functions - -### isRoleIdAssignableToOthers - -▸ **isRoleIdAssignableToOthers**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Returns - -value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" - -#### Defined in - -[src/roles.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L42) - -___ - -### isRoleIdForNewInvite - -▸ **isRoleIdForNewInvite**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Returns - -value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" - -#### Defined in - -[src/roles.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/roles.js#L36) diff --git a/docs/api/modules/schema_client.md b/docs/api/modules/schema_client.md deleted file mode 100644 index fad688594..000000000 --- a/docs/api/modules/schema_client.md +++ /dev/null @@ -1,70 +0,0 @@ -[API](../README.md) / schema/client - -# Module: schema/client - -## Table of contents - -### Interfaces - -- [ProjectInfo](../interfaces/schema_client.ProjectInfo.md) - -### Type Aliases - -- [DeviceInfoParam](schema_client.md#deviceinfoparam) - -### Variables - -- [localDeviceInfoTable](schema_client.md#localdeviceinfotable) -- [projectBacklinkTable](schema_client.md#projectbacklinktable) -- [projectKeysTable](schema_client.md#projectkeystable) -- [projectSettingsTable](schema_client.md#projectsettingstable) - -## Type Aliases - -### DeviceInfoParam - -Ƭ **DeviceInfoParam**\<\>: `Omit`\<`DeviceInfoValue`, ``"schemaName"``\> - -#### Defined in - -[src/schema/client.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L42) - -## Variables - -### localDeviceInfoTable - -• `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/client.js:51](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L51) - -___ - -### projectBacklinkTable - -• `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/client.js:27](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L27) - -___ - -### projectKeysTable - -• `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/client.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L28) - -___ - -### projectSettingsTable - -• `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/client.js:23](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/client.js#L23) diff --git a/docs/api/modules/schema_project.md b/docs/api/modules/schema_project.md deleted file mode 100644 index 192bd8044..000000000 --- a/docs/api/modules/schema_project.md +++ /dev/null @@ -1,217 +0,0 @@ -[API](../README.md) / schema/project - -# Module: schema/project - -## Table of contents - -### Variables - -- [coreOwnershipBacklinkTable](schema_project.md#coreownershipbacklinktable) -- [coreOwnershipTable](schema_project.md#coreownershiptable) -- [coresTable](schema_project.md#corestable) -- [deviceInfoBacklinkTable](schema_project.md#deviceinfobacklinktable) -- [deviceInfoTable](schema_project.md#deviceinfotable) -- [fieldBacklinkTable](schema_project.md#fieldbacklinktable) -- [fieldTable](schema_project.md#fieldtable) -- [iconBacklinkTable](schema_project.md#iconbacklinktable) -- [iconTable](schema_project.md#icontable) -- [observationBacklinkTable](schema_project.md#observationbacklinktable) -- [observationTable](schema_project.md#observationtable) -- [presetBacklinkTable](schema_project.md#presetbacklinktable) -- [presetTable](schema_project.md#presettable) -- [roleBacklinkTable](schema_project.md#rolebacklinktable) -- [roleTable](schema_project.md#roletable) -- [trackBacklinkTable](schema_project.md#trackbacklinktable) -- [trackTable](schema_project.md#tracktable) -- [translationBacklinkTable](schema_project.md#translationbacklinktable) -- [translationTable](schema_project.md#translationtable) - -## Variables - -### coreOwnershipBacklinkTable - -• `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:36](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L36) - -___ - -### coreOwnershipTable - -• `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:20](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L20) - -___ - -### coresTable - -• `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L41) - -___ - -### deviceInfoBacklinkTable - -• `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:38](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L38) - -___ - -### deviceInfoTable - -• `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L25) - -___ - -### fieldBacklinkTable - -• `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L35) - -___ - -### fieldTable - -• `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:19](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L19) - -___ - -### iconBacklinkTable - -• `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L39) - -___ - -### iconTable - -• `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:29](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L29) - -___ - -### observationBacklinkTable - -• `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:32](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L32) - -___ - -### observationTable - -• `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L13) - -___ - -### presetBacklinkTable - -• `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:34](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L34) - -___ - -### presetTable - -• `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L18) - -___ - -### roleBacklinkTable - -• `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:37](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L37) - -___ - -### roleTable - -• `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:24](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L24) - -___ - -### trackBacklinkTable - -• `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L33) - -___ - -### trackTable - -• `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:17](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L17) - -___ - -### translationBacklinkTable - -• `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:31](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L31) - -___ - -### translationTable - -• `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/project.js#L9) diff --git a/docs/api/modules/schema_schema_to_drizzle.md b/docs/api/modules/schema_schema_to_drizzle.md deleted file mode 100644 index ff724f3ac..000000000 --- a/docs/api/modules/schema_schema_to_drizzle.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / schema/schema-to-drizzle - -# Module: schema/schema-to-drizzle - -## Table of contents - -### References - -- [MapeoDocMap](schema_schema_to_drizzle.md#mapeodocmap) - -### Functions - -- [jsonSchemaToDrizzleColumns](schema_schema_to_drizzle.md#jsonschematodrizzlecolumns) - -## References - -### MapeoDocMap - -Re-exports [MapeoDocMap](datatype.md#mapeodocmap) - -## Functions - -### jsonSchemaToDrizzleColumns - -▸ **jsonSchemaToDrizzleColumns**\<`TSchema`, `TSchemaName`, `TObjectType`\>(`schema`): [`SchemaToDrizzleColumns`](schema_types.md#schematodrizzlecolumns)\<`TSchema`, `TObjectType`, `TSchema`[``"properties"``]\> - -Convert a JSONSchema definition to a Drizzle Columns Map (the parameter for -`sqliteTable()`). - -**NOTE**: The return of this function is _not_ type-checked (it is coerced with -`as`, because it's not possible to type-check what this function is doing), but -the return type _should_ be correct when using this function. - -#### Type parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `TSchema` | extends [`JSONSchema7WithProps`](schema_types.md#jsonschema7withprops) | NB: The inline typescript checker often marks this next line as an error, but this seems to be a bug with JSDoc parsing - running `tsc` does not show this as an error. | -| `TSchemaName` | extends `undefined` \| ``null`` \| `string` \| `number` \| `boolean` \| readonly (``null`` \| `string` \| `number` \| `boolean` \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| any \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| ReadonlyObjectDeep\ \| null)[] \| `ReadonlyObjectDeep`\<`JSONSchema7Object`\>)[] \| `ReadonlyObjectDeep`\<`JSONSchema7Object`\> | | -| `TObjectType` | extends `any` | | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `schema` | `TSchema` | - -#### Returns - -[`SchemaToDrizzleColumns`](schema_types.md#schematodrizzlecolumns)\<`TSchema`, `TObjectType`, `TSchema`[``"properties"``]\> - -#### Defined in - -[src/schema/schema-to-drizzle.js:26](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/schema-to-drizzle.js#L26) diff --git a/docs/api/modules/schema_types.md b/docs/api/modules/schema_types.md deleted file mode 100644 index 6931a921f..000000000 --- a/docs/api/modules/schema_types.md +++ /dev/null @@ -1,92 +0,0 @@ -[API](../README.md) / schema/types - -# Module: schema/types - -## Table of contents - -### Type Aliases - -- [JSONSchema7](schema_types.md#jsonschema7) -- [JSONSchema7WithProps](schema_types.md#jsonschema7withprops) -- [NonEmptyArray](schema_types.md#nonemptyarray) -- [OptionalToNull](schema_types.md#optionaltonull) -- [SchemaToDrizzleColumns](schema_types.md#schematodrizzlecolumns) - -## Type Aliases - -### JSONSchema7 - -Ƭ **JSONSchema7**: `ReadonlyDeep`\<`JSONSchema7Writable`\> - -#### Defined in - -[src/schema/types.ts:95](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L95) - -___ - -### JSONSchema7WithProps - -Ƭ **JSONSchema7WithProps**: `Omit`\<[`JSONSchema7`](schema_types.md#jsonschema7), ``"properties"``\> & \{ `properties`: `JsonSchema7Properties` } - -#### Defined in - -[src/schema/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L97) - -___ - -### NonEmptyArray - -Ƭ **NonEmptyArray**\<`T`\>: [`T`, ...T[]] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/schema/types.ts:153](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L153) - -___ - -### OptionalToNull - -Ƭ **OptionalToNull**\<`T`\>: \{ [K in keyof T]-?: undefined extends T[K] ? T[K] \| null : T[K] } - -Convert optional properties to nullable - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Object` | - -#### Defined in - -[src/schema/types.ts:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L8) - -___ - -### SchemaToDrizzleColumns - -Ƭ **SchemaToDrizzleColumns**\<`T`, `TObjectType`, `U`\>: \{ [K in keyof U]: K extends string ? U[K]["type"] extends "string" ? TextBuilder\, IsRequired\, HasDefault\\> : U[K]["type"] extends "boolean" ? BooleanBuilder\, HasDefault\\> : U[K]["type"] extends "number" ? RealBuilder\, HasDefault\\> : U[K]["type"] extends "integer" ? IntegerBuilder\, HasDefault\\> : U[K]["type"] extends "array" \| "object" ? JsonBuilder\, HasDefault\<(...)[(...)]\>\> : never : never } & \{ `forks`: `JsonBuilder`\<``"forks"``, `string`[], ``true``, ``false``\> } - -Convert a JSONSchema to a Drizzle Columns map (e.g. parameter for -`sqliteTable()`). All top-level properties map to SQLite columns, with -`required` properties marked as `NOT NULL`, and JSONSchema `default` will map -to SQLite defaults. Any properties that are of type `object` or `array` in -the JSONSchema will be mapped to a text field, which drizzle will parse and -stringify. Types for parsed JSON will be derived from MapeoDoc types. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`JSONSchema7WithProps`](schema_types.md#jsonschema7withprops) | -| `TObjectType` | extends \{ [K in keyof U]?: any } | -| `U` | extends `JsonSchema7Properties` = `T`[``"properties"``] | - -#### Defined in - -[src/schema/types.ts:133](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/types.ts#L133) diff --git a/docs/api/modules/schema_utils.md b/docs/api/modules/schema_utils.md deleted file mode 100644 index fe04e6cb8..000000000 --- a/docs/api/modules/schema_utils.md +++ /dev/null @@ -1,117 +0,0 @@ -[API](../README.md) / schema/utils - -# Module: schema/utils - -## Table of contents - -### Type Aliases - -- [SqliteTable](schema_utils.md#sqlitetable) - -### Variables - -- [BACKLINK\_TABLE\_POSTFIX](schema_utils.md#backlink_table_postfix) - -### Functions - -- [backlinkTable](schema_utils.md#backlinktable) -- [customJson](schema_utils.md#customjson) -- [getBacklinkTableName](schema_utils.md#getbacklinktablename) - -## Type Aliases - -### SqliteTable - -Ƭ **SqliteTable**\<`TName`\>: `SQLiteTableWithColumns` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TName` | extends `string` = `string` | - -#### Defined in - -[src/schema/utils.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L15) - -## Variables - -### BACKLINK\_TABLE\_POSTFIX - -• `Const` **BACKLINK\_TABLE\_POSTFIX**: ``"_backlink"`` - -**`Template`** - -#### Defined in - -[src/schema/utils.js:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L18) - -## Functions - -### backlinkTable - -▸ **backlinkTable**(`tableSchema`): `SQLiteTableWithColumns`\<{}\> - -Table for storing backlinks, used for indexing. There needs to be one for -each indexed document type - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tableSchema` | [`SqliteTable`](schema_utils.md#sqlitetable)\<`string`\> | - -#### Returns - -`SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/utils.js:25](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L25) - -___ - -### customJson - -▸ **customJson**\<`TName`\>(`dbName`, `fieldConfig?`): `SQLiteCustomColumnBuilder`\<{}\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TName` | extends `string` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `dbName` | `TName` | -| `fieldConfig?` | `unknown` | - -#### Returns - -`SQLiteCustomColumnBuilder`\<{}\> - -#### Defined in - -[src/schema/utils.js:39](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L39) - -___ - -### getBacklinkTableName - -▸ **getBacklinkTableName**(`tableName`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tableName` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/schema/utils.js:35](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/schema/utils.js#L35) diff --git a/docs/api/modules/sync_core_sync_state.md b/docs/api/modules/sync_core_sync_state.md deleted file mode 100644 index 92faf6a40..000000000 --- a/docs/api/modules/sync_core_sync_state.md +++ /dev/null @@ -1,78 +0,0 @@ -[API](../README.md) / sync/core-sync-state - -# Module: sync/core-sync-state - -## Table of contents - -### Classes - -- [CoreSyncState](../classes/sync_core_sync_state.CoreSyncState.md) - -### Interfaces - -- [CoreState](../interfaces/sync_core_sync_state.CoreState.md) -- [DerivedState](../interfaces/sync_core_sync_state.DerivedState.md) -- [InternalState](../interfaces/sync_core_sync_state.InternalState.md) - -### Type Aliases - -- [Bitfield](sync_core_sync_state.md#bitfield) -- [PeerCoreState](sync_core_sync_state.md#peercorestate) -- [PeerId](sync_core_sync_state.md#peerid) - -### Functions - -- [bitCount32](sync_core_sync_state.md#bitcount32) - -## Type Aliases - -### Bitfield - -Ƭ **Bitfield**\<\>: [`default`](../classes/core_manager_remote_bitfield.default.md) - -#### Defined in - -[src/sync/core-sync-state.js:7](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L7) - -___ - -### PeerCoreState - -Ƭ **PeerCoreState**\<\>: [`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) & \{ `status`: ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` } - -#### Defined in - -[src/sync/core-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L28) - -___ - -### PeerId - -Ƭ **PeerId**\<\>: `string` - -#### Defined in - -[src/sync/core-sync-state.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L10) - -## Functions - -### bitCount32 - -▸ **bitCount32**(`n`): `number` - -Apologies for the obscure code. From -https://stackoverflow.com/a/109025/903300 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -`number` - -#### Defined in - -[src/sync/core-sync-state.js:431](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/core-sync-state.js#L431) diff --git a/docs/api/modules/sync_namespace_sync_state.md b/docs/api/modules/sync_namespace_sync_state.md deleted file mode 100644 index 4b474ede1..000000000 --- a/docs/api/modules/sync_namespace_sync_state.md +++ /dev/null @@ -1,57 +0,0 @@ -[API](../README.md) / sync/namespace-sync-state - -# Module: sync/namespace-sync-state - -## Table of contents - -### Classes - -- [NamespaceSyncState](../classes/sync_namespace_sync_state.NamespaceSyncState.md) - -### Type Aliases - -- [SyncState](sync_namespace_sync_state.md#syncstate) - -### Functions - -- [createState](sync_namespace_sync_state.md#createstate) - -## Type Aliases - -### SyncState - -Ƭ **SyncState**\<\>: `Omit`\<[`sync/core-sync-state`](sync_core_sync_state.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } - -#### Defined in - -[src/sync/namespace-sync-state.js:5](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L5) - -## Functions - -### createState - -▸ **createState**(): [`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) - -#### Returns - -[`CoreState`](../interfaces/sync_core_sync_state.CoreState.md) - -#### Defined in - -[src/sync/namespace-sync-state.js:136](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L136) - -▸ **createState**(`status`): [`PeerCoreState`](sync_core_sync_state.md#peercorestate) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `status` | ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` | - -#### Returns - -[`PeerCoreState`](sync_core_sync_state.md#peercorestate) - -#### Defined in - -[src/sync/namespace-sync-state.js:141](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/namespace-sync-state.js#L141) diff --git a/docs/api/modules/sync_peer_sync_controller.md b/docs/api/modules/sync_peer_sync_controller.md deleted file mode 100644 index c63c60535..000000000 --- a/docs/api/modules/sync_peer_sync_controller.md +++ /dev/null @@ -1,80 +0,0 @@ -[API](../README.md) / sync/peer-sync-controller - -# Module: sync/peer-sync-controller - -## Table of contents - -### References - -- [Namespace](sync_peer_sync_controller.md#namespace) - -### Classes - -- [PeerSyncController](../classes/sync_peer_sync_controller.PeerSyncController.md) - -### Type Aliases - -- [PeerState](sync_peer_sync_controller.md#peerstate) -- [SyncCapability](sync_peer_sync_controller.md#synccapability) -- [SyncStatus](sync_peer_sync_controller.md#syncstatus) - -### Variables - -- [DATA\_NAMESPACES](sync_peer_sync_controller.md#data_namespaces) -- [PRESYNC\_NAMESPACES](sync_peer_sync_controller.md#presync_namespaces) - -## References - -### Namespace - -Re-exports [Namespace](core_manager_core_index.md#namespace) - -## Type Aliases - -### PeerState - -Ƭ **PeerState**\<\>: \{ [namespace in Namespace]?: sync/core-sync-state } - -#### Defined in - -[src/sync/peer-sync-controller.js:280](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L280) - -___ - -### SyncCapability - -Ƭ **SyncCapability**\<\>: [`roles`](roles.md)[``"sync"``][[`Namespace`](sync_peer_sync_controller.md#namespace)] \| ``"unknown"`` - -#### Defined in - -[src/sync/peer-sync-controller.js:10](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L10) - -___ - -### SyncStatus - -Ƭ **SyncStatus**\<\>: `Record`\<[`Namespace`](sync_peer_sync_controller.md#namespace), ``"unknown"`` \| ``"syncing"`` \| ``"synced"``\> - -#### Defined in - -[src/sync/peer-sync-controller.js:283](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L283) - -## Variables - -### DATA\_NAMESPACES - -• `Const` **DATA\_NAMESPACES**: (``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``)[] - -#### Defined in - -[src/sync/peer-sync-controller.js:15](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L15) - -___ - -### PRESYNC\_NAMESPACES - -• `Const` **PRESYNC\_NAMESPACES**: (``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``)[] - -#### Defined in - -[src/sync/peer-sync-controller.js:14](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/peer-sync-controller.js#L14) diff --git a/docs/api/modules/sync_sync_api.md b/docs/api/modules/sync_sync_api.md deleted file mode 100644 index 74ac0d5da..000000000 --- a/docs/api/modules/sync_sync_api.md +++ /dev/null @@ -1,54 +0,0 @@ -[API](../README.md) / sync/sync-api - -# Module: sync/sync-api - -## Table of contents - -### Classes - -- [SyncApi](../classes/sync_sync_api.SyncApi.md) - -### Interfaces - -- [State](../interfaces/sync_sync_api.State.md) -- [SyncEvents](../interfaces/sync_sync_api.SyncEvents.md) -- [SyncTypeState](../interfaces/sync_sync_api.SyncTypeState.md) - -### Type Aliases - -- [SyncType](sync_sync_api.md#synctype) - -### Variables - -- [kHandleDiscoveryKey](sync_sync_api.md#khandlediscoverykey) -- [kSyncState](sync_sync_api.md#ksyncstate) - -## Type Aliases - -### SyncType - -Ƭ **SyncType**\<\>: ``"initial"`` \| ``"full"`` - -#### Defined in - -[src/sync/sync-api.js:16](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L16) - -## Variables - -### kHandleDiscoveryKey - -• `Const` **kHandleDiscoveryKey**: typeof [`kHandleDiscoveryKey`](sync_sync_api.md#khandlediscoverykey) - -#### Defined in - -[src/sync/sync-api.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L12) - -___ - -### kSyncState - -• `Const` **kSyncState**: typeof [`kSyncState`](sync_sync_api.md#ksyncstate) - -#### Defined in - -[src/sync/sync-api.js:13](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-api.js#L13) diff --git a/docs/api/modules/sync_sync_state.md b/docs/api/modules/sync_sync_state.md deleted file mode 100644 index 9da2e2f60..000000000 --- a/docs/api/modules/sync_sync_state.md +++ /dev/null @@ -1,23 +0,0 @@ -[API](../README.md) / sync/sync-state - -# Module: sync/sync-state - -## Table of contents - -### Classes - -- [SyncState](../classes/sync_sync_state.SyncState.md) - -### Type Aliases - -- [State](sync_sync_state.md#state) - -## Type Aliases - -### State - -Ƭ **State**\<\>: `Record`\<[`core-manager`](core_manager.md), [`sync/namespace-sync-state`](sync_namespace_sync_state.md)\> - -#### Defined in - -[src/sync/sync-state.js:12](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/sync/sync-state.js#L12) diff --git a/docs/api/modules/types.md b/docs/api/modules/types.md deleted file mode 100644 index 9144a0f4d..000000000 --- a/docs/api/modules/types.md +++ /dev/null @@ -1,241 +0,0 @@ -[API](../README.md) / types - -# Module: types - -## Table of contents - -### References - -- [BlobId](types.md#blobid) -- [BlobType](types.md#blobtype) -- [CoreOwnershipWithSignatures](types.md#coreownershipwithsignatures) -- [MapeoDocMap](types.md#mapeodocmap) -- [MapeoValueMap](types.md#mapeovaluemap) - -### Type Aliases - -- [BlobFilter](types.md#blobfilter) -- [BlobVariant](types.md#blobvariant) -- [CoreOwnershipWithSignaturesValue](types.md#coreownershipwithsignaturesvalue) -- [CoreStorage](types.md#corestorage) -- [DefaultEmitterEvents](types.md#defaultemitterevents) -- [IdentityKeyPair](types.md#identitykeypair) -- [KeyPair](types.md#keypair) -- [MapBuffers](types.md#mapbuffers) -- [NullableToOptional](types.md#nullabletooptional) -- [PublicKey](types.md#publickey) -- [ReplicationStream](types.md#replicationstream) -- [SecretKey](types.md#secretkey) - -## References - -### BlobId - -Re-exports [BlobId](blob_api.md#blobid) - -___ - -### BlobType - -Re-exports [BlobType](blob_api.md#blobtype) - -___ - -### CoreOwnershipWithSignatures - -Re-exports [CoreOwnershipWithSignatures](core_ownership.md#coreownershipwithsignatures) - -___ - -### MapeoDocMap - -Re-exports [MapeoDocMap](datatype.md#mapeodocmap) - -___ - -### MapeoValueMap - -Re-exports [MapeoValueMap](datatype.md#mapeovaluemap) - -## Type Aliases - -### BlobFilter - -Ƭ **BlobFilter**: `RequireAtLeastOne`\<\{ [KeyType in BlobType]: ArrayAtLeastOne\\> }\> - -#### Defined in - -[src/types.ts:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L42) - -___ - -### BlobVariant - -Ƭ **BlobVariant**\<`TBlobType`\>: `TupleToUnion`\<`SupportedBlobVariants`[`TBlobType`]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TBlobType` | extends [`BlobType`](blob_api.md#blobtype) | - -#### Defined in - -[src/types.ts:18](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L18) - -___ - -### CoreOwnershipWithSignaturesValue - -Ƭ **CoreOwnershipWithSignaturesValue**: `Omit`\<[`CoreOwnershipWithSignatures`](core_ownership.md#coreownershipwithsignatures), `Exclude`\\> - -#### Defined in - -[src/types.ts:59](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L59) - -___ - -### CoreStorage - -Ƭ **CoreStorage**: (`name`: `string`) => `RandomAccessStorage` - -#### Type declaration - -▸ (`name`): `RandomAccessStorage` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | - -##### Returns - -`RandomAccessStorage` - -#### Defined in - -[src/types.ts:114](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L114) - -___ - -### DefaultEmitterEvents - -Ƭ **DefaultEmitterEvents**\<`L`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `L` | extends `ListenerSignature`\<`L`\> = `DefaultListener` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `newListener` | (`event`: keyof `L`, `listener`: `L`[keyof `L`]) => `void` | -| `removeListener` | (`event`: keyof `L`, `listener`: `L`[keyof `L`]) => `void` | - -#### Defined in - -[src/types.ts:116](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L116) - -___ - -### IdentityKeyPair - -Ƭ **IdentityKeyPair**: [`KeyPair`](types.md#keypair) - -#### Defined in - -[src/types.ts:106](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L106) - -___ - -### KeyPair - -Ƭ **KeyPair**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `publicKey` | [`PublicKey`](types.md#publickey) | -| `secretKey` | [`SecretKey`](types.md#secretkey) | - -#### Defined in - -[src/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L97) - -___ - -### MapBuffers - -Ƭ **MapBuffers**\<`T`\>: \{ [K in keyof T]: T[K] extends Buffer ? string : T[K] } - -Replace an object's `Buffer` values with `string`s. Useful for serialization. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/types.ts:86](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L86) - -___ - -### NullableToOptional - -Ƭ **NullableToOptional**\<`T`\>: `Simplify`\<`RemoveNull`\<`NullToOptional`\<`T`\>\>\> - -Make any properties whose value include `null` optional, and remove `null` -from the type. This converts the types returned from SQLite (which have all -top-level optional props set to `null`) to the original types in -@mapeo/schema - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/types.ts:96](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L96) - -___ - -### PublicKey - -Ƭ **PublicKey**: `Buffer` - -32 byte buffer - -#### Defined in - -[src/types.ts:103](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L103) - -___ - -### ReplicationStream - -Ƭ **ReplicationStream**: `Duplex` & \{ `noiseStream`: `ProtocolStream` } - -#### Defined in - -[src/types.ts:112](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L112) - -___ - -### SecretKey - -Ƭ **SecretKey**: `Buffer` - -32 byte buffer - -#### Defined in - -[src/types.ts:105](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/types.ts#L105) diff --git a/docs/api/modules/utils.md b/docs/api/modules/utils.md deleted file mode 100644 index 403b20801..000000000 --- a/docs/api/modules/utils.md +++ /dev/null @@ -1,416 +0,0 @@ -[API](../README.md) / utils - -# Module: utils - -## Table of contents - -### Classes - -- [ExhaustivenessError](../classes/utils.ExhaustivenessError.md) - -### Type Aliases - -- [DestroyedNoiseStream](utils.md#destroyednoisestream) -- [NoiseStream](utils.md#noisestream) -- [OpenedNoiseStream](utils.md#openednoisestream) - -### Functions - -- [assert](utils.md#assert) -- [createMap](utils.md#createmap) -- [deNullify](utils.md#denullify) -- [getDeviceId](utils.md#getdeviceid) -- [idToKey](utils.md#idtokey) -- [keyToId](utils.md#keytoid) -- [noop](utils.md#noop) -- [openedNoiseSecretStream](utils.md#openednoisesecretstream) -- [parseVersion](utils.md#parseversion) -- [projectIdToNonce](utils.md#projectidtononce) -- [projectKeyToId](utils.md#projectkeytoid) -- [projectKeyToPublicId](utils.md#projectkeytopublicid) -- [setHas](utils.md#sethas) -- [valueOf](utils.md#valueof) - -## Type Aliases - -### DestroyedNoiseStream - -Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](utils.md#noisestream) & \{ `destroyed`: ``true`` } - -#### Defined in - -[src/utils.js:42](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L42) - -___ - -### NoiseStream - -Ƭ **NoiseStream**\<\>: `__module` - -#### Defined in - -[src/utils.js:41](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L41) - -___ - -### OpenedNoiseStream - -Ƭ **OpenedNoiseStream**\<`T`\>: `__module` & \{ `handshake`: `Buffer` ; `publicKey`: `Buffer` ; `remotePublicKey`: `Buffer` } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Duplex` \| `Duplex` = `Duplex` \| `Duplex` | - -#### Defined in - -[src/utils.js:45](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L45) - -## Functions - -### assert - -▸ **assert**(`condition`, `message`): asserts condition - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `unknown` | -| `message` | `string` | - -#### Returns - -asserts condition - -#### Defined in - -[src/utils.js:79](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L79) - -___ - -### createMap - -▸ **createMap**\<`K`, `V`\>(`keys`, `value`): `Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> - -Small helper to create a typed map - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends `string` | -| `V` | extends `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keys` | readonly `K`[] | -| `value` | `V` | - -#### Returns - -`Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> - -#### Defined in - -[src/utils.js:187](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L187) - -___ - -### deNullify - -▸ **deNullify**\<`T`\>(`obj`): \{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } - -When reading from SQLite, any optional properties are set to `null`. This -converts `null` back to `undefined` to match the input types (e.g. the types -defined in @mapeo/schema) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Object` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `T` | - -#### Returns - -\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } - -#### Defined in - -[src/utils.js:114](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L114) - -___ - -### getDeviceId - -▸ **getDeviceId**(`keyManager`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `keyManager` | `KeyManager` | - -#### Returns - -`string` - -#### Defined in - -[src/utils.js:175](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L175) - -___ - -### idToKey - -▸ **idToKey**(`id`): `Buffer` \| `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` \| `Buffer` | - -#### Returns - -`Buffer` \| `Uint8Array` - -#### Defined in - -[src/utils.js:8](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L8) - -___ - -### keyToId - -▸ **keyToId**(`key`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` \| `Buffer` | - -#### Returns - -`string` - -#### Defined in - -[src/utils.js:21](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L21) - -___ - -### noop - -▸ **noop**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/utils.js:72](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L72) - -___ - -### openedNoiseSecretStream - -▸ **openedNoiseSecretStream**(`stream`): `Promise`\<[`DestroyedNoiseStream`](utils.md#destroyednoisestream) \| [`OpenedNoiseStream`](utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> - -Utility to await a NoiseSecretStream to open, that returns a stream with the -correct types for publicKey and remotePublicKey (which can be null before -stream is opened) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stream` | `NoiseSecretStream`\<`any`\> | - -#### Returns - -`Promise`\<[`DestroyedNoiseStream`](utils.md#destroyednoisestream) \| [`OpenedNoiseStream`](utils.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> - -#### Defined in - -[src/utils.js:56](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L56) - -___ - -### parseVersion - -▸ **parseVersion**(`version`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `version` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `blockIndex` | `number` | -| `coreId` | `string` | - -#### Defined in - -[src/utils.js:33](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L33) - -___ - -### projectIdToNonce - -▸ **projectIdToNonce**(`projectId`): `Buffer` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `projectId` | `string` | Project internal ID | - -#### Returns - -`Buffer` - -24-byte nonce (same length as sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES) - -#### Defined in - -[src/utils.js:167](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L167) - -___ - -### projectKeyToId - -▸ **projectKeyToId**(`projectKey`): `string` - -Create an internal ID from a project key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `projectKey` | `Buffer` | - -#### Returns - -`string` - -#### Defined in - -[src/utils.js:150](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L150) - -___ - -### projectKeyToPublicId - -▸ **projectKeyToPublicId**(`projectKey`): `string` - -Create a public ID from a project key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `projectKey` | `Buffer` | - -#### Returns - -`string` - -#### Defined in - -[src/utils.js:159](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L159) - -___ - -### setHas - -▸ **setHas**\<`T`\>(`set`): (`value`: `unknown`) => value is T - -Return a function that itself returns whether a value is part of the set. - -Similar to binding `Set.prototype.has`, but (1) is shorter (2) refines the type. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `set` | `Readonly`\<`Set`\<`T`\>\> | - -#### Returns - -`fn` - -▸ (`value`): value is T - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -##### Returns - -value is T - -**`Example`** - -```ts -const mySet = new Set([1, 2, 3]) -const isInMySet = setHas(mySet) - -console.log(isInMySet(2)) -// => true -``` - -#### Defined in - -[src/utils.js:97](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L97) - -___ - -### valueOf - -▸ **valueOf**\<`T`\>(`doc`): `Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `MapeoDoc` & \{ `forks?`: `string`[] } | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `doc` | `T` | - -#### Returns - -`Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> - -#### Defined in - -[src/utils.js:128](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils.js#L128) diff --git a/docs/api/modules/utils_types.md b/docs/api/modules/utils_types.md deleted file mode 100644 index 0adcb7e5e..000000000 --- a/docs/api/modules/utils_types.md +++ /dev/null @@ -1,60 +0,0 @@ -[API](../README.md) / utils\_types - -# Module: utils\_types - -## Table of contents - -### Type Aliases - -- [TypedEventArgs](utils_types.md#typedeventargs) -- [TypedEvents](utils_types.md#typedevents) -- [TypedEventsFor](utils_types.md#typedeventsfor) - -## Type Aliases - -### TypedEventArgs - -Ƭ **TypedEventArgs**\<`Emitter`, `Event`\>: `Parameters`\<[`TypedEvents`](utils_types.md#typedevents)\<`Emitter`\>[`Event`]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Emitter` | extends `TypedEmitter`\<`any`\> | -| `Event` | extends [`TypedEventsFor`](utils_types.md#typedeventsfor)\<`Emitter`\> | - -#### Defined in - -[src/utils_types.d.ts:11](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L11) - -___ - -### TypedEvents - -Ƭ **TypedEvents**\<`T`\>: `T` extends `TypedEmitter`\ ? `Result` : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `TypedEmitter`\<`any`\> | - -#### Defined in - -[src/utils_types.d.ts:3](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L3) - -___ - -### TypedEventsFor - -Ƭ **TypedEventsFor**\<`T`\>: keyof [`TypedEvents`](utils_types.md#typedevents)\<`T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `TypedEmitter`\<`any`\> | - -#### Defined in - -[src/utils_types.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/53dc843a45bb963f7a880f5f7973107d5b1fb99c/src/utils_types.d.ts#L9) From 5d0c422e4ec15d83261629008a67b7a619377077 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 16:13:14 -0300 Subject: [PATCH 08/28] test preview page deploy --- .github/workflows/docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a4e0fd4fe..753301dc9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,6 +27,10 @@ jobs: uses: actions/upload-pages-artifact@v2 with: path: docs/api/html + - uses: rossjrw/pr-preview-action@v1.4.3 + with: + preview-branch: feat/typedoc + source-dir: docs/api/html - id: deployment name: Deploy documentation to GitHub Pages uses: actions/deploy-pages@v2 From d9e336f546109c14d6e3db2143c53086f607de7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 7 May 2024 17:07:56 -0300 Subject: [PATCH 09/28] ignore generated html --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 090581c4c..f75228a8b 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,4 @@ proto/build /dist !/drizzle/**/*.sql .eslintcache -!/docs/html/* +docs/api/html/* From d606de21eabc548b2c5bcb63cdd72ed2bcd7a7d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Wed, 8 May 2024 12:35:53 -0300 Subject: [PATCH 10/28] remove preview --- .github/workflows/docs.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 753301dc9..a4e0fd4fe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,10 +27,6 @@ jobs: uses: actions/upload-pages-artifact@v2 with: path: docs/api/html - - uses: rossjrw/pr-preview-action@v1.4.3 - with: - preview-branch: feat/typedoc - source-dir: docs/api/html - id: deployment name: Deploy documentation to GitHub Pages uses: actions/deploy-pages@v2 From 315dc9781d8d2f74f17b1fd651a3ae81272b7fac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Thu, 9 May 2024 11:36:15 -0300 Subject: [PATCH 11/28] ignore docs for eslint --- package.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/package.json b/package.json index 811c818e4..3618248c2 100644 --- a/package.json +++ b/package.json @@ -49,6 +49,9 @@ "node": true }, "extends": "eslint:recommended", + "ignorePatterns": [ + "docs/*" + ], "parserOptions": { "ecmaVersion": 13, "sourceType": "module" From 518de6dcd6dbaf2011bdcd13651f82d1f74ab5cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Thu, 9 May 2024 13:52:45 -0300 Subject: [PATCH 12/28] add plugin for missing exports (not explicitly exported but used by exported types) --- docs/api/md/README.md | 16 +- docs/api/md/classes/FastifyController.md | 10 +- docs/api/md/classes/MapeoManager.md | 62 +- .../md/classes/internal_.BigSparseArray.md | 97 ++ docs/api/md/classes/internal_.BlobApi.md | 87 ++ .../md/classes/internal_.BlobReadStream.md | 41 + docs/api/md/classes/internal_.BlobStore.md | 281 ++++++ .../md/classes/internal_.BlobWriteStream.md | 41 + docs/api/md/classes/internal_.CoreIndex.md | 161 ++++ docs/api/md/classes/internal_.CoreManager.md | 321 +++++++ .../api/md/classes/internal_.CoreOwnership.md | 84 ++ .../api/md/classes/internal_.CoreSyncState.md | 166 ++++ docs/api/md/classes/internal_.Corestore.md | 220 +++++ docs/api/md/classes/internal_.DataStore.md | 251 +++++ docs/api/md/classes/internal_.DataType.md | 284 ++++++ docs/api/md/classes/internal_.DenseIndex.md | 187 ++++ .../md/classes/internal_.DriveLiveDownload.md | 66 ++ docs/api/md/classes/internal_.Hyperblobs-1.md | 209 +++++ docs/api/md/classes/internal_.Hyperdrive-1.md | 585 ++++++++++++ docs/api/md/classes/internal_.IconApi.md | 104 +++ docs/api/md/classes/internal_.Index.md | 160 ++++ docs/api/md/classes/internal_.IndexWriter.md | 92 ++ docs/api/md/classes/internal_.InviteApi.md | 129 +++ docs/api/md/classes/internal_.LiveDownload.md | 67 ++ .../md/classes/internal_.LocalDiscovery.md | 145 +++ docs/api/md/classes/internal_.LocalPeers.md | 220 +++++ docs/api/md/classes/internal_.Logger.md | 133 +++ docs/api/md/classes/internal_.MapeoProject.md | 465 ++++++++++ docs/api/md/classes/internal_.MemberApi.md | 164 ++++ docs/api/md/classes/internal_.Peer.md | 266 ++++++ .../classes/internal_.PeerSyncController.md | 145 +++ .../md/classes/internal_.PendingInvites.md | 198 ++++ docs/api/md/classes/internal_.Protomux.md | 265 ++++++ .../classes/internal_.RemoteBitfieldPage.md | 233 +++++ .../internal_.RemoteBitfieldSegment.md | 194 ++++ docs/api/md/classes/internal_.Roles.md | 125 +++ docs/api/md/classes/internal_.SparseIndex.md | 198 ++++ docs/api/md/classes/internal_.SyncApi.md | 156 ++++ docs/api/md/classes/internal_.SyncState.md | 85 ++ .../classes/internal_.TrackedKeyRequests.md | 124 +++ ..._src_local_peers_.PeerDisconnectedError.md | 59 ++ ..._local_peers_.PeerFailedConnectionError.md | 59 ++ ..._next_src_local_peers_.UnknownPeerError.md | 59 ++ ...amespace_sync_state_.NamespaceSyncState.md | 104 +++ ...ore_next_src_utils_.ExhaustivenessError.md | 59 ++ docs/api/md/classes/internal_.default-1.md | 197 ++++ docs/api/md/classes/internal_.default-2.md | 307 ++++++ docs/api/md/classes/internal_.default.md | 132 +++ .../api/md/interfaces/internal_.BitmapOpts.md | 43 + .../interfaces/internal_.BlobDownloadState.md | 86 ++ docs/api/md/interfaces/internal_.Channel.md | 177 ++++ docs/api/md/interfaces/internal_.CoreState.md | 62 ++ .../interfaces/internal_.CorestoreEvents.md | 52 ++ .../md/interfaces/internal_.DataTypeEvents.md | 41 + .../md/interfaces/internal_.DocCapability.md | 62 ++ docs/api/md/interfaces/internal_.Encoding.md | 75 ++ .../md/interfaces/internal_.EncodingState.md | 43 + docs/api/md/interfaces/internal_.HaveMsg.md | 54 ++ .../interfaces/internal_.Hyperblobs.BlobId.md | 54 ++ .../internal_.Hyperdrive.HyperdriveEntry.md | 52 ++ .../interfaces/internal_.HyperdriveEvents.md | 98 ++ .../interfaces/internal_.HyperdriveGetOpts.md | 32 + .../interfaces/internal_.HyperdriveOptions.md | 29 + .../md/interfaces/internal_.MapsPluginOpts.md | 32 + .../api/md/interfaces/internal_.MemberInfo.md | 54 ++ docs/api/md/interfaces/internal_.Message.md | 81 ++ .../internal_.OfflineFallbackMapPluginOpts.md | 43 + .../md/interfaces/internal_.PeerInfoBase.md | 43 + .../md/interfaces/internal_.PendingInvite.md | 43 + .../interfaces/internal_.PreEncodingState.md | 43 + docs/api/md/interfaces/internal_.Role.md | 71 ++ docs/api/md/interfaces/internal_.StartOpts.md | 32 + docs/api/md/interfaces/internal_.State.md | 49 + .../internal_.StaticMapsPluginOpts.md | 32 + docs/api/md/interfaces/internal_.SvgOpts.md | 32 + .../md/interfaces/internal_.SyncTypeState.md | 88 ++ ...ore_next_src_core_manager_index_.Events.md | 65 ++ ..._next_src_local_peers_.LocalPeersEvents.md | 232 +++++ ...ore_next_src_schema_client_.ProjectInfo.md | 21 + ..._src_sync_core_sync_state_.DerivedState.md | 49 + ...src_sync_core_sync_state_.InternalState.md | 67 ++ docs/api/md/modules/internal_.Hyperblobs.md | 11 + docs/api/md/modules/internal_.Hyperdrive.md | 11 + ...mapeo_core_next_src_core_manager_index_.md | 77 ++ ...dd_mapeo_core_next_src_datastore_index_.md | 73 ++ ...src_dd_mapeo_core_next_src_local_peers_.md | 109 +++ ..._szgy_src_dd_mapeo_core_next_src_roles_.md | 250 +++++ ...c_dd_mapeo_core_next_src_schema_client_.md | 68 ++ ..._dd_mapeo_core_next_src_schema_project_.md | 219 +++++ ...peo_core_next_src_sync_core_sync_state_.md | 88 ++ ...ore_next_src_sync_namespace_sync_state_.md | 59 ++ ..._szgy_src_dd_mapeo_core_next_src_utils_.md | 436 +++++++++ docs/api/md/modules/internal_._hyperdrive_.md | 17 + docs/api/md/modules/internal_.md | 876 ++++++++++++++++++ package-lock.json | 10 + package.json | 5 +- 96 files changed, 12115 insertions(+), 44 deletions(-) create mode 100644 docs/api/md/classes/internal_.BigSparseArray.md create mode 100644 docs/api/md/classes/internal_.BlobApi.md create mode 100644 docs/api/md/classes/internal_.BlobReadStream.md create mode 100644 docs/api/md/classes/internal_.BlobStore.md create mode 100644 docs/api/md/classes/internal_.BlobWriteStream.md create mode 100644 docs/api/md/classes/internal_.CoreIndex.md create mode 100644 docs/api/md/classes/internal_.CoreManager.md create mode 100644 docs/api/md/classes/internal_.CoreOwnership.md create mode 100644 docs/api/md/classes/internal_.CoreSyncState.md create mode 100644 docs/api/md/classes/internal_.Corestore.md create mode 100644 docs/api/md/classes/internal_.DataStore.md create mode 100644 docs/api/md/classes/internal_.DataType.md create mode 100644 docs/api/md/classes/internal_.DenseIndex.md create mode 100644 docs/api/md/classes/internal_.DriveLiveDownload.md create mode 100644 docs/api/md/classes/internal_.Hyperblobs-1.md create mode 100644 docs/api/md/classes/internal_.Hyperdrive-1.md create mode 100644 docs/api/md/classes/internal_.IconApi.md create mode 100644 docs/api/md/classes/internal_.Index.md create mode 100644 docs/api/md/classes/internal_.IndexWriter.md create mode 100644 docs/api/md/classes/internal_.InviteApi.md create mode 100644 docs/api/md/classes/internal_.LiveDownload.md create mode 100644 docs/api/md/classes/internal_.LocalDiscovery.md create mode 100644 docs/api/md/classes/internal_.LocalPeers.md create mode 100644 docs/api/md/classes/internal_.Logger.md create mode 100644 docs/api/md/classes/internal_.MapeoProject.md create mode 100644 docs/api/md/classes/internal_.MemberApi.md create mode 100644 docs/api/md/classes/internal_.Peer.md create mode 100644 docs/api/md/classes/internal_.PeerSyncController.md create mode 100644 docs/api/md/classes/internal_.PendingInvites.md create mode 100644 docs/api/md/classes/internal_.Protomux.md create mode 100644 docs/api/md/classes/internal_.RemoteBitfieldPage.md create mode 100644 docs/api/md/classes/internal_.RemoteBitfieldSegment.md create mode 100644 docs/api/md/classes/internal_.Roles.md create mode 100644 docs/api/md/classes/internal_.SparseIndex.md create mode 100644 docs/api/md/classes/internal_.SyncApi.md create mode 100644 docs/api/md/classes/internal_.SyncState.md create mode 100644 docs/api/md/classes/internal_.TrackedKeyRequests.md create mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md create mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md create mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md create mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md create mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md create mode 100644 docs/api/md/classes/internal_.default-1.md create mode 100644 docs/api/md/classes/internal_.default-2.md create mode 100644 docs/api/md/classes/internal_.default.md create mode 100644 docs/api/md/interfaces/internal_.BitmapOpts.md create mode 100644 docs/api/md/interfaces/internal_.BlobDownloadState.md create mode 100644 docs/api/md/interfaces/internal_.Channel.md create mode 100644 docs/api/md/interfaces/internal_.CoreState.md create mode 100644 docs/api/md/interfaces/internal_.CorestoreEvents.md create mode 100644 docs/api/md/interfaces/internal_.DataTypeEvents.md create mode 100644 docs/api/md/interfaces/internal_.DocCapability.md create mode 100644 docs/api/md/interfaces/internal_.Encoding.md create mode 100644 docs/api/md/interfaces/internal_.EncodingState.md create mode 100644 docs/api/md/interfaces/internal_.HaveMsg.md create mode 100644 docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md create mode 100644 docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md create mode 100644 docs/api/md/interfaces/internal_.HyperdriveEvents.md create mode 100644 docs/api/md/interfaces/internal_.HyperdriveGetOpts.md create mode 100644 docs/api/md/interfaces/internal_.HyperdriveOptions.md create mode 100644 docs/api/md/interfaces/internal_.MapsPluginOpts.md create mode 100644 docs/api/md/interfaces/internal_.MemberInfo.md create mode 100644 docs/api/md/interfaces/internal_.Message.md create mode 100644 docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md create mode 100644 docs/api/md/interfaces/internal_.PeerInfoBase.md create mode 100644 docs/api/md/interfaces/internal_.PendingInvite.md create mode 100644 docs/api/md/interfaces/internal_.PreEncodingState.md create mode 100644 docs/api/md/interfaces/internal_.Role.md create mode 100644 docs/api/md/interfaces/internal_.StartOpts.md create mode 100644 docs/api/md/interfaces/internal_.State.md create mode 100644 docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md create mode 100644 docs/api/md/interfaces/internal_.SvgOpts.md create mode 100644 docs/api/md/interfaces/internal_.SyncTypeState.md create mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md create mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md create mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md create mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md create mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md create mode 100644 docs/api/md/modules/internal_.Hyperblobs.md create mode 100644 docs/api/md/modules/internal_.Hyperdrive.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md create mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md create mode 100644 docs/api/md/modules/internal_._hyperdrive_.md create mode 100644 docs/api/md/modules/internal_.md diff --git a/docs/api/md/README.md b/docs/api/md/README.md index 139f0af5c..6fa438acf 100644 --- a/docs/api/md/README.md +++ b/docs/api/md/README.md @@ -4,6 +4,10 @@ API ## Table of contents +### Modules + +- [\](modules/internal_.md) + ### Classes - [FastifyController](classes/FastifyController.md) @@ -26,7 +30,7 @@ API | Name | Type | | :------ | :------ | | `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | `MapsPluginOpts` | +| `opts` | [`MapsPluginOpts`](interfaces/internal_.MapsPluginOpts.md) | #### Returns @@ -34,7 +38,7 @@ API #### Defined in -[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/index.js#L30) +[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L30) ___ @@ -47,7 +51,7 @@ ___ | Name | Type | | :------ | :------ | | `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | `OfflineFallbackMapPluginOpts` | +| `opts` | [`OfflineFallbackMapPluginOpts`](interfaces/internal_.OfflineFallbackMapPluginOpts.md) | #### Returns @@ -55,7 +59,7 @@ ___ #### Defined in -[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/offline-fallback-map.js#L14) +[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L14) ___ @@ -68,7 +72,7 @@ ___ | Name | Type | | :------ | :------ | | `instance` | `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\> | -| `opts` | `StaticMapsPluginOpts` | +| `opts` | [`StaticMapsPluginOpts`](interfaces/internal_.StaticMapsPluginOpts.md) | #### Returns @@ -76,4 +80,4 @@ ___ #### Defined in -[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-plugins/maps/static-maps.js#L18) +[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L18) diff --git a/docs/api/md/classes/FastifyController.md b/docs/api/md/classes/FastifyController.md index d40f4e41b..f60eee9e7 100644 --- a/docs/api/md/classes/FastifyController.md +++ b/docs/api/md/classes/FastifyController.md @@ -33,7 +33,7 @@ #### Defined in -[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L21) +[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L21) ## Methods @@ -45,7 +45,7 @@ | Name | Type | | :------ | :------ | -| `opts?` | `StartOpts` | +| `opts?` | [`StartOpts`](../interfaces/internal_.StartOpts.md) | #### Returns @@ -53,7 +53,7 @@ #### Defined in -[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L73) +[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L73) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L77) +[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L77) ___ @@ -81,4 +81,4 @@ ___ #### Defined in -[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/fastify-controller.js#L81) +[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L81) diff --git a/docs/api/md/classes/MapeoManager.md b/docs/api/md/classes/MapeoManager.md index 59d64f436..4b33e1d4c 100644 --- a/docs/api/md/classes/MapeoManager.md +++ b/docs/api/md/classes/MapeoManager.md @@ -48,7 +48,7 @@ | :------ | :------ | :------ | | `opts` | `Object` | | | `opts.clientMigrationsFolder` | `string` | path for drizzle migrations folder for client database | -| `opts.coreStorage` | `string` \| `CoreStorage` | Folder for hypercore storage or a function that returns a RandomAccessStorage instance | +| `opts.coreStorage` | `string` \| [`CoreStorage`](../modules/internal_.md#corestorage) | Folder for hypercore storage or a function that returns a RandomAccessStorage instance | | `opts.dbFolder` | `string` | Folder for sqlite Dbs. Folder must exist. Use ':memory:' to store everything in-memory | | `opts.defaultConfigPath` | `undefined` \| `string` | | | `opts.deviceType` | `undefined` \| `DeviceInfo_DeviceType` | Device type, shared with local peers and project members | @@ -66,23 +66,23 @@ TypedEmitter.constructor #### Defined in -[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L110) +[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L110) ## Accessors ### [kRPC] -• `get` **[kRPC]**(): `LocalPeers` +• `get` **[kRPC]**(): [`LocalPeers`](internal_.LocalPeers.md) MapeoRPC instance, used for tests #### Returns -`LocalPeers` +[`LocalPeers`](internal_.LocalPeers.md) #### Defined in -[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L201) +[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L201) ___ @@ -96,27 +96,27 @@ ___ #### Defined in -[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L205) +[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L205) ___ ### invite -• `get` **invite**(): `InviteApi` +• `get` **invite**(): [`InviteApi`](internal_.InviteApi.md) #### Returns -`InviteApi` +[`InviteApi`](internal_.InviteApi.md) #### Defined in -[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L731) +[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L731) ## Methods ### [kManagerReplicate] -▸ **[kManagerReplicate]**(`isInitiator`): `ReplicationStream` +▸ **[kManagerReplicate]**(`isInitiator`): [`ReplicationStream`](../modules/internal_.md#replicationstream) Create a Mapeo replication stream. This replication connects the Mapeo RPC channel and allows invites. All active projects will sync automatically to @@ -132,11 +132,11 @@ connecting RPC, use project[kProjectReplication]. #### Returns -`ReplicationStream` +[`ReplicationStream`](../modules/internal_.md#replicationstream) #### Defined in -[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L218) +[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L218) ___ @@ -162,7 +162,7 @@ downloaded their proof of project membership and the project config. #### Defined in -[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L542) +[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L542) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L746) +[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L746) ___ @@ -210,21 +210,21 @@ Project public id #### Defined in -[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L350) +[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L350) ___ ### getDeviceInfo -▸ **getDeviceInfo**(): \{ `deviceId`: `string` } & `Partial`\<`DeviceInfoParam`\> +▸ **getDeviceInfo**(): \{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/internal_.md#deviceinfoparam)\> #### Returns -\{ `deviceId`: `string` } & `Partial`\<`DeviceInfoParam`\> +\{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/internal_.md#deviceinfoparam)\> #### Defined in -[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L719) +[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L719) ___ @@ -238,13 +238,13 @@ ___ #### Defined in -[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L806) +[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L806) ___ ### getProject -▸ **getProject**(`projectPublicId`): `Promise`\<`MapeoProject`\> +▸ **getProject**(`projectPublicId`): `Promise`\<[`MapeoProject`](internal_.MapeoProject.md)\> #### Parameters @@ -254,11 +254,11 @@ ___ #### Returns -`Promise`\<`MapeoProject`\> +`Promise`\<[`MapeoProject`](internal_.MapeoProject.md)\> #### Defined in -[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L426) +[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L426) ___ @@ -278,21 +278,21 @@ ___ #### Defined in -[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L760) +[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L760) ___ ### listLocalPeers -▸ **listLocalPeers**(): `Promise`\<`PublicPeerInfo`[]\> +▸ **listLocalPeers**(): `Promise`\<[`PublicPeerInfo`](../modules/internal_.md#publicpeerinfo)[]\> #### Returns -`Promise`\<`PublicPeerInfo`[]\> +`Promise`\<[`PublicPeerInfo`](../modules/internal_.md#publicpeerinfo)[]\> #### Defined in -[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L753) +[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L753) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L485) +[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L485) ___ @@ -318,7 +318,7 @@ ___ | Name | Type | | :------ | :------ | -| `T` | extends `DeviceInfoParam` \| `ExactObject`\<`DeviceInfoParam`, `T`\> | +| `T` | extends [`DeviceInfoParam`](../modules/internal_.md#deviceinfoparam) \| `ExactObject`\<[`DeviceInfoParam`](../modules/internal_.md#deviceinfoparam), `T`\> | #### Parameters @@ -332,7 +332,7 @@ ___ #### Defined in -[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L686) +[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L686) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L736) +[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L736) ___ @@ -372,4 +372,4 @@ are force-closed after opts.timeout milliseconds #### Defined in -[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/9222af401663318d26533372ca2e130753329c39/src/mapeo-manager.js#L741) +[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L741) diff --git a/docs/api/md/classes/internal_.BigSparseArray.md b/docs/api/md/classes/internal_.BigSparseArray.md new file mode 100644 index 000000000..7aa3bb604 --- /dev/null +++ b/docs/api/md/classes/internal_.BigSparseArray.md @@ -0,0 +1,97 @@ +[API](../README.md) / [\](../modules/internal_.md) / BigSparseArray + +# Class: BigSparseArray\ + +[\](../modules/internal_.md).BigSparseArray + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Table of contents + +### Constructors + +- [constructor](internal_.BigSparseArray.md#constructor) + +### Properties + +- [maxLength](internal_.BigSparseArray.md#maxlength) + +### Methods + +- [get](internal_.BigSparseArray.md#get) +- [set](internal_.BigSparseArray.md#set) + +## Constructors + +### constructor + +• **new BigSparseArray**\<`T`\>(): [`BigSparseArray`](internal_.BigSparseArray.md)\<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Returns + +[`BigSparseArray`](internal_.BigSparseArray.md)\<`T`\> + +#### Defined in + +[types/big-sparse-array.d.ts:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L3) + +## Properties + +### maxLength + +• `Readonly` **maxLength**: `number` + +#### Defined in + +[types/big-sparse-array.d.ts:5](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L5) + +## Methods + +### get + +▸ **get**(`index`): `undefined` \| `T` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +`undefined` \| `T` + +#### Defined in + +[types/big-sparse-array.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L9) + +___ + +### set + +▸ **set**(`index`, `value`): `T` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `value` | `T` | + +#### Returns + +`T` + +#### Defined in + +[types/big-sparse-array.d.ts:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L7) diff --git a/docs/api/md/classes/internal_.BlobApi.md b/docs/api/md/classes/internal_.BlobApi.md new file mode 100644 index 000000000..d7b1aaa4d --- /dev/null +++ b/docs/api/md/classes/internal_.BlobApi.md @@ -0,0 +1,87 @@ +[API](../README.md) / [\](../modules/internal_.md) / BlobApi + +# Class: BlobApi + +[\](../modules/internal_.md).BlobApi + +## Table of contents + +### Constructors + +- [constructor](internal_.BlobApi.md#constructor) + +### Methods + +- [create](internal_.BlobApi.md#create) +- [getUrl](internal_.BlobApi.md#geturl) + +## Constructors + +### constructor + +• **new BlobApi**(`options`): [`BlobApi`](internal_.BlobApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.blobStore` | [`BlobStore`](internal_.BlobStore.md) | +| `options.getMediaBaseUrl` | () => `Promise`\<`string`\> | + +#### Returns + +[`BlobApi`](internal_.BlobApi.md) + +#### Defined in + +[src/blob-api.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L18) + +## Methods + +### create + +▸ **create**(`filepaths`, `metadata`): `Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> + +Write blobs for provided variants of a file + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filepaths` | `Object` | +| `filepaths.original` | `string` | +| `filepaths.preview?` | `string` | +| `filepaths.thumbnail?` | `string` | +| `metadata` | `Object` | +| `metadata.mimeType` | `string` | + +#### Returns + +`Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> + +#### Defined in + +[src/blob-api.js:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L46) + +___ + +### getUrl + +▸ **getUrl**(`blobId`): `Promise`\<`string`\> + +Get a url for a blob based on its BlobId + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blobId` | [`BlobId`](../modules/internal_.md#blobid-1) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/blob-api.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L28) diff --git a/docs/api/md/classes/internal_.BlobReadStream.md b/docs/api/md/classes/internal_.BlobReadStream.md new file mode 100644 index 000000000..20a4a87e8 --- /dev/null +++ b/docs/api/md/classes/internal_.BlobReadStream.md @@ -0,0 +1,41 @@ +[API](../README.md) / [\](../modules/internal_.md) / BlobReadStream + +# Class: BlobReadStream + +[\](../modules/internal_.md).BlobReadStream + +## Hierarchy + +- `Readable` + + ↳ **`BlobReadStream`** + +## Table of contents + +### Constructors + +- [constructor](internal_.BlobReadStream.md#constructor) + +## Constructors + +### constructor + +• **new BlobReadStream**(`opts`): [`BlobReadStream`](internal_.BlobReadStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `any` | + +#### Returns + +[`BlobReadStream`](internal_.BlobReadStream.md) + +#### Overrides + +Readable.constructor + +#### Defined in + +[types/hyperblobs.d.ts:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L17) diff --git a/docs/api/md/classes/internal_.BlobStore.md b/docs/api/md/classes/internal_.BlobStore.md new file mode 100644 index 000000000..7ce65f927 --- /dev/null +++ b/docs/api/md/classes/internal_.BlobStore.md @@ -0,0 +1,281 @@ +[API](../README.md) / [\](../modules/internal_.md) / BlobStore + +# Class: BlobStore + +[\](../modules/internal_.md).BlobStore + +## Table of contents + +### Constructors + +- [constructor](internal_.BlobStore.md#constructor) + +### Accessors + +- [writerDriveId](internal_.BlobStore.md#writerdriveid) + +### Methods + +- [clear](internal_.BlobStore.md#clear) +- [createEntryReadStream](internal_.BlobStore.md#createentryreadstream) +- [createReadStream](internal_.BlobStore.md#createreadstream) +- [createWriteStream](internal_.BlobStore.md#createwritestream) +- [download](internal_.BlobStore.md#download) +- [entry](internal_.BlobStore.md#entry) +- [get](internal_.BlobStore.md#get) +- [getEntryBlob](internal_.BlobStore.md#getentryblob) +- [put](internal_.BlobStore.md#put) + +## Constructors + +### constructor + +• **new BlobStore**(`options`): [`BlobStore`](internal_.BlobStore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.coreManager` | [`CoreManager`](internal_.CoreManager.md) | + +#### Returns + +[`BlobStore`](internal_.BlobStore.md) + +#### Defined in + +[src/blob-store/index.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L45) + +## Accessors + +### writerDriveId + +• `get` **writerDriveId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/blob-store/index.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L77) + +## Methods + +### clear + +▸ **clear**(`blobId`, `options?`): `Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/internal_.md#blobid-1) | | +| `options?` | `Object` | | +| `options.diff` | `undefined` \| `boolean` | Enable to return an object with a `block` property with number of bytes removed | + +#### Returns + +`Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Defined in + +[src/blob-store/index.js:234](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L234) + +___ + +### createEntryReadStream + +▸ **createEntryReadStream**(`driveId`, `entry`, `options?`): `Promise`\<[`BlobReadStream`](internal_.BlobReadStream.md)\> + +Optimization for creating the blobs read stream when you have +previously read the entry from Hyperdrive using `drive.entry` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `driveId` | `string` | Hyperdrive drive discovery id | +| `entry` | [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md) | Hyperdrive entry | +| `options?` | `Object` | | +| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<[`BlobReadStream`](internal_.BlobReadStream.md)\> + +#### Defined in + +[src/blob-store/index.js:150](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L150) + +___ + +### createReadStream + +▸ **createReadStream**(`blobId`, `options?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/internal_.md#blobid-1) | | +| `options?` | `Object` | | +| `options.timeout` | `undefined` \| `number` | Optional timeout to wait for a blob to download | +| `options.wait` | `undefined` \| `boolean` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[src/blob-store/index.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L130) + +___ + +### createWriteStream + +▸ **createWriteStream**(`blobId`, `options?`): `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | `Omit`\<[`BlobId`](../modules/internal_.md#blobid-1), ``"driveId"``\> | | +| `options?` | `Object` | | +| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | + +#### Returns + +`Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } + +#### Defined in + +[src/blob-store/index.js:201](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L201) + +___ + +### download + +▸ **download**(`filter?`, `options?`): [`LiveDownload`](internal_.LiveDownload.md) + +Download blobs from all drives, optionally filtering particular blob types +or blob variants. Download will be 'live' and will continue downloading new +data as it becomes available from any replicating drive. + +If no filter is specified, all blobs will be downloaded. If a filter is +specified, then _only_ blobs that match the filter will be downloaded. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `filter?` | [`BlobFilter`](../modules/internal_.md#blobfilter) | Filter blob types and/or variants to download. Filter is { [BlobType]: BlobVariants[] }. At least one blob variant must be specified for each blob type. | +| `options` | `Object` | | +| `options.signal` | `undefined` \| `AbortSignal` | Optional AbortSignal to cancel in-progress download | + +#### Returns + +[`LiveDownload`](internal_.LiveDownload.md) + +EventEmitter with `.state` propery, emits `state` with new state when it updates + +#### Defined in + +[src/blob-store/index.js:117](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L117) + +___ + +### entry + +▸ **entry**(`blobId`, `options?`): `Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/internal_.md#blobid-1) | | +| `options?` | `Object` | | +| `options.follow` | `undefined` \| `boolean` | Set to `true` to follow symlinks (16 max or throws an error) | +| `options.timeout` | `undefined` | Optional timeout to wait for a blob to download | +| `options.wait` | `undefined` \| ``false`` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> + +#### Defined in + +[src/blob-store/index.js:217](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L217) + +___ + +### get + +▸ **get**(`blobId`, `opts?`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `blobId` | [`BlobId`](../modules/internal_.md#blobid-1) | `undefined` | | +| `opts` | `Object` | `{}` | | +| `opts.timeout` | `undefined` | `undefined` | Optional timeout to wait for a blob to download | +| `opts.wait` | `undefined` \| ``false`` | `false` | Set to `true` to wait for a blob to download, otherwise will throw if blob is not available locally | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/blob-store/index.js:96](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L96) + +___ + +### getEntryBlob + +▸ **getEntryBlob**(`driveId`, `entry`, `opts?`): `Promise`\<``null`` \| `Buffer`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `driveId` | `string` | Hyperdrive drive id | +| `entry` | [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md) | Hyperdrive entry | +| `opts?` | `Object` | | +| `opts.length` | `undefined` \| `number` | | + +#### Returns + +`Promise`\<``null`` \| `Buffer`\> + +#### Defined in + +[src/blob-store/index.js:170](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L170) + +___ + +### put + +▸ **put**(`blobId`, `blob`, `options?`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `blobId` | `Omit`\<[`BlobId`](../modules/internal_.md#blobid-1), ``"driveId"``\> | | +| `blob` | `Buffer` | | +| `options?` | `Object` | | +| `options.metadata` | `undefined` \| \{ `mimeType`: `string` } | Metadata to store with the blob | + +#### Returns + +`Promise`\<`string`\> + +discovery key as hex string of hyperdrive where blob is stored + +#### Defined in + +[src/blob-store/index.js:190](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L190) diff --git a/docs/api/md/classes/internal_.BlobWriteStream.md b/docs/api/md/classes/internal_.BlobWriteStream.md new file mode 100644 index 000000000..239063a8c --- /dev/null +++ b/docs/api/md/classes/internal_.BlobWriteStream.md @@ -0,0 +1,41 @@ +[API](../README.md) / [\](../modules/internal_.md) / BlobWriteStream + +# Class: BlobWriteStream + +[\](../modules/internal_.md).BlobWriteStream + +## Hierarchy + +- `Writable` + + ↳ **`BlobWriteStream`** + +## Table of contents + +### Constructors + +- [constructor](internal_.BlobWriteStream.md#constructor) + +## Constructors + +### constructor + +• **new BlobWriteStream**(`opts`): [`BlobWriteStream`](internal_.BlobWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `any` | + +#### Returns + +[`BlobWriteStream`](internal_.BlobWriteStream.md) + +#### Overrides + +Writable.constructor + +#### Defined in + +[types/hyperblobs.d.ts:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L14) diff --git a/docs/api/md/classes/internal_.CoreIndex.md b/docs/api/md/classes/internal_.CoreIndex.md new file mode 100644 index 000000000..f830cbcf1 --- /dev/null +++ b/docs/api/md/classes/internal_.CoreIndex.md @@ -0,0 +1,161 @@ +[API](../README.md) / [\](../modules/internal_.md) / CoreIndex + +# Class: CoreIndex + +[\](../modules/internal_.md).CoreIndex + +An in-memory index of open cores. + +## Table of contents + +### Constructors + +- [constructor](internal_.CoreIndex.md#constructor) + +### Methods + +- [[iterator]](internal_.CoreIndex.md#[iterator]) +- [add](internal_.CoreIndex.md#add) +- [getByCoreKey](internal_.CoreIndex.md#getbycorekey) +- [getByDiscoveryId](internal_.CoreIndex.md#getbydiscoveryid) +- [getByNamespace](internal_.CoreIndex.md#getbynamespace) +- [getWriter](internal_.CoreIndex.md#getwriter) + +## Constructors + +### constructor + +• **new CoreIndex**(): [`CoreIndex`](internal_.CoreIndex.md) + +#### Returns + +[`CoreIndex`](internal_.CoreIndex.md) + +## Methods + +### [iterator] + +▸ **[iterator]**(): `IterableIterator`\<[`CoreRecord`](../modules/internal_.md#corerecord)\> + +#### Returns + +`IterableIterator`\<[`CoreRecord`](../modules/internal_.md#corerecord)\> + +#### Defined in + +[src/core-manager/core-index.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L15) + +___ + +### add + +▸ **add**(`options`): `void` + +NB. Need to pass key here because `core.key` is not populated until the +core is ready, but we know it beforehand. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | `Object` | `undefined` | | +| `options.core` | `Hypercore`\<``"binary"``, `Buffer`\> | `undefined` | Hypercore instance | +| `options.key` | `Buffer` | `undefined` | Buffer containing public key of this core | +| `options.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | `undefined` | | +| `options.writer` | `undefined` \| `boolean` | `false` | Is this a writer core? | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/core-index.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L29) + +___ + +### getByCoreKey + +▸ **getByCoreKey**(`coreKey`): `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +Get a core by its public key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coreKey` | `Buffer` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L83) + +___ + +### getByDiscoveryId + +▸ **getByDiscoveryId**(`discoveryId`): `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +Get a core by its discoveryId (discover key as hex string) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryId` | `string` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L73) + +___ + +### getByNamespace + +▸ **getByNamespace**(`namespace`): [`CoreRecord`](../modules/internal_.md#corerecord)[] + +Get all known cores in a namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/internal_.md#corerecord)[] + +#### Defined in + +[src/core-manager/core-index.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L45) + +___ + +### getWriter + +▸ **getWriter**(`namespace`): [`CoreRecord`](../modules/internal_.md#corerecord) + +Get the write core for the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/core-index.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L59) diff --git a/docs/api/md/classes/internal_.CoreManager.md b/docs/api/md/classes/internal_.CoreManager.md new file mode 100644 index 000000000..5549be2e5 --- /dev/null +++ b/docs/api/md/classes/internal_.CoreManager.md @@ -0,0 +1,321 @@ +[API](../README.md) / [\](../modules/internal_.md) / CoreManager + +# Class: CoreManager + +[\](../modules/internal_.md).CoreManager + +## Hierarchy + +- `TypedEmitter` + + ↳ **`CoreManager`** + +## Table of contents + +### Constructors + +- [constructor](internal_.CoreManager.md#constructor) + +### Accessors + +- [creatorCore](internal_.CoreManager.md#creatorcore) +- [deviceId](internal_.CoreManager.md#deviceid) +- [namespaces](internal_.CoreManager.md#namespaces) + +### Methods + +- [[kCoreManagerReplicate]](internal_.CoreManager.md#[kcoremanagerreplicate]) +- [addCore](internal_.CoreManager.md#addcore) +- [close](internal_.CoreManager.md#close) +- [deleteOthersData](internal_.CoreManager.md#deleteothersdata) +- [getCoreByDiscoveryKey](internal_.CoreManager.md#getcorebydiscoverykey) +- [getCoreByKey](internal_.CoreManager.md#getcorebykey) +- [getCores](internal_.CoreManager.md#getcores) +- [getWriterCore](internal_.CoreManager.md#getwritercore) +- [ready](internal_.CoreManager.md#ready) +- [requestCoreKey](internal_.CoreManager.md#requestcorekey) + +## Constructors + +### constructor + +• **new CoreManager**(`options`): [`CoreManager`](internal_.CoreManager.md) + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `options` | `Object` | `undefined` | | +| `options.autoDownload` | `undefined` \| `boolean` | `true` | Immediately start downloading cores - should only be set to false for tests | +| `options.db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | `undefined` | Drizzle better-sqlite3 database instance | +| `options.encryptionKeys` | `undefined` \| `Partial`\<`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `Buffer`\>\> | `{}` | Encryption keys for each namespace | +| `options.keyManager` | `KeyManager` | `undefined` | mapeo/crypto KeyManager instance | +| `options.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | `undefined` | | +| `options.projectKey` | `Buffer` | `undefined` | 32-byte public key of the project creator core | +| `options.projectSecretKey` | `undefined` \| `Buffer` | `undefined` | 32-byte secret key of the project creator core | +| `options.storage` | `HypercoreStorage` | `undefined` | Folder to store all hypercore data | + +#### Returns + +[`CoreManager`](internal_.CoreManager.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/core-manager/index.js:70](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L70) + +## Accessors + +### creatorCore + +• `get` **creatorCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/core-manager/index.js:191](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L191) + +___ + +### deviceId + +• `get` **deviceId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/core-manager/index.js:187](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L187) + +___ + +### namespaces + +• `get` **namespaces**(): readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Returns + +readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Defined in + +[src/core-manager/index.js:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L55) + +## Methods + +### [kCoreManagerReplicate] + +▸ **[kCoreManagerReplicate]**(`stream`): [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +ONLY FOR TESTING +Replicate all cores in core manager + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | + +#### Returns + +[`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Defined in + +[src/core-manager/index.js:482](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L482) + +___ + +### addCore + +▸ **addCore**(`key`, `namespace`): [`CoreRecord`](../modules/internal_.md#corerecord) + +Add a core to the manager (will be persisted across restarts) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `Buffer` | 32-byte public key of core to add | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | + +#### Returns + +[`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:268](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L268) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +Close all open cores and end any replication streams +TODO: gracefully close replication streams + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:250](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L250) + +___ + +### deleteOthersData + +▸ **deleteOthersData**(`namespace`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:501](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L501) + +___ + +### getCoreByDiscoveryKey + +▸ **getCoreByDiscoveryKey**(`discoveryKey`): `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +Get a core by its discovery key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:239](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L239) + +___ + +### getCoreByKey + +▸ **getCoreByKey**(`key`): `undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> + +Get a core by its public key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `Buffer` | + +#### Returns + +`undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/core-manager/index.js:228](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L228) + +___ + +### getCores + +▸ **getCores**(`namespace`): [`CoreRecord`](../modules/internal_.md#corerecord)[] + +Get an array of all cores in the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/internal_.md#corerecord)[] + +#### Defined in + +[src/core-manager/index.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L218) + +___ + +### getWriterCore + +▸ **getWriterCore**(`namespace`): [`CoreRecord`](../modules/internal_.md#corerecord) + +Get the writer core for the given namespace + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +[`CoreRecord`](../modules/internal_.md#corerecord) + +#### Defined in + +[src/core-manager/index.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L209) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +Resolves when all cores have finished loading + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/core-manager/index.js:200](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L200) + +___ + +### requestCoreKey + +▸ **requestCoreKey**(`peerKey`, `discoveryKey`): `void` + +Send an extension message over the project creator core replication stream +requesting a core key for the given discovery key. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerKey` | `Buffer` | +| `discoveryKey` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:366](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L366) diff --git a/docs/api/md/classes/internal_.CoreOwnership.md b/docs/api/md/classes/internal_.CoreOwnership.md new file mode 100644 index 000000000..3bf97dfec --- /dev/null +++ b/docs/api/md/classes/internal_.CoreOwnership.md @@ -0,0 +1,84 @@ +[API](../README.md) / [\](../modules/internal_.md) / CoreOwnership + +# Class: CoreOwnership + +[\](../modules/internal_.md).CoreOwnership + +## Table of contents + +### Constructors + +- [constructor](internal_.CoreOwnership.md#constructor) + +### Methods + +- [getCoreId](internal_.CoreOwnership.md#getcoreid) +- [getOwner](internal_.CoreOwnership.md#getowner) + +## Constructors + +### constructor + +• **new CoreOwnership**(`opts`): [`CoreOwnership`](internal_.CoreOwnership.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.coreKeypairs` | `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`KeyPair`](../modules/internal_.md#keypair)\> | +| `opts.dataType` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | +| `opts.identityKeypair` | [`KeyPair`](../modules/internal_.md#keypair) | + +#### Returns + +[`CoreOwnership`](internal_.CoreOwnership.md) + +#### Defined in + +[src/core-ownership.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L33) + +## Methods + +### getCoreId + +▸ **getCoreId**(`deviceId`, `namespace`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Returns + +`Promise`\<`string`\> + +coreId of core belonging to `deviceId` for `namespace` + +#### Defined in + +[src/core-ownership.js:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L83) + +___ + +### getOwner + +▸ **getOwner**(`coreId`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coreId` | `string` | + +#### Returns + +`Promise`\<`string`\> + +deviceId of device that owns the core + +#### Defined in + +[src/core-ownership.js:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L60) diff --git a/docs/api/md/classes/internal_.CoreSyncState.md b/docs/api/md/classes/internal_.CoreSyncState.md new file mode 100644 index 000000000..da6aef378 --- /dev/null +++ b/docs/api/md/classes/internal_.CoreSyncState.md @@ -0,0 +1,166 @@ +[API](../README.md) / [\](../modules/internal_.md) / CoreSyncState + +# Class: CoreSyncState + +[\](../modules/internal_.md).CoreSyncState + +Track sync state for a core identified by `discoveryId`. Can start tracking +state before the core instance exists locally, via the "preHave" messages +received over the project creator core. + +Because deriving the state is expensive (it iterates through the bitfields of +all peers), this is designed to be pull-based: the onUpdate event signals +that the state is updated, but does not pass the state. The consumer can +"pull" the state when it wants it via `coreSyncState.getState()`. + +Each peer (including the local peer) has a state of: + 1. `have` - number of blocks the peer has locally + 2. `want` - number of blocks the peer wants, and at least one peer has + 3. `wanted` - number of blocks the peer has that at least one peer wants + 4. `missing` - number of blocks the peer wants but no peer has + +## Table of contents + +### Constructors + +- [constructor](internal_.CoreSyncState.md#constructor) + +### Methods + +- [addPeer](internal_.CoreSyncState.md#addpeer) +- [attachCore](internal_.CoreSyncState.md#attachcore) +- [getState](internal_.CoreSyncState.md#getstate) +- [insertPreHaves](internal_.CoreSyncState.md#insertprehaves) +- [setPeerWants](internal_.CoreSyncState.md#setpeerwants) + +## Constructors + +### constructor + +• **new CoreSyncState**(`opts`): [`CoreSyncState`](internal_.CoreSyncState.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | | +| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](internal_.PeerSyncController.md)\> | | + +#### Returns + +[`CoreSyncState`](internal_.CoreSyncState.md) + +#### Defined in + +[src/sync/core-sync-state.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L74) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:176](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L176) + +___ + +### attachCore + +▸ **attachCore**(`core`): `void` + +Attach a core. The sync state can be initialized without a core instance, +because we could receive peer want and have states via extension messages +before we have the core key that allows us to create a core instance. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `core` | `Hypercore`\<``"binary"``, `Buffer`\> | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L105) + +___ + +### getState + +▸ **getState**(): [`DerivedState`](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) + +#### Returns + +[`DerivedState`](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) + +#### Defined in + +[src/sync/core-sync-state.js:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L85) + +___ + +### insertPreHaves + +▸ **insertPreHaves**(`peerId`, `start`, `bitfield`): `void` + +Add a pre-emptive "have" bitfield for a peer. This is used when we receive +a peer "have" via extension message - it allows us to have a state for the +peer before the peer actually starts syncing this core + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `start` | `number` | +| `bitfield` | `Uint32Array` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:147](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L147) + +___ + +### setPeerWants + +▸ **setPeerWants**(`peerId`, `ranges`): `void` + +Add a ranges of wanted blocks for a peer. By default a peer wants all +blocks in a core - calling this will change the peer to only want the +blocks/ranges that are added here + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `ranges` | \{ `length`: `number` ; `start`: `number` }[] | + +#### Returns + +`void` + +#### Defined in + +[src/sync/core-sync-state.js:165](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L165) diff --git a/docs/api/md/classes/internal_.Corestore.md b/docs/api/md/classes/internal_.Corestore.md new file mode 100644 index 000000000..4b6a91694 --- /dev/null +++ b/docs/api/md/classes/internal_.Corestore.md @@ -0,0 +1,220 @@ +[API](../README.md) / [\](../modules/internal_.md) / Corestore + +# Class: Corestore + +[\](../modules/internal_.md).Corestore + +## Hierarchy + +- `TypedEmitter`\<[`CorestoreEvents`](../interfaces/internal_.CorestoreEvents.md)\> + + ↳ **`Corestore`** + +## Table of contents + +### Constructors + +- [constructor](internal_.Corestore.md#constructor) + +### Properties + +- [cores](internal_.Corestore.md#cores) +- [replicate](internal_.Corestore.md#replicate) + +### Methods + +- [close](internal_.Corestore.md#close) +- [get](internal_.Corestore.md#get) +- [namespace](internal_.Corestore.md#namespace) +- [ready](internal_.Corestore.md#ready) + +## Constructors + +### constructor + +• **new Corestore**(`storage`, `options?`): [`Corestore`](internal_.Corestore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `storage` | `HypercoreStorage` | +| `options?` | `Object` | +| `options.poolSize?` | `number` | +| `options.primaryKey?` | `Buffer` \| `Uint8Array` | + +#### Returns + +[`Corestore`](internal_.Corestore.md) + +#### Overrides + +TypedEmitter\<CorestoreEvents\>.constructor + +#### Defined in + +[types/corestore.d.ts:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L15) + +## Properties + +### cores + +• **cores**: `Map`\<`string`, `Hypercore`\<`ValueEncoding`, `Buffer`\>\> + +#### Defined in + +[types/corestore.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L37) + +___ + +### replicate + +• **replicate**: (`isInitiatorOrReplicationStream`: `boolean` \| `Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>, `opts?`: {}) => `ReplicationStream`(`protomux`: [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>, `opts?`: {}) => [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Type declaration + +▸ (`isInitiatorOrReplicationStream`, `opts?`): `ReplicationStream` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `isInitiatorOrReplicationStream` | `boolean` \| `Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> | +| `opts?` | `Object` | + +##### Returns + +`ReplicationStream` + +▸ (`protomux`, `opts?`): [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `protomux` | [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | +| `opts?` | `Object` | + +##### Returns + +[`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Defined in + +[types/corestore.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L33) + +## Methods + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[types/corestore.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L36) + +___ + +### get + +▸ **get**(`key`): `Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `Buffer` \| `Uint8Array` | + +#### Returns + +`Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Defined in + +[types/corestore.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L19) + +▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Omit`\<`HypercoreOptions`\<``"binary"``, `undefined`\>, ``"keyPair"``\> & \{ `name`: `string` } | + +#### Returns + +`Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Defined in + +[types/corestore.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L20) + +▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `never` | + +#### Returns + +`Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Defined in + +[types/corestore.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L23) + +▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Omit`\<`HypercoreOptions`\<``"binary"``, `undefined`\>, ``"key"`` \| ``"keyPair"``\> & \{ `key?`: `string` \| `Buffer` ; `keyPair`: \{ `publicKey`: `Buffer` ; `secretKey?`: ``null`` \| `Buffer` } ; `sparse?`: `boolean` } | + +#### Returns + +`Hypercore`\<`ValueEncoding`, `Buffer`\> + +#### Defined in + +[types/corestore.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L26) + +___ + +### namespace + +▸ **namespace**(`name`): [`Corestore`](internal_.Corestore.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`Corestore`](internal_.Corestore.md) + +#### Defined in + +[types/corestore.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L34) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[types/corestore.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L35) diff --git a/docs/api/md/classes/internal_.DataStore.md b/docs/api/md/classes/internal_.DataStore.md new file mode 100644 index 000000000..27e283679 --- /dev/null +++ b/docs/api/md/classes/internal_.DataStore.md @@ -0,0 +1,251 @@ +[API](../README.md) / [\](../modules/internal_.md) / DataStore + +# Class: DataStore\ + +[\](../modules/internal_.md).DataStore + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | keyof [`NamespaceSchemas`](../modules/internal_.md#namespaceschemas) | +| `TSchemaName` | [`NamespaceSchemas`](../modules/internal_.md#namespaceschemas)[`TNamespace`][`number`] | + +## Hierarchy + +- `TypedEmitter` + + ↳ **`DataStore`** + +## Table of contents + +### Constructors + +- [constructor](internal_.DataStore.md#constructor) + +### Accessors + +- [indexer](internal_.DataStore.md#indexer) +- [namespace](internal_.DataStore.md#namespace) +- [schemas](internal_.DataStore.md#schemas) +- [writerCore](internal_.DataStore.md#writercore) + +### Methods + +- [close](internal_.DataStore.md#close) +- [getIndexState](internal_.DataStore.md#getindexstate) +- [read](internal_.DataStore.md#read) +- [readRaw](internal_.DataStore.md#readraw) +- [write](internal_.DataStore.md#write) +- [writeRaw](internal_.DataStore.md#writeraw) + +## Constructors + +### constructor + +• **new DataStore**\<`TNamespace`, `TSchemaName`\>(`opts`): [`DataStore`](internal_.DataStore.md)\<`TNamespace`, `TSchemaName`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | extends ``"auth"`` \| ``"config"`` \| ``"data"`` = ``"auth"`` \| ``"config"`` \| ``"data"`` | +| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` = \{ `auth`: readonly [``"coreOwnership"``, ``"role"``] ; `config`: readonly [``"translation"``, ``"preset"``, ``"field"``, ``"projectSettings"``, ``"deviceInfo"``, ``"icon"``] ; `data`: readonly [``"observation"``, ``"track"``] }[`TNamespace`][`number`] | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.batch` | (`entries`: `Entry`\<``"binary"``\>[]) => `Promise`\<[`IndexedDocIds`](../modules/internal_.md#indexeddocids)\> | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | +| `opts.namespace` | `TNamespace` | +| `opts.storage` | `StorageParam` | + +#### Returns + +[`DataStore`](internal_.DataStore.md)\<`TNamespace`, `TSchemaName`\> + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/datastore/index.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L72) + +## Accessors + +### indexer + +• `get` **indexer**(): `MultiCoreIndexer`\<``"binary"``\> + +#### Returns + +`MultiCoreIndexer`\<``"binary"``\> + +#### Defined in + +[src/datastore/index.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L94) + +___ + +### namespace + +• `get` **namespace**(): `TNamespace` + +#### Returns + +`TNamespace` + +#### Defined in + +[src/datastore/index.js:98](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L98) + +___ + +### schemas + +• `get` **schemas**(): (``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] + +#### Returns + +(``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] + +#### Defined in + +[src/datastore/index.js:102](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L102) + +___ + +### writerCore + +• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/datastore/index.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L107) + +## Methods + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/datastore/index.js:229](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L229) + +___ + +### getIndexState + +▸ **getIndexState**(): `IndexState` + +#### Returns + +`IndexState` + +#### Defined in + +[src/datastore/index.js:111](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L111) + +___ + +### read + +▸ **read**(`versionId`): `Promise`\<`MapeoDoc`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`MapeoDoc`\> + +#### Defined in + +[src/datastore/index.js:198](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L198) + +___ + +### readRaw + +▸ **readRaw**(`versionId`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/datastore/index.js:220](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L220) + +___ + +### write + +▸ **write**\<`TDoc`\>(`doc`): `Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> + +UNSAFE: Does not check links: [] refer to a valid doc - should only be used +internally. + +Write a doc, must be one of the schema types supported by the namespace of +this DataStore. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{}, ``"versionId"``\> \| \{ `schemaName`: `TSchemaName` } & `Omit`\<{} & `CoreOwnershipSignatures`, ``"versionId"``\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | `TDoc` | + +#### Returns + +`Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> + +#### Defined in + +[src/datastore/index.js:157](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L157) + +___ + +### writeRaw + +▸ **writeRaw**(`buf`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buf` | `Buffer` | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/datastore/index.js:208](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L208) diff --git a/docs/api/md/classes/internal_.DataType.md b/docs/api/md/classes/internal_.DataType.md new file mode 100644 index 000000000..8aee943c1 --- /dev/null +++ b/docs/api/md/classes/internal_.DataType.md @@ -0,0 +1,284 @@ +[API](../README.md) / [\](../modules/internal_.md) / DataType + +# Class: DataType\ + +[\](../modules/internal_.md).DataType + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TDataStore` | extends [`"/home/szgy/src/dd/mapeo-core-next/src/datastore/index"`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md) | +| `TTable` | extends [`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1) | +| `TSchemaName` | extends `TTable`[``"_"``][``"name"``] | +| `TDoc` | extends [`MapeoDocMap`](../modules/internal_.md#mapeodocmap)[`TSchemaName`] | +| `TValue` | extends [`MapeoValueMap`](../modules/internal_.md#mapeovaluemap)[`TSchemaName`] | + +## Hierarchy + +- `TypedEmitter`\<[`DataTypeEvents`](../interfaces/internal_.DataTypeEvents.md)\<`TDoc`\>\> + + ↳ **`DataType`** + +## Table of contents + +### Constructors + +- [constructor](internal_.DataType.md#constructor) + +### Accessors + +- [[kTable]](internal_.DataType.md#[ktable]) +- [writerCore](internal_.DataType.md#writercore) + +### Methods + +- [[kCreateWithDocId]](internal_.DataType.md#[kcreatewithdocid]) +- [[kSelect]](internal_.DataType.md#[kselect]) +- [create](internal_.DataType.md#create) +- [delete](internal_.DataType.md#delete) +- [getByDocId](internal_.DataType.md#getbydocid) +- [getByVersionId](internal_.DataType.md#getbyversionid) +- [getMany](internal_.DataType.md#getmany) +- [update](internal_.DataType.md#update) + +## Constructors + +### constructor + +• **new DataType**\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>(`«destructured»`): [`DataType`](internal_.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TDataStore` | extends [`DataStore`](internal_.DataStore.md)\<``"auth"`` \| ``"config"`` \| ``"data"``, ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``\> | +| `TTable` | extends [`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1) | +| `TSchemaName` | extends ``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"`` | +| `TDoc` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | +| `TValue` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `dataStore` | `TDataStore` | +| › `db` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | +| › `getPermissions?` | () => `any` | +| › `getTranslations` | (`value`: {}) => `Promise`\<{}[]\> | +| › `table` | `TTable` | + +#### Returns + +[`DataType`](internal_.DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\> + +#### Overrides + +TypedEmitter\<DataTypeEvents\<TDoc\>\>.constructor + +#### Defined in + +[src/datatype/index.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L51) + +## Accessors + +### [kTable] + +• `get` **[kTable]**(): `TTable` + +#### Returns + +`TTable` + +#### Defined in + +[src/datatype/index.d.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L65) + +___ + +### writerCore + +• `get` **writerCore**(): `Hypercore`\<``"binary"``, `Buffer`\> + +#### Returns + +`Hypercore`\<``"binary"``, `Buffer`\> + +#### Defined in + +[src/datatype/index.d.ts:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L67) + +## Methods + +### [kCreateWithDocId] + +▸ **[kCreateWithDocId]**(`docId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | +| `value` | `Exclude`\<`TValue`, \{ `schemaName`: ``"coreOwnership"`` }\> \| [`CoreOwnershipWithSignaturesValue`](../modules/internal_.md#coreownershipwithsignaturesvalue) | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:69](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L69) + +___ + +### [kSelect] + +▸ **[kSelect]**(): `Promise`\<`any`\> + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[src/datatype/index.d.ts:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L76) + +___ + +### create + +▸ **create**\<`T`\>(`value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `T` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L78) + +___ + +### delete + +▸ **delete**(`docId`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:104](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L104) + +___ + +### getByDocId + +▸ **getByDocId**(`docId`, `opts?`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `docId` | `string` | +| `opts?` | `Object` | +| `opts.lang?` | `string` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L85) + +___ + +### getByVersionId + +▸ **getByVersionId**(`versionId`, `opts?`): `Promise`\<`TDoc`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` | +| `opts?` | `Object` | +| `opts.lang?` | `string` | + +#### Returns + +`Promise`\<`TDoc`\> + +#### Defined in + +[src/datatype/index.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L90) + +___ + +### getMany + +▸ **getMany**(`opts?`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `Object` | +| `opts.includeDeleted?` | `boolean` | +| `opts.lang?` | `string` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> + +#### Defined in + +[src/datatype/index.d.ts:92](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L92) + +___ + +### update + +▸ **update**\<`T`\>(`versionId`, `value`): `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| \{ `schemaName`: `TSchemaName` } & {} \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `ExactObject`\<\{ `schemaName`: `TSchemaName` } & {}, `T`\> \| `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| readonly `Exact`\<`ArrayElement`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>\>, `ArrayElement`\<`T`\>\>[] \| `ExactObject`\<`Exclude`\<`Extract`\<{}, \{ `schemaName`: `TSchemaName` }\>, \{ `schemaName`: ``"coreOwnership"`` }\>, `T`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `versionId` | `string` \| `string`[] | +| `value` | `T` | + +#### Returns + +`Promise`\<`TDoc` & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/datatype/index.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L97) diff --git a/docs/api/md/classes/internal_.DenseIndex.md b/docs/api/md/classes/internal_.DenseIndex.md new file mode 100644 index 000000000..3f1ac7f78 --- /dev/null +++ b/docs/api/md/classes/internal_.DenseIndex.md @@ -0,0 +1,187 @@ +[API](../README.md) / [\](../modules/internal_.md) / DenseIndex + +# Class: DenseIndex + +[\](../modules/internal_.md).DenseIndex + +## Hierarchy + +- [`Index`](internal_.Index.md) + + ↳ **`DenseIndex`** + +## Table of contents + +### Constructors + +- [constructor](internal_.DenseIndex.md#constructor) + +### Properties + +- [byteLength](internal_.DenseIndex.md#bytelength) + +### Methods + +- [skipFirst](internal_.DenseIndex.md#skipfirst) +- [skipLast](internal_.DenseIndex.md#skiplast) +- [update](internal_.DenseIndex.md#update) +- [from](internal_.DenseIndex.md#from) + +## Constructors + +### constructor + +• **new DenseIndex**(`field`, `byteLength`): [`DenseIndex`](internal_.DenseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `TypedArray` | +| `byteLength` | `number` | + +#### Returns + +[`DenseIndex`](internal_.DenseIndex.md) + +#### Overrides + +[Index](internal_.Index.md).[constructor](internal_.Index.md#constructor) + +#### Defined in + +[types/quickbit-universal.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L33) + +## Properties + +### byteLength + +• `Readonly` **byteLength**: `number` + +#### Inherited from + +[Index](internal_.Index.md).[byteLength](internal_.Index.md#bytelength) + +#### Defined in + +[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) + +## Methods + +### skipFirst + +▸ **skipFirst**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[Index](internal_.Index.md).[skipFirst](internal_.Index.md#skipfirst) + +#### Defined in + +[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) + +___ + +### skipLast + +▸ **skipLast**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[Index](internal_.Index.md).[skipLast](internal_.Index.md#skiplast) + +#### Defined in + +[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) + +___ + +### update + +▸ **update**(`bit`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`boolean` + +#### Overrides + +[Index](internal_.Index.md).[update](internal_.Index.md#update) + +#### Defined in + +[types/quickbit-universal.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L34) + +___ + +### from + +▸ **from**(`field`, `byteLength`): [`DenseIndex`](internal_.DenseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `TypedArray` | +| `byteLength` | `number` | + +#### Returns + +[`DenseIndex`](internal_.DenseIndex.md) + +#### Inherited from + +[Index](internal_.Index.md).[from](internal_.Index.md#from) + +#### Defined in + +[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) + +▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | [`Chunk`](../modules/internal_.md#chunk)[] | +| `byteLength` | `number` | + +#### Returns + +[`SparseIndex`](internal_.SparseIndex.md) + +#### Inherited from + +[Index](internal_.Index.md).[from](internal_.Index.md#from) + +#### Defined in + +[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.DriveLiveDownload.md b/docs/api/md/classes/internal_.DriveLiveDownload.md new file mode 100644 index 000000000..88ef60485 --- /dev/null +++ b/docs/api/md/classes/internal_.DriveLiveDownload.md @@ -0,0 +1,66 @@ +[API](../README.md) / [\](../modules/internal_.md) / DriveLiveDownload + +# Class: DriveLiveDownload + +[\](../modules/internal_.md).DriveLiveDownload + +LiveDownload class + +## Hierarchy + +- `TypedEmitter` + + ↳ **`DriveLiveDownload`** + +## Table of contents + +### Constructors + +- [constructor](internal_.DriveLiveDownload.md#constructor) + +### Accessors + +- [state](internal_.DriveLiveDownload.md#state) + +## Constructors + +### constructor + +• **new DriveLiveDownload**(`drive`, `options?`): [`DriveLiveDownload`](internal_.DriveLiveDownload.md) + +Like drive.download() but 'live', + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `drive` | [`Hyperdrive`](internal_.Hyperdrive-1.md) | | +| `options` | `Object` | | +| `options.filter` | `undefined` \| [`BlobFilter`](../modules/internal_.md#blobfilter) | Filter blobs of specific types and/or sizes to download | +| `options.signal` | `undefined` \| `AbortSignal` | | + +#### Returns + +[`DriveLiveDownload`](internal_.DriveLiveDownload.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/blob-store/live-download.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L107) + +## Accessors + +### state + +• `get` **state**(): [`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) + +#### Returns + +[`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) + +#### Defined in + +[src/blob-store/live-download.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L129) diff --git a/docs/api/md/classes/internal_.Hyperblobs-1.md b/docs/api/md/classes/internal_.Hyperblobs-1.md new file mode 100644 index 000000000..2b79b1d67 --- /dev/null +++ b/docs/api/md/classes/internal_.Hyperblobs-1.md @@ -0,0 +1,209 @@ +[API](../README.md) / [\](../modules/internal_.md) / Hyperblobs + +# Class: Hyperblobs + +[\](../modules/internal_.md).Hyperblobs + +## Table of contents + +### Constructors + +- [constructor](internal_.Hyperblobs-1.md#constructor) + +### Properties + +- [blockSize](internal_.Hyperblobs-1.md#blocksize) +- [core](internal_.Hyperblobs-1.md#core) + +### Accessors + +- [feed](internal_.Hyperblobs-1.md#feed) +- [locked](internal_.Hyperblobs-1.md#locked) + +### Methods + +- [clear](internal_.Hyperblobs-1.md#clear) +- [createReadStream](internal_.Hyperblobs-1.md#createreadstream) +- [createWriteStream](internal_.Hyperblobs-1.md#createwritestream) +- [get](internal_.Hyperblobs-1.md#get) +- [put](internal_.Hyperblobs-1.md#put) + +## Constructors + +### constructor + +• **new Hyperblobs**(`core`, `opts?`): [`Hyperblobs`](internal_.Hyperblobs-1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `core` | `Hypercore`\<``"binary"``, `undefined`\> | +| `opts?` | `Object` | +| `opts.blocksize?` | `number` | + +#### Returns + +[`Hyperblobs`](internal_.Hyperblobs-1.md) + +#### Defined in + +[types/hyperblobs.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L33) + +## Properties + +### blockSize + +• `Readonly` **blockSize**: `number` + +#### Defined in + +[types/hyperblobs.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L31) + +___ + +### core + +• `Readonly` **core**: `Hypercore`\<``"binary"``, `undefined`\> + +#### Defined in + +[types/hyperblobs.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L30) + +## Accessors + +### feed + +• `get` **feed**(): `Hypercore`\<``"binary"``, `undefined`\> + +#### Returns + +`Hypercore`\<``"binary"``, `undefined`\> + +#### Defined in + +[types/hyperblobs.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L35) + +___ + +### locked + +• `get` **locked**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[types/hyperblobs.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L37) + +## Methods + +### clear + +▸ **clear**(`id`, `opts?`): `Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | [`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md) | +| `opts?` | `Object` | +| `opts.diff?` | `boolean` | + +#### Returns + +`Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Defined in + +[types/hyperblobs.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L59) + +___ + +### createReadStream + +▸ **createReadStream**(`id`, `opts?`): [`BlobReadStream`](internal_.BlobReadStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | [`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md) | +| `opts?` | `any` | + +#### Returns + +[`BlobReadStream`](internal_.BlobReadStream.md) + +#### Defined in + +[types/hyperblobs.d.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L65) + +___ + +### createWriteStream + +▸ **createWriteStream**(`opts?`): [`BlobWriteStream`](internal_.BlobWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `any` | + +#### Returns + +[`BlobWriteStream`](internal_.BlobWriteStream.md) + +#### Defined in + +[types/hyperblobs.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L64) + +___ + +### get + +▸ **get**(`id`, `opts?`): `Promise`\<``null`` \| `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | [`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md) | +| `opts?` | `any` | + +#### Returns + +`Promise`\<``null`` \| `Buffer`\> + +#### Defined in + +[types/hyperblobs.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L50) + +___ + +### put + +▸ **put**(`blob`, `opts?`): `Promise`\<[`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `blob` | `Buffer` | +| `opts?` | `Object` | +| `opts.blockSize?` | `number` | +| `opts.core?` | `Hypercore`\<``"binary"``, `undefined`\> | +| `opts.end?` | `number` | +| `opts.length?` | `number` | +| `opts.start?` | `number` | + +#### Returns + +`Promise`\<[`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md)\> + +#### Defined in + +[types/hyperblobs.d.ts:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L39) diff --git a/docs/api/md/classes/internal_.Hyperdrive-1.md b/docs/api/md/classes/internal_.Hyperdrive-1.md new file mode 100644 index 000000000..1c7dab850 --- /dev/null +++ b/docs/api/md/classes/internal_.Hyperdrive-1.md @@ -0,0 +1,585 @@ +[API](../README.md) / [\](../modules/internal_.md) / Hyperdrive + +# Class: Hyperdrive + +[\](../modules/internal_.md).Hyperdrive + +## Hierarchy + +- `TypedEmitter`\<[`HyperdriveEvents`](../interfaces/internal_.HyperdriveEvents.md)\> + + ↳ **`Hyperdrive`** + +## Table of contents + +### Constructors + +- [constructor](internal_.Hyperdrive-1.md#constructor) + +### Properties + +- [blobs](internal_.Hyperdrive-1.md#blobs) +- [contentKey](internal_.Hyperdrive-1.md#contentkey) +- [core](internal_.Hyperdrive-1.md#core) +- [db](internal_.Hyperdrive-1.md#db) +- [discoveryKey](internal_.Hyperdrive-1.md#discoverykey) +- [id](internal_.Hyperdrive-1.md#id) +- [key](internal_.Hyperdrive-1.md#key) +- [version](internal_.Hyperdrive-1.md#version) + +### Methods + +- [batch](internal_.Hyperdrive-1.md#batch) +- [checkout](internal_.Hyperdrive-1.md#checkout) +- [clear](internal_.Hyperdrive-1.md#clear) +- [createReadStream](internal_.Hyperdrive-1.md#createreadstream) +- [createWriteStream](internal_.Hyperdrive-1.md#createwritestream) +- [del](internal_.Hyperdrive-1.md#del) +- [diff](internal_.Hyperdrive-1.md#diff) +- [download](internal_.Hyperdrive-1.md#download) +- [downloadDiff](internal_.Hyperdrive-1.md#downloaddiff) +- [downloadRange](internal_.Hyperdrive-1.md#downloadrange) +- [entries](internal_.Hyperdrive-1.md#entries) +- [entry](internal_.Hyperdrive-1.md#entry) +- [get](internal_.Hyperdrive-1.md#get) +- [getBlobs](internal_.Hyperdrive-1.md#getblobs) +- [list](internal_.Hyperdrive-1.md#list) +- [mirror](internal_.Hyperdrive-1.md#mirror) +- [put](internal_.Hyperdrive-1.md#put) +- [readdir](internal_.Hyperdrive-1.md#readdir) +- [ready](internal_.Hyperdrive-1.md#ready) +- [update](internal_.Hyperdrive-1.md#update) + +## Constructors + +### constructor + +• **new Hyperdrive**(`corestore`, `key?`, `opts?`): [`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `corestore` | [`Corestore`](internal_.Corestore.md) | +| `key?` | ``null`` \| `Buffer` | +| `opts?` | [`HyperdriveOptions`](../interfaces/internal_.HyperdriveOptions.md) | + +#### Returns + +[`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Overrides + +TypedEmitter\<HyperdriveEvents\>.constructor + +#### Defined in + +[types/hyperdrive.d.ts:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L48) + +• **new Hyperdrive**(`corestore`, `opts?`): [`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `corestore` | [`Corestore`](internal_.Corestore.md) | +| `opts?` | [`HyperdriveOptions`](../interfaces/internal_.HyperdriveOptions.md) | + +#### Returns + +[`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Overrides + +TypedEmitter\<HyperdriveEvents\>.constructor + +#### Defined in + +[types/hyperdrive.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L53) + +## Properties + +### blobs + +• `Readonly` **blobs**: ``null`` \| [`Hyperblobs`](internal_.Hyperblobs-1.md) + +#### Defined in + +[types/hyperdrive.d.ts:56](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L56) + +___ + +### contentKey + +• `Readonly` **contentKey**: ``null`` \| `Buffer` + +#### Defined in + +[types/hyperdrive.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L59) + +___ + +### core + +• `Readonly` **core**: `Hypercore`\<``"binary"``, `undefined`\> + +#### Defined in + +[types/hyperdrive.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L55) + +___ + +### db + +• `Readonly` **db**: `any` + +#### Defined in + +[types/hyperdrive.d.ts:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L60) + +___ + +### discoveryKey + +• `Readonly` **discoveryKey**: ``null`` \| `Buffer` + +#### Defined in + +[types/hyperdrive.d.ts:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L58) + +___ + +### id + +• `Readonly` **id**: ``null`` \| `string` + +#### Defined in + +[types/hyperdrive.d.ts:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L54) + +___ + +### key + +• `Readonly` **key**: ``null`` \| `Buffer` + +#### Defined in + +[types/hyperdrive.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L57) + +___ + +### version + +• `Readonly` **version**: `number` + +#### Defined in + +[types/hyperdrive.d.ts:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L61) + +## Methods + +### batch + +▸ **batch**(): `any` + +#### Returns + +`any` + +#### Defined in + +[types/hyperdrive.d.ts:99](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L99) + +___ + +### checkout + +▸ **checkout**(`version`): [`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `version` | `number` | + +#### Returns + +[`Hyperdrive`](internal_.Hyperdrive-1.md) + +#### Defined in + +[types/hyperdrive.d.ts:88](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L88) + +___ + +### clear + +▸ **clear**(`path`, `opts?`): `Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `opts?` | `Object` | +| `opts.diff?` | `boolean` | + +#### Returns + +`Promise`\<``null`` \| \{ `blocks`: `number` }\> + +#### Defined in + +[types/hyperdrive.d.ts:100](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L100) + +___ + +### createReadStream + +▸ **createReadStream**(`path`, `opts?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `opts?` | `Object` | +| `opts.core?` | `Hypercore`\<``"binary"``, `undefined`\> | +| `opts.end?` | `number` | +| `opts.length?` | `number` | +| `opts.start?` | `number` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L64) + +___ + +### createWriteStream + +▸ **createWriteStream**(`path`, `opts?`): `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `opts?` | `Object` | +| `opts.executable?` | `boolean` | +| `opts.metadata?` | `any` | + +#### Returns + +`Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L83) + +___ + +### del + +▸ **del**(`path`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[types/hyperdrive.d.ts:87](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L87) + +___ + +### diff + +▸ **diff**(`version`, `folder`, `opts?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `version` | `number` | +| `folder` | `string` | +| `opts?` | `any` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:89](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L89) + +___ + +### download + +▸ **download**(`folder?`, `opts?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `folder?` | `string` | +| `opts?` | `Object` | +| `opts.recursive?` | `boolean` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:96](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L96) + +___ + +### downloadDiff + +▸ **downloadDiff**(`version`, `folder`, `opts?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `version` | `number` | +| `folder` | `string` | +| `opts?` | `any` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L90) + +___ + +### downloadRange + +▸ **downloadRange**(`dbRanges`, `blobRanges`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `dbRanges` | [`Range`](../modules/internal_.md#range) | +| `blobRanges` | [`Range`](../modules/internal_.md#range) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `destroy` | () => `void` | +| `done` | `Promise`\<`void`\> | + +#### Defined in + +[types/hyperdrive.d.ts:91](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L91) + +___ + +### entries + +▸ **entries**(`opts`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `any` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L77) + +___ + +### entry + +▸ **entry**(`path`, `opts?`): `Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `opts?` | [`HyperdriveGetOpts`](../interfaces/internal_.HyperdriveGetOpts.md) | + +#### Returns + +`Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> + +#### Defined in + +[types/hyperdrive.d.ts:68](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L68) + +___ + +### get + +▸ **get**(`path`, `opts?`): `Promise`\<``null`` \| `Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `opts?` | \{ `follow?`: `boolean` } & [`HyperdriveGetOpts`](../interfaces/internal_.HyperdriveGetOpts.md) | + +#### Returns + +`Promise`\<``null`` \| `Buffer`\> + +#### Defined in + +[types/hyperdrive.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L73) + +___ + +### getBlobs + +▸ **getBlobs**(): `Promise`\<``null`` \| [`Hyperblobs`](internal_.Hyperblobs-1.md)\> + +#### Returns + +`Promise`\<``null`` \| [`Hyperblobs`](internal_.Hyperblobs-1.md)\> + +#### Defined in + +[types/hyperdrive.d.ts:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L72) + +___ + +### list + +▸ **list**(`folder`, `opts?`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `folder` | `string` | +| `opts?` | `Object` | +| `opts.recursive?` | `boolean` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:95](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L95) + +___ + +### mirror + +▸ **mirror**(): `any` + +#### Returns + +`any` + +#### Defined in + +[types/hyperdrive.d.ts:98](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L98) + +___ + +### put + +▸ **put**(`path`, `blob`, `opts?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `blob` | `Buffer` | +| `opts?` | `Object` | +| `opts.executable?` | `boolean` | +| `opts.metadata?` | `any` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[types/hyperdrive.d.ts:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L78) + +___ + +### readdir + +▸ **readdir**(`folder`): `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `folder` | `string` | + +#### Returns + +`Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> + +#### Defined in + +[types/hyperdrive.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L97) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[types/hyperdrive.d.ts:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L62) + +___ + +### update + +▸ **update**(`options?`): `Promise`\<`Boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.wait?` | `boolean` | + +#### Returns + +`Promise`\<`Boolean`\> + +#### Defined in + +[types/hyperdrive.d.ts:63](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L63) diff --git a/docs/api/md/classes/internal_.IconApi.md b/docs/api/md/classes/internal_.IconApi.md new file mode 100644 index 000000000..62bd85030 --- /dev/null +++ b/docs/api/md/classes/internal_.IconApi.md @@ -0,0 +1,104 @@ +[API](../README.md) / [\](../modules/internal_.md) / IconApi + +# Class: IconApi + +[\](../modules/internal_.md).IconApi + +## Table of contents + +### Constructors + +- [constructor](internal_.IconApi.md#constructor) + +### Methods + +- [[kGetIconBlob]](internal_.IconApi.md#[kgeticonblob]) +- [create](internal_.IconApi.md#create) +- [getIconUrl](internal_.IconApi.md#geticonurl) + +## Constructors + +### constructor + +• **new IconApi**(`opts`): [`IconApi`](internal_.IconApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.getMediaBaseUrl` | () => `Promise`\<`string`\> | +| `opts.iconDataStore` | [`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\> | +| `opts.iconDataType` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | + +#### Returns + +[`IconApi`](internal_.IconApi.md) + +#### Defined in + +[src/icon-api.js:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L40) + +## Methods + +### [kGetIconBlob] + +▸ **[kGetIconBlob]**(`iconId`, `opts`): `Promise`\<`Buffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iconId` | `string` | +| `opts` | [`BitmapOpts`](../interfaces/internal_.BitmapOpts.md) \| [`SvgOpts`](../interfaces/internal_.SvgOpts.md) | + +#### Returns + +`Promise`\<`Buffer`\> + +#### Defined in + +[src/icon-api.js:80](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L80) + +___ + +### create + +▸ **create**(`icon`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `icon` | `Object` | +| `icon.name` | `string` | +| `icon.variants` | [`BitmapOpts`](../interfaces/internal_.BitmapOpts.md) \| [`SvgOpts`](../interfaces/internal_.SvgOpts.md) & \{ `blob`: `Buffer` }[] | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/icon-api.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L53) + +___ + +### getIconUrl + +▸ **getIconUrl**(`iconId`, `opts`): `Promise`\<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iconId` | `string` | +| `opts` | [`BitmapOpts`](../interfaces/internal_.BitmapOpts.md) \| [`SvgOpts`](../interfaces/internal_.SvgOpts.md) | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/icon-api.js:93](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L93) diff --git a/docs/api/md/classes/internal_.Index.md b/docs/api/md/classes/internal_.Index.md new file mode 100644 index 000000000..217a3d55b --- /dev/null +++ b/docs/api/md/classes/internal_.Index.md @@ -0,0 +1,160 @@ +[API](../README.md) / [\](../modules/internal_.md) / Index + +# Class: Index + +[\](../modules/internal_.md).Index + +## Hierarchy + +- **`Index`** + + ↳ [`SparseIndex`](internal_.SparseIndex.md) + + ↳ [`DenseIndex`](internal_.DenseIndex.md) + +## Table of contents + +### Constructors + +- [constructor](internal_.Index.md#constructor) + +### Properties + +- [byteLength](internal_.Index.md#bytelength) + +### Methods + +- [skipFirst](internal_.Index.md#skipfirst) +- [skipLast](internal_.Index.md#skiplast) +- [update](internal_.Index.md#update) +- [from](internal_.Index.md#from) + +## Constructors + +### constructor + +• **new Index**(`byteLength`): [`Index`](internal_.Index.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `byteLength` | `number` | + +#### Returns + +[`Index`](internal_.Index.md) + +#### Defined in + +[types/quickbit-universal.d.ts:49](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L49) + +## Properties + +### byteLength + +• `Readonly` **byteLength**: `number` + +#### Defined in + +[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) + +## Methods + +### skipFirst + +▸ **skipFirst**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Defined in + +[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) + +___ + +### skipLast + +▸ **skipLast**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Defined in + +[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) + +___ + +### update + +▸ **update**(`bit`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[types/quickbit-universal.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L53) + +___ + +### from + +▸ **from**(`field`, `byteLength`): [`DenseIndex`](internal_.DenseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `TypedArray` | +| `byteLength` | `number` | + +#### Returns + +[`DenseIndex`](internal_.DenseIndex.md) + +#### Defined in + +[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) + +▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | [`Chunk`](../modules/internal_.md#chunk)[] | +| `byteLength` | `number` | + +#### Returns + +[`SparseIndex`](internal_.SparseIndex.md) + +#### Defined in + +[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.IndexWriter.md b/docs/api/md/classes/internal_.IndexWriter.md new file mode 100644 index 000000000..450d7e5b6 --- /dev/null +++ b/docs/api/md/classes/internal_.IndexWriter.md @@ -0,0 +1,92 @@ +[API](../README.md) / [\](../modules/internal_.md) / IndexWriter + +# Class: IndexWriter\ + +[\](../modules/internal_.md).IndexWriter + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TTables` | [`MapeoDocTables`](../modules/internal_.md#mapeodoctables) | + +## Table of contents + +### Constructors + +- [constructor](internal_.IndexWriter.md#constructor) + +### Accessors + +- [schemas](internal_.IndexWriter.md#schemas) + +### Methods + +- [batch](internal_.IndexWriter.md#batch) + +## Constructors + +### constructor + +• **new IndexWriter**\<`TTables`\>(`opts`): [`IndexWriter`](internal_.IndexWriter.md)\<`TTables`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TTables` | extends [`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1) = [`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.getWinner` | `undefined` \| \(`docA`: `T`, `docB`: `U`) => `T` \| `U` | custom function to determine the "winner" of two forked documents. Defaults to choosing the document with the most recent `updatedAt` | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | | +| `opts.mapDoc` | `undefined` \| (`doc`: `MapeoDocInternal`, `version`: `VersionIdObject`) => `MapeoDoc` | optionally transform a document prior to indexing. Can also validate, if an error is thrown then the document will not be indexed | +| `opts.sqlite` | `Database` | | +| `opts.tables` | `TTables`[] | | + +#### Returns + +[`IndexWriter`](internal_.IndexWriter.md)\<`TTables`\> + +#### Defined in + +[src/index-writer/index.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L38) + +## Accessors + +### schemas + +• `get` **schemas**(): `TTables`[``"_"``][``"name"``][] + +#### Returns + +`TTables`[``"_"``][``"name"``][] + +#### Defined in + +[src/index-writer/index.js:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L55) + +## Methods + +### batch + +▸ **batch**(`entries`): `Promise`\<[`IndexedDocIds`](../modules/internal_.md#indexeddocids)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `entries` | `Entry`\<``"binary"``\>[] | + +#### Returns + +`Promise`\<[`IndexedDocIds`](../modules/internal_.md#indexeddocids)\> + +map of indexed docIds by schemaName + +#### Defined in + +[src/index-writer/index.js:63](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L63) diff --git a/docs/api/md/classes/internal_.InviteApi.md b/docs/api/md/classes/internal_.InviteApi.md new file mode 100644 index 000000000..25efe14ba --- /dev/null +++ b/docs/api/md/classes/internal_.InviteApi.md @@ -0,0 +1,129 @@ +[API](../README.md) / [\](../modules/internal_.md) / InviteApi + +# Class: InviteApi + +[\](../modules/internal_.md).InviteApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`InviteApi`** + +## Table of contents + +### Constructors + +- [constructor](internal_.InviteApi.md#constructor) + +### Properties + +- [rpc](internal_.InviteApi.md#rpc) + +### Methods + +- [accept](internal_.InviteApi.md#accept) +- [getPending](internal_.InviteApi.md#getpending) +- [reject](internal_.InviteApi.md#reject) + +## Constructors + +### constructor + +• **new InviteApi**(`options`): [`InviteApi`](internal_.InviteApi.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | +| `options.queries` | `Object` | +| `options.queries.addProject` | (`projectDetails`: `Pick`\<`ProjectJoinDetails`, ``"projectKey"`` \| ``"encryptionKeys"``\> & \{ `projectName`: `string` }) => `Promise`\<`unknown`\> | +| `options.queries.isMember` | (`projectId`: `string`) => `boolean` | +| `options.rpc` | [`LocalPeers`](internal_.LocalPeers.md) | + +#### Returns + +[`InviteApi`](internal_.InviteApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/invite-api.js:175](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L175) + +## Properties + +### rpc + +• **rpc**: [`LocalPeers`](internal_.LocalPeers.md) + +#### Defined in + +[src/invite-api.js:180](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L180) + +## Methods + +### accept + +▸ **accept**(`invite`): `Promise`\<`string`\> + +Attempt to accept the invite. + +This can fail if the invitor has canceled the invite or if you cannot +connect to the invitor's device. + +If the invite is accepted and you had other invites to the same project, +those invites are removed, and the invitors are told that you're already +part of this project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `Pick`\<[`MapBuffers`](../modules/internal_.md#mapbuffers)\<[`InviteInternal`](../modules/internal_.md#inviteinternal)\>, ``"inviteId"``\> | + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/invite-api.js:286](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L286) + +___ + +### getPending + +▸ **getPending**(): [`MapBuffers`](../modules/internal_.md#mapbuffers)\<[`InviteInternal`](../modules/internal_.md#inviteinternal)\>[] + +#### Returns + +[`MapBuffers`](../modules/internal_.md#mapbuffers)\<[`InviteInternal`](../modules/internal_.md#inviteinternal)\>[] + +#### Defined in + +[src/invite-api.js:267](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L267) + +___ + +### reject + +▸ **reject**(`invite`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `Pick`\<[`MapBuffers`](../modules/internal_.md#mapbuffers)\<[`InviteInternal`](../modules/internal_.md#inviteinternal)\>, ``"inviteId"``\> | + +#### Returns + +`void` + +#### Defined in + +[src/invite-api.js:416](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L416) diff --git a/docs/api/md/classes/internal_.LiveDownload.md b/docs/api/md/classes/internal_.LiveDownload.md new file mode 100644 index 000000000..8c93e08a8 --- /dev/null +++ b/docs/api/md/classes/internal_.LiveDownload.md @@ -0,0 +1,67 @@ +[API](../README.md) / [\](../modules/internal_.md) / LiveDownload + +# Class: LiveDownload + +[\](../modules/internal_.md).LiveDownload + +LiveDownload class + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LiveDownload`** + +## Table of contents + +### Constructors + +- [constructor](internal_.LiveDownload.md#constructor) + +### Accessors + +- [state](internal_.LiveDownload.md#state) + +## Constructors + +### constructor + +• **new LiveDownload**(`drives`, `emitter`, `options`): [`LiveDownload`](internal_.LiveDownload.md) + +Like drive.download() but 'live', and for multiple drives + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `drives` | `Iterable`\<[`Hyperdrive`](internal_.Hyperdrive-1.md)\> | | +| `emitter` | [`InternalDriveEmitter`](../modules/internal_.md#internaldriveemitter) | | +| `options` | `Object` | | +| `options.filter` | `undefined` \| [`BlobFilter`](../modules/internal_.md#blobfilter) | Filter blobs of specific types and/or sizes to download | +| `options.signal` | `undefined` \| `AbortSignal` | | + +#### Returns + +[`LiveDownload`](internal_.LiveDownload.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/blob-store/live-download.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L42) + +## Accessors + +### state + +• `get` **state**(): [`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) + +#### Returns + +[`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) + +#### Defined in + +[src/blob-store/live-download.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L78) diff --git a/docs/api/md/classes/internal_.LocalDiscovery.md b/docs/api/md/classes/internal_.LocalDiscovery.md new file mode 100644 index 000000000..81152df6a --- /dev/null +++ b/docs/api/md/classes/internal_.LocalDiscovery.md @@ -0,0 +1,145 @@ +[API](../README.md) / [\](../modules/internal_.md) / LocalDiscovery + +# Class: LocalDiscovery + +[\](../modules/internal_.md).LocalDiscovery + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LocalDiscovery`** + +## Table of contents + +### Constructors + +- [constructor](internal_.LocalDiscovery.md#constructor) + +### Accessors + +- [connections](internal_.LocalDiscovery.md#connections) +- [publicKey](internal_.LocalDiscovery.md#publickey) + +### Methods + +- [connectPeer](internal_.LocalDiscovery.md#connectpeer) +- [start](internal_.LocalDiscovery.md#start) +- [stop](internal_.LocalDiscovery.md#stop) + +## Constructors + +### constructor + +• **new LocalDiscovery**(`opts`): [`LocalDiscovery`](internal_.LocalDiscovery.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.identityKeypair` | [`Keypair`](../modules/internal_.md#keypair-1) | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | + +#### Returns + +[`LocalDiscovery`](internal_.LocalDiscovery.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/discovery/local-discovery.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L43) + +## Accessors + +### connections + +• `get` **connections**(): `IterableIterator`\<[`OpenedNoiseStream`](../modules/internal_.md#openednoisestream-1)\> + +#### Returns + +`IterableIterator`\<[`OpenedNoiseStream`](../modules/internal_.md#openednoisestream-1)\> + +#### Defined in + +[src/discovery/local-discovery.js:247](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L247) + +___ + +### publicKey + +• `get` **publicKey**(): `Buffer` + +#### Returns + +`Buffer` + +#### Defined in + +[src/discovery/local-discovery.js:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L61) + +## Methods + +### connectPeer + +▸ **connectPeer**(`peer`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peer` | `Object` | +| `peer.address` | `string` | +| `peer.name` | `string` | +| `peer.port` | `number` | + +#### Returns + +`void` + +#### Defined in + +[src/discovery/local-discovery.js:86](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L86) + +___ + +### start + +▸ **start**(): `Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Returns + +`Promise`\<\{ `name`: `string` ; `port`: `number` }\> + +#### Defined in + +[src/discovery/local-discovery.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L66) + +___ + +### stop + +▸ **stop**(`opts?`): `Promise`\<`void`\> + +Close all servers and stop multicast advertising and browsing. Will wait +for open sockets to close unless opts.force=true in which case open sockets +are force-closed after opts.timeout milliseconds + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts?` | `Object` | | +| `opts.force` | `undefined` \| `boolean` | Force-close open sockets after timeout milliseconds | +| `opts.timeout` | `undefined` \| `number` | Optional timeout when calling stop() with force=true | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/discovery/local-discovery.js:261](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L261) diff --git a/docs/api/md/classes/internal_.LocalPeers.md b/docs/api/md/classes/internal_.LocalPeers.md new file mode 100644 index 000000000..db9d7556a --- /dev/null +++ b/docs/api/md/classes/internal_.LocalPeers.md @@ -0,0 +1,220 @@ +[API](../README.md) / [\](../modules/internal_.md) / LocalPeers + +# Class: LocalPeers + +[\](../modules/internal_.md).LocalPeers + +## Hierarchy + +- `TypedEmitter` + + ↳ **`LocalPeers`** + +## Table of contents + +### Constructors + +- [constructor](internal_.LocalPeers.md#constructor) + +### Accessors + +- [peers](internal_.LocalPeers.md#peers) + +### Methods + +- [[kTestOnlySendRawInvite]](internal_.LocalPeers.md#[ktestonlysendrawinvite]) +- [connect](internal_.LocalPeers.md#connect) +- [sendDeviceInfo](internal_.LocalPeers.md#senddeviceinfo) +- [sendInvite](internal_.LocalPeers.md#sendinvite) +- [sendInviteCancel](internal_.LocalPeers.md#sendinvitecancel) +- [sendInviteResponse](internal_.LocalPeers.md#sendinviteresponse) +- [sendProjectJoinDetails](internal_.LocalPeers.md#sendprojectjoindetails) + +## Constructors + +### constructor + +• **new LocalPeers**(`opts?`): [`LocalPeers`](internal_.LocalPeers.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `Object` | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | + +#### Returns + +[`LocalPeers`](internal_.LocalPeers.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/local-peers.js:251](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L251) + +## Accessors + +### peers + +• `get` **peers**(): ([`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: [`Protomux`](internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] + +#### Returns + +([`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: [`Protomux`](internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] + +#### Defined in + +[src/local-peers.js:256](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L256) + +## Methods + +### [kTestOnlySendRawInvite] + +▸ **[kTestOnlySendRawInvite]**(`deviceId`, `buf`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `buf` | `Buffer` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:323](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L323) + +___ + +### connect + +▸ **connect**(`stream`): [`ReplicationStream`](../modules/internal_.md#replicationstream) + +Connect to a peer over an existing NoiseSecretStream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | `NoiseSecretStream`\<`any`\> | a NoiseSecretStream from @hyperswarm/secret-stream | + +#### Returns + +[`ReplicationStream`](../modules/internal_.md#replicationstream) + +#### Defined in + +[src/local-peers.js:335](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L335) + +___ + +### sendDeviceInfo + +▸ **sendDeviceInfo**(`deviceId`, `deviceInfo`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deviceId` | `string` | id of the peer you want to send to (publicKey of peer as hex string) | +| `deviceInfo` | `DeviceInfo` | device info to send | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:313](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L313) + +___ + +### sendInvite + +▸ **sendInvite**(`deviceId`, `invite`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `invite` | `Invite` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L269) + +___ + +### sendInviteCancel + +▸ **sendInviteCancel**(`deviceId`, `inviteCancel`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `inviteCancel` | `InviteCancel` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:280](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L280) + +___ + +### sendInviteResponse + +▸ **sendInviteResponse**(`deviceId`, `inviteResponse`): `Promise`\<`void`\> + +Respond to an invite from a peer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `deviceId` | `string` | id of the peer you want to respond to (publicKey of peer as hex string) | +| `inviteResponse` | `InviteResponse` | | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:292](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L292) + +___ + +### sendProjectJoinDetails + +▸ **sendProjectJoinDetails**(`deviceId`, `details`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `details` | `ProjectJoinDetails` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/local-peers.js:302](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L302) diff --git a/docs/api/md/classes/internal_.Logger.md b/docs/api/md/classes/internal_.Logger.md new file mode 100644 index 000000000..e2fdf1b96 --- /dev/null +++ b/docs/api/md/classes/internal_.Logger.md @@ -0,0 +1,133 @@ +[API](../README.md) / [\](../modules/internal_.md) / Logger + +# Class: Logger + +[\](../modules/internal_.md).Logger + +## Table of contents + +### Constructors + +- [constructor](internal_.Logger.md#constructor) + +### Properties + +- [deviceId](internal_.Logger.md#deviceid) + +### Accessors + +- [enabled](internal_.Logger.md#enabled) + +### Methods + +- [extend](internal_.Logger.md#extend) +- [log](internal_.Logger.md#log) +- [create](internal_.Logger.md#create) + +## Constructors + +### constructor + +• **new Logger**(`opts`): [`Logger`](internal_.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.baseLogger` | `undefined` \| `Debugger` | +| `opts.deviceId` | `string` | +| `opts.ns` | `undefined` \| `string` | + +#### Returns + +[`Logger`](internal_.Logger.md) + +#### Defined in + +[src/logger.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L72) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/logger.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L73) + +## Accessors + +### enabled + +• `get` **enabled**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/logger.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L77) + +## Methods + +### extend + +▸ **extend**(`ns`): [`Logger`](internal_.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ns` | `string` | + +#### Returns + +[`Logger`](internal_.Logger.md) + +#### Defined in + +[src/logger.js:91](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L91) + +___ + +### log + +▸ **log**(`...args`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [formatter: any, ...args: any[]] | + +#### Returns + +`void` + +#### Defined in + +[src/logger.js:84](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L84) + +___ + +### create + +▸ **create**(`ns`, `logger?`): [`Logger`](internal_.Logger.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ns` | `string` | +| `logger?` | [`Logger`](internal_.Logger.md) | + +#### Returns + +[`Logger`](internal_.Logger.md) + +#### Defined in + +[src/logger.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L59) diff --git a/docs/api/md/classes/internal_.MapeoProject.md b/docs/api/md/classes/internal_.MapeoProject.md new file mode 100644 index 000000000..b46d81b1b --- /dev/null +++ b/docs/api/md/classes/internal_.MapeoProject.md @@ -0,0 +1,465 @@ +[API](../README.md) / [\](../modules/internal_.md) / MapeoProject + +# Class: MapeoProject + +[\](../modules/internal_.md).MapeoProject + +## Hierarchy + +- `TypedEmitter` + + ↳ **`MapeoProject`** + +## Table of contents + +### Constructors + +- [constructor](internal_.MapeoProject.md#constructor) + +### Properties + +- [$blobs](internal_.MapeoProject.md#$blobs) +- [EMPTY\_PROJECT\_SETTINGS](internal_.MapeoProject.md#empty_project_settings) + +### Accessors + +- [$icons](internal_.MapeoProject.md#$icons) +- [$member](internal_.MapeoProject.md#$member) +- [$sync](internal_.MapeoProject.md#$sync) +- [$translation](internal_.MapeoProject.md#$translation) +- [[kBlobStore]](internal_.MapeoProject.md#[kblobstore]) +- [[kCoreManager]](internal_.MapeoProject.md#[kcoremanager]) +- [[kCoreOwnership]](internal_.MapeoProject.md#[kcoreownership]) +- [[kDataTypes]](internal_.MapeoProject.md#[kdatatypes]) +- [deviceId](internal_.MapeoProject.md#deviceid) +- [field](internal_.MapeoProject.md#field) +- [observation](internal_.MapeoProject.md#observation) +- [preset](internal_.MapeoProject.md#preset) +- [track](internal_.MapeoProject.md#track) + +### Methods + +- [$getOwnRole](internal_.MapeoProject.md#$getownrole) +- [$getProjectSettings](internal_.MapeoProject.md#$getprojectsettings) +- [$setProjectSettings](internal_.MapeoProject.md#$setprojectsettings) +- [[kProjectLeave]](internal_.MapeoProject.md#[kprojectleave]) +- [[kProjectReplicate]](internal_.MapeoProject.md#[kprojectreplicate]) +- [[kSetOwnDeviceInfo]](internal_.MapeoProject.md#[ksetowndeviceinfo]) +- [close](internal_.MapeoProject.md#close) +- [importConfig](internal_.MapeoProject.md#importconfig) +- [ready](internal_.MapeoProject.md#ready) + +## Constructors + +### constructor + +• **new MapeoProject**(`opts`): [`MapeoProject`](internal_.MapeoProject.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreStorage` | [`CoreStorage`](../modules/internal_.md#corestorage) | Folder to store all hypercore data | +| `opts.dbPath` | `string` | Path to store project sqlite db. Use `:memory:` for memory storage | +| `opts.encryptionKeys` | `EncryptionKeys` | Encryption keys for each namespace | +| `opts.getMediaBaseUrl` | (`mediaType`: ``"blobs"`` \| ``"icons"``) => `Promise`\<`string`\> | | +| `opts.keyManager` | `KeyManager` | mapeo/crypto KeyManager instance | +| `opts.localPeers` | [`LocalPeers`](internal_.LocalPeers.md) | | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | | +| `opts.projectKey` | `Buffer` | 32-byte public key of the project creator core | +| `opts.projectMigrationsFolder` | `string` | path for drizzle migration folder for project | +| `opts.projectSecretKey` | `undefined` \| `Buffer` | 32-byte secret key of the project creator core | +| `opts.sharedDb` | `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\> | | +| `opts.sharedIndexWriter` | [`IndexWriter`](internal_.IndexWriter.md)\<[`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1)\> | | + +#### Returns + +[`MapeoProject`](internal_.MapeoProject.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/mapeo-project.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L108) + +## Properties + +### $blobs + +• **$blobs**: [`BlobApi`](internal_.BlobApi.md) + +#### Defined in + +[src/mapeo-project.js:311](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L311) + +___ + +### EMPTY\_PROJECT\_SETTINGS + +▪ `Static` **EMPTY\_PROJECT\_SETTINGS**: `Readonly`\<{}\> = `EMPTY_PROJECT_SETTINGS` + +#### Defined in + +[src/mapeo-project.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L90) + +## Accessors + +### $icons + +• `get` **$icons**(): [`IconApi`](internal_.IconApi.md) + +#### Returns + +[`IconApi`](internal_.IconApi.md) + +#### Defined in + +[src/mapeo-project.js:611](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L611) + +___ + +### $member + +• `get` **$member**(): [`MemberApi`](internal_.MemberApi.md) + +#### Returns + +[`MemberApi`](internal_.MemberApi.md) + +#### Defined in + +[src/mapeo-project.js:494](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L494) + +___ + +### $sync + +• `get` **$sync**(): [`SyncApi`](internal_.SyncApi.md) + +#### Returns + +[`SyncApi`](internal_.SyncApi.md) + +#### Defined in + +[src/mapeo-project.js:498](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L498) + +___ + +### $translation + +• `get` **$translation**(): [`default`](internal_.default.md) + +#### Returns + +[`default`](internal_.default.md) + +#### Defined in + +[src/mapeo-project.js:502](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L502) + +___ + +### [kBlobStore] + +• `get` **[kBlobStore]**(): [`BlobStore`](internal_.BlobStore.md) + +#### Returns + +[`BlobStore`](internal_.BlobStore.md) + +#### Defined in + +[src/mapeo-project.js:405](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L405) + +___ + +### [kCoreManager] + +• `get` **[kCoreManager]**(): [`CoreManager`](internal_.CoreManager.md) + +CoreManager instance, used for tests + +#### Returns + +[`CoreManager`](internal_.CoreManager.md) + +#### Defined in + +[src/mapeo-project.js:387](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L387) + +___ + +### [kCoreOwnership] + +• `get` **[kCoreOwnership]**(): [`CoreOwnership`](internal_.CoreOwnership.md) + +CoreOwnership instance, used for tests + +#### Returns + +[`CoreOwnership`](internal_.CoreOwnership.md) + +#### Defined in + +[src/mapeo-project.js:394](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L394) + +___ + +### [kDataTypes] + +• `get` **[kDataTypes]**(): `Object` + +DataTypes object mappings, used for tests + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `coreOwnership` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"coreOwnership"``, {}, {}\> | +| `deviceInfo` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\> | +| `field` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> | +| `icon` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"icon"``, {}, {}\> | +| `observation` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> | +| `preset` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> | +| `projectSettings` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\> | +| `role` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | +| `track` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> | +| `translation` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"translation"``, {}, {}\> | + +#### Defined in + +[src/mapeo-project.js:401](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L401) + +___ + +### deviceId + +• `get` **deviceId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/mapeo-project.js:409](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L409) + +___ + +### field + +• `get` **field**(): [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> + +#### Returns + +[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:490](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L490) + +___ + +### observation + +• `get` **observation**(): [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> + +#### Returns + +[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:481](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L481) + +___ + +### preset + +• `get` **preset**(): [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> + +#### Returns + +[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:487](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L487) + +___ + +### track + +• `get` **track**(): [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> + +#### Returns + +[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> + +#### Defined in + +[src/mapeo-project.js:484](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L484) + +## Methods + +### $getOwnRole + +▸ **$getOwnRole**(): `Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Returns + +`Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Defined in + +[src/mapeo-project.js:553](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L553) + +___ + +### $getProjectSettings + +▸ **$getProjectSettings**(): `Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> + +#### Returns + +`Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> + +#### Defined in + +[src/mapeo-project.js:542](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L542) + +___ + +### $setProjectSettings + +▸ **$setProjectSettings**(`settings`): `Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `settings` | `Partial`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> | + +#### Returns + +`Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> + +#### Defined in + +[src/mapeo-project.js:510](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L510) + +___ + +### [kProjectLeave] + +▸ **[kProjectLeave]**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:615](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L615) + +___ + +### [kProjectReplicate] + +▸ **[kProjectReplicate]**(`stream`): `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +Replicate a project to a @hyperswarm/secret-stream. Invites will not +function because the RPC channel is not connected for project replication, +and only this project will replicate (to replicate multiple projects you +need to replicate the manager instance via manager[kManagerReplicate]) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> | A duplex stream, a @hyperswarm/secret-stream, or a Protomux instance | + +#### Returns + +`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> + +#### Defined in + +[src/mapeo-project.js:566](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L566) + +___ + +### [kSetOwnDeviceInfo] + +▸ **[kSetOwnDeviceInfo]**(`value`): `Promise`\<{}\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `Pick`\<{}, ``"name"`` \| ``"deviceType"``\> | + +#### Returns + +`Promise`\<{}\> + +#### Defined in + +[src/mapeo-project.js:585](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L585) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:422](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L422) + +___ + +### importConfig + +▸ **importConfig**(`opts`): `Promise`\<`Error`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.configPath` | `string` | + +#### Returns + +`Promise`\<`Error`[]\> + +#### Defined in + +[src/mapeo-project.js:696](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L696) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +Resolves when hypercores have all loaded + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/mapeo-project.js:416](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L416) diff --git a/docs/api/md/classes/internal_.MemberApi.md b/docs/api/md/classes/internal_.MemberApi.md new file mode 100644 index 000000000..aba06a99d --- /dev/null +++ b/docs/api/md/classes/internal_.MemberApi.md @@ -0,0 +1,164 @@ +[API](../README.md) / [\](../modules/internal_.md) / MemberApi + +# Class: MemberApi + +[\](../modules/internal_.md).MemberApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`MemberApi`** + +## Table of contents + +### Constructors + +- [constructor](internal_.MemberApi.md#constructor) + +### Methods + +- [assignRole](internal_.MemberApi.md#assignrole) +- [getById](internal_.MemberApi.md#getbyid) +- [getMany](internal_.MemberApi.md#getmany) +- [invite](internal_.MemberApi.md#invite) +- [requestCancelInvite](internal_.MemberApi.md#requestcancelinvite) + +## Constructors + +### constructor + +• **new MemberApi**(`opts`): [`MemberApi`](internal_.MemberApi.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreOwnership` | [`CoreOwnership`](internal_.CoreOwnership.md) | | +| `opts.dataTypes` | `Object` | | +| `opts.dataTypes.deviceInfo` | `Pick`\<[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"deviceInfo"``, {}, {}\>, ``"getByDocId"`` \| ``"getMany"``\> | - | +| `opts.dataTypes.project` | `Pick`\<[`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"projectSettings"``, {}, {}\>, ``"getByDocId"``\> | - | +| `opts.deviceId` | `string` | public key of this device as hex string | +| `opts.encryptionKeys` | `EncryptionKeys` | | +| `opts.projectKey` | `Buffer` | | +| `opts.roles` | [`Roles`](internal_.Roles.md) | | +| `opts.rpc` | [`LocalPeers`](internal_.LocalPeers.md) | | + +#### Returns + +[`MemberApi`](internal_.MemberApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/member-api.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L59) + +## Methods + +### assignRole + +▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/member-api.js:308](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L308) + +___ + +### getById + +▸ **getById**(`deviceId`): `Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)\> + +#### Defined in + +[src/member-api.js:239](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L239) + +___ + +### getMany + +▸ **getMany**(): `Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)[]\> + +#### Returns + +`Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)[]\> + +#### Defined in + +[src/member-api.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L269) + +___ + +### invite + +▸ **invite**(`deviceId`, `opts`): `Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> + +Send an invite. Resolves when receiving a response. Rejects if the invite +is canceled, or if something else goes wrong. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `opts` | `Object` | +| `opts.roleDescription` | `undefined` \| `string` | +| `opts.roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` | +| `opts.roleName` | `undefined` \| `string` | + +#### Returns + +`Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> + +#### Defined in + +[src/member-api.js:93](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L93) + +___ + +### requestCancelInvite + +▸ **requestCancelInvite**(`deviceId`): `void` + +Attempt to cancel an outbound invite, if it exists. + +No-op if we weren't inviting this device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/member-api.js:231](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L231) diff --git a/docs/api/md/classes/internal_.Peer.md b/docs/api/md/classes/internal_.Peer.md new file mode 100644 index 000000000..c993803b4 --- /dev/null +++ b/docs/api/md/classes/internal_.Peer.md @@ -0,0 +1,266 @@ +[API](../README.md) / [\](../modules/internal_.md) / Peer + +# Class: Peer + +[\](../modules/internal_.md).Peer + +## Table of contents + +### Constructors + +- [constructor](internal_.Peer.md#constructor) + +### Accessors + +- [connected](internal_.Peer.md#connected) +- [info](internal_.Peer.md#info) +- [protomux](internal_.Peer.md#protomux) + +### Methods + +- [[kTestOnlySendRawInvite]](internal_.Peer.md#[ktestonlysendrawinvite]) +- [connect](internal_.Peer.md#connect) +- [disconnect](internal_.Peer.md#disconnect) +- [receiveDeviceInfo](internal_.Peer.md#receivedeviceinfo) +- [sendDeviceInfo](internal_.Peer.md#senddeviceinfo) +- [sendInvite](internal_.Peer.md#sendinvite) +- [sendInviteCancel](internal_.Peer.md#sendinvitecancel) +- [sendInviteResponse](internal_.Peer.md#sendinviteresponse) +- [sendProjectJoinDetails](internal_.Peer.md#sendprojectjoindetails) + +## Constructors + +### constructor + +• **new Peer**(`options`): [`Peer`](internal_.Peer.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.channel` | [`Channel`](../interfaces/internal_.Channel.md) | +| `options.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | +| `options.peerId` | `string` | +| `options.protomux` | [`Protomux`](internal_.Protomux.md)\<`any`\> | + +#### Returns + +[`Peer`](internal_.Peer.md) + +#### Defined in + +[src/local-peers.js:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L76) + +## Accessors + +### connected + +• `get` **connected**(): `Promise`\<`any`\> + +A promise that resolves when the peer connects, or rejects if it +fails to connect + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[src/local-peers.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L129) + +___ + +### info + +• `get` **info**(): [`PeerInfoInternal`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) + +#### Returns + +[`PeerInfoInternal`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) + +#### Defined in + +[src/local-peers.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L94) + +___ + +### protomux + +• `get` **protomux**(): [`Protomux`](internal_.Protomux.md)\<`any`\> + +#### Returns + +[`Protomux`](internal_.Protomux.md)\<`any`\> + +#### Defined in + +[src/local-peers.js:132](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L132) + +## Methods + +### [kTestOnlySendRawInvite] + +▸ **[kTestOnlySendRawInvite]**(`buf`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buf` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:164](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L164) + +___ + +### connect + +▸ **connect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L136) + +___ + +### disconnect + +▸ **disconnect**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:147](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L147) + +___ + +### receiveDeviceInfo + +▸ **receiveDeviceInfo**(`deviceInfo`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceInfo` | `DeviceInfo` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L209) + +___ + +### sendDeviceInfo + +▸ **sendDeviceInfo**(`deviceInfo`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceInfo` | `DeviceInfo` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:202](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L202) + +___ + +### sendInvite + +▸ **sendInvite**(`invite`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `invite` | `Invite` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:170](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L170) + +___ + +### sendInviteCancel + +▸ **sendInviteCancel**(`inviteCancel`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteCancel` | `InviteCancel` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:178](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L178) + +___ + +### sendInviteResponse + +▸ **sendInviteResponse**(`response`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `response` | `InviteResponse` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:186](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L186) + +___ + +### sendProjectJoinDetails + +▸ **sendProjectJoinDetails**(`details`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `ProjectJoinDetails` | + +#### Returns + +`void` + +#### Defined in + +[src/local-peers.js:194](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L194) diff --git a/docs/api/md/classes/internal_.PeerSyncController.md b/docs/api/md/classes/internal_.PeerSyncController.md new file mode 100644 index 000000000..e391a4736 --- /dev/null +++ b/docs/api/md/classes/internal_.PeerSyncController.md @@ -0,0 +1,145 @@ +[API](../README.md) / [\](../modules/internal_.md) / PeerSyncController + +# Class: PeerSyncController + +[\](../modules/internal_.md).PeerSyncController + +## Table of contents + +### Constructors + +- [constructor](internal_.PeerSyncController.md#constructor) + +### Accessors + +- [peerId](internal_.PeerSyncController.md#peerid) +- [peerKey](internal_.PeerSyncController.md#peerkey) +- [syncCapability](internal_.PeerSyncController.md#synccapability) + +### Methods + +- [disableDataSync](internal_.PeerSyncController.md#disabledatasync) +- [enableDataSync](internal_.PeerSyncController.md#enabledatasync) +- [handleDiscoveryKey](internal_.PeerSyncController.md#handlediscoverykey) + +## Constructors + +### constructor + +• **new PeerSyncController**(`opts`): [`PeerSyncController`](internal_.PeerSyncController.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | +| `opts.protomux` | [`Protomux`](internal_.Protomux.md)\<[`OpenedNoiseStream`](../modules/internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | +| `opts.roles` | [`Roles`](internal_.Roles.md) | +| `opts.syncState` | [`SyncState`](internal_.SyncState.md) | + +#### Returns + +[`PeerSyncController`](internal_.PeerSyncController.md) + +#### Defined in + +[src/sync/peer-sync-controller.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L47) + +## Accessors + +### peerId + +• `get` **peerId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/sync/peer-sync-controller.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L78) + +___ + +### peerKey + +• `get` **peerKey**(): `Buffer` + +#### Returns + +`Buffer` + +#### Defined in + +[src/sync/peer-sync-controller.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L74) + +___ + +### syncCapability + +• `get` **syncCapability**(): `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/internal_.md#synccapability)\> + +#### Returns + +`Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/internal_.md#synccapability)\> + +#### Defined in + +[src/sync/peer-sync-controller.js:82](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L82) + +## Methods + +### disableDataSync + +▸ **disableDataSync**(): `void` + +Disable syncing of data (in the data and blob namespaces). + +Syncing of metadata (auth, config and blobIndex namespaces) will continue +in the background without user interaction. + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:100](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L100) + +___ + +### enableDataSync + +▸ **enableDataSync**(): `void` + +Enable syncing of data (in the data and blob namespaces) + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:89](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L89) + +___ + +### handleDiscoveryKey + +▸ **handleDiscoveryKey**(`discoveryKey`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/peer-sync-controller.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L108) diff --git a/docs/api/md/classes/internal_.PendingInvites.md b/docs/api/md/classes/internal_.PendingInvites.md new file mode 100644 index 000000000..a27cb4f14 --- /dev/null +++ b/docs/api/md/classes/internal_.PendingInvites.md @@ -0,0 +1,198 @@ +[API](../README.md) / [\](../modules/internal_.md) / PendingInvites + +# Class: PendingInvites + +[\](../modules/internal_.md).PendingInvites + +Manage pending invite state. + +## Table of contents + +### Constructors + +- [constructor](internal_.PendingInvites.md#constructor) + +### Methods + +- [add](internal_.PendingInvites.md#add) +- [deleteByInviteId](internal_.PendingInvites.md#deletebyinviteid) +- [deleteByProjectPublicId](internal_.PendingInvites.md#deletebyprojectpublicid) +- [getByInviteId](internal_.PendingInvites.md#getbyinviteid) +- [hasInviteId](internal_.PendingInvites.md#hasinviteid) +- [invites](internal_.PendingInvites.md#invites) +- [isAcceptingForProject](internal_.PendingInvites.md#isacceptingforproject) +- [markAccepting](internal_.PendingInvites.md#markaccepting) + +## Constructors + +### constructor + +• **new PendingInvites**(): [`PendingInvites`](internal_.PendingInvites.md) + +#### Returns + +[`PendingInvites`](internal_.PendingInvites.md) + +## Methods + +### add + +▸ **add**(`pendingInvite`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pendingInvite` | [`PendingInvite`](../interfaces/internal_.PendingInvite.md) | + +#### Returns + +`void` + +**`Throws`** + +if adding a duplicate invite ID + +#### Defined in + +[src/invite-api.js:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L76) + +___ + +### deleteByInviteId + +▸ **deleteByInviteId**(`inviteId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `Buffer` | + +#### Returns + +`boolean` + +`true` if an invite existed and was deleted, `false` otherwise + +#### Defined in + +[src/invite-api.js:128](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L128) + +___ + +### deleteByProjectPublicId + +▸ **deleteByProjectPublicId**(`projectPublicId`): [`PendingInvite`](../interfaces/internal_.PendingInvite.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectPublicId` | `string` | + +#### Returns + +[`PendingInvite`](../interfaces/internal_.PendingInvite.md)[] + +the pending invites that were deleted + +#### Defined in + +[src/invite-api.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L136) + +___ + +### getByInviteId + +▸ **getByInviteId**(`inviteId`): `undefined` \| [`PendingInvite`](../interfaces/internal_.PendingInvite.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `Buffer` | + +#### Returns + +`undefined` \| [`PendingInvite`](../interfaces/internal_.PendingInvite.md) + +#### Defined in + +[src/invite-api.js:120](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L120) + +___ + +### hasInviteId + +▸ **hasInviteId**(`inviteId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `Buffer` | + +#### Returns + +`boolean` + +#### Defined in + +[src/invite-api.js:101](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L101) + +___ + +### invites + +▸ **invites**(): `Iterable`\<[`PendingInvite`](../interfaces/internal_.PendingInvite.md)\> + +#### Returns + +`Iterable`\<[`PendingInvite`](../interfaces/internal_.PendingInvite.md)\> + +the pending invites, in insertion order + +#### Defined in + +[src/invite-api.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L67) + +___ + +### isAcceptingForProject + +▸ **isAcceptingForProject**(`projectPublicId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectPublicId` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/invite-api.js:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L109) + +___ + +### markAccepting + +▸ **markAccepting**(`inviteId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inviteId` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/invite-api.js:88](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L88) diff --git a/docs/api/md/classes/internal_.Protomux.md b/docs/api/md/classes/internal_.Protomux.md new file mode 100644 index 000000000..81a4bea24 --- /dev/null +++ b/docs/api/md/classes/internal_.Protomux.md @@ -0,0 +1,265 @@ +[API](../README.md) / [\](../modules/internal_.md) / Protomux + +# Class: Protomux\ + +[\](../modules/internal_.md).Protomux + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TStream` | extends `Duplex` \| `NodeDuplex` = `Duplex` | + +## Table of contents + +### Constructors + +- [constructor](internal_.Protomux.md#constructor) + +### Properties + +- [isProtomux](internal_.Protomux.md#isprotomux) +- [stream](internal_.Protomux.md#stream) + +### Methods + +- [cork](internal_.Protomux.md#cork) +- [createChannel](internal_.Protomux.md#createchannel) +- [destroy](internal_.Protomux.md#destroy) +- [opened](internal_.Protomux.md#opened) +- [pair](internal_.Protomux.md#pair) +- [uncork](internal_.Protomux.md#uncork) +- [unpair](internal_.Protomux.md#unpair) +- [from](internal_.Protomux.md#from) +- [isProtomux](internal_.Protomux.md#isprotomux-1) + +## Constructors + +### constructor + +• **new Protomux**\<`TStream`\>(`stream`): [`Protomux`](internal_.Protomux.md)\<`TStream`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TStream` | extends `Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> = `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | `TStream` | + +#### Returns + +[`Protomux`](internal_.Protomux.md)\<`TStream`\> + +#### Defined in + +[types/protomux.d.ts:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L48) + +## Properties + +### isProtomux + +• **isProtomux**: ``true`` + +#### Defined in + +[types/protomux.d.ts:49](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L49) + +___ + +### stream + +• **stream**: `TStream` + +#### Defined in + +[types/protomux.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L50) + +## Methods + +### cork + +▸ **cork**(): `void` + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L53) + +___ + +### createChannel + +▸ **createChannel**(`opts`): [`Channel`](../interfaces/internal_.Channel.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.aliases?` | `string`[] | +| `opts.handshake?` | [`Encoding`](../interfaces/internal_.Encoding.md) | +| `opts.id?` | `Buffer` | +| `opts.messages` | `Partial`\<`Pick`\<[`Message`](../interfaces/internal_.Message.md), ``"onmessage"`` \| ``"encoding"``\>\>[] | +| `opts.protocol` | `string` | +| `opts.unique?` | `boolean` | +| `opts.userData?` | `any` | +| `opts.onclose?` | () => `void` \| `Promise`\<`void`\> | +| `opts.ondestroy?` | () => `void` \| `Promise`\<`void`\> | +| `opts.onopen?` | (`handshake?`: `any`) => `void` \| `Promise`\<`void`\> | + +#### Returns + +[`Channel`](../interfaces/internal_.Channel.md) + +#### Defined in + +[types/protomux.d.ts:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L61) + +___ + +### destroy + +▸ **destroy**(`err`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L73) + +___ + +### opened + +▸ **opened**(`opts`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.id?` | `Buffer` | +| `opts.protocol` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[types/protomux.d.ts:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L60) + +___ + +### pair + +▸ **pair**(`opts`, `notify`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.id?` | `Buffer` | +| `opts.protocol` | `string` | +| `notify` | (`id`: `Buffer`) => `Promise`\<`void`\> | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L55) + +___ + +### uncork + +▸ **uncork**(): `void` + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L54) + +___ + +### unpair + +▸ **unpair**(`opts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.id?` | `Buffer` | +| `opts.protocol` | `string` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L59) + +___ + +### from + +▸ **from**(`stream`): [`Protomux`](internal_.Protomux.md)\<`TStream`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | `TStream` | + +#### Returns + +[`Protomux`](internal_.Protomux.md)\<`TStream`\> + +#### Defined in + +[types/protomux.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L51) + +___ + +### isProtomux + +▸ **isProtomux**(`mux`): mux is Protomux\\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `mux` | `unknown` | + +#### Returns + +mux is Protomux\\>\> + +#### Defined in + +[types/protomux.d.ts:52](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L52) diff --git a/docs/api/md/classes/internal_.RemoteBitfieldPage.md b/docs/api/md/classes/internal_.RemoteBitfieldPage.md new file mode 100644 index 000000000..43223db34 --- /dev/null +++ b/docs/api/md/classes/internal_.RemoteBitfieldPage.md @@ -0,0 +1,233 @@ +[API](../README.md) / [\](../modules/internal_.md) / RemoteBitfieldPage + +# Class: RemoteBitfieldPage + +[\](../modules/internal_.md).RemoteBitfieldPage + +## Table of contents + +### Constructors + +- [constructor](internal_.RemoteBitfieldPage.md#constructor) + +### Properties + +- [bitfield](internal_.RemoteBitfieldPage.md#bitfield) +- [index](internal_.RemoteBitfieldPage.md#index) +- [offset](internal_.RemoteBitfieldPage.md#offset) +- [segment](internal_.RemoteBitfieldPage.md#segment) + +### Accessors + +- [tree](internal_.RemoteBitfieldPage.md#tree) + +### Methods + +- [findFirst](internal_.RemoteBitfieldPage.md#findfirst) +- [findLast](internal_.RemoteBitfieldPage.md#findlast) +- [get](internal_.RemoteBitfieldPage.md#get) +- [insert](internal_.RemoteBitfieldPage.md#insert) +- [set](internal_.RemoteBitfieldPage.md#set) +- [setRange](internal_.RemoteBitfieldPage.md#setrange) + +## Constructors + +### constructor + +• **new RemoteBitfieldPage**(`index`, `bitfield`, `segment`): [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `bitfield` | `Uint32Array` | +| `segment` | [`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) | + +#### Returns + +[`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L22) + +## Properties + +### bitfield + +• **bitfield**: `Uint32Array` + +#### Defined in + +[src/core-manager/remote-bitfield.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L28) + +___ + +### index + +• **index**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L24) + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L26) + +___ + +### segment + +• **segment**: [`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L30) + +## Accessors + +### tree + +• `get` **tree**(): [`SparseIndex`](internal_.SparseIndex.md) + +#### Returns + +[`SparseIndex`](internal_.SparseIndex.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L35) + +## Methods + +### findFirst + +▸ **findFirst**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L78) + +___ + +### findLast + +▸ **findLast**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L85) + +___ + +### get + +▸ **get**(`index`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/remote-bitfield.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L44) + +___ + +### insert + +▸ **insert**(`start`, `bitfield`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `bitfield` | `Uint32Array` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L94) + +___ + +### set + +▸ **set**(`index`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L53) + +___ + +### setRange + +▸ **setRange**(`start`, `length`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `length` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L65) diff --git a/docs/api/md/classes/internal_.RemoteBitfieldSegment.md b/docs/api/md/classes/internal_.RemoteBitfieldSegment.md new file mode 100644 index 000000000..04864f9bc --- /dev/null +++ b/docs/api/md/classes/internal_.RemoteBitfieldSegment.md @@ -0,0 +1,194 @@ +[API](../README.md) / [\](../modules/internal_.md) / RemoteBitfieldSegment + +# Class: RemoteBitfieldSegment + +[\](../modules/internal_.md).RemoteBitfieldSegment + +## Table of contents + +### Constructors + +- [constructor](internal_.RemoteBitfieldSegment.md#constructor) + +### Properties + +- [index](internal_.RemoteBitfieldSegment.md#index) +- [offset](internal_.RemoteBitfieldSegment.md#offset) +- [pages](internal_.RemoteBitfieldSegment.md#pages) +- [pagesLength](internal_.RemoteBitfieldSegment.md#pageslength) +- [tree](internal_.RemoteBitfieldSegment.md#tree) + +### Accessors + +- [chunks](internal_.RemoteBitfieldSegment.md#chunks) + +### Methods + +- [add](internal_.RemoteBitfieldSegment.md#add) +- [findFirst](internal_.RemoteBitfieldSegment.md#findfirst) +- [findLast](internal_.RemoteBitfieldSegment.md#findlast) +- [refresh](internal_.RemoteBitfieldSegment.md#refresh) + +## Constructors + +### constructor + +• **new RemoteBitfieldSegment**(`index`): [`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +[`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L105) + +## Properties + +### index + +• **index**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:106](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L106) + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L107) + +___ + +### pages + +• **pages**: `any`[] + +#### Defined in + +[src/core-manager/remote-bitfield.js:111](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L111) + +___ + +### pagesLength + +• **pagesLength**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:112](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L112) + +[src/core-manager/remote-bitfield.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L130) + +___ + +### tree + +• **tree**: [`SparseIndex`](internal_.SparseIndex.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L108) + +[src/core-manager/remote-bitfield.js:120](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L120) + +## Accessors + +### chunks + +• `get` **chunks**(): [`Chunk`](../modules/internal_.md#chunk)[] + +#### Returns + +[`Chunk`](../modules/internal_.md#chunk)[] + +#### Defined in + +[src/core-manager/remote-bitfield.js:115](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L115) + +## Methods + +### add + +▸ **add**(`page`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `page` | [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:128](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L128) + +___ + +### findFirst + +▸ **findFirst**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:151](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L151) + +___ + +### findLast + +▸ **findLast**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:180](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L180) + +___ + +### refresh + +▸ **refresh**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:119](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L119) diff --git a/docs/api/md/classes/internal_.Roles.md b/docs/api/md/classes/internal_.Roles.md new file mode 100644 index 000000000..df2ab09ec --- /dev/null +++ b/docs/api/md/classes/internal_.Roles.md @@ -0,0 +1,125 @@ +[API](../README.md) / [\](../modules/internal_.md) / Roles + +# Class: Roles + +[\](../modules/internal_.md).Roles + +## Table of contents + +### Constructors + +- [constructor](internal_.Roles.md#constructor) + +### Properties + +- [NO\_ROLE](internal_.Roles.md#no_role) + +### Methods + +- [assignRole](internal_.Roles.md#assignrole) +- [getAll](internal_.Roles.md#getall) +- [getRole](internal_.Roles.md#getrole) + +## Constructors + +### constructor + +• **new Roles**(`opts`): [`Roles`](internal_.Roles.md) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | | +| `opts.coreOwnership` | [`CoreOwnership`](internal_.CoreOwnership.md) | | +| `opts.dataType` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"auth"``, ``"role"`` \| ``"coreOwnership"``\>, `SQLiteTableWithColumns`\<{}\>, ``"role"``, {}, {}\> | | +| `opts.deviceKey` | `Buffer` | public key of this device | +| `opts.projectKey` | `Buffer` | | + +#### Returns + +[`Roles`](internal_.Roles.md) + +#### Defined in + +[src/roles.js:240](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L240) + +## Properties + +### NO\_ROLE + +▪ `Static` **NO\_ROLE**: [`Role`](../interfaces/internal_.Role.md)\<``"08e4251e36f6e7ed"``\> = `NO_ROLE` + +#### Defined in + +[src/roles.js:223](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L223) + +## Methods + +### assignRole + +▸ **assignRole**(`deviceId`, `roleId`): `Promise`\<`void`\> + +Assign a role to the specified `deviceId`. Devices without an assigned role +are unable to sync, except the project creator who can do anything. Only +the project creator can assign their own role. Will throw if the device's +role cannot assign the role by consulting `roleAssignment`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | +| `roleId` | ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/roles.js:332](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L332) + +___ + +### getAll + +▸ **getAll**(): `Promise`\<`Map`\<`string`, [`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> + +Get roles of all devices in the project. For your own device, if you have +not yet synced your own role record, the "no role" capabilties is +returned. The project creator will have the creator role unless a +different one has been assigned. + +#### Returns + +`Promise`\<`Map`\<`string`, [`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\>\> + +Map of deviceId to Role + +#### Defined in + +[src/roles.js:285](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L285) + +___ + +### getRole + +▸ **getRole**(`deviceId`): `Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +Get the role for device `deviceId`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `deviceId` | `string` | + +#### Returns + +`Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> + +#### Defined in + +[src/roles.js:254](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L254) diff --git a/docs/api/md/classes/internal_.SparseIndex.md b/docs/api/md/classes/internal_.SparseIndex.md new file mode 100644 index 000000000..bc860f2f5 --- /dev/null +++ b/docs/api/md/classes/internal_.SparseIndex.md @@ -0,0 +1,198 @@ +[API](../README.md) / [\](../modules/internal_.md) / SparseIndex + +# Class: SparseIndex + +[\](../modules/internal_.md).SparseIndex + +## Hierarchy + +- [`Index`](internal_.Index.md) + + ↳ **`SparseIndex`** + +## Table of contents + +### Constructors + +- [constructor](internal_.SparseIndex.md#constructor) + +### Properties + +- [byteLength](internal_.SparseIndex.md#bytelength) +- [chunks](internal_.SparseIndex.md#chunks) + +### Methods + +- [skipFirst](internal_.SparseIndex.md#skipfirst) +- [skipLast](internal_.SparseIndex.md#skiplast) +- [update](internal_.SparseIndex.md#update) +- [from](internal_.SparseIndex.md#from) + +## Constructors + +### constructor + +• **new SparseIndex**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | [`Chunk`](../modules/internal_.md#chunk)[] | +| `byteLength` | `number` | + +#### Returns + +[`SparseIndex`](internal_.SparseIndex.md) + +#### Overrides + +[Index](internal_.Index.md).[constructor](internal_.Index.md#constructor) + +#### Defined in + +[types/quickbit-universal.d.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L40) + +## Properties + +### byteLength + +• `Readonly` **byteLength**: `number` + +#### Inherited from + +[Index](internal_.Index.md).[byteLength](internal_.Index.md#bytelength) + +#### Defined in + +[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) + +___ + +### chunks + +• `Readonly` **chunks**: [`Chunk`](../modules/internal_.md#chunk)[] + +#### Defined in + +[types/quickbit-universal.d.ts:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L41) + +## Methods + +### skipFirst + +▸ **skipFirst**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[Index](internal_.Index.md).[skipFirst](internal_.Index.md#skipfirst) + +#### Defined in + +[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) + +___ + +### skipLast + +▸ **skipLast**(`value`, `position?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | +| `position?` | `number` | + +#### Returns + +`number` + +#### Inherited from + +[Index](internal_.Index.md).[skipLast](internal_.Index.md#skiplast) + +#### Defined in + +[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) + +___ + +### update + +▸ **update**(`bit`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`boolean` + +#### Overrides + +[Index](internal_.Index.md).[update](internal_.Index.md#update) + +#### Defined in + +[types/quickbit-universal.d.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L42) + +___ + +### from + +▸ **from**(`field`, `byteLength`): [`DenseIndex`](internal_.DenseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `field` | `TypedArray` | +| `byteLength` | `number` | + +#### Returns + +[`DenseIndex`](internal_.DenseIndex.md) + +#### Inherited from + +[Index](internal_.Index.md).[from](internal_.Index.md#from) + +#### Defined in + +[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) + +▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | [`Chunk`](../modules/internal_.md#chunk)[] | +| `byteLength` | `number` | + +#### Returns + +[`SparseIndex`](internal_.SparseIndex.md) + +#### Inherited from + +[Index](internal_.Index.md).[from](internal_.Index.md#from) + +#### Defined in + +[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.SyncApi.md b/docs/api/md/classes/internal_.SyncApi.md new file mode 100644 index 000000000..7108a0cb3 --- /dev/null +++ b/docs/api/md/classes/internal_.SyncApi.md @@ -0,0 +1,156 @@ +[API](../README.md) / [\](../modules/internal_.md) / SyncApi + +# Class: SyncApi + +[\](../modules/internal_.md).SyncApi + +## Hierarchy + +- `TypedEmitter` + + ↳ **`SyncApi`** + +## Table of contents + +### Constructors + +- [constructor](internal_.SyncApi.md#constructor) + +### Properties + +- [[kSyncState]](internal_.SyncApi.md#[ksyncstate]) + +### Methods + +- [[kHandleDiscoveryKey]](internal_.SyncApi.md#[khandlediscoverykey]) +- [getState](internal_.SyncApi.md#getstate) +- [start](internal_.SyncApi.md#start) +- [stop](internal_.SyncApi.md#stop) +- [waitForSync](internal_.SyncApi.md#waitforsync) + +## Constructors + +### constructor + +• **new SyncApi**(`opts`): [`SyncApi`](internal_.SyncApi.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `opts` | `Object` | `undefined` | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | `undefined` | +| `opts.logger` | `undefined` \| [`Logger`](internal_.Logger.md) | `undefined` | +| `opts.roles` | [`Roles`](internal_.Roles.md) | `undefined` | +| `opts.throttleMs` | `undefined` \| `number` | `200` | + +#### Returns + +[`SyncApi`](internal_.SyncApi.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/sync/sync-api.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L66) + +## Properties + +### [kSyncState] + +• **[kSyncState]**: [`SyncState`](internal_.SyncState.md) + +#### Defined in + +[src/sync/sync-api.js:71](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L71) + +## Methods + +### [kHandleDiscoveryKey] + +▸ **[kHandleDiscoveryKey]**(`discoveryKey`, `protomux`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | +| `protomux` | [`Protomux`](internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:87](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L87) + +___ + +### getState + +▸ **getState**(): [`State`](../interfaces/internal_.State.md) + +Get the current sync state (initial and full). Also emitted via the 'sync-state' event + +#### Returns + +[`State`](../interfaces/internal_.State.md) + +#### Defined in + +[src/sync/sync-api.js:118](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L118) + +___ + +### start + +▸ **start**(): `void` + +Start syncing data cores + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:135](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L135) + +___ + +### stop + +▸ **stop**(): `void` + +Stop syncing data cores (metadata cores will continue syncing in the background) + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-api.js:148](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L148) + +___ + +### waitForSync + +▸ **waitForSync**(`type`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`SyncType`](../modules/internal_.md#synctype) | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/sync/sync-api.js:162](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L162) diff --git a/docs/api/md/classes/internal_.SyncState.md b/docs/api/md/classes/internal_.SyncState.md new file mode 100644 index 000000000..ea8a8ae67 --- /dev/null +++ b/docs/api/md/classes/internal_.SyncState.md @@ -0,0 +1,85 @@ +[API](../README.md) / [\](../modules/internal_.md) / SyncState + +# Class: SyncState + +[\](../modules/internal_.md).SyncState + +Emit sync state when it changes + +## Hierarchy + +- `TypedEmitter` + + ↳ **`SyncState`** + +## Table of contents + +### Constructors + +- [constructor](internal_.SyncState.md#constructor) + +### Methods + +- [addPeer](internal_.SyncState.md#addpeer) +- [getState](internal_.SyncState.md#getstate) + +## Constructors + +### constructor + +• **new SyncState**(`opts`): [`SyncState`](internal_.SyncState.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `opts` | `Object` | `undefined` | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | `undefined` | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](internal_.PeerSyncController.md)\> | `undefined` | +| `opts.throttleMs` | `undefined` \| `number` | `200` | + +#### Returns + +[`SyncState`](internal_.SyncState.md) + +#### Overrides + +TypedEmitter.constructor + +#### Defined in + +[src/sync/sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L33) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L53) + +___ + +### getState + +▸ **getState**(): [`State`](../modules/internal_.md#state) + +#### Returns + +[`State`](../modules/internal_.md#state) + +#### Defined in + +[src/sync/sync-state.js:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L62) diff --git a/docs/api/md/classes/internal_.TrackedKeyRequests.md b/docs/api/md/classes/internal_.TrackedKeyRequests.md new file mode 100644 index 000000000..b219b1fff --- /dev/null +++ b/docs/api/md/classes/internal_.TrackedKeyRequests.md @@ -0,0 +1,124 @@ +[API](../README.md) / [\](../modules/internal_.md) / TrackedKeyRequests + +# Class: TrackedKeyRequests + +[\](../modules/internal_.md).TrackedKeyRequests + +## Table of contents + +### Constructors + +- [constructor](internal_.TrackedKeyRequests.md#constructor) + +### Methods + +- [clear](internal_.TrackedKeyRequests.md#clear) +- [deleteByDiscoveryKey](internal_.TrackedKeyRequests.md#deletebydiscoverykey) +- [deleteByPeerKey](internal_.TrackedKeyRequests.md#deletebypeerkey) +- [has](internal_.TrackedKeyRequests.md#has) +- [set](internal_.TrackedKeyRequests.md#set) + +## Constructors + +### constructor + +• **new TrackedKeyRequests**(): [`TrackedKeyRequests`](internal_.TrackedKeyRequests.md) + +#### Returns + +[`TrackedKeyRequests`](internal_.TrackedKeyRequests.md) + +## Methods + +### clear + +▸ **clear**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:614](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L614) + +___ + +### deleteByDiscoveryKey + +▸ **deleteByDiscoveryKey**(`discoveryKey`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/index.js:591](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L591) + +___ + +### deleteByPeerKey + +▸ **deleteByPeerKey**(`peerKey`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerKey` | `Buffer` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:605](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L605) + +___ + +### has + +▸ **has**(`discoveryKey`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/index.js:584](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L584) + +___ + +### set + +▸ **set**(`discoveryKey`, `peerKey`): [`TrackedKeyRequests`](internal_.TrackedKeyRequests.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | +| `peerKey` | `Buffer` | + +#### Returns + +[`TrackedKeyRequests`](internal_.TrackedKeyRequests.md) + +#### Defined in + +[src/core-manager/index.js:572](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L572) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md new file mode 100644 index 000000000..d81f2de74 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / PeerDisconnectedError + +# Class: PeerDisconnectedError + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).PeerDisconnectedError + +## Hierarchy + +- `Error` + + ↳ **`PeerDisconnectedError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#constructor) + +### Properties + +- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#name) + +## Constructors + +### constructor + +• **new PeerDisconnectedError**(`message?`): [`PeerDisconnectedError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerDisconnectedError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:624](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L624) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:626](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L626) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md new file mode 100644 index 000000000..fdcc75297 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / PeerFailedConnectionError + +# Class: PeerFailedConnectionError + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).PeerFailedConnectionError + +## Hierarchy + +- `Error` + + ↳ **`PeerFailedConnectionError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#constructor) + +### Properties + +- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#name) + +## Constructors + +### constructor + +• **new PeerFailedConnectionError**(`message?`): [`PeerFailedConnectionError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerFailedConnectionError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:632](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L632) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:634](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L634) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md new file mode 100644 index 000000000..37e6ccfda --- /dev/null +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / UnknownPeerError + +# Class: UnknownPeerError + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).UnknownPeerError + +## Hierarchy + +- `Error` + + ↳ **`UnknownPeerError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md#constructor) + +### Properties + +- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md#name) + +## Constructors + +### constructor + +• **new UnknownPeerError**(`message?`): [`UnknownPeerError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`UnknownPeerError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/local-peers.js:616](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L616) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/local-peers.js:618](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L618) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md new file mode 100644 index 000000000..8b90753ed --- /dev/null +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md @@ -0,0 +1,104 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md) / NamespaceSyncState + +# Class: NamespaceSyncState\ + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md).NamespaceSyncState + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | [`"/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) | + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#constructor) + +### Accessors + +- [namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#namespace) + +### Methods + +- [addPeer](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#addpeer) +- [getState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#getstate) + +## Constructors + +### constructor + +• **new NamespaceSyncState**\<`TNamespace`\>(`opts`): [`NamespaceSyncState`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | extends ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` = ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | | +| `opts.namespace` | `TNamespace` | | +| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](internal_.PeerSyncController.md)\> | | + +#### Returns + +[`NamespaceSyncState`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> + +#### Defined in + +[src/sync/namespace-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L28) + +## Accessors + +### namespace + +• `get` **namespace**(): `TNamespace` + +#### Returns + +`TNamespace` + +#### Defined in + +[src/sync/namespace-sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L53) + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/sync/namespace-sync-state.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L90) + +___ + +### getState + +▸ **getState**(): [`SyncState`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +#### Returns + +[`SyncState`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +#### Defined in + +[src/sync/namespace-sync-state.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L58) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md new file mode 100644 index 000000000..3800233f9 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md @@ -0,0 +1,59 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/utils"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) / ExhaustivenessError + +# Class: ExhaustivenessError + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/utils"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md).ExhaustivenessError + +## Hierarchy + +- `Error` + + ↳ **`ExhaustivenessError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md#constructor) + +### Properties + +- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md#name) + +## Constructors + +### constructor + +• **new ExhaustivenessError**(`value`): [`ExhaustivenessError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `never` | + +#### Returns + +[`ExhaustivenessError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) + +#### Overrides + +Error.constructor + +#### Defined in + +[src/utils.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L65) + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +[src/utils.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L67) diff --git a/docs/api/md/classes/internal_.default-1.md b/docs/api/md/classes/internal_.default-1.md new file mode 100644 index 000000000..4c29eaca0 --- /dev/null +++ b/docs/api/md/classes/internal_.default-1.md @@ -0,0 +1,197 @@ +[API](../README.md) / [\](../modules/internal_.md) / default + +# Class: default\ + +[\](../modules/internal_.md).default + +`Map` uses same-value-zero equality for keys, which makes it more difficult +to use reference types like buffers. + +`HashMap` is very similar to `Map`, but accepts a hash function for keys. +This function should return a primitive, such as a number or string, which +will be used as the key. + +It doesn't contain all the functionality of `Map` because we don't need it, +but it should be fairly easy to update as needed. + +**`Example`** + +```ts +const join = (arr) => arr.join(' ') + +const map = new HashMap(join) + +map.set([1, 2], 3) +map.get([1, 2]) +// => 3 +``` + +## Type parameters + +| Name | +| :------ | +| `K` | +| `V` | + +## Table of contents + +### Constructors + +- [constructor](internal_.default-1.md#constructor) + +### Accessors + +- [size](internal_.default-1.md#size) + +### Methods + +- [delete](internal_.default-1.md#delete) +- [get](internal_.default-1.md#get) +- [has](internal_.default-1.md#has) +- [set](internal_.default-1.md#set) +- [values](internal_.default-1.md#values) + +## Constructors + +### constructor + +• **new default**\<`K`, `V`\>(`hash`, `iterable?`): [`default`](internal_.default-1.md)\<`K`, `V`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | `K` | +| `V` | extends `unknown` | + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `hash` | (`key`: `K`) => [`Primitive`](../modules/internal_.md#primitive) | `undefined` | +| `iterable?` | `Iterable`\<[`K`, `V`]\> | `[]` | + +#### Returns + +[`default`](internal_.default-1.md)\<`K`, `V`\> + +#### Defined in + +[src/lib/hashmap.js:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L37) + +## Accessors + +### size + +• `get` **size**(): `number` + +#### Returns + +`number` + +#### Defined in + +[src/lib/hashmap.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L45) + +## Methods + +### delete + +▸ **delete**(`key`): `boolean` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to remove. | + +#### Returns + +`boolean` + +`true` if the key was present and removed, `false` otherwise. + +#### Defined in + +[src/lib/hashmap.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L53) + +___ + +### get + +▸ **get**(`key`): `undefined` \| `V` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to look up. | + +#### Returns + +`undefined` \| `V` + +The element associated with `key`, or `undefined` if it's not present. + +#### Defined in + +[src/lib/hashmap.js:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L62) + +___ + +### has + +▸ **has**(`key`): `boolean` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to look up. | + +#### Returns + +`boolean` + +`true` if `key` is present in the map, `false` otherwise. + +#### Defined in + +[src/lib/hashmap.js:71](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L71) + +___ + +### set + +▸ **set**(`key`, `value`): [`default`](internal_.default-1.md)\<`K`, `V`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `K` | The key to update. | +| `value` | `V` | The value to add at `key`. | + +#### Returns + +[`default`](internal_.default-1.md)\<`K`, `V`\> + +The map. + +#### Defined in + +[src/lib/hashmap.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L81) + +___ + +### values + +▸ **values**(): `IterableIterator`\<`V`\> + +#### Returns + +`IterableIterator`\<`V`\> + +#### Defined in + +[src/lib/hashmap.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L90) diff --git a/docs/api/md/classes/internal_.default-2.md b/docs/api/md/classes/internal_.default-2.md new file mode 100644 index 000000000..adf57a190 --- /dev/null +++ b/docs/api/md/classes/internal_.default-2.md @@ -0,0 +1,307 @@ +[API](../README.md) / [\](../modules/internal_.md) / default + +# Class: default + +[\](../modules/internal_.md).default + +## Table of contents + +### Constructors + +- [constructor](internal_.default-2.md#constructor) + +### Properties + +- [\_maxSegments](internal_.default-2.md#_maxsegments) +- [\_pages](internal_.default-2.md#_pages) +- [\_segments](internal_.default-2.md#_segments) + +### Methods + +- [findFirst](internal_.default-2.md#findfirst) +- [findLast](internal_.default-2.md#findlast) +- [firstSet](internal_.default-2.md#firstset) +- [firstUnset](internal_.default-2.md#firstunset) +- [get](internal_.default-2.md#get) +- [getBitfield](internal_.default-2.md#getbitfield) +- [insert](internal_.default-2.md#insert) +- [lastSet](internal_.default-2.md#lastset) +- [lastUnset](internal_.default-2.md#lastunset) +- [set](internal_.default-2.md#set) +- [setRange](internal_.default-2.md#setrange) + +## Constructors + +### constructor + +• **new default**(): [`default`](internal_.default-2.md) + +#### Returns + +[`default`](internal_.default-2.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:207](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L207) + +## Properties + +### \_maxSegments + +• **\_maxSegments**: `number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:212](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L212) + +[src/core-manager/remote-bitfield.js:253](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L253) + +[src/core-manager/remote-bitfield.js:281](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L281) + +[src/core-manager/remote-bitfield.js:394](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L394) + +___ + +### \_pages + +• **\_pages**: [`BigSparseArray`](internal_.BigSparseArray.md)\<[`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md)\> + +#### Defined in + +[src/core-manager/remote-bitfield.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L209) + +___ + +### \_segments + +• **\_segments**: [`BigSparseArray`](internal_.BigSparseArray.md)\<[`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md)\> + +#### Defined in + +[src/core-manager/remote-bitfield.js:211](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L211) + +## Methods + +### findFirst + +▸ **findFirst**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:304](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L304) + +___ + +### findLast + +▸ **findLast**(`val`, `position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:340](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L340) + +___ + +### firstSet + +▸ **firstSet**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:327](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L327) + +___ + +### firstUnset + +▸ **firstUnset**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:333](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L333) + +___ + +### get + +▸ **get**(`index`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/remote-bitfield.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L218) + +___ + +### getBitfield + +▸ **getBitfield**(`index`): ``null`` \| [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +``null`` \| [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) + +#### Defined in + +[src/core-manager/remote-bitfield.js:230](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L230) + +___ + +### insert + +▸ **insert**(`start`, `bitfield`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `bitfield` | `Uint32Array` | + +#### Returns + +`boolean` + +#### Defined in + +[src/core-manager/remote-bitfield.js:378](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L378) + +___ + +### lastSet + +▸ **lastSet**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:364](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L364) + +___ + +### lastUnset + +▸ **lastUnset**(`position`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `position` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/core-manager/remote-bitfield.js:370](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L370) + +___ + +### set + +▸ **set**(`index`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:242](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L242) + +___ + +### setRange + +▸ **setRange**(`start`, `length`, `val`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start` | `number` | +| `length` | `number` | +| `val` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[src/core-manager/remote-bitfield.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L269) diff --git a/docs/api/md/classes/internal_.default.md b/docs/api/md/classes/internal_.default.md new file mode 100644 index 000000000..82dc6cd2a --- /dev/null +++ b/docs/api/md/classes/internal_.default.md @@ -0,0 +1,132 @@ +[API](../README.md) / [\](../modules/internal_.md) / default + +# Class: default + +[\](../modules/internal_.md).default + +## Table of contents + +### Constructors + +- [constructor](internal_.default.md#constructor) + +### Accessors + +- [[ktranslatedLanguageCodeToSchemaNames]](internal_.default.md#[ktranslatedlanguagecodetoschemanames]) + +### Methods + +- [get](internal_.default.md#get) +- [index](internal_.default.md#index) +- [put](internal_.default.md#put) +- [ready](internal_.default.md#ready) + +## Constructors + +### constructor + +• **new default**(`opts`): [`default`](internal_.default.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts` | `Object` | +| `opts.dataType` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"translation"``, {}, {}\> | +| `opts.table` | `SQLiteTableWithColumns`\<{}\> | + +#### Returns + +[`default`](internal_.default.md) + +#### Defined in + +[src/translation-api.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L29) + +## Accessors + +### [ktranslatedLanguageCodeToSchemaNames] + +• `get` **[ktranslatedLanguageCodeToSchemaNames]**(): `Map`\<`string`, `Set`\<`SchemaName`\>\> + +#### Returns + +`Map`\<`string`, `Set`\<`SchemaName`\>\> + +#### Defined in + +[src/translation-api.js:126](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L126) + +## Methods + +### get + +▸ **get**(`value`): `Promise`\<{}[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `Object` | + +#### Returns + +`Promise`\<{}[]\> + +#### Defined in + +[src/translation-api.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L72) + +___ + +### index + +▸ **index**(`doc`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | `Object` | + +#### Returns + +`void` + +#### Defined in + +[src/translation-api.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L107) + +___ + +### put + +▸ **put**(`value`): `Promise`\<{} & \{ `forks`: `string`[] }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `Object` | + +#### Returns + +`Promise`\<{} & \{ `forks`: `string`[] }\> + +#### Defined in + +[src/translation-api.js:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L50) + +___ + +### ready + +▸ **ready**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/translation-api.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L43) diff --git a/docs/api/md/interfaces/internal_.BitmapOpts.md b/docs/api/md/interfaces/internal_.BitmapOpts.md new file mode 100644 index 000000000..5a24a0126 --- /dev/null +++ b/docs/api/md/interfaces/internal_.BitmapOpts.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / BitmapOpts + +# Interface: BitmapOpts\<\> + +[\](../modules/internal_.md).BitmapOpts + +## Table of contents + +### Properties + +- [mimeType](internal_.BitmapOpts.md#mimetype) +- [pixelDensity](internal_.BitmapOpts.md#pixeldensity) +- [size](internal_.BitmapOpts.md#size) + +## Properties + +### mimeType + +• **mimeType**: ``"image/png"`` + +#### Defined in + +[src/icon-api.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L8) + +___ + +### pixelDensity + +• **pixelDensity**: ``1`` \| ``2`` \| ``3`` + +#### Defined in + +[src/icon-api.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L9) + +___ + +### size + +• **size**: `Size` + +#### Defined in + +[src/icon-api.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L10) diff --git a/docs/api/md/interfaces/internal_.BlobDownloadState.md b/docs/api/md/interfaces/internal_.BlobDownloadState.md new file mode 100644 index 000000000..47a39ba50 --- /dev/null +++ b/docs/api/md/interfaces/internal_.BlobDownloadState.md @@ -0,0 +1,86 @@ +[API](../README.md) / [\](../modules/internal_.md) / BlobDownloadState + +# Interface: BlobDownloadState\<\> + +[\](../modules/internal_.md).BlobDownloadState + +## Table of contents + +### Properties + +- [error](internal_.BlobDownloadState.md#error) +- [haveBytes](internal_.BlobDownloadState.md#havebytes) +- [haveCount](internal_.BlobDownloadState.md#havecount) +- [status](internal_.BlobDownloadState.md#status) +- [wantBytes](internal_.BlobDownloadState.md#wantbytes) +- [wantCount](internal_.BlobDownloadState.md#wantcount) + +## Properties + +### error + +• **error**: ``null`` + +If status = 'error' then this will be an Error object + +#### Defined in + +[src/blob-store/live-download.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L14) + +___ + +### haveBytes + +• **haveBytes**: `number` + +The bytes already downloaded + +#### Defined in + +[src/blob-store/live-download.js:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L11) + +___ + +### haveCount + +• **haveCount**: `number` + +The number of files already downloaded + +#### Defined in + +[src/blob-store/live-download.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L10) + +___ + +### status + +• **status**: ``"checking"`` \| ``"downloading"`` \| ``"downloaded"`` \| ``"aborted"`` + +#### Defined in + +[src/blob-store/live-download.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L15) + +___ + +### wantBytes + +• **wantBytes**: `number` + +The bytes pending download + +#### Defined in + +[src/blob-store/live-download.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L13) + +___ + +### wantCount + +• **wantCount**: `number` + +The number of files pending download + +#### Defined in + +[src/blob-store/live-download.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L12) diff --git a/docs/api/md/interfaces/internal_.Channel.md b/docs/api/md/interfaces/internal_.Channel.md new file mode 100644 index 000000000..b5be06cc8 --- /dev/null +++ b/docs/api/md/interfaces/internal_.Channel.md @@ -0,0 +1,177 @@ +[API](../README.md) / [\](../modules/internal_.md) / Channel + +# Interface: Channel + +[\](../modules/internal_.md).Channel + +## Table of contents + +### Properties + +- [closed](internal_.Channel.md#closed) +- [destroyed](internal_.Channel.md#destroyed) +- [id](internal_.Channel.md#id) +- [messages](internal_.Channel.md#messages) +- [opened](internal_.Channel.md#opened) +- [protocol](internal_.Channel.md#protocol) +- [userData](internal_.Channel.md#userdata) + +### Methods + +- [addMessage](internal_.Channel.md#addmessage) +- [close](internal_.Channel.md#close) +- [cork](internal_.Channel.md#cork) +- [open](internal_.Channel.md#open) +- [uncork](internal_.Channel.md#uncork) + +## Properties + +### closed + +• **closed**: `boolean` + +#### Defined in + +[types/protomux.d.ts:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L39) + +___ + +### destroyed + +• **destroyed**: `boolean` + +#### Defined in + +[types/protomux.d.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L40) + +___ + +### id + +• **id**: `Buffer` + +#### Defined in + +[types/protomux.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L36) + +___ + +### messages + +• **messages**: [`Message`](internal_.Message.md)[] + +#### Defined in + +[types/protomux.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L37) + +___ + +### opened + +• **opened**: `boolean` + +#### Defined in + +[types/protomux.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L38) + +___ + +### protocol + +• **protocol**: `string` + +#### Defined in + +[types/protomux.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L35) + +___ + +### userData + +• **userData**: `any` + +#### Defined in + +[types/protomux.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L34) + +## Methods + +### addMessage + +▸ **addMessage**(`opts?`): [`Message`](internal_.Message.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | `Partial`\<`Pick`\<[`Message`](internal_.Message.md), ``"onmessage"`` \| ``"encoding"``\>\> | + +#### Returns + +[`Message`](internal_.Message.md) + +#### Defined in + +[types/protomux.d.ts:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L44) + +___ + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L43) + +___ + +### cork + +▸ **cork**(): `void` + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L41) + +___ + +### open + +▸ **open**(`handshake?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `handshake?` | `any` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L33) + +___ + +### uncork + +▸ **uncork**(): `void` + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L42) diff --git a/docs/api/md/interfaces/internal_.CoreState.md b/docs/api/md/interfaces/internal_.CoreState.md new file mode 100644 index 000000000..9696fda80 --- /dev/null +++ b/docs/api/md/interfaces/internal_.CoreState.md @@ -0,0 +1,62 @@ +[API](../README.md) / [\](../modules/internal_.md) / CoreState + +# Interface: CoreState\<\> + +[\](../modules/internal_.md).CoreState + +## Table of contents + +### Properties + +- [have](internal_.CoreState.md#have) +- [missing](internal_.CoreState.md#missing) +- [want](internal_.CoreState.md#want) +- [wanted](internal_.CoreState.md#wanted) + +## Properties + +### have + +• **have**: `number` + +blocks the peer has locally + +#### Defined in + +[src/sync/core-sync-state.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L22) + +___ + +### missing + +• **missing**: `number` + +blocks the peer wants but no peer has + +#### Defined in + +[src/sync/core-sync-state.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L25) + +___ + +### want + +• **want**: `number` + +blocks the peer wants, and at least one peer has + +#### Defined in + +[src/sync/core-sync-state.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L23) + +___ + +### wanted + +• **wanted**: `number` + +blocks the peer has that at least one peer wants + +#### Defined in + +[src/sync/core-sync-state.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L24) diff --git a/docs/api/md/interfaces/internal_.CorestoreEvents.md b/docs/api/md/interfaces/internal_.CorestoreEvents.md new file mode 100644 index 000000000..bfeb14149 --- /dev/null +++ b/docs/api/md/interfaces/internal_.CorestoreEvents.md @@ -0,0 +1,52 @@ +[API](../README.md) / [\](../modules/internal_.md) / CorestoreEvents + +# Interface: CorestoreEvents + +[\](../modules/internal_.md).CorestoreEvents + +## Table of contents + +### Methods + +- [core-close](internal_.CorestoreEvents.md#core-close) +- [core-open](internal_.CorestoreEvents.md#core-open) + +## Methods + +### core-close + +▸ **core-close**(`core`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `core` | [`Corestore`](../classes/internal_.Corestore.md) | + +#### Returns + +`void` + +#### Defined in + +[types/corestore.d.ts:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L11) + +___ + +### core-open + +▸ **core-open**(`core`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `core` | [`Corestore`](../classes/internal_.Corestore.md) | + +#### Returns + +`void` + +#### Defined in + +[types/corestore.d.ts:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L10) diff --git a/docs/api/md/interfaces/internal_.DataTypeEvents.md b/docs/api/md/interfaces/internal_.DataTypeEvents.md new file mode 100644 index 000000000..ac9296a1b --- /dev/null +++ b/docs/api/md/interfaces/internal_.DataTypeEvents.md @@ -0,0 +1,41 @@ +[API](../README.md) / [\](../modules/internal_.md) / DataTypeEvents + +# Interface: DataTypeEvents\ + +[\](../modules/internal_.md).DataTypeEvents + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TDoc` | extends `MapeoDoc` | + +## Table of contents + +### Properties + +- [updated-docs](internal_.DataTypeEvents.md#updated-docs) + +## Properties + +### updated-docs + +• **updated-docs**: (`docs`: `TDoc`[]) => `void` + +#### Type declaration + +▸ (`docs`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `docs` | `TDoc`[] | + +##### Returns + +`void` + +#### Defined in + +[src/datatype/index.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L31) diff --git a/docs/api/md/interfaces/internal_.DocCapability.md b/docs/api/md/interfaces/internal_.DocCapability.md new file mode 100644 index 000000000..38859bbf0 --- /dev/null +++ b/docs/api/md/interfaces/internal_.DocCapability.md @@ -0,0 +1,62 @@ +[API](../README.md) / [\](../modules/internal_.md) / DocCapability + +# Interface: DocCapability\<\> + +[\](../modules/internal_.md).DocCapability + +## Table of contents + +### Properties + +- [readOthers](internal_.DocCapability.md#readothers) +- [readOwn](internal_.DocCapability.md#readown) +- [writeOthers](internal_.DocCapability.md#writeothers) +- [writeOwn](internal_.DocCapability.md#writeown) + +## Properties + +### readOthers + +• **readOthers**: `boolean` + +can read other's data + +#### Defined in + +[src/roles.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L59) + +___ + +### readOwn + +• **readOwn**: `boolean` + +can read own data + +#### Defined in + +[src/roles.js:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L57) + +___ + +### writeOthers + +• **writeOthers**: `boolean` + +can edit or delete other's data + +#### Defined in + +[src/roles.js:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L60) + +___ + +### writeOwn + +• **writeOwn**: `boolean` + +can write own data + +#### Defined in + +[src/roles.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L58) diff --git a/docs/api/md/interfaces/internal_.Encoding.md b/docs/api/md/interfaces/internal_.Encoding.md new file mode 100644 index 000000000..b002c069b --- /dev/null +++ b/docs/api/md/interfaces/internal_.Encoding.md @@ -0,0 +1,75 @@ +[API](../README.md) / [\](../modules/internal_.md) / Encoding + +# Interface: Encoding + +[\](../modules/internal_.md).Encoding + +## Table of contents + +### Methods + +- [decode](internal_.Encoding.md#decode) +- [encode](internal_.Encoding.md#encode) +- [preencode](internal_.Encoding.md#preencode) + +## Methods + +### decode + +▸ **decode**(`state`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`EncodingState`](internal_.EncodingState.md) | + +#### Returns + +`any` + +#### Defined in + +[types/protomux.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L20) + +___ + +### encode + +▸ **encode**(`state`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`EncodingState`](internal_.EncodingState.md) | +| `value` | `any` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L19) + +___ + +### preencode + +▸ **preencode**(`state`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`PreEncodingState`](internal_.PreEncodingState.md) | +| `value` | `any` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L18) diff --git a/docs/api/md/interfaces/internal_.EncodingState.md b/docs/api/md/interfaces/internal_.EncodingState.md new file mode 100644 index 000000000..75f65021a --- /dev/null +++ b/docs/api/md/interfaces/internal_.EncodingState.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / EncodingState + +# Interface: EncodingState + +[\](../modules/internal_.md).EncodingState + +## Table of contents + +### Properties + +- [buffer](internal_.EncodingState.md#buffer) +- [end](internal_.EncodingState.md#end) +- [start](internal_.EncodingState.md#start) + +## Properties + +### buffer + +• **buffer**: ``null`` \| `Buffer` + +#### Defined in + +[types/protomux.d.ts:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L12) + +___ + +### end + +• **end**: `number` + +#### Defined in + +[types/protomux.d.ts:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L14) + +___ + +### start + +• **start**: `number` + +#### Defined in + +[types/protomux.d.ts:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L13) diff --git a/docs/api/md/interfaces/internal_.HaveMsg.md b/docs/api/md/interfaces/internal_.HaveMsg.md new file mode 100644 index 000000000..0be592252 --- /dev/null +++ b/docs/api/md/interfaces/internal_.HaveMsg.md @@ -0,0 +1,54 @@ +[API](../README.md) / [\](../modules/internal_.md) / HaveMsg + +# Interface: HaveMsg\<\> + +[\](../modules/internal_.md).HaveMsg + +## Table of contents + +### Properties + +- [bitfield](internal_.HaveMsg.md#bitfield) +- [discoveryKey](internal_.HaveMsg.md#discoverykey) +- [namespace](internal_.HaveMsg.md#namespace) +- [start](internal_.HaveMsg.md#start) + +## Properties + +### bitfield + +• **bitfield**: `Uint32Array` + +#### Defined in + +[src/core-manager/index.js:522](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L522) + +___ + +### discoveryKey + +• **discoveryKey**: `Buffer` + +#### Defined in + +[src/core-manager/index.js:520](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L520) + +___ + +### namespace + +• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` + +#### Defined in + +[src/core-manager/index.js:523](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L523) + +___ + +### start + +• **start**: `number` + +#### Defined in + +[src/core-manager/index.js:521](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L521) diff --git a/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md b/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md new file mode 100644 index 000000000..98f26635f --- /dev/null +++ b/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md @@ -0,0 +1,54 @@ +[API](../README.md) / [\](../modules/internal_.md) / [Hyperblobs](../modules/internal_.Hyperblobs.md) / BlobId + +# Interface: BlobId + +[\](../modules/internal_.md).[Hyperblobs](../modules/internal_.Hyperblobs.md).BlobId + +## Table of contents + +### Properties + +- [blockLength](internal_.Hyperblobs.BlobId.md#blocklength) +- [blockOffset](internal_.Hyperblobs.BlobId.md#blockoffset) +- [byteLength](internal_.Hyperblobs.BlobId.md#bytelength) +- [byteOffset](internal_.Hyperblobs.BlobId.md#byteoffset) + +## Properties + +### blockLength + +• **blockLength**: `number` + +#### Defined in + +[types/hyperblobs.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L23) + +___ + +### blockOffset + +• **blockOffset**: `number` + +#### Defined in + +[types/hyperblobs.d.ts:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L22) + +___ + +### byteLength + +• **byteLength**: `number` + +#### Defined in + +[types/hyperblobs.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L25) + +___ + +### byteOffset + +• **byteOffset**: `number` + +#### Defined in + +[types/hyperblobs.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L24) diff --git a/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md b/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md new file mode 100644 index 000000000..ef6077e47 --- /dev/null +++ b/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md @@ -0,0 +1,52 @@ +[API](../README.md) / [\](../modules/internal_.md) / [Hyperdrive](../modules/internal_.Hyperdrive.md) / HyperdriveEntry + +# Interface: HyperdriveEntry + +[\](../modules/internal_.md).[Hyperdrive](../modules/internal_.Hyperdrive.md).HyperdriveEntry + +## Table of contents + +### Properties + +- [key](internal_.Hyperdrive.HyperdriveEntry.md#key) +- [seq](internal_.Hyperdrive.HyperdriveEntry.md#seq) +- [value](internal_.Hyperdrive.HyperdriveEntry.md#value) + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +[types/hyperdrive.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L37) + +___ + +### seq + +• **seq**: `number` + +#### Defined in + +[types/hyperdrive.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L36) + +___ + +### value + +• **value**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `blob` | [`BlobId`](internal_.Hyperblobs.BlobId.md) | +| `executable` | `boolean` | +| `linkname` | ``null`` \| `string` | +| `metadata` | ``null`` \| `object` | + +#### Defined in + +[types/hyperdrive.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L38) diff --git a/docs/api/md/interfaces/internal_.HyperdriveEvents.md b/docs/api/md/interfaces/internal_.HyperdriveEvents.md new file mode 100644 index 000000000..f467f0479 --- /dev/null +++ b/docs/api/md/interfaces/internal_.HyperdriveEvents.md @@ -0,0 +1,98 @@ +[API](../README.md) / [\](../modules/internal_.md) / HyperdriveEvents + +# Interface: HyperdriveEvents + +[\](../modules/internal_.md).HyperdriveEvents + +## Table of contents + +### Properties + +- [blobs](internal_.HyperdriveEvents.md#blobs) +- [close](internal_.HyperdriveEvents.md#close) +- [content-key](internal_.HyperdriveEvents.md#content-key) +- [ready](internal_.HyperdriveEvents.md#ready) + +## Properties + +### blobs + +• **blobs**: (`blobs`: [`Hyperblobs`](../classes/internal_.Hyperblobs-1.md)) => `void` + +#### Type declaration + +▸ (`blobs`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `blobs` | [`Hyperblobs`](../classes/internal_.Hyperblobs-1.md) | + +##### Returns + +`void` + +#### Defined in + +[types/hyperdrive.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L25) + +___ + +### close + +• **close**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[types/hyperdrive.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L23) + +___ + +### content-key + +• **content-key**: (`contentKey`: `Buffer`) => `void` + +#### Type declaration + +▸ (`contentKey`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `contentKey` | `Buffer` | + +##### Returns + +`void` + +#### Defined in + +[types/hyperdrive.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L26) + +___ + +### ready + +• **ready**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[types/hyperdrive.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L24) diff --git a/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md b/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md new file mode 100644 index 000000000..a6708f80c --- /dev/null +++ b/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [\](../modules/internal_.md) / HyperdriveGetOpts + +# Interface: HyperdriveGetOpts + +[\](../modules/internal_.md).HyperdriveGetOpts + +## Table of contents + +### Properties + +- [timeout](internal_.HyperdriveGetOpts.md#timeout) +- [wait](internal_.HyperdriveGetOpts.md#wait) + +## Properties + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[types/hyperdrive.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L31) + +___ + +### wait + +• `Optional` **wait**: `boolean` + +#### Defined in + +[types/hyperdrive.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L30) diff --git a/docs/api/md/interfaces/internal_.HyperdriveOptions.md b/docs/api/md/interfaces/internal_.HyperdriveOptions.md new file mode 100644 index 000000000..73ae7f979 --- /dev/null +++ b/docs/api/md/interfaces/internal_.HyperdriveOptions.md @@ -0,0 +1,29 @@ +[API](../README.md) / [\](../modules/internal_.md) / HyperdriveOptions + +# Interface: HyperdriveOptions + +[\](../modules/internal_.md).HyperdriveOptions + +## Table of contents + +### Properties + +- [onwait](internal_.HyperdriveOptions.md#onwait) + +## Properties + +### onwait + +• **onwait**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[types/hyperdrive.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L9) diff --git a/docs/api/md/interfaces/internal_.MapsPluginOpts.md b/docs/api/md/interfaces/internal_.MapsPluginOpts.md new file mode 100644 index 000000000..0e6b6e3c5 --- /dev/null +++ b/docs/api/md/interfaces/internal_.MapsPluginOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [\](../modules/internal_.md) / MapsPluginOpts + +# Interface: MapsPluginOpts\<\> + +[\](../modules/internal_.md).MapsPluginOpts + +## Table of contents + +### Properties + +- [defaultOnlineStyleUrl](internal_.MapsPluginOpts.md#defaultonlinestyleurl) +- [prefix](internal_.MapsPluginOpts.md#prefix) + +## Properties + +### defaultOnlineStyleUrl + +• **defaultOnlineStyleUrl**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/index.js:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L40) + +___ + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/index.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L39) diff --git a/docs/api/md/interfaces/internal_.MemberInfo.md b/docs/api/md/interfaces/internal_.MemberInfo.md new file mode 100644 index 000000000..8e18a128f --- /dev/null +++ b/docs/api/md/interfaces/internal_.MemberInfo.md @@ -0,0 +1,54 @@ +[API](../README.md) / [\](../modules/internal_.md) / MemberInfo + +# Interface: MemberInfo\<\> + +[\](../modules/internal_.md).MemberInfo + +## Table of contents + +### Properties + +- [deviceId](internal_.MemberInfo.md#deviceid) +- [deviceType](internal_.MemberInfo.md#devicetype) +- [name](internal_.MemberInfo.md#name) +- [role](internal_.MemberInfo.md#role) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/member-api.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L29) + +___ + +### deviceType + +• **deviceType**: `undefined` \| ``"UNRECOGNIZED"`` \| ``"mobile"`` \| ``"tablet"`` \| ``"desktop"`` + +#### Defined in + +[src/member-api.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L32) + +___ + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/member-api.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L31) + +___ + +### role + +• **role**: [`Role`](internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> + +#### Defined in + +[src/member-api.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L30) diff --git a/docs/api/md/interfaces/internal_.Message.md b/docs/api/md/interfaces/internal_.Message.md new file mode 100644 index 000000000..8398b41c6 --- /dev/null +++ b/docs/api/md/interfaces/internal_.Message.md @@ -0,0 +1,81 @@ +[API](../README.md) / [\](../modules/internal_.md) / Message + +# Interface: Message + +[\](../modules/internal_.md).Message + +## Table of contents + +### Properties + +- [encoding](internal_.Message.md#encoding) +- [onmessage](internal_.Message.md#onmessage) +- [type](internal_.Message.md#type) + +### Methods + +- [send](internal_.Message.md#send) + +## Properties + +### encoding + +• **encoding**: [`Encoding`](internal_.Encoding.md) + +#### Defined in + +[types/protomux.d.ts:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L27) + +___ + +### onmessage + +• **onmessage**: (`message`: `any`) => `void` + +#### Type declaration + +▸ (`message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L26) + +___ + +### type + +• **type**: `number` + +#### Defined in + +[types/protomux.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L24) + +## Methods + +### send + +▸ **send**(`msg`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `any` | + +#### Returns + +`void` + +#### Defined in + +[types/protomux.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L25) diff --git a/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md b/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md new file mode 100644 index 000000000..8eb1e8c9d --- /dev/null +++ b/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / OfflineFallbackMapPluginOpts + +# Interface: OfflineFallbackMapPluginOpts\<\> + +[\](../modules/internal_.md).OfflineFallbackMapPluginOpts + +## Table of contents + +### Properties + +- [prefix](internal_.OfflineFallbackMapPluginOpts.md#prefix) +- [sourcesDir](internal_.OfflineFallbackMapPluginOpts.md#sourcesdir) +- [styleJsonPath](internal_.OfflineFallbackMapPluginOpts.md#stylejsonpath) + +## Properties + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L21) + +___ + +### sourcesDir + +• **sourcesDir**: `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L23) + +___ + +### styleJsonPath + +• **styleJsonPath**: `string` + +#### Defined in + +[src/fastify-plugins/maps/offline-fallback-map.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L22) diff --git a/docs/api/md/interfaces/internal_.PeerInfoBase.md b/docs/api/md/interfaces/internal_.PeerInfoBase.md new file mode 100644 index 000000000..b7fdd3335 --- /dev/null +++ b/docs/api/md/interfaces/internal_.PeerInfoBase.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / PeerInfoBase + +# Interface: PeerInfoBase\<\> + +[\](../modules/internal_.md).PeerInfoBase + +## Table of contents + +### Properties + +- [deviceId](internal_.PeerInfoBase.md#deviceid) +- [deviceType](internal_.PeerInfoBase.md#devicetype) +- [name](internal_.PeerInfoBase.md#name) + +## Properties + +### deviceId + +• **deviceId**: `string` + +#### Defined in + +[src/local-peers.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L42) + +___ + +### deviceType + +• **deviceType**: `undefined` \| `DeviceInfo_DeviceType` + +#### Defined in + +[src/local-peers.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L44) + +___ + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/local-peers.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L43) diff --git a/docs/api/md/interfaces/internal_.PendingInvite.md b/docs/api/md/interfaces/internal_.PendingInvite.md new file mode 100644 index 000000000..d6842658a --- /dev/null +++ b/docs/api/md/interfaces/internal_.PendingInvite.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / PendingInvite + +# Interface: PendingInvite\<\> + +[\](../modules/internal_.md).PendingInvite + +## Table of contents + +### Properties + +- [invite](internal_.PendingInvite.md#invite) +- [isAccepting](internal_.PendingInvite.md#isaccepting) +- [peerId](internal_.PendingInvite.md#peerid) + +## Properties + +### invite + +• **invite**: [`InviteInternal`](../modules/internal_.md#inviteinternal) + +#### Defined in + +[src/invite-api.js:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L57) + +___ + +### isAccepting + +• **isAccepting**: `boolean` + +#### Defined in + +[src/invite-api.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L58) + +___ + +### peerId + +• **peerId**: `string` + +#### Defined in + +[src/invite-api.js:56](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L56) diff --git a/docs/api/md/interfaces/internal_.PreEncodingState.md b/docs/api/md/interfaces/internal_.PreEncodingState.md new file mode 100644 index 000000000..dfaf67909 --- /dev/null +++ b/docs/api/md/interfaces/internal_.PreEncodingState.md @@ -0,0 +1,43 @@ +[API](../README.md) / [\](../modules/internal_.md) / PreEncodingState + +# Interface: PreEncodingState + +[\](../modules/internal_.md).PreEncodingState + +## Table of contents + +### Properties + +- [buffer](internal_.PreEncodingState.md#buffer) +- [end](internal_.PreEncodingState.md#end) +- [start](internal_.PreEncodingState.md#start) + +## Properties + +### buffer + +• **buffer**: ``null`` + +#### Defined in + +[types/protomux.d.ts:6](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L6) + +___ + +### end + +• **end**: `number` + +#### Defined in + +[types/protomux.d.ts:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L8) + +___ + +### start + +• **start**: `number` + +#### Defined in + +[types/protomux.d.ts:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L7) diff --git a/docs/api/md/interfaces/internal_.Role.md b/docs/api/md/interfaces/internal_.Role.md new file mode 100644 index 000000000..668b170eb --- /dev/null +++ b/docs/api/md/interfaces/internal_.Role.md @@ -0,0 +1,71 @@ +[API](../README.md) / [\](../modules/internal_.md) / Role + +# Interface: Role\ + +[\](../modules/internal_.md).Role + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`RoleId`](../modules/internal_.md#roleid) = [`RoleId`](../modules/internal_.md#roleid) | + +## Table of contents + +### Properties + +- [docs](internal_.Role.md#docs) +- [name](internal_.Role.md#name) +- [roleAssignment](internal_.Role.md#roleassignment) +- [roleId](internal_.Role.md#roleid) +- [sync](internal_.Role.md#sync) + +## Properties + +### docs + +• **docs**: `Record`\<``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``, [`DocCapability`](internal_.DocCapability.md)\> + +#### Defined in + +[src/roles.js:68](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L68) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[src/roles.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L67) + +___ + +### roleAssignment + +• **roleAssignment**: (``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``)[] + +#### Defined in + +[src/roles.js:69](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L69) + +___ + +### roleId + +• **roleId**: `T` + +#### Defined in + +[src/roles.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L66) + +___ + +### sync + +• **sync**: `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, ``"allowed"`` \| ``"blocked"``\> + +#### Defined in + +[src/roles.js:70](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L70) diff --git a/docs/api/md/interfaces/internal_.StartOpts.md b/docs/api/md/interfaces/internal_.StartOpts.md new file mode 100644 index 000000000..da1ae1237 --- /dev/null +++ b/docs/api/md/interfaces/internal_.StartOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [\](../modules/internal_.md) / StartOpts + +# Interface: StartOpts\<\> + +[\](../modules/internal_.md).StartOpts + +## Table of contents + +### Properties + +- [host](internal_.StartOpts.md#host) +- [port](internal_.StartOpts.md#port) + +## Properties + +### host + +• **host**: `undefined` \| `string` + +#### Defined in + +[src/fastify-controller.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L7) + +___ + +### port + +• **port**: `undefined` \| `number` + +#### Defined in + +[src/fastify-controller.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L8) diff --git a/docs/api/md/interfaces/internal_.State.md b/docs/api/md/interfaces/internal_.State.md new file mode 100644 index 000000000..4b6d6db59 --- /dev/null +++ b/docs/api/md/interfaces/internal_.State.md @@ -0,0 +1,49 @@ +[API](../README.md) / [\](../modules/internal_.md) / State + +# Interface: State\<\> + +[\](../modules/internal_.md).State + +## Table of contents + +### Properties + +- [connectedPeers](internal_.State.md#connectedpeers) +- [data](internal_.State.md#data) +- [initial](internal_.State.md#initial) + +## Properties + +### connectedPeers + +• **connectedPeers**: `number` + +Number of connected peers + +#### Defined in + +[src/sync/sync-api.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L33) + +___ + +### data + +• **data**: [`SyncTypeState`](internal_.SyncTypeState.md) + +State of data sync (observations, map data, photos, audio, video etc.) + +#### Defined in + +[src/sync/sync-api.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L32) + +___ + +### initial + +• **initial**: [`SyncTypeState`](internal_.SyncTypeState.md) + +State of initial sync (sync of auth, metadata and project config) + +#### Defined in + +[src/sync/sync-api.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L31) diff --git a/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md b/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md new file mode 100644 index 000000000..3ef9185ab --- /dev/null +++ b/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [\](../modules/internal_.md) / StaticMapsPluginOpts + +# Interface: StaticMapsPluginOpts\<\> + +[\](../modules/internal_.md).StaticMapsPluginOpts + +## Table of contents + +### Properties + +- [prefix](internal_.StaticMapsPluginOpts.md#prefix) +- [staticRootDir](internal_.StaticMapsPluginOpts.md#staticrootdir) + +## Properties + +### prefix + +• **prefix**: `undefined` \| `string` + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L25) + +___ + +### staticRootDir + +• **staticRootDir**: `string` + +#### Defined in + +[src/fastify-plugins/maps/static-maps.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L26) diff --git a/docs/api/md/interfaces/internal_.SvgOpts.md b/docs/api/md/interfaces/internal_.SvgOpts.md new file mode 100644 index 000000000..c03220829 --- /dev/null +++ b/docs/api/md/interfaces/internal_.SvgOpts.md @@ -0,0 +1,32 @@ +[API](../README.md) / [\](../modules/internal_.md) / SvgOpts + +# Interface: SvgOpts\<\> + +[\](../modules/internal_.md).SvgOpts + +## Table of contents + +### Properties + +- [mimeType](internal_.SvgOpts.md#mimetype) +- [size](internal_.SvgOpts.md#size) + +## Properties + +### mimeType + +• **mimeType**: ``"image/svg+xml"`` + +#### Defined in + +[src/icon-api.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L13) + +___ + +### size + +• **size**: `Size` + +#### Defined in + +[src/icon-api.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L14) diff --git a/docs/api/md/interfaces/internal_.SyncTypeState.md b/docs/api/md/interfaces/internal_.SyncTypeState.md new file mode 100644 index 000000000..ede4c6e00 --- /dev/null +++ b/docs/api/md/interfaces/internal_.SyncTypeState.md @@ -0,0 +1,88 @@ +[API](../README.md) / [\](../modules/internal_.md) / SyncTypeState + +# Interface: SyncTypeState\<\> + +[\](../modules/internal_.md).SyncTypeState + +## Table of contents + +### Properties + +- [dataToSync](internal_.SyncTypeState.md#datatosync) +- [have](internal_.SyncTypeState.md#have) +- [missing](internal_.SyncTypeState.md#missing) +- [syncing](internal_.SyncTypeState.md#syncing) +- [want](internal_.SyncTypeState.md#want) +- [wanted](internal_.SyncTypeState.md#wanted) + +## Properties + +### dataToSync + +• **dataToSync**: `boolean` + +Is there data available to sync? (want > 0 || wanted > 0) + +#### Defined in + +[src/sync/sync-api.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L25) + +___ + +### have + +• **have**: `number` + +Number of blocks we have locally + +#### Defined in + +[src/sync/sync-api.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L21) + +___ + +### missing + +• **missing**: `number` + +Number of blocks missing (we don't have them, but connected peers don't have them either) + +#### Defined in + +[src/sync/sync-api.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L24) + +___ + +### syncing + +• **syncing**: `boolean` + +Are we currently syncing? + +#### Defined in + +[src/sync/sync-api.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L26) + +___ + +### want + +• **want**: `number` + +Number of blocks we want from connected peers + +#### Defined in + +[src/sync/sync-api.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L22) + +___ + +### wanted + +• **wanted**: `number` + +Number of blocks that connected peers want from us + +#### Defined in + +[src/sync/sync-api.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L23) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md new file mode 100644 index 000000000..2527d0c7e --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md @@ -0,0 +1,65 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) / Events + +# Interface: Events\<\> + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md).Events + +## Table of contents + +### Properties + +- [add-core](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md#add-core) +- [peer-have](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md#peer-have) + +## Properties + +### add-core + +• **add-core**: (`coreRecord`: [`CoreRecord`](../modules/internal_.md#corerecord)) => `void` + +#### Type declaration + +▸ (`coreRecord`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `coreRecord` | [`CoreRecord`](../modules/internal_.md#corerecord) | + +##### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L25) + +___ + +### peer-have + +• **peer-have**: (`namespace`: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, `msg`: \{ `bitfield`: `Uint32Array` ; `coreDiscoveryId`: `string` ; `peerId`: `string` ; `start`: `number` }) => `void` + +#### Type declaration + +▸ (`namespace`, `msg`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | +| `msg` | `Object` | +| `msg.bitfield` | `Uint32Array` | +| `msg.coreDiscoveryId` | `string` | +| `msg.peerId` | `string` | +| `msg.start` | `number` | + +##### Returns + +`void` + +#### Defined in + +[src/core-manager/index.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L26) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md new file mode 100644 index 000000000..a9644ba60 --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md @@ -0,0 +1,232 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / LocalPeersEvents + +# Interface: LocalPeersEvents\<\> + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).LocalPeersEvents + +## Table of contents + +### Properties + +- [discovery-key](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#discovery-key) +- [failed-to-handle-message](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#failed-to-handle-message) +- [got-project-details](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#got-project-details) +- [invite](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite) +- [invite-cancel](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-cancel) +- [invite-response](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-response) +- [peer-add](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peer-add) +- [peers](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peers) + +## Properties + +### discovery-key + +• **discovery-key**: (`discoveryKey`: `Buffer`, `protomux`: [`Protomux`](../classes/internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\>) => `void` + +Emitted when a new hypercore is replicated (by a peer) to a peer protomux instance (passed as the second parameter) + +#### Type declaration + +▸ (`discoveryKey`, `protomux`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryKey` | `Buffer` | +| `protomux` | [`Protomux`](../classes/internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:229](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L229) + +___ + +### failed-to-handle-message + +• **failed-to-handle-message**: (`messageType`: `string`, `errorMessage?`: `string`) => `void` + +Emitted when we received a message we couldn't handle for some reason. Primarily useful for testing + +#### Type declaration + +▸ (`messageType`, `errorMessage?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `messageType` | `string` | +| `errorMessage?` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:230](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L230) + +___ + +### got-project-details + +• **got-project-details**: (`peerId`: `string`, `details`: `ProjectJoinDetails`) => `void` + +Emitted when project details are received + +#### Type declaration + +▸ (`peerId`, `details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `details` | `ProjectJoinDetails` | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:228](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L228) + +___ + +### invite + +• **invite**: (`peerId`: `string`, `invite`: `Invite`) => `void` + +Emitted when an invite is received + +#### Type declaration + +▸ (`peerId`, `invite`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `invite` | `Invite` | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:225](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L225) + +___ + +### invite-cancel + +• **invite-cancel**: (`peerId`: `string`, `invite`: `InviteCancel`) => `void` + +Emitted when we receive a cancelation for an invite + +#### Type declaration + +▸ (`peerId`, `invite`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `invite` | `InviteCancel` | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:226](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L226) + +___ + +### invite-response + +• **invite-response**: (`peerId`: `string`, `inviteResponse`: `InviteResponse`) => `void` + +Emitted when an invite response is received + +#### Type declaration + +▸ (`peerId`, `inviteResponse`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | +| `inviteResponse` | `InviteResponse` | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:227](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L227) + +___ + +### peer-add + +• **peer-add**: (`peer`: [`PeerInfoConnected`](../modules/internal_.md#peerinfoconnected)) => `void` + +Emitted when a new peer is connected + +#### Type declaration + +▸ (`peer`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peer` | [`PeerInfoConnected`](../modules/internal_.md#peerinfoconnected) | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:224](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L224) + +___ + +### peers + +• **peers**: (`peers`: [`PeerInfo`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo)[]) => `void` + +Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status + +#### Type declaration + +▸ (`peers`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `peers` | [`PeerInfo`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo)[] | + +##### Returns + +`void` + +#### Defined in + +[src/local-peers.js:223](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L223) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md new file mode 100644 index 000000000..49416ee3d --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md @@ -0,0 +1,21 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md) / ProjectInfo + +# Interface: ProjectInfo\<\> + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md).ProjectInfo + +## Table of contents + +### Properties + +- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md#name) + +## Properties + +### name + +• **name**: `undefined` \| `string` + +#### Defined in + +[src/schema/client.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L12) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md new file mode 100644 index 000000000..507f3838e --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md @@ -0,0 +1,49 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) / DerivedState + +# Interface: DerivedState\<\> + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md).DerivedState + +## Table of contents + +### Properties + +- [coreLength](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#corelength) +- [localState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#localstate) +- [remoteStates](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#remotestates) + +## Properties + +### coreLength + +• **coreLength**: `number` + +known (sparse) length of the core + +#### Defined in + +[src/sync/core-sync-state.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L32) + +___ + +### localState + +• **localState**: [`CoreState`](internal_.CoreState.md) + +local state + +#### Defined in + +[src/sync/core-sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L33) + +___ + +### remoteStates + +• **remoteStates**: `Object` + +map of state of all known peers + +#### Defined in + +[src/sync/core-sync-state.js:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L34) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md new file mode 100644 index 000000000..bfc49bd70 --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md @@ -0,0 +1,67 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) / InternalState + +# Interface: InternalState\<\> + +[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md).InternalState + +## Table of contents + +### Properties + +- [length](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#length) +- [localState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#localstate) +- [namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#namespace) +- [peerSyncControllers](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#peersynccontrollers) +- [remoteStates](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#remotestates) + +## Properties + +### length + +• **length**: `undefined` \| `number` + +Core length, e.g. how many blocks in the core (including blocks that are not downloaded) + +#### Defined in + +[src/sync/core-sync-state.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L14) + +___ + +### localState + +• **localState**: `PeerState` + +#### Defined in + +[src/sync/core-sync-state.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L15) + +___ + +### namespace + +• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` + +#### Defined in + +[src/sync/core-sync-state.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L18) + +___ + +### peerSyncControllers + +• **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/internal_.PeerSyncController.md)\> + +#### Defined in + +[src/sync/core-sync-state.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L17) + +___ + +### remoteStates + +• **remoteStates**: `Map`\<`string`, `PeerState`\> + +#### Defined in + +[src/sync/core-sync-state.js:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L16) diff --git a/docs/api/md/modules/internal_.Hyperblobs.md b/docs/api/md/modules/internal_.Hyperblobs.md new file mode 100644 index 000000000..e3c16cb81 --- /dev/null +++ b/docs/api/md/modules/internal_.Hyperblobs.md @@ -0,0 +1,11 @@ +[API](../README.md) / [\](internal_.md) / Hyperblobs + +# Namespace: Hyperblobs + +[\](internal_.md).Hyperblobs + +## Table of contents + +### Interfaces + +- [BlobId](../interfaces/internal_.Hyperblobs.BlobId.md) diff --git a/docs/api/md/modules/internal_.Hyperdrive.md b/docs/api/md/modules/internal_.Hyperdrive.md new file mode 100644 index 000000000..052082649 --- /dev/null +++ b/docs/api/md/modules/internal_.Hyperdrive.md @@ -0,0 +1,11 @@ +[API](../README.md) / [\](internal_.md) / Hyperdrive + +# Namespace: Hyperdrive + +[\](internal_.md).Hyperdrive + +## Table of contents + +### Interfaces + +- [HyperdriveEntry](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md new file mode 100644 index 000000000..1e87ccbff --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md @@ -0,0 +1,77 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" + +## Table of contents + +### References + +- [Core](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#core) +- [CoreManager](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#coremanager) +- [CoreRecord](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#corerecord) +- [HaveMsg](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#havemsg) +- [Namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#namespace) + +### Interfaces + +- [Events](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md) + +### Type Aliases + +- [DuplexStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#duplexstream) + +### Variables + +- [kCoreManagerReplicate](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) + +## References + +### Core + +Re-exports [Core](internal_.md#core) + +___ + +### CoreManager + +Re-exports [CoreManager](../classes/internal_.CoreManager.md) + +___ + +### CoreRecord + +Re-exports [CoreRecord](internal_.md#corerecord) + +___ + +### HaveMsg + +Re-exports [HaveMsg](../interfaces/internal_.HaveMsg.md) + +___ + +### Namespace + +Re-exports [Namespace](internal_.md#namespace-1) + +## Type Aliases + +### DuplexStream + +Ƭ **DuplexStream**\<\>: `Duplex` + +#### Defined in + +[src/core-manager/index.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L22) + +## Variables + +### kCoreManagerReplicate + +• `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) + +#### Defined in + +[src/core-manager/index.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L17) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md new file mode 100644 index 000000000..e210cf653 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md @@ -0,0 +1,73 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/datastore/index" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/datastore/index" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/datastore/index" + +## Table of contents + +### References + +- [DataStore](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#datastore) +- [NamespaceSchemas](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#namespaceschemas) + +### Type Aliases + +- [DataStoreEvents](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#datastoreevents) +- [MapeoDocTablesMap](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#mapeodoctablesmap) +- [OmitUnion](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#omitunion) + +## References + +### DataStore + +Re-exports [DataStore](../classes/internal_.DataStore.md) + +___ + +### NamespaceSchemas + +Re-exports [NamespaceSchemas](internal_.md#namespaceschemas) + +## Type Aliases + +### DataStoreEvents + +Ƭ **DataStoreEvents**\<`TSchemaName`\>: \{ [S in Exclude\]: Function } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | + +#### Defined in + +[src/datastore/index.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L22) + +___ + +### MapeoDocTablesMap + +Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } + +#### Defined in + +[src/datatype/index.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L24) + +___ + +### OmitUnion + +Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | + +#### Defined in + +[src/datastore/index.js:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L27) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md new file mode 100644 index 000000000..19603e915 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md @@ -0,0 +1,109 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/local-peers" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/local-peers" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/local-peers" + +## Table of contents + +### References + +- [LocalPeers](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#localpeers) +- [PeerInfoBase](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfobase) +- [PeerInfoConnected](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnected) +- [PeerInfoDisconnected](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfodisconnected) + +### Classes + +- [PeerDisconnectedError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) +- [PeerFailedConnectionError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) +- [UnknownPeerError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +### Interfaces + +- [LocalPeersEvents](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md) + +### Type Aliases + +- [PeerInfo](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo) +- [PeerInfoConnecting](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) +- [PeerInfoInternal](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) +- [PeerState](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerstate) + +### Variables + +- [kTestOnlySendRawInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) + +## References + +### LocalPeers + +Re-exports [LocalPeers](../classes/internal_.LocalPeers.md) + +___ + +### PeerInfoBase + +Re-exports [PeerInfoBase](../interfaces/internal_.PeerInfoBase.md) + +___ + +### PeerInfoConnected + +Re-exports [PeerInfoConnected](internal_.md#peerinfoconnected) + +___ + +### PeerInfoDisconnected + +Re-exports [PeerInfoDisconnected](internal_.md#peerinfodisconnected) + +## Type Aliases + +### PeerInfo + +Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) + +#### Defined in + +[src/local-peers.js:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L51) + +___ + +### PeerInfoConnecting + +Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } + +#### Defined in + +[src/local-peers.js:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L46) + +___ + +### PeerInfoInternal + +Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) \| [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) + +#### Defined in + +[src/local-peers.js:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L50) + +___ + +### PeerState + +Ƭ **PeerState**\<\>: [`PeerInfoInternal`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal)[``"status"``] + +#### Defined in + +[src/local-peers.js:52](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L52) + +## Variables + +### kTestOnlySendRawInvite + +• `Const` **kTestOnlySendRawInvite**: typeof [`kTestOnlySendRawInvite`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) + +#### Defined in + +[src/local-peers.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L38) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md new file mode 100644 index 000000000..7ed165697 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md @@ -0,0 +1,250 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/roles" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/roles" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/roles" + +## Table of contents + +### References + +- [DocCapability](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#doccapability) +- [ElementOf](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#elementof) +- [Role](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#role) +- [RoleId](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleid) +- [Roles](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roles) + +### Type Aliases + +- [RoleIdAssignableToAnyone](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidassignabletoanyone) +- [RoleIdAssignableToOthers](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidassignabletoothers) +- [RoleIdForNewInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidfornewinvite) + +### Variables + +- [BLOCKED\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#blocked_role_id) +- [COORDINATOR\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#coordinator_role_id) +- [CREATOR\_ROLE](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#creator_role) +- [CREATOR\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#creator_role_id) +- [LEFT\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#left_role_id) +- [MEMBER\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#member_role_id) +- [NO\_ROLE](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#no_role) +- [NO\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#no_role_id) +- [ROLES](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roles-1) + +### Functions + +- [isRoleIdAssignableToOthers](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#isroleidassignabletoothers) +- [isRoleIdForNewInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#isroleidfornewinvite) + +## References + +### DocCapability + +Re-exports [DocCapability](../interfaces/internal_.DocCapability.md) + +___ + +### ElementOf + +Re-exports [ElementOf](internal_.md#elementof) + +___ + +### Role + +Re-exports [Role](../interfaces/internal_.Role.md) + +___ + +### RoleId + +Re-exports [RoleId](internal_.md#roleid) + +___ + +### Roles + +Re-exports [Roles](../classes/internal_.Roles.md) + +## Type Aliases + +### RoleIdAssignableToAnyone + +Ƭ **RoleIdAssignableToAnyone**\<\>: [`ElementOf`](internal_.md#elementof)\ + +#### Defined in + +[src/roles.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L44) + +___ + +### RoleIdAssignableToOthers + +Ƭ **RoleIdAssignableToOthers**\<\>: [`ElementOf`](internal_.md#elementof)\ + +#### Defined in + +[src/roles.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L38) + +___ + +### RoleIdForNewInvite + +Ƭ **RoleIdForNewInvite**\<\>: [`ElementOf`](internal_.md#elementof)\ + +#### Defined in + +[src/roles.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L32) + +## Variables + +### BLOCKED\_ROLE\_ID + +• `Const` **BLOCKED\_ROLE\_ID**: ``"9e6d29263cba36c9"`` + +#### Defined in + +[src/roles.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L10) + +___ + +### COORDINATOR\_ROLE\_ID + +• `Const` **COORDINATOR\_ROLE\_ID**: ``"f7c150f5a3a9a855"`` + +#### Defined in + +[src/roles.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L8) + +___ + +### CREATOR\_ROLE + +• `Const` **CREATOR\_ROLE**: [`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"``\> + +This is currently the same as 'Coordinator' role, but defined separately +because the creator should always have ALL powers, but we could edit the +'Coordinator' powers in the future. + +#### Defined in + +[src/roles.js:80](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L80) + +___ + +### CREATOR\_ROLE\_ID + +• `Const` **CREATOR\_ROLE\_ID**: ``"a12a6702b93bd7ff"`` + +#### Defined in + +[src/roles.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L7) + +___ + +### LEFT\_ROLE\_ID + +• `Const` **LEFT\_ROLE\_ID**: ``"8ced989b1904606b"`` + +#### Defined in + +[src/roles.js:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L11) + +___ + +### MEMBER\_ROLE\_ID + +• `Const` **MEMBER\_ROLE\_ID**: ``"012fd2d431c0bf60"`` + +#### Defined in + +[src/roles.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L9) + +___ + +### NO\_ROLE + +• `Const` **NO\_ROLE**: [`Role`](../interfaces/internal_.Role.md)\<``"08e4251e36f6e7ed"``\> + +This is the role assumed for a device when no role record can be found. This +can happen when an invited device did not manage to sync with the device that +invited them, and they then try to sync with someone else. We want them to be +able to sync the auth and config store, because that way they may be able to +receive their role record, and they can get the project config so that they +can start collecting data. + +#### Defined in + +[src/roles.js:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L109) + +___ + +### NO\_ROLE\_ID + +• `Const` **NO\_ROLE\_ID**: ``"08e4251e36f6e7ed"`` + +#### Defined in + +[src/roles.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L12) + +___ + +### ROLES + +• `Const` **ROLES**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `012fd2d431c0bf60` | [`Role`](../interfaces/internal_.Role.md)\<``"012fd2d431c0bf60"``\> | +| `08e4251e36f6e7ed` | [`Role`](../interfaces/internal_.Role.md)\<``"08e4251e36f6e7ed"``\> | +| `8ced989b1904606b` | [`Role`](../interfaces/internal_.Role.md)\<``"8ced989b1904606b"``\> | +| `9e6d29263cba36c9` | [`Role`](../interfaces/internal_.Role.md)\<``"9e6d29263cba36c9"``\> | +| `a12a6702b93bd7ff` | [`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"``\> | +| `f7c150f5a3a9a855` | [`Role`](../interfaces/internal_.Role.md)\<``"f7c150f5a3a9a855"``\> | + +#### Defined in + +[src/roles.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L129) + +## Functions + +### isRoleIdAssignableToOthers + +▸ **isRoleIdAssignableToOthers**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Returns + +value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Defined in + +[src/roles.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L42) + +___ + +### isRoleIdForNewInvite + +▸ **isRoleIdForNewInvite**(`value`): value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Returns + +value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" + +#### Defined in + +[src/roles.js:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L36) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md new file mode 100644 index 000000000..59b5f1c1e --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md @@ -0,0 +1,68 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/schema/client" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/schema/client" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/schema/client" + +## Table of contents + +### References + +- [DeviceInfoParam](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#deviceinfoparam) + +### Interfaces + +- [ProjectInfo](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md) + +### Variables + +- [localDeviceInfoTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#localdeviceinfotable) +- [projectBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectbacklinktable) +- [projectKeysTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectkeystable) +- [projectSettingsTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectsettingstable) + +## References + +### DeviceInfoParam + +Re-exports [DeviceInfoParam](internal_.md#deviceinfoparam) + +## Variables + +### localDeviceInfoTable + +• `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L51) + +___ + +### projectBacklinkTable + +• `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L27) + +___ + +### projectKeysTable + +• `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L28) + +___ + +### projectSettingsTable + +• `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/client.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L23) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md new file mode 100644 index 000000000..a69b2a9fc --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md @@ -0,0 +1,219 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/schema/project" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/schema/project" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/schema/project" + +## Table of contents + +### Variables + +- [coreOwnershipBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#coreownershipbacklinktable) +- [coreOwnershipTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#coreownershiptable) +- [coresTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#corestable) +- [deviceInfoBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#deviceinfobacklinktable) +- [deviceInfoTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#deviceinfotable) +- [fieldBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#fieldbacklinktable) +- [fieldTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#fieldtable) +- [iconBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#iconbacklinktable) +- [iconTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#icontable) +- [observationBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#observationbacklinktable) +- [observationTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#observationtable) +- [presetBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#presetbacklinktable) +- [presetTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#presettable) +- [roleBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#rolebacklinktable) +- [roleTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#roletable) +- [trackBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#trackbacklinktable) +- [trackTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#tracktable) +- [translationBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#translationbacklinktable) +- [translationTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#translationtable) + +## Variables + +### coreOwnershipBacklinkTable + +• `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L36) + +___ + +### coreOwnershipTable + +• `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L20) + +___ + +### coresTable + +• `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L41) + +___ + +### deviceInfoBacklinkTable + +• `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L38) + +___ + +### deviceInfoTable + +• `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L25) + +___ + +### fieldBacklinkTable + +• `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L35) + +___ + +### fieldTable + +• `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L19) + +___ + +### iconBacklinkTable + +• `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L39) + +___ + +### iconTable + +• `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L29) + +___ + +### observationBacklinkTable + +• `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L32) + +___ + +### observationTable + +• `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L13) + +___ + +### presetBacklinkTable + +• `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L34) + +___ + +### presetTable + +• `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L18) + +___ + +### roleBacklinkTable + +• `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L37) + +___ + +### roleTable + +• `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L24) + +___ + +### trackBacklinkTable + +• `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L33) + +___ + +### trackTable + +• `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L17) + +___ + +### translationBacklinkTable + +• `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L31) + +___ + +### translationTable + +• `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> + +#### Defined in + +[src/schema/project.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L9) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md new file mode 100644 index 000000000..a8bd4f246 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md @@ -0,0 +1,88 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" + +## Table of contents + +### References + +- [CoreState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#corestate) +- [CoreSyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#coresyncstate) +- [PeerCoreState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#peercorestate) + +### Interfaces + +- [DerivedState](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) +- [InternalState](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md) + +### Type Aliases + +- [Bitfield](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#bitfield) +- [PeerId](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#peerid) + +### Functions + +- [bitCount32](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#bitcount32) + +## References + +### CoreState + +Re-exports [CoreState](../interfaces/internal_.CoreState.md) + +___ + +### CoreSyncState + +Re-exports [CoreSyncState](../classes/internal_.CoreSyncState.md) + +___ + +### PeerCoreState + +Re-exports [PeerCoreState](internal_.md#peercorestate) + +## Type Aliases + +### Bitfield + +Ƭ **Bitfield**\<\>: [`default`](../classes/internal_.default-2.md) + +#### Defined in + +[src/sync/core-sync-state.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L7) + +___ + +### PeerId + +Ƭ **PeerId**\<\>: `string` + +#### Defined in + +[src/sync/core-sync-state.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L10) + +## Functions + +### bitCount32 + +▸ **bitCount32**(`n`): `number` + +Apologies for the obscure code. From +https://stackoverflow.com/a/109025/903300 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +`number` + +#### Defined in + +[src/sync/core-sync-state.js:431](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L431) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md new file mode 100644 index 000000000..536f5504a --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md @@ -0,0 +1,59 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" + +## Table of contents + +### Classes + +- [NamespaceSyncState](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) + +### Type Aliases + +- [SyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +### Functions + +- [createState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#createstate) + +## Type Aliases + +### SyncState + +Ƭ **SyncState**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } + +#### Defined in + +[src/sync/namespace-sync-state.js:5](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L5) + +## Functions + +### createState + +▸ **createState**(): [`CoreState`](../interfaces/internal_.CoreState.md) + +#### Returns + +[`CoreState`](../interfaces/internal_.CoreState.md) + +#### Defined in + +[src/sync/namespace-sync-state.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L136) + +▸ **createState**(`status`): [`PeerCoreState`](internal_.md#peercorestate) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `status` | ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` | + +#### Returns + +[`PeerCoreState`](internal_.md#peercorestate) + +#### Defined in + +[src/sync/namespace-sync-state.js:141](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L141) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md new file mode 100644 index 000000000..f5277f1ed --- /dev/null +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md @@ -0,0 +1,436 @@ +[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/utils" + +# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/utils" + +[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/utils" + +## Table of contents + +### References + +- [OpenedNoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#openednoisestream) + +### Classes + +- [ExhaustivenessError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) + +### Type Aliases + +- [DestroyedNoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) +- [NoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noisestream) + +### Functions + +- [assert](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#assert) +- [createMap](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#createmap) +- [deNullify](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#denullify) +- [getDeviceId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#getdeviceid) +- [hashObject](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#hashobject) +- [idToKey](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#idtokey) +- [keyToId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#keytoid) +- [noop](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noop) +- [openedNoiseSecretStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#openednoisesecretstream) +- [parseVersion](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#parseversion) +- [projectIdToNonce](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectidtononce) +- [projectKeyToId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectkeytoid) +- [projectKeyToPublicId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectkeytopublicid) +- [setHas](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#sethas) +- [valueOf](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#valueof) + +## References + +### OpenedNoiseStream + +Re-exports [OpenedNoiseStream](internal_.md#openednoisestream) + +## Type Aliases + +### DestroyedNoiseStream + +Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noisestream) & \{ `destroyed`: ``true`` } + +#### Defined in + +[src/utils.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L44) + +___ + +### NoiseStream + +Ƭ **NoiseStream**\<\>: `__module` + +#### Defined in + +[src/utils.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L43) + +## Functions + +### assert + +▸ **assert**(`condition`, `message`): asserts condition + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `condition` | `unknown` | +| `message` | `string` | + +#### Returns + +asserts condition + +#### Defined in + +[src/utils.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L81) + +___ + +### createMap + +▸ **createMap**\<`K`, `V`\>(`keys`, `value`): `Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> + +Small helper to create a typed map + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends `string` | +| `V` | extends `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `keys` | readonly `K`[] | +| `value` | `V` | + +#### Returns + +`Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> + +#### Defined in + +[src/utils.js:189](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L189) + +___ + +### deNullify + +▸ **deNullify**\<`T`\>(`obj`): \{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } + +When reading from SQLite, any optional properties are set to `null`. This +converts `null` back to `undefined` to match the input types (e.g. the types +defined in @mapeo/schema) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Object` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `T` | + +#### Returns + +\{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } + +#### Defined in + +[src/utils.js:116](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L116) + +___ + +### getDeviceId + +▸ **getDeviceId**(`keyManager`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `keyManager` | `KeyManager` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:177](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L177) + +___ + +### hashObject + +▸ **hashObject**(`obj`): `string` + +create a sha256 hash of an object using json-stable-stringify for deterministic results + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `Object` | + +#### Returns + +`string` + +hash of the object + +#### Defined in + +[src/utils.js:202](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L202) + +___ + +### idToKey + +▸ **idToKey**(`id`): `Buffer` \| `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` \| `Buffer` | + +#### Returns + +`Buffer` \| `Uint8Array` + +#### Defined in + +[src/utils.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L10) + +___ + +### keyToId + +▸ **keyToId**(`key`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` \| `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L23) + +___ + +### noop + +▸ **noop**(): `void` + +#### Returns + +`void` + +#### Defined in + +[src/utils.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L74) + +___ + +### openedNoiseSecretStream + +▸ **openedNoiseSecretStream**(`stream`): `Promise`\<[`DestroyedNoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> + +Utility to await a NoiseSecretStream to open, that returns a stream with the +correct types for publicKey and remotePublicKey (which can be null before +stream is opened) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | `NoiseSecretStream`\<`any`\> | + +#### Returns + +`Promise`\<[`DestroyedNoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> + +#### Defined in + +[src/utils.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L58) + +___ + +### parseVersion + +▸ **parseVersion**(`version`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `version` | `string` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `blockIndex` | `number` | +| `coreId` | `string` | + +#### Defined in + +[src/utils.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L35) + +___ + +### projectIdToNonce + +▸ **projectIdToNonce**(`projectId`): `Buffer` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `projectId` | `string` | Project internal ID | + +#### Returns + +`Buffer` + +24-byte nonce (same length as sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES) + +#### Defined in + +[src/utils.js:169](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L169) + +___ + +### projectKeyToId + +▸ **projectKeyToId**(`projectKey`): `string` + +Create an internal ID from a project key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectKey` | `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:152](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L152) + +___ + +### projectKeyToPublicId + +▸ **projectKeyToPublicId**(`projectKey`): `string` + +Create a public ID from a project key + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `projectKey` | `Buffer` | + +#### Returns + +`string` + +#### Defined in + +[src/utils.js:161](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L161) + +___ + +### setHas + +▸ **setHas**\<`T`\>(`set`): (`value`: `unknown`) => value is T + +Return a function that itself returns whether a value is part of the set. + +Similar to binding `Set.prototype.has`, but (1) is shorter (2) refines the type. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `set` | `Readonly`\<`Set`\<`T`\>\> | + +#### Returns + +`fn` + +▸ (`value`): value is T + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +##### Returns + +value is T + +**`Example`** + +```ts +const mySet = new Set([1, 2, 3]) +const isInMySet = setHas(mySet) + +console.log(isInMySet(2)) +// => true +``` + +#### Defined in + +[src/utils.js:99](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L99) + +___ + +### valueOf + +▸ **valueOf**\<`T`\>(`doc`): `Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `MapeoDoc` & \{ `forks?`: `string`[] } | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `doc` | `T` | + +#### Returns + +`Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> + +#### Defined in + +[src/utils.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L130) diff --git a/docs/api/md/modules/internal_._hyperdrive_.md b/docs/api/md/modules/internal_._hyperdrive_.md new file mode 100644 index 000000000..cb207e621 --- /dev/null +++ b/docs/api/md/modules/internal_._hyperdrive_.md @@ -0,0 +1,17 @@ +[API](../README.md) / [\](internal_.md) / "hyperdrive" + +# Namespace: "hyperdrive" + +[\](internal_.md)."hyperdrive" + +## Table of contents + +### References + +- [HyperdriveEntry](internal_._hyperdrive_.md#hyperdriveentry) + +## References + +### HyperdriveEntry + +Re-exports [HyperdriveEntry](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md) diff --git a/docs/api/md/modules/internal_.md b/docs/api/md/modules/internal_.md new file mode 100644 index 000000000..671cf0b97 --- /dev/null +++ b/docs/api/md/modules/internal_.md @@ -0,0 +1,876 @@ +[API](../README.md) / \ + +# Module: \ + +## Table of contents + +### References + +- [BlobId](internal_.md#blobid) +- [HyperdriveEntry](internal_.md#hyperdriveentry) +- [MapeoDocTables](internal_.md#mapeodoctables) +- [Namespace](internal_.md#namespace) +- [NamespaceSyncState](internal_.md#namespacesyncstate) +- [SyncState](internal_.md#syncstate) + +### Namespaces + +- ["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/datastore/index"](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/roles"](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/schema/project"](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md) +- ["/home/szgy/src/dd/mapeo-core-next/src/utils"](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) +- ["hyperdrive"](internal_._hyperdrive_.md) +- [Hyperblobs](internal_.Hyperblobs.md) +- [Hyperdrive](internal_.Hyperdrive.md) + +### Classes + +- [BigSparseArray](../classes/internal_.BigSparseArray.md) +- [BlobApi](../classes/internal_.BlobApi.md) +- [BlobReadStream](../classes/internal_.BlobReadStream.md) +- [BlobStore](../classes/internal_.BlobStore.md) +- [BlobWriteStream](../classes/internal_.BlobWriteStream.md) +- [CoreIndex](../classes/internal_.CoreIndex.md) +- [CoreManager](../classes/internal_.CoreManager.md) +- [CoreOwnership](../classes/internal_.CoreOwnership.md) +- [CoreSyncState](../classes/internal_.CoreSyncState.md) +- [Corestore](../classes/internal_.Corestore.md) +- [DataStore](../classes/internal_.DataStore.md) +- [DataType](../classes/internal_.DataType.md) +- [DenseIndex](../classes/internal_.DenseIndex.md) +- [DriveLiveDownload](../classes/internal_.DriveLiveDownload.md) +- [Hyperblobs](../classes/internal_.Hyperblobs-1.md) +- [Hyperdrive](../classes/internal_.Hyperdrive-1.md) +- [IconApi](../classes/internal_.IconApi.md) +- [Index](../classes/internal_.Index.md) +- [IndexWriter](../classes/internal_.IndexWriter.md) +- [InviteApi](../classes/internal_.InviteApi.md) +- [LiveDownload](../classes/internal_.LiveDownload.md) +- [LocalDiscovery](../classes/internal_.LocalDiscovery.md) +- [LocalPeers](../classes/internal_.LocalPeers.md) +- [Logger](../classes/internal_.Logger.md) +- [MapeoProject](../classes/internal_.MapeoProject.md) +- [MemberApi](../classes/internal_.MemberApi.md) +- [Peer](../classes/internal_.Peer.md) +- [PeerSyncController](../classes/internal_.PeerSyncController.md) +- [PendingInvites](../classes/internal_.PendingInvites.md) +- [Protomux](../classes/internal_.Protomux.md) +- [RemoteBitfieldPage](../classes/internal_.RemoteBitfieldPage.md) +- [RemoteBitfieldSegment](../classes/internal_.RemoteBitfieldSegment.md) +- [Roles](../classes/internal_.Roles.md) +- [SparseIndex](../classes/internal_.SparseIndex.md) +- [SyncApi](../classes/internal_.SyncApi.md) +- [SyncState](../classes/internal_.SyncState.md) +- [TrackedKeyRequests](../classes/internal_.TrackedKeyRequests.md) +- [default](../classes/internal_.default.md) +- [default](../classes/internal_.default-1.md) +- [default](../classes/internal_.default-2.md) + +### Interfaces + +- [BitmapOpts](../interfaces/internal_.BitmapOpts.md) +- [BlobDownloadState](../interfaces/internal_.BlobDownloadState.md) +- [Channel](../interfaces/internal_.Channel.md) +- [CoreState](../interfaces/internal_.CoreState.md) +- [CorestoreEvents](../interfaces/internal_.CorestoreEvents.md) +- [DataTypeEvents](../interfaces/internal_.DataTypeEvents.md) +- [DocCapability](../interfaces/internal_.DocCapability.md) +- [Encoding](../interfaces/internal_.Encoding.md) +- [EncodingState](../interfaces/internal_.EncodingState.md) +- [HaveMsg](../interfaces/internal_.HaveMsg.md) +- [HyperdriveEvents](../interfaces/internal_.HyperdriveEvents.md) +- [HyperdriveGetOpts](../interfaces/internal_.HyperdriveGetOpts.md) +- [HyperdriveOptions](../interfaces/internal_.HyperdriveOptions.md) +- [MapsPluginOpts](../interfaces/internal_.MapsPluginOpts.md) +- [MemberInfo](../interfaces/internal_.MemberInfo.md) +- [Message](../interfaces/internal_.Message.md) +- [OfflineFallbackMapPluginOpts](../interfaces/internal_.OfflineFallbackMapPluginOpts.md) +- [PeerInfoBase](../interfaces/internal_.PeerInfoBase.md) +- [PendingInvite](../interfaces/internal_.PendingInvite.md) +- [PreEncodingState](../interfaces/internal_.PreEncodingState.md) +- [Role](../interfaces/internal_.Role.md) +- [StartOpts](../interfaces/internal_.StartOpts.md) +- [State](../interfaces/internal_.State.md) +- [StaticMapsPluginOpts](../interfaces/internal_.StaticMapsPluginOpts.md) +- [SvgOpts](../interfaces/internal_.SvgOpts.md) +- [SyncTypeState](../interfaces/internal_.SyncTypeState.md) + +### Type Aliases + +- [ArrayAtLeastOne](internal_.md#arrayatleastone) +- [BitField](internal_.md#bitfield) +- [BlobDownloadStateError](internal_.md#blobdownloadstateerror) +- [BlobFilter](internal_.md#blobfilter) +- [BlobId](internal_.md#blobid-1) +- [BlobIdBase](internal_.md#blobidbase) +- [BlobType](internal_.md#blobtype) +- [BlobVariant](internal_.md#blobvariant) +- [Chunk](internal_.md#chunk) +- [Core](internal_.md#core) +- [CoreOwnershipWithSignatures](internal_.md#coreownershipwithsignatures) +- [CoreOwnershipWithSignaturesValue](internal_.md#coreownershipwithsignaturesvalue) +- [CoreRecord](internal_.md#corerecord) +- [CoreStorage](internal_.md#corestorage) +- [DeviceInfoParam](internal_.md#deviceinfoparam) +- [EditableProjectSettings](internal_.md#editableprojectsettings) +- [ElementOf](internal_.md#elementof) +- [GetMapeoDocTables](internal_.md#getmapeodoctables) +- [IndexedDocIds](internal_.md#indexeddocids) +- [InternalDriveEmitter](internal_.md#internaldriveemitter) +- [InviteInternal](internal_.md#inviteinternal) +- [KeyPair](internal_.md#keypair) +- [Keypair](internal_.md#keypair-1) +- [MapBuffers](internal_.md#mapbuffers) +- [MapeoDocMap](internal_.md#mapeodocmap) +- [MapeoDocTableName](internal_.md#mapeodoctablename) +- [MapeoDocTables](internal_.md#mapeodoctables-1) +- [MapeoValueMap](internal_.md#mapeovaluemap) +- [Namespace](internal_.md#namespace-1) +- [NamespaceSchemas](internal_.md#namespaceschemas) +- [OpenedNoiseStream](internal_.md#openednoisestream) +- [OpenedNoiseStream](internal_.md#openednoisestream-1) +- [PeerCoreState](internal_.md#peercorestate) +- [PeerInfoConnected](internal_.md#peerinfoconnected) +- [PeerInfoDisconnected](internal_.md#peerinfodisconnected) +- [Primitive](internal_.md#primitive) +- [ProtocolStream](internal_.md#protocolstream) +- [PublicKey](internal_.md#publickey) +- [PublicPeerInfo](internal_.md#publicpeerinfo) +- [Range](internal_.md#range) +- [RemoveNull](internal_.md#removenull) +- [ReplicationStream](internal_.md#replicationstream) +- [RoleId](internal_.md#roleid) +- [SecretKey](internal_.md#secretkey) +- [State](internal_.md#state) +- [SupportedBlobVariants](internal_.md#supportedblobvariants) +- [SyncCapability](internal_.md#synccapability) +- [SyncType](internal_.md#synctype) + +### Variables + +- [NAMESPACES](internal_.md#namespaces) +- [NAMESPACE\_SCHEMAS](internal_.md#namespace_schemas) +- [ROLE\_IDS](internal_.md#role_ids) +- [ROLE\_IDS\_ASSIGNABLE\_TO\_ANYONE](internal_.md#role_ids_assignable_to_anyone) +- [ROLE\_IDS\_ASSIGNABLE\_TO\_OTHERS](internal_.md#role_ids_assignable_to_others) +- [ROLE\_IDS\_FOR\_NEW\_INVITE](internal_.md#role_ids_for_new_invite) +- [SUPPORTED\_BLOB\_VARIANTS](internal_.md#supported_blob_variants) + +## References + +### BlobId + +Re-exports [BlobId](../interfaces/internal_.Hyperblobs.BlobId.md) + +___ + +### HyperdriveEntry + +Re-exports [HyperdriveEntry](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md) + +___ + +### MapeoDocTables + +Re-exports [MapeoDocTables](internal_.md#mapeodoctables-1) + +___ + +### Namespace + +Re-exports [Namespace](internal_.md#namespace-1) + +___ + +### NamespaceSyncState + +Re-exports [NamespaceSyncState](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) + +___ + +### SyncState + +Re-exports [SyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +## Type Aliases + +### ArrayAtLeastOne + +Ƭ **ArrayAtLeastOne**\<`T`\>: [`T`, ...T[]] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L40) + +___ + +### BitField + +Ƭ **BitField**: `TypedArray` + +#### Defined in + +[types/quickbit-universal.d.ts:2](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L2) + +___ + +### BlobDownloadStateError + +Ƭ **BlobDownloadStateError**\<\>: `Omit`\<[`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md), ``"error"`` \| ``"status"``\> & \{ `error`: `Error` ; `status`: ``"error"`` } + +#### Defined in + +[src/blob-store/live-download.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L18) + +___ + +### BlobFilter + +Ƭ **BlobFilter**: `RequireAtLeastOne`\<\{ [KeyType in BlobType]: ArrayAtLeastOne\\> }\> + +#### Defined in + +[src/types.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L42) + +___ + +### BlobId + +Ƭ **BlobId**: `Simplify`\<`ValueOf`\<\{ [KeyType in BlobType]: BlobIdBase\ }\>\> + +#### Defined in + +[src/types.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L34) + +___ + +### BlobIdBase + +Ƭ **BlobIdBase**\<`T`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`BlobType`](internal_.md#blobtype) | + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `driveId` | `string` | discovery key as hex string of hyperdrive where blob is stored | +| `name` | `string` | unique identifier for blob (e.g. hash of content) | +| `type` | `T` | Type of blob | +| `variant` | [`BlobVariant`](internal_.md#blobvariant)\<`T`\> | Blob variant (some blob types have smaller previews and thumbnails available) | + +#### Defined in + +[src/types.ts:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L22) + +___ + +### BlobType + +Ƭ **BlobType**: keyof [`SupportedBlobVariants`](internal_.md#supportedblobvariants) + +#### Defined in + +[src/types.ts:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L17) + +___ + +### BlobVariant + +Ƭ **BlobVariant**\<`TBlobType`\>: `TupleToUnion`\<[`SupportedBlobVariants`](internal_.md#supportedblobvariants)[`TBlobType`]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TBlobType` | extends [`BlobType`](internal_.md#blobtype) | + +#### Defined in + +[src/types.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L18) + +___ + +### Chunk + +Ƭ **Chunk**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `field` | [`BitField`](internal_.md#bitfield) | +| `offset` | `number` | + +#### Defined in + +[types/quickbit-universal.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L37) + +___ + +### Core + +Ƭ **Core**\<\>: `__module` + +#### Defined in + +[src/core-manager/index.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L19) + +___ + +### CoreOwnershipWithSignatures + +Ƭ **CoreOwnershipWithSignatures**: `Extract`\<`ReturnType`\, \{ `schemaName`: ``"coreOwnership"`` }\> + +#### Defined in + +[src/types.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L55) + +___ + +### CoreOwnershipWithSignaturesValue + +Ƭ **CoreOwnershipWithSignaturesValue**: `Omit`\<[`CoreOwnershipWithSignatures`](internal_.md#coreownershipwithsignatures), `Exclude`\\> + +#### Defined in + +[src/types.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L59) + +___ + +### CoreRecord + +Ƭ **CoreRecord**\<\>: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `core` | [`Core`](internal_.md#core) | +| `key` | `Buffer` | +| `namespace` | [`Namespace`](internal_.md#namespace-1) | + +#### Defined in + +[src/core-manager/index.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L21) + +___ + +### CoreStorage + +Ƭ **CoreStorage**: (`name`: `string`) => `RandomAccessStorage` + +#### Type declaration + +▸ (`name`): `RandomAccessStorage` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +##### Returns + +`RandomAccessStorage` + +#### Defined in + +[src/types.ts:114](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L114) + +___ + +### DeviceInfoParam + +Ƭ **DeviceInfoParam**\<\>: `Omit`\<`DeviceInfoValue`, ``"schemaName"``\> + +#### Defined in + +[src/schema/client.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L42) + +___ + +### EditableProjectSettings + +Ƭ **EditableProjectSettings**\<\>: `Omit`\<`ProjectSettingsValue`, ``"schemaName"``\> + +#### Defined in + +[src/mapeo-project.js:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L54) + +___ + +### ElementOf + +Ƭ **ElementOf**\<`T`\>: `T` extends `Iterable`\ ? `U` : `never` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/roles.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L15) + +___ + +### GetMapeoDocTables + +Ƭ **GetMapeoDocTables**\<`T`\>: `T`[keyof `T` & [`MapeoDocTableName`](internal_.md#mapeodoctablename)] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/datatype/index.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L19) + +___ + +### IndexedDocIds + +Ƭ **IndexedDocIds**\<\>: \{ [K in MapeoDoc["schemaName"]]?: string[] } + +#### Defined in + +[src/index-writer/index.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L15) + +___ + +### InternalDriveEmitter + +Ƭ **InternalDriveEmitter**\<\>: `TypedEmitter`\<\{ `add-drive`: (`drive`: [`"hyperdrive"`](internal_._hyperdrive_.md)) => `void` }\> + +#### Defined in + +[src/blob-store/index.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L8) + +___ + +### InviteInternal + +Ƭ **InviteInternal**\<\>: `InviteRpcMessage` & \{ `receivedAt`: `number` } + +#### Defined in + +[src/invite-api.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L23) + +___ + +### KeyPair + +Ƭ **KeyPair**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `publicKey` | [`PublicKey`](internal_.md#publickey) | +| `secretKey` | [`SecretKey`](internal_.md#secretkey) | + +#### Defined in + +[src/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L97) + +___ + +### Keypair + +Ƭ **Keypair**\<\>: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `publicKey` | `Buffer` | +| `secretKey` | `Buffer` | + +#### Defined in + +[src/discovery/local-discovery.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L13) + +___ + +### MapBuffers + +Ƭ **MapBuffers**\<`T`\>: \{ [K in keyof T]: T[K] extends Buffer ? string : T[K] } + +Replace an object's `Buffer` values with `string`s. Useful for serialization. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types.ts:86](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L86) + +___ + +### MapeoDocMap + +Ƭ **MapeoDocMap**: \{ [K in MapeoDoc["schemaName"]]: Extract\ } + +#### Defined in + +[src/types.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L46) + +___ + +### MapeoDocTableName + +Ƭ **MapeoDocTableName**: \`$\{MapeoDoc["schemaName"]}Table\` + +#### Defined in + +[src/datatype/index.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L18) + +___ + +### MapeoDocTables + +Ƭ **MapeoDocTables**: [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/szgy/src/dd/mapeo-core-next/src/schema/project"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md)\> \| [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/szgy/src/dd/mapeo-core-next/src/schema/client"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md)\> + +Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables) + +#### Defined in + +[src/datatype/index.d.ts:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L21) + +___ + +### MapeoValueMap + +Ƭ **MapeoValueMap**: \{ [K in MapeoValue["schemaName"]]: Extract\ } + +#### Defined in + +[src/types.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L50) + +___ + +### Namespace + +Ƭ **Namespace**\<\>: typeof [`NAMESPACES`](internal_.md#namespaces)[`number`] + +#### Defined in + +[src/core-manager/index.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L20) + +___ + +### NamespaceSchemas + +Ƭ **NamespaceSchemas**\<\>: typeof [`NAMESPACE_SCHEMAS`](internal_.md#namespace_schemas) + +#### Defined in + +[src/datastore/index.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L44) + +___ + +### OpenedNoiseStream + +Ƭ **OpenedNoiseStream**\<`T`\>: `__module` & \{ `handshake`: `Buffer` ; `publicKey`: `Buffer` ; `remotePublicKey`: `Buffer` } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Duplex` \| `Duplex` = `Duplex` \| `Duplex` | + +#### Defined in + +[src/utils.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L47) + +___ + +### OpenedNoiseStream + +Ƭ **OpenedNoiseStream**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/utils"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) + +#### Defined in + +[src/discovery/local-discovery.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L14) + +___ + +### PeerCoreState + +Ƭ **PeerCoreState**\<\>: [`CoreState`](../interfaces/internal_.CoreState.md) & \{ `status`: ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` } + +#### Defined in + +[src/sync/core-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L28) + +___ + +### PeerInfoConnected + +Ƭ **PeerInfoConnected**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: [`Protomux`](../classes/internal_.Protomux.md)\<`__module`\> ; `status`: ``"connected"`` } + +#### Defined in + +[src/local-peers.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L47) + +___ + +### PeerInfoDisconnected + +Ƭ **PeerInfoDisconnected**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` } + +#### Defined in + +[src/local-peers.js:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L48) + +___ + +### Primitive + +Ƭ **Primitive**\<\>: `string` \| `number` \| `bigint` \| `boolean` \| `undefined` \| `symbol` \| ``null`` + +#### Defined in + +[src/lib/hashmap.js:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L3) + +___ + +### ProtocolStream + +Ƭ **ProtocolStream**: `Omit`\<`NoiseStream`, ``"userData"``\> & \{ `userData`: [`Protomux`](../classes/internal_.Protomux.md) } + +#### Defined in + +[src/types.ts:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L109) + +___ + +### PublicKey + +Ƭ **PublicKey**: `Buffer` + +32 byte buffer + +#### Defined in + +[src/types.ts:103](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L103) + +___ + +### PublicPeerInfo + +Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/local-peers"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md), ``"protomux"``\> + +#### Defined in + +[src/mapeo-manager.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L65) + +___ + +### Range + +Ƭ **Range**: \{ `end`: `number` ; `linear`: `boolean` ; `start`: `number` } \| \{ `blocks`: `number`[] } + +#### Defined in + +[types/hyperdrive.d.ts:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L12) + +___ + +### RemoveNull + +Ƭ **RemoveNull**\<`T`\>: \{ [K in keyof T]: Exclude\ } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L65) + +___ + +### ReplicationStream + +Ƭ **ReplicationStream**: `Duplex` & \{ `noiseStream`: [`ProtocolStream`](internal_.md#protocolstream) } + +#### Defined in + +[src/types.ts:112](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L112) + +___ + +### RoleId + +Ƭ **RoleId**\<\>: [`ElementOf`](internal_.md#elementof)\ + +#### Defined in + +[src/roles.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L19) + +___ + +### SecretKey + +Ƭ **SecretKey**: `Buffer` + +32 byte buffer + +#### Defined in + +[src/types.ts:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L105) + +___ + +### State + +Ƭ **State**\<\>: `Record`\<[`"/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md), [`"/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md)\> + +#### Defined in + +[src/sync/sync-state.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L12) + +___ + +### SupportedBlobVariants + +Ƭ **SupportedBlobVariants**: typeof [`SUPPORTED_BLOB_VARIANTS`](internal_.md#supported_blob_variants) + +#### Defined in + +[src/types.ts:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L16) + +___ + +### SyncCapability + +Ƭ **SyncCapability**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/roles"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md)[``"sync"``][[`Namespace`](internal_.md#namespace)] \| ``"unknown"`` + +#### Defined in + +[src/sync/peer-sync-controller.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L10) + +___ + +### SyncType + +Ƭ **SyncType**\<\>: ``"initial"`` \| ``"full"`` + +#### Defined in + +[src/sync/sync-api.js:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L16) + +## Variables + +### NAMESPACES + +• `Const` **NAMESPACES**: readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] + +#### Defined in + +[src/constants.js:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/constants.js#L3) + +___ + +### NAMESPACE\_SCHEMAS + +• `Const` **NAMESPACE\_SCHEMAS**: `Object` + +**`Template`** + +**`Template`** + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `auth` | readonly [``"coreOwnership"``, ``"role"``] | +| `config` | readonly [``"translation"``, ``"preset"``, ``"field"``, ``"projectSettings"``, ``"deviceInfo"``, ``"icon"``] | +| `data` | readonly [``"observation"``, ``"track"``] | + +#### Defined in + +[src/datastore/index.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L30) + +___ + +### ROLE\_IDS + +• `Const` **ROLE\_IDS**: `Set`\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> + +#### Defined in + +[src/roles.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L20) + +___ + +### ROLE\_IDS\_ASSIGNABLE\_TO\_ANYONE + +• `Const` **ROLE\_IDS\_ASSIGNABLE\_TO\_ANYONE**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"``\> + +#### Defined in + +[src/roles.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L45) + +___ + +### ROLE\_IDS\_ASSIGNABLE\_TO\_OTHERS + +• `Const` **ROLE\_IDS\_ASSIGNABLE\_TO\_OTHERS**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``\> + +#### Defined in + +[src/roles.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L39) + +___ + +### ROLE\_IDS\_FOR\_NEW\_INVITE + +• `Const` **ROLE\_IDS\_FOR\_NEW\_INVITE**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``\> + +#### Defined in + +[src/roles.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L33) + +___ + +### SUPPORTED\_BLOB\_VARIANTS + +• `Const` **SUPPORTED\_BLOB\_VARIANTS**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `audio` | readonly [``"original"``] | +| `photo` | readonly [``"original"``, ``"preview"``, ``"thumbnail"``] | +| `video` | readonly [``"original"``] | + +#### Defined in + +[src/blob-store/index.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L13) diff --git a/package-lock.json b/package-lock.json index 11cbe72d0..c26b07331 100644 --- a/package-lock.json +++ b/package-lock.json @@ -103,6 +103,7 @@ "ts-proto": "^1.156.7", "typedoc": "^0.25.13", "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-missing-exports": "^2.2.0", "typescript": "^5.4.5" } }, @@ -8842,6 +8843,15 @@ "typedoc": ">=0.24.0" } }, + "node_modules/typedoc-plugin-missing-exports": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-2.2.0.tgz", + "integrity": "sha512-2+XR1IcyQ5UwXZVJe9NE6HrLmNufT9i5OwoIuuj79VxuA3eYq+Y6itS9rnNV1D7UeQnUSH8kISYD73gHE5zw+w==", + "dev": true, + "peerDependencies": { + "typedoc": "0.24.x || 0.25.x" + } + }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", diff --git a/package.json b/package.json index 3618248c2..80acf2881 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,8 @@ "build:types": "tsc -p tsconfig.npm.json && cpy 'src/**/*.d.ts' dist", "bench": "nanobench benchmarks/*.js", "type": "tsc", - "doc": "rimraf docs/api/md && typedoc --plugin typedoc-plugin-markdown --out docs/api/md", - "doc:publish": "rimraf docs/api/html && typedoc --out docs/api/html", + "doc": "rimraf docs/api/md && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-missing-exports --out docs/api/md", + "doc:publish": "rimraf docs/api/html && typedoc --plugin typedoc-plugin-missing-exports --out docs/api/html", "protobuf": "node ./scripts/build-messages.js", "db:generate:project": "drizzle-kit generate:sqlite --schema src/schema/project.js --out drizzle/project", "db:generate:client": "drizzle-kit generate:sqlite --schema src/schema/client.js --out drizzle/client", @@ -142,6 +142,7 @@ "ts-proto": "^1.156.7", "typedoc": "^0.25.13", "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-missing-exports": "^2.2.0", "typescript": "^5.4.5" }, "dependencies": { From b28237f43012597c7d6d1389c96a3b94f78de607 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Mon, 13 May 2024 16:14:25 -0300 Subject: [PATCH 13/28] disable sources --- docs/api/md/README.md | 12 - docs/api/md/classes/FastifyController.md | 16 -- docs/api/md/classes/MapeoManager.md | 68 ------ .../md/classes/internal_.BigSparseArray.md | 16 -- docs/api/md/classes/internal_.BlobApi.md | 12 - .../md/classes/internal_.BlobReadStream.md | 4 - docs/api/md/classes/internal_.BlobStore.md | 44 ---- .../md/classes/internal_.BlobWriteStream.md | 4 - docs/api/md/classes/internal_.CoreIndex.md | 24 -- docs/api/md/classes/internal_.CoreManager.md | 56 ----- .../api/md/classes/internal_.CoreOwnership.md | 12 - .../api/md/classes/internal_.CoreSyncState.md | 24 -- docs/api/md/classes/internal_.Corestore.md | 40 ---- docs/api/md/classes/internal_.DataStore.md | 44 ---- docs/api/md/classes/internal_.DataType.md | 44 ---- docs/api/md/classes/internal_.DenseIndex.md | 28 --- .../md/classes/internal_.DriveLiveDownload.md | 8 - docs/api/md/classes/internal_.Hyperblobs-1.md | 40 ---- docs/api/md/classes/internal_.Hyperdrive-1.md | 120 ---------- docs/api/md/classes/internal_.IconApi.md | 16 -- docs/api/md/classes/internal_.Index.md | 28 --- docs/api/md/classes/internal_.IndexWriter.md | 12 - docs/api/md/classes/internal_.InviteApi.md | 20 -- docs/api/md/classes/internal_.LiveDownload.md | 8 - .../md/classes/internal_.LocalDiscovery.md | 24 -- docs/api/md/classes/internal_.LocalPeers.md | 36 --- docs/api/md/classes/internal_.Logger.md | 24 -- docs/api/md/classes/internal_.MapeoProject.md | 100 -------- docs/api/md/classes/internal_.MemberApi.md | 24 -- docs/api/md/classes/internal_.Peer.md | 52 ----- .../classes/internal_.PeerSyncController.md | 28 --- .../md/classes/internal_.PendingInvites.md | 32 --- docs/api/md/classes/internal_.Protomux.md | 48 ---- .../classes/internal_.RemoteBitfieldPage.md | 48 ---- .../internal_.RemoteBitfieldSegment.md | 48 ---- docs/api/md/classes/internal_.Roles.md | 20 -- docs/api/md/classes/internal_.SparseIndex.md | 32 --- docs/api/md/classes/internal_.SyncApi.md | 28 --- docs/api/md/classes/internal_.SyncState.md | 12 - .../classes/internal_.TrackedKeyRequests.md | 20 -- ..._src_local_peers_.PeerDisconnectedError.md | 8 - ..._local_peers_.PeerFailedConnectionError.md | 8 - ..._next_src_local_peers_.UnknownPeerError.md | 8 - ...amespace_sync_state_.NamespaceSyncState.md | 16 -- ...ore_next_src_utils_.ExhaustivenessError.md | 8 - docs/api/md/classes/internal_.default-1.md | 28 --- docs/api/md/classes/internal_.default-2.md | 66 ------ docs/api/md/classes/internal_.default.md | 24 -- .../api/md/interfaces/internal_.BitmapOpts.md | 12 - .../interfaces/internal_.BlobDownloadState.md | 24 -- docs/api/md/interfaces/internal_.Channel.md | 48 ---- docs/api/md/interfaces/internal_.CoreState.md | 16 -- .../interfaces/internal_.CorestoreEvents.md | 8 - .../md/interfaces/internal_.DataTypeEvents.md | 4 - .../md/interfaces/internal_.DocCapability.md | 16 -- docs/api/md/interfaces/internal_.Encoding.md | 12 - .../md/interfaces/internal_.EncodingState.md | 12 - docs/api/md/interfaces/internal_.HaveMsg.md | 16 -- .../interfaces/internal_.Hyperblobs.BlobId.md | 16 -- .../internal_.Hyperdrive.HyperdriveEntry.md | 12 - .../interfaces/internal_.HyperdriveEvents.md | 16 -- .../interfaces/internal_.HyperdriveGetOpts.md | 8 - .../interfaces/internal_.HyperdriveOptions.md | 4 - .../md/interfaces/internal_.MapsPluginOpts.md | 8 - .../api/md/interfaces/internal_.MemberInfo.md | 16 -- docs/api/md/interfaces/internal_.Message.md | 16 -- .../internal_.OfflineFallbackMapPluginOpts.md | 12 - .../md/interfaces/internal_.PeerInfoBase.md | 12 - .../md/interfaces/internal_.PendingInvite.md | 12 - .../interfaces/internal_.PreEncodingState.md | 12 - docs/api/md/interfaces/internal_.Role.md | 20 -- docs/api/md/interfaces/internal_.StartOpts.md | 8 - docs/api/md/interfaces/internal_.State.md | 12 - .../internal_.StaticMapsPluginOpts.md | 8 - docs/api/md/interfaces/internal_.SvgOpts.md | 8 - .../md/interfaces/internal_.SyncTypeState.md | 24 -- ...ore_next_src_core_manager_index_.Events.md | 8 - ..._next_src_local_peers_.LocalPeersEvents.md | 32 --- ...ore_next_src_schema_client_.ProjectInfo.md | 4 - ..._src_sync_core_sync_state_.DerivedState.md | 12 - ...src_sync_core_sync_state_.InternalState.md | 20 -- ...mapeo_core_next_src_core_manager_index_.md | 8 - ...dd_mapeo_core_next_src_datastore_index_.md | 12 - ...src_dd_mapeo_core_next_src_local_peers_.md | 20 -- ..._szgy_src_dd_mapeo_core_next_src_roles_.md | 56 ----- ...c_dd_mapeo_core_next_src_schema_client_.md | 16 -- ..._dd_mapeo_core_next_src_schema_project_.md | 76 ------ ...peo_core_next_src_sync_core_sync_state_.md | 12 - ...ore_next_src_sync_namespace_sync_state_.md | 12 - ..._szgy_src_dd_mapeo_core_next_src_utils_.md | 68 ------ docs/api/md/modules/internal_.md | 220 ------------------ typedoc.json | 3 +- 92 files changed, 2 insertions(+), 2411 deletions(-) diff --git a/docs/api/md/README.md b/docs/api/md/README.md index 6fa438acf..0a40085a5 100644 --- a/docs/api/md/README.md +++ b/docs/api/md/README.md @@ -36,10 +36,6 @@ API `Promise`\<`void`\> -#### Defined in - -[src/fastify-plugins/maps/index.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L30) - ___ ### MapeoOfflineFallbackMapFastifyPlugin @@ -57,10 +53,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L14) - ___ ### MapeoStaticMapsFastifyPlugin @@ -77,7 +69,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L18) diff --git a/docs/api/md/classes/FastifyController.md b/docs/api/md/classes/FastifyController.md index f60eee9e7..08b12c9e4 100644 --- a/docs/api/md/classes/FastifyController.md +++ b/docs/api/md/classes/FastifyController.md @@ -31,10 +31,6 @@ [`FastifyController`](FastifyController.md) -#### Defined in - -[src/fastify-controller.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L21) - ## Methods ### start @@ -51,10 +47,6 @@ `Promise`\<`void`\> -#### Defined in - -[src/fastify-controller.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L73) - ___ ### started @@ -65,10 +57,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/fastify-controller.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L77) - ___ ### stop @@ -78,7 +66,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/fastify-controller.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L81) diff --git a/docs/api/md/classes/MapeoManager.md b/docs/api/md/classes/MapeoManager.md index 4b33e1d4c..58c47bd59 100644 --- a/docs/api/md/classes/MapeoManager.md +++ b/docs/api/md/classes/MapeoManager.md @@ -64,10 +64,6 @@ TypedEmitter.constructor -#### Defined in - -[src/mapeo-manager.js:110](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L110) - ## Accessors ### [kRPC] @@ -80,10 +76,6 @@ MapeoRPC instance, used for tests [`LocalPeers`](internal_.LocalPeers.md) -#### Defined in - -[src/mapeo-manager.js:201](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L201) - ___ ### deviceId @@ -94,10 +86,6 @@ ___ `string` -#### Defined in - -[src/mapeo-manager.js:205](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L205) - ___ ### invite @@ -108,10 +96,6 @@ ___ [`InviteApi`](internal_.InviteApi.md) -#### Defined in - -[src/mapeo-manager.js:731](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L731) - ## Methods ### [kManagerReplicate] @@ -134,10 +118,6 @@ connecting RPC, use project[kProjectReplication]. [`ReplicationStream`](../modules/internal_.md#replicationstream) -#### Defined in - -[src/mapeo-manager.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L218) - ___ ### addProject @@ -160,10 +140,6 @@ downloaded their proof of project membership and the project config. `Promise`\<`string`\> -#### Defined in - -[src/mapeo-manager.js:542](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L542) - ___ ### connectPeer @@ -183,10 +159,6 @@ ___ `void` -#### Defined in - -[src/mapeo-manager.js:746](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L746) - ___ ### createProject @@ -208,10 +180,6 @@ Create a new project. Project public id -#### Defined in - -[src/mapeo-manager.js:350](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L350) - ___ ### getDeviceInfo @@ -222,10 +190,6 @@ ___ \{ `deviceId`: `string` } & `Partial`\<[`DeviceInfoParam`](../modules/internal_.md#deviceinfoparam)\> -#### Defined in - -[src/mapeo-manager.js:719](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L719) - ___ ### getMapStyleJsonUrl @@ -236,10 +200,6 @@ ___ `Promise`\<`string`\> -#### Defined in - -[src/mapeo-manager.js:806](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L806) - ___ ### getProject @@ -256,10 +216,6 @@ ___ `Promise`\<[`MapeoProject`](internal_.MapeoProject.md)\> -#### Defined in - -[src/mapeo-manager.js:426](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L426) - ___ ### leaveProject @@ -276,10 +232,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/mapeo-manager.js:760](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L760) - ___ ### listLocalPeers @@ -290,10 +242,6 @@ ___ `Promise`\<[`PublicPeerInfo`](../modules/internal_.md#publicpeerinfo)[]\> -#### Defined in - -[src/mapeo-manager.js:753](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L753) - ___ ### listProjects @@ -304,10 +252,6 @@ ___ `Promise`\<`Pick`\<{}, ``"name"``\> & \{ `createdAt?`: `string` ; `projectId`: `string` ; `updatedAt?`: `string` }[]\> -#### Defined in - -[src/mapeo-manager.js:485](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L485) - ___ ### setDeviceInfo @@ -330,10 +274,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/mapeo-manager.js:686](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L686) - ___ ### startLocalPeerDiscoveryServer @@ -344,10 +284,6 @@ ___ `Promise`\<\{ `name`: `string` ; `port`: `number` }\> -#### Defined in - -[src/mapeo-manager.js:736](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L736) - ___ ### stopLocalPeerDiscoveryServer @@ -369,7 +305,3 @@ are force-closed after opts.timeout milliseconds #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/mapeo-manager.js:741](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L741) diff --git a/docs/api/md/classes/internal_.BigSparseArray.md b/docs/api/md/classes/internal_.BigSparseArray.md index 7aa3bb604..f05acfb14 100644 --- a/docs/api/md/classes/internal_.BigSparseArray.md +++ b/docs/api/md/classes/internal_.BigSparseArray.md @@ -41,20 +41,12 @@ [`BigSparseArray`](internal_.BigSparseArray.md)\<`T`\> -#### Defined in - -[types/big-sparse-array.d.ts:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L3) - ## Properties ### maxLength • `Readonly` **maxLength**: `number` -#### Defined in - -[types/big-sparse-array.d.ts:5](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L5) - ## Methods ### get @@ -71,10 +63,6 @@ `undefined` \| `T` -#### Defined in - -[types/big-sparse-array.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L9) - ___ ### set @@ -91,7 +79,3 @@ ___ #### Returns `T` - -#### Defined in - -[types/big-sparse-array.d.ts:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/big-sparse-array.d.ts#L7) diff --git a/docs/api/md/classes/internal_.BlobApi.md b/docs/api/md/classes/internal_.BlobApi.md index d7b1aaa4d..d1b55a0cb 100644 --- a/docs/api/md/classes/internal_.BlobApi.md +++ b/docs/api/md/classes/internal_.BlobApi.md @@ -33,10 +33,6 @@ [`BlobApi`](internal_.BlobApi.md) -#### Defined in - -[src/blob-api.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L18) - ## Methods ### create @@ -60,10 +56,6 @@ Write blobs for provided variants of a file `Promise`\<\{ `driveId`: `string` ; `hash`: `string` ; `name`: `string` ; `type`: ``"photo"`` \| ``"audio"`` \| ``"video"`` }\> -#### Defined in - -[src/blob-api.js:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L46) - ___ ### getUrl @@ -81,7 +73,3 @@ Get a url for a blob based on its BlobId #### Returns `Promise`\<`string`\> - -#### Defined in - -[src/blob-api.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-api.js#L28) diff --git a/docs/api/md/classes/internal_.BlobReadStream.md b/docs/api/md/classes/internal_.BlobReadStream.md index 20a4a87e8..3b89bf57e 100644 --- a/docs/api/md/classes/internal_.BlobReadStream.md +++ b/docs/api/md/classes/internal_.BlobReadStream.md @@ -35,7 +35,3 @@ #### Overrides Readable.constructor - -#### Defined in - -[types/hyperblobs.d.ts:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L17) diff --git a/docs/api/md/classes/internal_.BlobStore.md b/docs/api/md/classes/internal_.BlobStore.md index 7ce65f927..ec6d54419 100644 --- a/docs/api/md/classes/internal_.BlobStore.md +++ b/docs/api/md/classes/internal_.BlobStore.md @@ -43,10 +43,6 @@ [`BlobStore`](internal_.BlobStore.md) -#### Defined in - -[src/blob-store/index.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L45) - ## Accessors ### writerDriveId @@ -57,10 +53,6 @@ `string` -#### Defined in - -[src/blob-store/index.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L77) - ## Methods ### clear @@ -79,10 +71,6 @@ `Promise`\<``null`` \| \{ `blocks`: `number` }\> -#### Defined in - -[src/blob-store/index.js:234](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L234) - ___ ### createEntryReadStream @@ -105,10 +93,6 @@ previously read the entry from Hyperdrive using `drive.entry` `Promise`\<[`BlobReadStream`](internal_.BlobReadStream.md)\> -#### Defined in - -[src/blob-store/index.js:150](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L150) - ___ ### createReadStream @@ -128,10 +112,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[src/blob-store/index.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L130) - ___ ### createWriteStream @@ -150,10 +130,6 @@ ___ `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> & \{ `driveId`: `string` } -#### Defined in - -[src/blob-store/index.js:201](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L201) - ___ ### download @@ -181,10 +157,6 @@ specified, then _only_ blobs that match the filter will be downloaded. EventEmitter with `.state` propery, emits `state` with new state when it updates -#### Defined in - -[src/blob-store/index.js:117](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L117) - ___ ### entry @@ -205,10 +177,6 @@ ___ `Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> -#### Defined in - -[src/blob-store/index.js:217](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L217) - ___ ### get @@ -228,10 +196,6 @@ ___ `Promise`\<`Buffer`\> -#### Defined in - -[src/blob-store/index.js:96](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L96) - ___ ### getEntryBlob @@ -251,10 +215,6 @@ ___ `Promise`\<``null`` \| `Buffer`\> -#### Defined in - -[src/blob-store/index.js:170](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L170) - ___ ### put @@ -275,7 +235,3 @@ ___ `Promise`\<`string`\> discovery key as hex string of hyperdrive where blob is stored - -#### Defined in - -[src/blob-store/index.js:190](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L190) diff --git a/docs/api/md/classes/internal_.BlobWriteStream.md b/docs/api/md/classes/internal_.BlobWriteStream.md index 239063a8c..879c76328 100644 --- a/docs/api/md/classes/internal_.BlobWriteStream.md +++ b/docs/api/md/classes/internal_.BlobWriteStream.md @@ -35,7 +35,3 @@ #### Overrides Writable.constructor - -#### Defined in - -[types/hyperblobs.d.ts:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L14) diff --git a/docs/api/md/classes/internal_.CoreIndex.md b/docs/api/md/classes/internal_.CoreIndex.md index f830cbcf1..8d18f096a 100644 --- a/docs/api/md/classes/internal_.CoreIndex.md +++ b/docs/api/md/classes/internal_.CoreIndex.md @@ -41,10 +41,6 @@ An in-memory index of open cores. `IterableIterator`\<[`CoreRecord`](../modules/internal_.md#corerecord)\> -#### Defined in - -[src/core-manager/core-index.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L15) - ___ ### add @@ -68,10 +64,6 @@ core is ready, but we know it beforehand. `void` -#### Defined in - -[src/core-manager/core-index.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L29) - ___ ### getByCoreKey @@ -90,10 +82,6 @@ Get a core by its public key `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) -#### Defined in - -[src/core-manager/core-index.js:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L83) - ___ ### getByDiscoveryId @@ -112,10 +100,6 @@ Get a core by its discoveryId (discover key as hex string) `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) -#### Defined in - -[src/core-manager/core-index.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L73) - ___ ### getByNamespace @@ -134,10 +118,6 @@ Get all known cores in a namespace [`CoreRecord`](../modules/internal_.md#corerecord)[] -#### Defined in - -[src/core-manager/core-index.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L45) - ___ ### getWriter @@ -155,7 +135,3 @@ Get the write core for the given namespace #### Returns [`CoreRecord`](../modules/internal_.md#corerecord) - -#### Defined in - -[src/core-manager/core-index.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/core-index.js#L59) diff --git a/docs/api/md/classes/internal_.CoreManager.md b/docs/api/md/classes/internal_.CoreManager.md index 5549be2e5..acc31587c 100644 --- a/docs/api/md/classes/internal_.CoreManager.md +++ b/docs/api/md/classes/internal_.CoreManager.md @@ -63,10 +63,6 @@ TypedEmitter.constructor -#### Defined in - -[src/core-manager/index.js:70](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L70) - ## Accessors ### creatorCore @@ -77,10 +73,6 @@ TypedEmitter.constructor `Hypercore`\<``"binary"``, `Buffer`\> -#### Defined in - -[src/core-manager/index.js:191](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L191) - ___ ### deviceId @@ -91,10 +83,6 @@ ___ `string` -#### Defined in - -[src/core-manager/index.js:187](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L187) - ___ ### namespaces @@ -105,10 +93,6 @@ ___ readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] -#### Defined in - -[src/core-manager/index.js:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L55) - ## Methods ### [kCoreManagerReplicate] @@ -128,10 +112,6 @@ Replicate all cores in core manager [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> -#### Defined in - -[src/core-manager/index.js:482](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L482) - ___ ### addCore @@ -151,10 +131,6 @@ Add a core to the manager (will be persisted across restarts) [`CoreRecord`](../modules/internal_.md#corerecord) -#### Defined in - -[src/core-manager/index.js:268](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L268) - ___ ### close @@ -168,10 +144,6 @@ TODO: gracefully close replication streams `Promise`\<`void`\> -#### Defined in - -[src/core-manager/index.js:250](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L250) - ___ ### deleteOthersData @@ -188,10 +160,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/core-manager/index.js:501](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L501) - ___ ### getCoreByDiscoveryKey @@ -210,10 +178,6 @@ Get a core by its discovery key `undefined` \| [`CoreRecord`](../modules/internal_.md#corerecord) -#### Defined in - -[src/core-manager/index.js:239](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L239) - ___ ### getCoreByKey @@ -232,10 +196,6 @@ Get a core by its public key `undefined` \| `Hypercore`\<``"binary"``, `Buffer`\> -#### Defined in - -[src/core-manager/index.js:228](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L228) - ___ ### getCores @@ -254,10 +214,6 @@ Get an array of all cores in the given namespace [`CoreRecord`](../modules/internal_.md#corerecord)[] -#### Defined in - -[src/core-manager/index.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L218) - ___ ### getWriterCore @@ -276,10 +232,6 @@ Get the writer core for the given namespace [`CoreRecord`](../modules/internal_.md#corerecord) -#### Defined in - -[src/core-manager/index.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L209) - ___ ### ready @@ -292,10 +244,6 @@ Resolves when all cores have finished loading `Promise`\<`void`\> -#### Defined in - -[src/core-manager/index.js:200](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L200) - ___ ### requestCoreKey @@ -315,7 +263,3 @@ requesting a core key for the given discovery key. #### Returns `void` - -#### Defined in - -[src/core-manager/index.js:366](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L366) diff --git a/docs/api/md/classes/internal_.CoreOwnership.md b/docs/api/md/classes/internal_.CoreOwnership.md index 3bf97dfec..72c06781d 100644 --- a/docs/api/md/classes/internal_.CoreOwnership.md +++ b/docs/api/md/classes/internal_.CoreOwnership.md @@ -34,10 +34,6 @@ [`CoreOwnership`](internal_.CoreOwnership.md) -#### Defined in - -[src/core-ownership.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L33) - ## Methods ### getCoreId @@ -57,10 +53,6 @@ coreId of core belonging to `deviceId` for `namespace` -#### Defined in - -[src/core-ownership.js:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L83) - ___ ### getOwner @@ -78,7 +70,3 @@ ___ `Promise`\<`string`\> deviceId of device that owns the core - -#### Defined in - -[src/core-ownership.js:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-ownership.js#L60) diff --git a/docs/api/md/classes/internal_.CoreSyncState.md b/docs/api/md/classes/internal_.CoreSyncState.md index da6aef378..fdb553d7e 100644 --- a/docs/api/md/classes/internal_.CoreSyncState.md +++ b/docs/api/md/classes/internal_.CoreSyncState.md @@ -52,10 +52,6 @@ Each peer (including the local peer) has a state of: [`CoreSyncState`](internal_.CoreSyncState.md) -#### Defined in - -[src/sync/core-sync-state.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L74) - ## Methods ### addPeer @@ -72,10 +68,6 @@ Each peer (including the local peer) has a state of: `void` -#### Defined in - -[src/sync/core-sync-state.js:176](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L176) - ___ ### attachCore @@ -96,10 +88,6 @@ before we have the core key that allows us to create a core instance. `void` -#### Defined in - -[src/sync/core-sync-state.js:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L105) - ___ ### getState @@ -110,10 +98,6 @@ ___ [`DerivedState`](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) -#### Defined in - -[src/sync/core-sync-state.js:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L85) - ___ ### insertPreHaves @@ -136,10 +120,6 @@ peer before the peer actually starts syncing this core `void` -#### Defined in - -[src/sync/core-sync-state.js:147](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L147) - ___ ### setPeerWants @@ -160,7 +140,3 @@ blocks/ranges that are added here #### Returns `void` - -#### Defined in - -[src/sync/core-sync-state.js:165](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L165) diff --git a/docs/api/md/classes/internal_.Corestore.md b/docs/api/md/classes/internal_.Corestore.md index 4b6a91694..5d5f382fe 100644 --- a/docs/api/md/classes/internal_.Corestore.md +++ b/docs/api/md/classes/internal_.Corestore.md @@ -51,20 +51,12 @@ TypedEmitter\<CorestoreEvents\>.constructor -#### Defined in - -[types/corestore.d.ts:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L15) - ## Properties ### cores • **cores**: `Map`\<`string`, `Hypercore`\<`ValueEncoding`, `Buffer`\>\> -#### Defined in - -[types/corestore.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L37) - ___ ### replicate @@ -99,10 +91,6 @@ ___ [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> -#### Defined in - -[types/corestore.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L33) - ## Methods ### close @@ -113,10 +101,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[types/corestore.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L36) - ___ ### get @@ -133,10 +117,6 @@ ___ `Hypercore`\<`ValueEncoding`, `Buffer`\> -#### Defined in - -[types/corestore.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L19) - ▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> #### Parameters @@ -149,10 +129,6 @@ ___ `Hypercore`\<`ValueEncoding`, `Buffer`\> -#### Defined in - -[types/corestore.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L20) - ▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> #### Parameters @@ -165,10 +141,6 @@ ___ `Hypercore`\<`ValueEncoding`, `Buffer`\> -#### Defined in - -[types/corestore.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L23) - ▸ **get**(`options`): `Hypercore`\<`ValueEncoding`, `Buffer`\> #### Parameters @@ -181,10 +153,6 @@ ___ `Hypercore`\<`ValueEncoding`, `Buffer`\> -#### Defined in - -[types/corestore.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L26) - ___ ### namespace @@ -201,10 +169,6 @@ ___ [`Corestore`](internal_.Corestore.md) -#### Defined in - -[types/corestore.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L34) - ___ ### ready @@ -214,7 +178,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[types/corestore.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L35) diff --git a/docs/api/md/classes/internal_.DataStore.md b/docs/api/md/classes/internal_.DataStore.md index 27e283679..33247b663 100644 --- a/docs/api/md/classes/internal_.DataStore.md +++ b/docs/api/md/classes/internal_.DataStore.md @@ -70,10 +70,6 @@ TypedEmitter.constructor -#### Defined in - -[src/datastore/index.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L72) - ## Accessors ### indexer @@ -84,10 +80,6 @@ TypedEmitter.constructor `MultiCoreIndexer`\<``"binary"``\> -#### Defined in - -[src/datastore/index.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L94) - ___ ### namespace @@ -98,10 +90,6 @@ ___ `TNamespace` -#### Defined in - -[src/datastore/index.js:98](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L98) - ___ ### schemas @@ -112,10 +100,6 @@ ___ (``"track"`` \| ``"observation"``)[] \| (``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``)[] \| (``"role"`` \| ``"coreOwnership"``)[] -#### Defined in - -[src/datastore/index.js:102](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L102) - ___ ### writerCore @@ -126,10 +110,6 @@ ___ `Hypercore`\<``"binary"``, `Buffer`\> -#### Defined in - -[src/datastore/index.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L107) - ## Methods ### close @@ -140,10 +120,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/datastore/index.js:229](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L229) - ___ ### getIndexState @@ -154,10 +130,6 @@ ___ `IndexState` -#### Defined in - -[src/datastore/index.js:111](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L111) - ___ ### read @@ -174,10 +146,6 @@ ___ `Promise`\<`MapeoDoc`\> -#### Defined in - -[src/datastore/index.js:198](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L198) - ___ ### readRaw @@ -194,10 +162,6 @@ ___ `Promise`\<`Buffer`\> -#### Defined in - -[src/datastore/index.js:220](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L220) - ___ ### write @@ -226,10 +190,6 @@ this DataStore. `Promise`\<`Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\> \| `Extract`\<{}, `TDoc`\>\> -#### Defined in - -[src/datastore/index.js:157](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L157) - ___ ### writeRaw @@ -245,7 +205,3 @@ ___ #### Returns `Promise`\<`string`\> - -#### Defined in - -[src/datastore/index.js:208](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L208) diff --git a/docs/api/md/classes/internal_.DataType.md b/docs/api/md/classes/internal_.DataType.md index 8aee943c1..4ed90b624 100644 --- a/docs/api/md/classes/internal_.DataType.md +++ b/docs/api/md/classes/internal_.DataType.md @@ -77,10 +77,6 @@ TypedEmitter\<DataTypeEvents\<TDoc\>\>.constructor -#### Defined in - -[src/datatype/index.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L51) - ## Accessors ### [kTable] @@ -91,10 +87,6 @@ TypedEmitter\<DataTypeEvents\<TDoc\>\>.constructor `TTable` -#### Defined in - -[src/datatype/index.d.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L65) - ___ ### writerCore @@ -105,10 +97,6 @@ ___ `Hypercore`\<``"binary"``, `Buffer`\> -#### Defined in - -[src/datatype/index.d.ts:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L67) - ## Methods ### [kCreateWithDocId] @@ -126,10 +114,6 @@ ___ `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> -#### Defined in - -[src/datatype/index.d.ts:69](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L69) - ___ ### [kSelect] @@ -140,10 +124,6 @@ ___ `Promise`\<`any`\> -#### Defined in - -[src/datatype/index.d.ts:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L76) - ___ ### create @@ -166,10 +146,6 @@ ___ `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> -#### Defined in - -[src/datatype/index.d.ts:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L78) - ___ ### delete @@ -186,10 +162,6 @@ ___ `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> -#### Defined in - -[src/datatype/index.d.ts:104](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L104) - ___ ### getByDocId @@ -208,10 +180,6 @@ ___ `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> -#### Defined in - -[src/datatype/index.d.ts:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L85) - ___ ### getByVersionId @@ -230,10 +198,6 @@ ___ `Promise`\<`TDoc`\> -#### Defined in - -[src/datatype/index.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L90) - ___ ### getMany @@ -252,10 +216,6 @@ ___ `Promise`\<`TDoc` & \{ `forks`: `string`[] }[]\> -#### Defined in - -[src/datatype/index.d.ts:92](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L92) - ___ ### update @@ -278,7 +238,3 @@ ___ #### Returns `Promise`\<`TDoc` & \{ `forks`: `string`[] }\> - -#### Defined in - -[src/datatype/index.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L97) diff --git a/docs/api/md/classes/internal_.DenseIndex.md b/docs/api/md/classes/internal_.DenseIndex.md index 3f1ac7f78..dc1ed8c08 100644 --- a/docs/api/md/classes/internal_.DenseIndex.md +++ b/docs/api/md/classes/internal_.DenseIndex.md @@ -48,10 +48,6 @@ [Index](internal_.Index.md).[constructor](internal_.Index.md#constructor) -#### Defined in - -[types/quickbit-universal.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L33) - ## Properties ### byteLength @@ -62,10 +58,6 @@ [Index](internal_.Index.md).[byteLength](internal_.Index.md#bytelength) -#### Defined in - -[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) - ## Methods ### skipFirst @@ -87,10 +79,6 @@ [Index](internal_.Index.md).[skipFirst](internal_.Index.md#skipfirst) -#### Defined in - -[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) - ___ ### skipLast @@ -112,10 +100,6 @@ ___ [Index](internal_.Index.md).[skipLast](internal_.Index.md#skiplast) -#### Defined in - -[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) - ___ ### update @@ -136,10 +120,6 @@ ___ [Index](internal_.Index.md).[update](internal_.Index.md#update) -#### Defined in - -[types/quickbit-universal.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L34) - ___ ### from @@ -161,10 +141,6 @@ ___ [Index](internal_.Index.md).[from](internal_.Index.md#from) -#### Defined in - -[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) - ▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) #### Parameters @@ -181,7 +157,3 @@ ___ #### Inherited from [Index](internal_.Index.md).[from](internal_.Index.md#from) - -#### Defined in - -[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.DriveLiveDownload.md b/docs/api/md/classes/internal_.DriveLiveDownload.md index 88ef60485..803f19dc8 100644 --- a/docs/api/md/classes/internal_.DriveLiveDownload.md +++ b/docs/api/md/classes/internal_.DriveLiveDownload.md @@ -47,10 +47,6 @@ Like drive.download() but 'live', TypedEmitter.constructor -#### Defined in - -[src/blob-store/live-download.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L107) - ## Accessors ### state @@ -60,7 +56,3 @@ TypedEmitter.constructor #### Returns [`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) - -#### Defined in - -[src/blob-store/live-download.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L129) diff --git a/docs/api/md/classes/internal_.Hyperblobs-1.md b/docs/api/md/classes/internal_.Hyperblobs-1.md index 2b79b1d67..95455f919 100644 --- a/docs/api/md/classes/internal_.Hyperblobs-1.md +++ b/docs/api/md/classes/internal_.Hyperblobs-1.md @@ -46,30 +46,18 @@ [`Hyperblobs`](internal_.Hyperblobs-1.md) -#### Defined in - -[types/hyperblobs.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L33) - ## Properties ### blockSize • `Readonly` **blockSize**: `number` -#### Defined in - -[types/hyperblobs.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L31) - ___ ### core • `Readonly` **core**: `Hypercore`\<``"binary"``, `undefined`\> -#### Defined in - -[types/hyperblobs.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L30) - ## Accessors ### feed @@ -80,10 +68,6 @@ ___ `Hypercore`\<``"binary"``, `undefined`\> -#### Defined in - -[types/hyperblobs.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L35) - ___ ### locked @@ -94,10 +78,6 @@ ___ `boolean` -#### Defined in - -[types/hyperblobs.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L37) - ## Methods ### clear @@ -116,10 +96,6 @@ ___ `Promise`\<``null`` \| \{ `blocks`: `number` }\> -#### Defined in - -[types/hyperblobs.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L59) - ___ ### createReadStream @@ -137,10 +113,6 @@ ___ [`BlobReadStream`](internal_.BlobReadStream.md) -#### Defined in - -[types/hyperblobs.d.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L65) - ___ ### createWriteStream @@ -157,10 +129,6 @@ ___ [`BlobWriteStream`](internal_.BlobWriteStream.md) -#### Defined in - -[types/hyperblobs.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L64) - ___ ### get @@ -178,10 +146,6 @@ ___ `Promise`\<``null`` \| `Buffer`\> -#### Defined in - -[types/hyperblobs.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L50) - ___ ### put @@ -203,7 +167,3 @@ ___ #### Returns `Promise`\<[`BlobId`](../interfaces/internal_.Hyperblobs.BlobId.md)\> - -#### Defined in - -[types/hyperblobs.d.ts:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L39) diff --git a/docs/api/md/classes/internal_.Hyperdrive-1.md b/docs/api/md/classes/internal_.Hyperdrive-1.md index 1c7dab850..ebdc41f9f 100644 --- a/docs/api/md/classes/internal_.Hyperdrive-1.md +++ b/docs/api/md/classes/internal_.Hyperdrive-1.md @@ -72,10 +72,6 @@ TypedEmitter\<HyperdriveEvents\>.constructor -#### Defined in - -[types/hyperdrive.d.ts:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L48) - • **new Hyperdrive**(`corestore`, `opts?`): [`Hyperdrive`](internal_.Hyperdrive-1.md) #### Parameters @@ -93,90 +89,54 @@ TypedEmitter\<HyperdriveEvents\>.constructor TypedEmitter\<HyperdriveEvents\>.constructor -#### Defined in - -[types/hyperdrive.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L53) - ## Properties ### blobs • `Readonly` **blobs**: ``null`` \| [`Hyperblobs`](internal_.Hyperblobs-1.md) -#### Defined in - -[types/hyperdrive.d.ts:56](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L56) - ___ ### contentKey • `Readonly` **contentKey**: ``null`` \| `Buffer` -#### Defined in - -[types/hyperdrive.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L59) - ___ ### core • `Readonly` **core**: `Hypercore`\<``"binary"``, `undefined`\> -#### Defined in - -[types/hyperdrive.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L55) - ___ ### db • `Readonly` **db**: `any` -#### Defined in - -[types/hyperdrive.d.ts:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L60) - ___ ### discoveryKey • `Readonly` **discoveryKey**: ``null`` \| `Buffer` -#### Defined in - -[types/hyperdrive.d.ts:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L58) - ___ ### id • `Readonly` **id**: ``null`` \| `string` -#### Defined in - -[types/hyperdrive.d.ts:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L54) - ___ ### key • `Readonly` **key**: ``null`` \| `Buffer` -#### Defined in - -[types/hyperdrive.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L57) - ___ ### version • `Readonly` **version**: `number` -#### Defined in - -[types/hyperdrive.d.ts:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L61) - ## Methods ### batch @@ -187,10 +147,6 @@ ___ `any` -#### Defined in - -[types/hyperdrive.d.ts:99](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L99) - ___ ### checkout @@ -207,10 +163,6 @@ ___ [`Hyperdrive`](internal_.Hyperdrive-1.md) -#### Defined in - -[types/hyperdrive.d.ts:88](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L88) - ___ ### clear @@ -229,10 +181,6 @@ ___ `Promise`\<``null`` \| \{ `blocks`: `number` }\> -#### Defined in - -[types/hyperdrive.d.ts:100](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L100) - ___ ### createReadStream @@ -254,10 +202,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:64](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L64) - ___ ### createWriteStream @@ -277,10 +221,6 @@ ___ `Writable`\<`any`, `any`, `any`, ``false``, ``true``, `WritableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:83](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L83) - ___ ### del @@ -297,10 +237,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[types/hyperdrive.d.ts:87](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L87) - ___ ### diff @@ -319,10 +255,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:89](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L89) - ___ ### download @@ -341,10 +273,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:96](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L96) - ___ ### downloadDiff @@ -363,10 +291,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L90) - ___ ### downloadRange @@ -389,10 +313,6 @@ ___ | `destroy` | () => `void` | | `done` | `Promise`\<`void`\> | -#### Defined in - -[types/hyperdrive.d.ts:91](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L91) - ___ ### entries @@ -409,10 +329,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L77) - ___ ### entry @@ -430,10 +346,6 @@ ___ `Promise`\<``null`` \| [`HyperdriveEntry`](../interfaces/internal_.Hyperdrive.HyperdriveEntry.md)\> -#### Defined in - -[types/hyperdrive.d.ts:68](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L68) - ___ ### get @@ -451,10 +363,6 @@ ___ `Promise`\<``null`` \| `Buffer`\> -#### Defined in - -[types/hyperdrive.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L73) - ___ ### getBlobs @@ -465,10 +373,6 @@ ___ `Promise`\<``null`` \| [`Hyperblobs`](internal_.Hyperblobs-1.md)\> -#### Defined in - -[types/hyperdrive.d.ts:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L72) - ___ ### list @@ -487,10 +391,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:95](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L95) - ___ ### mirror @@ -501,10 +401,6 @@ ___ `any` -#### Defined in - -[types/hyperdrive.d.ts:98](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L98) - ___ ### put @@ -525,10 +421,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[types/hyperdrive.d.ts:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L78) - ___ ### readdir @@ -545,10 +437,6 @@ ___ `Readable`\<`any`, `any`, `any`, ``true``, ``false``, `ReadableEvents`\<`any`\>\> -#### Defined in - -[types/hyperdrive.d.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L97) - ___ ### ready @@ -559,10 +447,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[types/hyperdrive.d.ts:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L62) - ___ ### update @@ -579,7 +463,3 @@ ___ #### Returns `Promise`\<`Boolean`\> - -#### Defined in - -[types/hyperdrive.d.ts:63](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L63) diff --git a/docs/api/md/classes/internal_.IconApi.md b/docs/api/md/classes/internal_.IconApi.md index 62bd85030..6475e25eb 100644 --- a/docs/api/md/classes/internal_.IconApi.md +++ b/docs/api/md/classes/internal_.IconApi.md @@ -35,10 +35,6 @@ [`IconApi`](internal_.IconApi.md) -#### Defined in - -[src/icon-api.js:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L40) - ## Methods ### [kGetIconBlob] @@ -56,10 +52,6 @@ `Promise`\<`Buffer`\> -#### Defined in - -[src/icon-api.js:80](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L80) - ___ ### create @@ -78,10 +70,6 @@ ___ `Promise`\<`string`\> -#### Defined in - -[src/icon-api.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L53) - ___ ### getIconUrl @@ -98,7 +86,3 @@ ___ #### Returns `Promise`\<`string`\> - -#### Defined in - -[src/icon-api.js:93](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L93) diff --git a/docs/api/md/classes/internal_.Index.md b/docs/api/md/classes/internal_.Index.md index 217a3d55b..941d144f7 100644 --- a/docs/api/md/classes/internal_.Index.md +++ b/docs/api/md/classes/internal_.Index.md @@ -45,20 +45,12 @@ [`Index`](internal_.Index.md) -#### Defined in - -[types/quickbit-universal.d.ts:49](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L49) - ## Properties ### byteLength • `Readonly` **byteLength**: `number` -#### Defined in - -[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) - ## Methods ### skipFirst @@ -76,10 +68,6 @@ `number` -#### Defined in - -[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) - ___ ### skipLast @@ -97,10 +85,6 @@ ___ `number` -#### Defined in - -[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) - ___ ### update @@ -117,10 +101,6 @@ ___ `boolean` -#### Defined in - -[types/quickbit-universal.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L53) - ___ ### from @@ -138,10 +118,6 @@ ___ [`DenseIndex`](internal_.DenseIndex.md) -#### Defined in - -[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) - ▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) #### Parameters @@ -154,7 +130,3 @@ ___ #### Returns [`SparseIndex`](internal_.SparseIndex.md) - -#### Defined in - -[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.IndexWriter.md b/docs/api/md/classes/internal_.IndexWriter.md index 450d7e5b6..045b32be8 100644 --- a/docs/api/md/classes/internal_.IndexWriter.md +++ b/docs/api/md/classes/internal_.IndexWriter.md @@ -51,10 +51,6 @@ [`IndexWriter`](internal_.IndexWriter.md)\<`TTables`\> -#### Defined in - -[src/index-writer/index.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L38) - ## Accessors ### schemas @@ -65,10 +61,6 @@ `TTables`[``"_"``][``"name"``][] -#### Defined in - -[src/index-writer/index.js:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L55) - ## Methods ### batch @@ -86,7 +78,3 @@ `Promise`\<[`IndexedDocIds`](../modules/internal_.md#indexeddocids)\> map of indexed docIds by schemaName - -#### Defined in - -[src/index-writer/index.js:63](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L63) diff --git a/docs/api/md/classes/internal_.InviteApi.md b/docs/api/md/classes/internal_.InviteApi.md index 25efe14ba..a8b940fc8 100644 --- a/docs/api/md/classes/internal_.InviteApi.md +++ b/docs/api/md/classes/internal_.InviteApi.md @@ -51,20 +51,12 @@ TypedEmitter.constructor -#### Defined in - -[src/invite-api.js:175](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L175) - ## Properties ### rpc • **rpc**: [`LocalPeers`](internal_.LocalPeers.md) -#### Defined in - -[src/invite-api.js:180](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L180) - ## Methods ### accept @@ -90,10 +82,6 @@ part of this project. `Promise`\<`string`\> -#### Defined in - -[src/invite-api.js:286](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L286) - ___ ### getPending @@ -104,10 +92,6 @@ ___ [`MapBuffers`](../modules/internal_.md#mapbuffers)\<[`InviteInternal`](../modules/internal_.md#inviteinternal)\>[] -#### Defined in - -[src/invite-api.js:267](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L267) - ___ ### reject @@ -123,7 +107,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/invite-api.js:416](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L416) diff --git a/docs/api/md/classes/internal_.LiveDownload.md b/docs/api/md/classes/internal_.LiveDownload.md index 8c93e08a8..dce2f2bbb 100644 --- a/docs/api/md/classes/internal_.LiveDownload.md +++ b/docs/api/md/classes/internal_.LiveDownload.md @@ -48,10 +48,6 @@ Like drive.download() but 'live', and for multiple drives TypedEmitter.constructor -#### Defined in - -[src/blob-store/live-download.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L42) - ## Accessors ### state @@ -61,7 +57,3 @@ TypedEmitter.constructor #### Returns [`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md) \| [`BlobDownloadStateError`](../modules/internal_.md#blobdownloadstateerror) - -#### Defined in - -[src/blob-store/live-download.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L78) diff --git a/docs/api/md/classes/internal_.LocalDiscovery.md b/docs/api/md/classes/internal_.LocalDiscovery.md index 81152df6a..0e9970470 100644 --- a/docs/api/md/classes/internal_.LocalDiscovery.md +++ b/docs/api/md/classes/internal_.LocalDiscovery.md @@ -49,10 +49,6 @@ TypedEmitter.constructor -#### Defined in - -[src/discovery/local-discovery.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L43) - ## Accessors ### connections @@ -63,10 +59,6 @@ TypedEmitter.constructor `IterableIterator`\<[`OpenedNoiseStream`](../modules/internal_.md#openednoisestream-1)\> -#### Defined in - -[src/discovery/local-discovery.js:247](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L247) - ___ ### publicKey @@ -77,10 +69,6 @@ ___ `Buffer` -#### Defined in - -[src/discovery/local-discovery.js:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L61) - ## Methods ### connectPeer @@ -100,10 +88,6 @@ ___ `void` -#### Defined in - -[src/discovery/local-discovery.js:86](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L86) - ___ ### start @@ -114,10 +98,6 @@ ___ `Promise`\<\{ `name`: `string` ; `port`: `number` }\> -#### Defined in - -[src/discovery/local-discovery.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L66) - ___ ### stop @@ -139,7 +119,3 @@ are force-closed after opts.timeout milliseconds #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/discovery/local-discovery.js:261](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L261) diff --git a/docs/api/md/classes/internal_.LocalPeers.md b/docs/api/md/classes/internal_.LocalPeers.md index db9d7556a..bd2200cb1 100644 --- a/docs/api/md/classes/internal_.LocalPeers.md +++ b/docs/api/md/classes/internal_.LocalPeers.md @@ -51,10 +51,6 @@ TypedEmitter.constructor -#### Defined in - -[src/local-peers.js:251](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L251) - ## Accessors ### peers @@ -65,10 +61,6 @@ TypedEmitter.constructor ([`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: [`Protomux`](internal_.Protomux.md)\<`NoiseSecretStream`\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ; `status`: ``"connected"`` } \| [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` })[] -#### Defined in - -[src/local-peers.js:256](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L256) - ## Methods ### [kTestOnlySendRawInvite] @@ -86,10 +78,6 @@ TypedEmitter.constructor `Promise`\<`void`\> -#### Defined in - -[src/local-peers.js:323](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L323) - ___ ### connect @@ -108,10 +96,6 @@ Connect to a peer over an existing NoiseSecretStream [`ReplicationStream`](../modules/internal_.md#replicationstream) -#### Defined in - -[src/local-peers.js:335](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L335) - ___ ### sendDeviceInfo @@ -129,10 +113,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/local-peers.js:313](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L313) - ___ ### sendInvite @@ -150,10 +130,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/local-peers.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L269) - ___ ### sendInviteCancel @@ -171,10 +147,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/local-peers.js:280](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L280) - ___ ### sendInviteResponse @@ -194,10 +166,6 @@ Respond to an invite from a peer `Promise`\<`void`\> -#### Defined in - -[src/local-peers.js:292](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L292) - ___ ### sendProjectJoinDetails @@ -214,7 +182,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/local-peers.js:302](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L302) diff --git a/docs/api/md/classes/internal_.Logger.md b/docs/api/md/classes/internal_.Logger.md index e2fdf1b96..0042a8039 100644 --- a/docs/api/md/classes/internal_.Logger.md +++ b/docs/api/md/classes/internal_.Logger.md @@ -43,20 +43,12 @@ [`Logger`](internal_.Logger.md) -#### Defined in - -[src/logger.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L72) - ## Properties ### deviceId • **deviceId**: `string` -#### Defined in - -[src/logger.js:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L73) - ## Accessors ### enabled @@ -67,10 +59,6 @@ `boolean` -#### Defined in - -[src/logger.js:77](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L77) - ## Methods ### extend @@ -87,10 +75,6 @@ [`Logger`](internal_.Logger.md) -#### Defined in - -[src/logger.js:91](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L91) - ___ ### log @@ -107,10 +91,6 @@ ___ `void` -#### Defined in - -[src/logger.js:84](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L84) - ___ ### create @@ -127,7 +107,3 @@ ___ #### Returns [`Logger`](internal_.Logger.md) - -#### Defined in - -[src/logger.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/logger.js#L59) diff --git a/docs/api/md/classes/internal_.MapeoProject.md b/docs/api/md/classes/internal_.MapeoProject.md index b46d81b1b..2fa8dc7ab 100644 --- a/docs/api/md/classes/internal_.MapeoProject.md +++ b/docs/api/md/classes/internal_.MapeoProject.md @@ -81,30 +81,18 @@ TypedEmitter.constructor -#### Defined in - -[src/mapeo-project.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L108) - ## Properties ### $blobs • **$blobs**: [`BlobApi`](internal_.BlobApi.md) -#### Defined in - -[src/mapeo-project.js:311](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L311) - ___ ### EMPTY\_PROJECT\_SETTINGS ▪ `Static` **EMPTY\_PROJECT\_SETTINGS**: `Readonly`\<{}\> = `EMPTY_PROJECT_SETTINGS` -#### Defined in - -[src/mapeo-project.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L90) - ## Accessors ### $icons @@ -115,10 +103,6 @@ ___ [`IconApi`](internal_.IconApi.md) -#### Defined in - -[src/mapeo-project.js:611](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L611) - ___ ### $member @@ -129,10 +113,6 @@ ___ [`MemberApi`](internal_.MemberApi.md) -#### Defined in - -[src/mapeo-project.js:494](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L494) - ___ ### $sync @@ -143,10 +123,6 @@ ___ [`SyncApi`](internal_.SyncApi.md) -#### Defined in - -[src/mapeo-project.js:498](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L498) - ___ ### $translation @@ -157,10 +133,6 @@ ___ [`default`](internal_.default.md) -#### Defined in - -[src/mapeo-project.js:502](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L502) - ___ ### [kBlobStore] @@ -171,10 +143,6 @@ ___ [`BlobStore`](internal_.BlobStore.md) -#### Defined in - -[src/mapeo-project.js:405](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L405) - ___ ### [kCoreManager] @@ -187,10 +155,6 @@ CoreManager instance, used for tests [`CoreManager`](internal_.CoreManager.md) -#### Defined in - -[src/mapeo-project.js:387](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L387) - ___ ### [kCoreOwnership] @@ -203,10 +167,6 @@ CoreOwnership instance, used for tests [`CoreOwnership`](internal_.CoreOwnership.md) -#### Defined in - -[src/mapeo-project.js:394](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L394) - ___ ### [kDataTypes] @@ -232,10 +192,6 @@ DataTypes object mappings, used for tests | `track` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> | | `translation` | [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"translation"``, {}, {}\> | -#### Defined in - -[src/mapeo-project.js:401](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L401) - ___ ### deviceId @@ -246,10 +202,6 @@ ___ `string` -#### Defined in - -[src/mapeo-project.js:409](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L409) - ___ ### field @@ -260,10 +212,6 @@ ___ [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"field"``, {}, {}\> -#### Defined in - -[src/mapeo-project.js:490](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L490) - ___ ### observation @@ -274,10 +222,6 @@ ___ [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"observation"``, {}, {}\> -#### Defined in - -[src/mapeo-project.js:481](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L481) - ___ ### preset @@ -288,10 +232,6 @@ ___ [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"config"``, ``"translation"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"``\>, `SQLiteTableWithColumns`\<{}\>, ``"preset"``, {}, {}\> -#### Defined in - -[src/mapeo-project.js:487](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L487) - ___ ### track @@ -302,10 +242,6 @@ ___ [`DataType`](internal_.DataType.md)\<[`DataStore`](internal_.DataStore.md)\<``"data"``, ``"track"`` \| ``"observation"``\>, `SQLiteTableWithColumns`\<{}\>, ``"track"``, {}, {}\> -#### Defined in - -[src/mapeo-project.js:484](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L484) - ## Methods ### $getOwnRole @@ -316,10 +252,6 @@ ___ `Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> -#### Defined in - -[src/mapeo-project.js:553](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L553) - ___ ### $getProjectSettings @@ -330,10 +262,6 @@ ___ `Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> -#### Defined in - -[src/mapeo-project.js:542](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L542) - ___ ### $setProjectSettings @@ -350,10 +278,6 @@ ___ `Promise`\<[`EditableProjectSettings`](../modules/internal_.md#editableprojectsettings)\> -#### Defined in - -[src/mapeo-project.js:510](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L510) - ___ ### [kProjectLeave] @@ -364,10 +288,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/mapeo-project.js:615](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L615) - ___ ### [kProjectReplicate] @@ -389,10 +309,6 @@ need to replicate the manager instance via manager[kManagerReplicate]) `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\> & {} & [`Protomux`](internal_.Protomux.md)\<`Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\> -#### Defined in - -[src/mapeo-project.js:566](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L566) - ___ ### [kSetOwnDeviceInfo] @@ -409,10 +325,6 @@ ___ `Promise`\<{}\> -#### Defined in - -[src/mapeo-project.js:585](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L585) - ___ ### close @@ -423,10 +335,6 @@ ___ `Promise`\<`void`\> -#### Defined in - -[src/mapeo-project.js:422](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L422) - ___ ### importConfig @@ -444,10 +352,6 @@ ___ `Promise`\<`Error`[]\> -#### Defined in - -[src/mapeo-project.js:696](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L696) - ___ ### ready @@ -459,7 +363,3 @@ Resolves when hypercores have all loaded #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/mapeo-project.js:416](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L416) diff --git a/docs/api/md/classes/internal_.MemberApi.md b/docs/api/md/classes/internal_.MemberApi.md index aba06a99d..e6ef6ee7e 100644 --- a/docs/api/md/classes/internal_.MemberApi.md +++ b/docs/api/md/classes/internal_.MemberApi.md @@ -53,10 +53,6 @@ TypedEmitter.constructor -#### Defined in - -[src/member-api.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L59) - ## Methods ### assignRole @@ -74,10 +70,6 @@ TypedEmitter.constructor `Promise`\<`void`\> -#### Defined in - -[src/member-api.js:308](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L308) - ___ ### getById @@ -94,10 +86,6 @@ ___ `Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)\> -#### Defined in - -[src/member-api.js:239](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L239) - ___ ### getMany @@ -108,10 +96,6 @@ ___ `Promise`\<[`MemberInfo`](../interfaces/internal_.MemberInfo.md)[]\> -#### Defined in - -[src/member-api.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L269) - ___ ### invite @@ -135,10 +119,6 @@ is canceled, or if something else goes wrong. `Promise`\<``"REJECT"`` \| ``"ACCEPT"`` \| ``"ALREADY"``\> -#### Defined in - -[src/member-api.js:93](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L93) - ___ ### requestCancelInvite @@ -158,7 +138,3 @@ No-op if we weren't inviting this device. #### Returns `void` - -#### Defined in - -[src/member-api.js:231](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L231) diff --git a/docs/api/md/classes/internal_.Peer.md b/docs/api/md/classes/internal_.Peer.md index c993803b4..b26b67244 100644 --- a/docs/api/md/classes/internal_.Peer.md +++ b/docs/api/md/classes/internal_.Peer.md @@ -48,10 +48,6 @@ [`Peer`](internal_.Peer.md) -#### Defined in - -[src/local-peers.js:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L76) - ## Accessors ### connected @@ -65,10 +61,6 @@ fails to connect `Promise`\<`any`\> -#### Defined in - -[src/local-peers.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L129) - ___ ### info @@ -79,10 +71,6 @@ ___ [`PeerInfoInternal`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) -#### Defined in - -[src/local-peers.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L94) - ___ ### protomux @@ -93,10 +81,6 @@ ___ [`Protomux`](internal_.Protomux.md)\<`any`\> -#### Defined in - -[src/local-peers.js:132](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L132) - ## Methods ### [kTestOnlySendRawInvite] @@ -113,10 +97,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:164](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L164) - ___ ### connect @@ -127,10 +107,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L136) - ___ ### disconnect @@ -141,10 +117,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:147](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L147) - ___ ### receiveDeviceInfo @@ -161,10 +133,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L209) - ___ ### sendDeviceInfo @@ -181,10 +149,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:202](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L202) - ___ ### sendInvite @@ -201,10 +165,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:170](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L170) - ___ ### sendInviteCancel @@ -221,10 +181,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:178](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L178) - ___ ### sendInviteResponse @@ -241,10 +197,6 @@ ___ `void` -#### Defined in - -[src/local-peers.js:186](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L186) - ___ ### sendProjectJoinDetails @@ -260,7 +212,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/local-peers.js:194](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L194) diff --git a/docs/api/md/classes/internal_.PeerSyncController.md b/docs/api/md/classes/internal_.PeerSyncController.md index e391a4736..2cc73f24d 100644 --- a/docs/api/md/classes/internal_.PeerSyncController.md +++ b/docs/api/md/classes/internal_.PeerSyncController.md @@ -43,10 +43,6 @@ [`PeerSyncController`](internal_.PeerSyncController.md) -#### Defined in - -[src/sync/peer-sync-controller.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L47) - ## Accessors ### peerId @@ -57,10 +53,6 @@ `string` -#### Defined in - -[src/sync/peer-sync-controller.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L78) - ___ ### peerKey @@ -71,10 +63,6 @@ ___ `Buffer` -#### Defined in - -[src/sync/peer-sync-controller.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L74) - ___ ### syncCapability @@ -85,10 +73,6 @@ ___ `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, [`SyncCapability`](../modules/internal_.md#synccapability)\> -#### Defined in - -[src/sync/peer-sync-controller.js:82](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L82) - ## Methods ### disableDataSync @@ -104,10 +88,6 @@ in the background without user interaction. `void` -#### Defined in - -[src/sync/peer-sync-controller.js:100](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L100) - ___ ### enableDataSync @@ -120,10 +100,6 @@ Enable syncing of data (in the data and blob namespaces) `void` -#### Defined in - -[src/sync/peer-sync-controller.js:89](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L89) - ___ ### handleDiscoveryKey @@ -139,7 +115,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/sync/peer-sync-controller.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L108) diff --git a/docs/api/md/classes/internal_.PendingInvites.md b/docs/api/md/classes/internal_.PendingInvites.md index a27cb4f14..71efff774 100644 --- a/docs/api/md/classes/internal_.PendingInvites.md +++ b/docs/api/md/classes/internal_.PendingInvites.md @@ -53,10 +53,6 @@ Manage pending invite state. if adding a duplicate invite ID -#### Defined in - -[src/invite-api.js:76](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L76) - ___ ### deleteByInviteId @@ -75,10 +71,6 @@ ___ `true` if an invite existed and was deleted, `false` otherwise -#### Defined in - -[src/invite-api.js:128](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L128) - ___ ### deleteByProjectPublicId @@ -97,10 +89,6 @@ ___ the pending invites that were deleted -#### Defined in - -[src/invite-api.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L136) - ___ ### getByInviteId @@ -117,10 +105,6 @@ ___ `undefined` \| [`PendingInvite`](../interfaces/internal_.PendingInvite.md) -#### Defined in - -[src/invite-api.js:120](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L120) - ___ ### hasInviteId @@ -137,10 +121,6 @@ ___ `boolean` -#### Defined in - -[src/invite-api.js:101](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L101) - ___ ### invites @@ -153,10 +133,6 @@ ___ the pending invites, in insertion order -#### Defined in - -[src/invite-api.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L67) - ___ ### isAcceptingForProject @@ -173,10 +149,6 @@ ___ `boolean` -#### Defined in - -[src/invite-api.js:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L109) - ___ ### markAccepting @@ -192,7 +164,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/invite-api.js:88](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L88) diff --git a/docs/api/md/classes/internal_.Protomux.md b/docs/api/md/classes/internal_.Protomux.md index 81a4bea24..8964b9ba6 100644 --- a/docs/api/md/classes/internal_.Protomux.md +++ b/docs/api/md/classes/internal_.Protomux.md @@ -55,30 +55,18 @@ [`Protomux`](internal_.Protomux.md)\<`TStream`\> -#### Defined in - -[types/protomux.d.ts:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L48) - ## Properties ### isProtomux • **isProtomux**: ``true`` -#### Defined in - -[types/protomux.d.ts:49](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L49) - ___ ### stream • **stream**: `TStream` -#### Defined in - -[types/protomux.d.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L50) - ## Methods ### cork @@ -89,10 +77,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L53) - ___ ### createChannel @@ -119,10 +103,6 @@ ___ [`Channel`](../interfaces/internal_.Channel.md) -#### Defined in - -[types/protomux.d.ts:61](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L61) - ___ ### destroy @@ -139,10 +119,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:73](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L73) - ___ ### opened @@ -161,10 +137,6 @@ ___ `boolean` -#### Defined in - -[types/protomux.d.ts:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L60) - ___ ### pair @@ -184,10 +156,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L55) - ___ ### uncork @@ -198,10 +166,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L54) - ___ ### unpair @@ -220,10 +184,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L59) - ___ ### from @@ -240,10 +200,6 @@ ___ [`Protomux`](internal_.Protomux.md)\<`TStream`\> -#### Defined in - -[types/protomux.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L51) - ___ ### isProtomux @@ -259,7 +215,3 @@ ___ #### Returns mux is Protomux\\>\> - -#### Defined in - -[types/protomux.d.ts:52](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L52) diff --git a/docs/api/md/classes/internal_.RemoteBitfieldPage.md b/docs/api/md/classes/internal_.RemoteBitfieldPage.md index 43223db34..200e42e8b 100644 --- a/docs/api/md/classes/internal_.RemoteBitfieldPage.md +++ b/docs/api/md/classes/internal_.RemoteBitfieldPage.md @@ -48,50 +48,30 @@ [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L22) - ## Properties ### bitfield • **bitfield**: `Uint32Array` -#### Defined in - -[src/core-manager/remote-bitfield.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L28) - ___ ### index • **index**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L24) - ___ ### offset • **offset**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L26) - ___ ### segment • **segment**: [`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L30) - ## Accessors ### tree @@ -102,10 +82,6 @@ ___ [`SparseIndex`](internal_.SparseIndex.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L35) - ## Methods ### findFirst @@ -123,10 +99,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:78](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L78) - ___ ### findLast @@ -144,10 +116,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:85](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L85) - ___ ### get @@ -164,10 +132,6 @@ ___ `boolean` -#### Defined in - -[src/core-manager/remote-bitfield.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L44) - ___ ### insert @@ -185,10 +149,6 @@ ___ `void` -#### Defined in - -[src/core-manager/remote-bitfield.js:94](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L94) - ___ ### set @@ -206,10 +166,6 @@ ___ `void` -#### Defined in - -[src/core-manager/remote-bitfield.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L53) - ___ ### setRange @@ -227,7 +183,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/core-manager/remote-bitfield.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L65) diff --git a/docs/api/md/classes/internal_.RemoteBitfieldSegment.md b/docs/api/md/classes/internal_.RemoteBitfieldSegment.md index 04864f9bc..1e0bf85db 100644 --- a/docs/api/md/classes/internal_.RemoteBitfieldSegment.md +++ b/docs/api/md/classes/internal_.RemoteBitfieldSegment.md @@ -45,64 +45,36 @@ [`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L105) - ## Properties ### index • **index**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:106](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L106) - ___ ### offset • **offset**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L107) - ___ ### pages • **pages**: `any`[] -#### Defined in - -[src/core-manager/remote-bitfield.js:111](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L111) - ___ ### pagesLength • **pagesLength**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:112](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L112) - -[src/core-manager/remote-bitfield.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L130) - ___ ### tree • **tree**: [`SparseIndex`](internal_.SparseIndex.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:108](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L108) - -[src/core-manager/remote-bitfield.js:120](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L120) - ## Accessors ### chunks @@ -113,10 +85,6 @@ ___ [`Chunk`](../modules/internal_.md#chunk)[] -#### Defined in - -[src/core-manager/remote-bitfield.js:115](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L115) - ## Methods ### add @@ -133,10 +101,6 @@ ___ `void` -#### Defined in - -[src/core-manager/remote-bitfield.js:128](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L128) - ___ ### findFirst @@ -154,10 +118,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:151](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L151) - ___ ### findLast @@ -175,10 +135,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:180](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L180) - ___ ### refresh @@ -188,7 +144,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/core-manager/remote-bitfield.js:119](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L119) diff --git a/docs/api/md/classes/internal_.Roles.md b/docs/api/md/classes/internal_.Roles.md index df2ab09ec..b0d7275a7 100644 --- a/docs/api/md/classes/internal_.Roles.md +++ b/docs/api/md/classes/internal_.Roles.md @@ -41,20 +41,12 @@ [`Roles`](internal_.Roles.md) -#### Defined in - -[src/roles.js:240](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L240) - ## Properties ### NO\_ROLE ▪ `Static` **NO\_ROLE**: [`Role`](../interfaces/internal_.Role.md)\<``"08e4251e36f6e7ed"``\> = `NO_ROLE` -#### Defined in - -[src/roles.js:223](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L223) - ## Methods ### assignRole @@ -77,10 +69,6 @@ role cannot assign the role by consulting `roleAssignment`. `Promise`\<`void`\> -#### Defined in - -[src/roles.js:332](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L332) - ___ ### getAll @@ -98,10 +86,6 @@ different one has been assigned. Map of deviceId to Role -#### Defined in - -[src/roles.js:285](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L285) - ___ ### getRole @@ -119,7 +103,3 @@ Get the role for device `deviceId`. #### Returns `Promise`\<[`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\>\> - -#### Defined in - -[src/roles.js:254](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L254) diff --git a/docs/api/md/classes/internal_.SparseIndex.md b/docs/api/md/classes/internal_.SparseIndex.md index bc860f2f5..690516686 100644 --- a/docs/api/md/classes/internal_.SparseIndex.md +++ b/docs/api/md/classes/internal_.SparseIndex.md @@ -49,10 +49,6 @@ [Index](internal_.Index.md).[constructor](internal_.Index.md#constructor) -#### Defined in - -[types/quickbit-universal.d.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L40) - ## Properties ### byteLength @@ -63,20 +59,12 @@ [Index](internal_.Index.md).[byteLength](internal_.Index.md#bytelength) -#### Defined in - -[types/quickbit-universal.d.ts:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L51) - ___ ### chunks • `Readonly` **chunks**: [`Chunk`](../modules/internal_.md#chunk)[] -#### Defined in - -[types/quickbit-universal.d.ts:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L41) - ## Methods ### skipFirst @@ -98,10 +86,6 @@ ___ [Index](internal_.Index.md).[skipFirst](internal_.Index.md#skipfirst) -#### Defined in - -[types/quickbit-universal.d.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L55) - ___ ### skipLast @@ -123,10 +107,6 @@ ___ [Index](internal_.Index.md).[skipLast](internal_.Index.md#skiplast) -#### Defined in - -[types/quickbit-universal.d.ts:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L57) - ___ ### update @@ -147,10 +127,6 @@ ___ [Index](internal_.Index.md).[update](internal_.Index.md#update) -#### Defined in - -[types/quickbit-universal.d.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L42) - ___ ### from @@ -172,10 +148,6 @@ ___ [Index](internal_.Index.md).[from](internal_.Index.md#from) -#### Defined in - -[types/quickbit-universal.d.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L46) - ▸ **from**(`chunks`, `byteLength`): [`SparseIndex`](internal_.SparseIndex.md) #### Parameters @@ -192,7 +164,3 @@ ___ #### Inherited from [Index](internal_.Index.md).[from](internal_.Index.md#from) - -#### Defined in - -[types/quickbit-universal.d.ts:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L47) diff --git a/docs/api/md/classes/internal_.SyncApi.md b/docs/api/md/classes/internal_.SyncApi.md index 7108a0cb3..ab4bd9836 100644 --- a/docs/api/md/classes/internal_.SyncApi.md +++ b/docs/api/md/classes/internal_.SyncApi.md @@ -52,20 +52,12 @@ TypedEmitter.constructor -#### Defined in - -[src/sync/sync-api.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L66) - ## Properties ### [kSyncState] • **[kSyncState]**: [`SyncState`](internal_.SyncState.md) -#### Defined in - -[src/sync/sync-api.js:71](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L71) - ## Methods ### [kHandleDiscoveryKey] @@ -83,10 +75,6 @@ TypedEmitter.constructor `void` -#### Defined in - -[src/sync/sync-api.js:87](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L87) - ___ ### getState @@ -99,10 +87,6 @@ Get the current sync state (initial and full). Also emitted via the 'sync-state' [`State`](../interfaces/internal_.State.md) -#### Defined in - -[src/sync/sync-api.js:118](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L118) - ___ ### start @@ -115,10 +99,6 @@ Start syncing data cores `void` -#### Defined in - -[src/sync/sync-api.js:135](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L135) - ___ ### stop @@ -131,10 +111,6 @@ Stop syncing data cores (metadata cores will continue syncing in the background) `void` -#### Defined in - -[src/sync/sync-api.js:148](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L148) - ___ ### waitForSync @@ -150,7 +126,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/sync/sync-api.js:162](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L162) diff --git a/docs/api/md/classes/internal_.SyncState.md b/docs/api/md/classes/internal_.SyncState.md index ea8a8ae67..bfc47794e 100644 --- a/docs/api/md/classes/internal_.SyncState.md +++ b/docs/api/md/classes/internal_.SyncState.md @@ -46,10 +46,6 @@ Emit sync state when it changes TypedEmitter.constructor -#### Defined in - -[src/sync/sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L33) - ## Methods ### addPeer @@ -66,10 +62,6 @@ TypedEmitter.constructor `void` -#### Defined in - -[src/sync/sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L53) - ___ ### getState @@ -79,7 +71,3 @@ ___ #### Returns [`State`](../modules/internal_.md#state) - -#### Defined in - -[src/sync/sync-state.js:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L62) diff --git a/docs/api/md/classes/internal_.TrackedKeyRequests.md b/docs/api/md/classes/internal_.TrackedKeyRequests.md index b219b1fff..23419704f 100644 --- a/docs/api/md/classes/internal_.TrackedKeyRequests.md +++ b/docs/api/md/classes/internal_.TrackedKeyRequests.md @@ -38,10 +38,6 @@ `void` -#### Defined in - -[src/core-manager/index.js:614](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L614) - ___ ### deleteByDiscoveryKey @@ -58,10 +54,6 @@ ___ `boolean` -#### Defined in - -[src/core-manager/index.js:591](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L591) - ___ ### deleteByPeerKey @@ -78,10 +70,6 @@ ___ `void` -#### Defined in - -[src/core-manager/index.js:605](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L605) - ___ ### has @@ -98,10 +86,6 @@ ___ `boolean` -#### Defined in - -[src/core-manager/index.js:584](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L584) - ___ ### set @@ -118,7 +102,3 @@ ___ #### Returns [`TrackedKeyRequests`](internal_.TrackedKeyRequests.md) - -#### Defined in - -[src/core-manager/index.js:572](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L572) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md index d81f2de74..ae8284d32 100644 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md @@ -40,10 +40,6 @@ Error.constructor -#### Defined in - -[src/local-peers.js:624](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L624) - ## Properties ### name @@ -53,7 +49,3 @@ Error.constructor #### Inherited from Error.name - -#### Defined in - -[src/local-peers.js:626](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L626) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md index fdcc75297..658fb0321 100644 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md @@ -40,10 +40,6 @@ Error.constructor -#### Defined in - -[src/local-peers.js:632](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L632) - ## Properties ### name @@ -53,7 +49,3 @@ Error.constructor #### Inherited from Error.name - -#### Defined in - -[src/local-peers.js:634](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L634) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md index 37e6ccfda..463fb3b55 100644 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md @@ -40,10 +40,6 @@ Error.constructor -#### Defined in - -[src/local-peers.js:616](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L616) - ## Properties ### name @@ -53,7 +49,3 @@ Error.constructor #### Inherited from Error.name - -#### Defined in - -[src/local-peers.js:618](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L618) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md index 8b90753ed..f0bb9de00 100644 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md @@ -51,10 +51,6 @@ [`NamespaceSyncState`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> -#### Defined in - -[src/sync/namespace-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L28) - ## Accessors ### namespace @@ -65,10 +61,6 @@ `TNamespace` -#### Defined in - -[src/sync/namespace-sync-state.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L53) - ## Methods ### addPeer @@ -85,10 +77,6 @@ `void` -#### Defined in - -[src/sync/namespace-sync-state.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L90) - ___ ### getState @@ -98,7 +86,3 @@ ___ #### Returns [`SyncState`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) - -#### Defined in - -[src/sync/namespace-sync-state.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L58) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md index 3800233f9..7cf91cde3 100644 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md +++ b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md @@ -40,10 +40,6 @@ Error.constructor -#### Defined in - -[src/utils.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L65) - ## Properties ### name @@ -53,7 +49,3 @@ Error.constructor #### Inherited from Error.name - -#### Defined in - -[src/utils.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L67) diff --git a/docs/api/md/classes/internal_.default-1.md b/docs/api/md/classes/internal_.default-1.md index 4c29eaca0..63fa78bab 100644 --- a/docs/api/md/classes/internal_.default-1.md +++ b/docs/api/md/classes/internal_.default-1.md @@ -75,10 +75,6 @@ map.get([1, 2]) [`default`](internal_.default-1.md)\<`K`, `V`\> -#### Defined in - -[src/lib/hashmap.js:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L37) - ## Accessors ### size @@ -89,10 +85,6 @@ map.get([1, 2]) `number` -#### Defined in - -[src/lib/hashmap.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L45) - ## Methods ### delete @@ -111,10 +103,6 @@ map.get([1, 2]) `true` if the key was present and removed, `false` otherwise. -#### Defined in - -[src/lib/hashmap.js:53](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L53) - ___ ### get @@ -133,10 +121,6 @@ ___ The element associated with `key`, or `undefined` if it's not present. -#### Defined in - -[src/lib/hashmap.js:62](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L62) - ___ ### has @@ -155,10 +139,6 @@ ___ `true` if `key` is present in the map, `false` otherwise. -#### Defined in - -[src/lib/hashmap.js:71](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L71) - ___ ### set @@ -178,10 +158,6 @@ ___ The map. -#### Defined in - -[src/lib/hashmap.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L81) - ___ ### values @@ -191,7 +167,3 @@ ___ #### Returns `IterableIterator`\<`V`\> - -#### Defined in - -[src/lib/hashmap.js:90](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L90) diff --git a/docs/api/md/classes/internal_.default-2.md b/docs/api/md/classes/internal_.default-2.md index adf57a190..91683db7a 100644 --- a/docs/api/md/classes/internal_.default-2.md +++ b/docs/api/md/classes/internal_.default-2.md @@ -40,46 +40,24 @@ [`default`](internal_.default-2.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:207](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L207) - ## Properties ### \_maxSegments • **\_maxSegments**: `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:212](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L212) - -[src/core-manager/remote-bitfield.js:253](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L253) - -[src/core-manager/remote-bitfield.js:281](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L281) - -[src/core-manager/remote-bitfield.js:394](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L394) - ___ ### \_pages • **\_pages**: [`BigSparseArray`](internal_.BigSparseArray.md)\<[`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md)\> -#### Defined in - -[src/core-manager/remote-bitfield.js:209](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L209) - ___ ### \_segments • **\_segments**: [`BigSparseArray`](internal_.BigSparseArray.md)\<[`RemoteBitfieldSegment`](internal_.RemoteBitfieldSegment.md)\> -#### Defined in - -[src/core-manager/remote-bitfield.js:211](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L211) - ## Methods ### findFirst @@ -97,10 +75,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:304](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L304) - ___ ### findLast @@ -118,10 +92,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:340](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L340) - ___ ### firstSet @@ -138,10 +108,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:327](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L327) - ___ ### firstUnset @@ -158,10 +124,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:333](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L333) - ___ ### get @@ -178,10 +140,6 @@ ___ `boolean` -#### Defined in - -[src/core-manager/remote-bitfield.js:218](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L218) - ___ ### getBitfield @@ -198,10 +156,6 @@ ___ ``null`` \| [`RemoteBitfieldPage`](internal_.RemoteBitfieldPage.md) -#### Defined in - -[src/core-manager/remote-bitfield.js:230](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L230) - ___ ### insert @@ -219,10 +173,6 @@ ___ `boolean` -#### Defined in - -[src/core-manager/remote-bitfield.js:378](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L378) - ___ ### lastSet @@ -239,10 +189,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:364](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L364) - ___ ### lastUnset @@ -259,10 +205,6 @@ ___ `number` -#### Defined in - -[src/core-manager/remote-bitfield.js:370](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L370) - ___ ### set @@ -280,10 +222,6 @@ ___ `void` -#### Defined in - -[src/core-manager/remote-bitfield.js:242](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L242) - ___ ### setRange @@ -301,7 +239,3 @@ ___ #### Returns `void` - -#### Defined in - -[src/core-manager/remote-bitfield.js:269](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/remote-bitfield.js#L269) diff --git a/docs/api/md/classes/internal_.default.md b/docs/api/md/classes/internal_.default.md index 82dc6cd2a..efc184ede 100644 --- a/docs/api/md/classes/internal_.default.md +++ b/docs/api/md/classes/internal_.default.md @@ -39,10 +39,6 @@ [`default`](internal_.default.md) -#### Defined in - -[src/translation-api.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L29) - ## Accessors ### [ktranslatedLanguageCodeToSchemaNames] @@ -53,10 +49,6 @@ `Map`\<`string`, `Set`\<`SchemaName`\>\> -#### Defined in - -[src/translation-api.js:126](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L126) - ## Methods ### get @@ -73,10 +65,6 @@ `Promise`\<{}[]\> -#### Defined in - -[src/translation-api.js:72](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L72) - ___ ### index @@ -93,10 +81,6 @@ ___ `void` -#### Defined in - -[src/translation-api.js:107](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L107) - ___ ### put @@ -113,10 +97,6 @@ ___ `Promise`\<{} & \{ `forks`: `string`[] }\> -#### Defined in - -[src/translation-api.js:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L50) - ___ ### ready @@ -126,7 +106,3 @@ ___ #### Returns `Promise`\<`void`\> - -#### Defined in - -[src/translation-api.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/translation-api.js#L43) diff --git a/docs/api/md/interfaces/internal_.BitmapOpts.md b/docs/api/md/interfaces/internal_.BitmapOpts.md index 5a24a0126..f96709622 100644 --- a/docs/api/md/interfaces/internal_.BitmapOpts.md +++ b/docs/api/md/interfaces/internal_.BitmapOpts.md @@ -18,26 +18,14 @@ • **mimeType**: ``"image/png"`` -#### Defined in - -[src/icon-api.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L8) - ___ ### pixelDensity • **pixelDensity**: ``1`` \| ``2`` \| ``3`` -#### Defined in - -[src/icon-api.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L9) - ___ ### size • **size**: `Size` - -#### Defined in - -[src/icon-api.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L10) diff --git a/docs/api/md/interfaces/internal_.BlobDownloadState.md b/docs/api/md/interfaces/internal_.BlobDownloadState.md index 47a39ba50..a97089cf0 100644 --- a/docs/api/md/interfaces/internal_.BlobDownloadState.md +++ b/docs/api/md/interfaces/internal_.BlobDownloadState.md @@ -23,10 +23,6 @@ If status = 'error' then this will be an Error object -#### Defined in - -[src/blob-store/live-download.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L14) - ___ ### haveBytes @@ -35,10 +31,6 @@ ___ The bytes already downloaded -#### Defined in - -[src/blob-store/live-download.js:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L11) - ___ ### haveCount @@ -47,20 +39,12 @@ ___ The number of files already downloaded -#### Defined in - -[src/blob-store/live-download.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L10) - ___ ### status • **status**: ``"checking"`` \| ``"downloading"`` \| ``"downloaded"`` \| ``"aborted"`` -#### Defined in - -[src/blob-store/live-download.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L15) - ___ ### wantBytes @@ -69,10 +53,6 @@ ___ The bytes pending download -#### Defined in - -[src/blob-store/live-download.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L13) - ___ ### wantCount @@ -80,7 +60,3 @@ ___ • **wantCount**: `number` The number of files pending download - -#### Defined in - -[src/blob-store/live-download.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L12) diff --git a/docs/api/md/interfaces/internal_.Channel.md b/docs/api/md/interfaces/internal_.Channel.md index b5be06cc8..ecaac6337 100644 --- a/docs/api/md/interfaces/internal_.Channel.md +++ b/docs/api/md/interfaces/internal_.Channel.md @@ -30,70 +30,42 @@ • **closed**: `boolean` -#### Defined in - -[types/protomux.d.ts:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L39) - ___ ### destroyed • **destroyed**: `boolean` -#### Defined in - -[types/protomux.d.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L40) - ___ ### id • **id**: `Buffer` -#### Defined in - -[types/protomux.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L36) - ___ ### messages • **messages**: [`Message`](internal_.Message.md)[] -#### Defined in - -[types/protomux.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L37) - ___ ### opened • **opened**: `boolean` -#### Defined in - -[types/protomux.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L38) - ___ ### protocol • **protocol**: `string` -#### Defined in - -[types/protomux.d.ts:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L35) - ___ ### userData • **userData**: `any` -#### Defined in - -[types/protomux.d.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L34) - ## Methods ### addMessage @@ -110,10 +82,6 @@ ___ [`Message`](internal_.Message.md) -#### Defined in - -[types/protomux.d.ts:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L44) - ___ ### close @@ -124,10 +92,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L43) - ___ ### cork @@ -138,10 +102,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L41) - ___ ### open @@ -158,10 +118,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L33) - ___ ### uncork @@ -171,7 +127,3 @@ ___ #### Returns `void` - -#### Defined in - -[types/protomux.d.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L42) diff --git a/docs/api/md/interfaces/internal_.CoreState.md b/docs/api/md/interfaces/internal_.CoreState.md index 9696fda80..b48db2d82 100644 --- a/docs/api/md/interfaces/internal_.CoreState.md +++ b/docs/api/md/interfaces/internal_.CoreState.md @@ -21,10 +21,6 @@ blocks the peer has locally -#### Defined in - -[src/sync/core-sync-state.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L22) - ___ ### missing @@ -33,10 +29,6 @@ ___ blocks the peer wants but no peer has -#### Defined in - -[src/sync/core-sync-state.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L25) - ___ ### want @@ -45,10 +37,6 @@ ___ blocks the peer wants, and at least one peer has -#### Defined in - -[src/sync/core-sync-state.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L23) - ___ ### wanted @@ -56,7 +44,3 @@ ___ • **wanted**: `number` blocks the peer has that at least one peer wants - -#### Defined in - -[src/sync/core-sync-state.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L24) diff --git a/docs/api/md/interfaces/internal_.CorestoreEvents.md b/docs/api/md/interfaces/internal_.CorestoreEvents.md index bfeb14149..27ff4761f 100644 --- a/docs/api/md/interfaces/internal_.CorestoreEvents.md +++ b/docs/api/md/interfaces/internal_.CorestoreEvents.md @@ -27,10 +27,6 @@ `void` -#### Defined in - -[types/corestore.d.ts:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L11) - ___ ### core-open @@ -46,7 +42,3 @@ ___ #### Returns `void` - -#### Defined in - -[types/corestore.d.ts:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/corestore.d.ts#L10) diff --git a/docs/api/md/interfaces/internal_.DataTypeEvents.md b/docs/api/md/interfaces/internal_.DataTypeEvents.md index ac9296a1b..dca372b68 100644 --- a/docs/api/md/interfaces/internal_.DataTypeEvents.md +++ b/docs/api/md/interfaces/internal_.DataTypeEvents.md @@ -35,7 +35,3 @@ ##### Returns `void` - -#### Defined in - -[src/datatype/index.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L31) diff --git a/docs/api/md/interfaces/internal_.DocCapability.md b/docs/api/md/interfaces/internal_.DocCapability.md index 38859bbf0..002abd19f 100644 --- a/docs/api/md/interfaces/internal_.DocCapability.md +++ b/docs/api/md/interfaces/internal_.DocCapability.md @@ -21,10 +21,6 @@ can read other's data -#### Defined in - -[src/roles.js:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L59) - ___ ### readOwn @@ -33,10 +29,6 @@ ___ can read own data -#### Defined in - -[src/roles.js:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L57) - ___ ### writeOthers @@ -45,10 +37,6 @@ ___ can edit or delete other's data -#### Defined in - -[src/roles.js:60](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L60) - ___ ### writeOwn @@ -56,7 +44,3 @@ ___ • **writeOwn**: `boolean` can write own data - -#### Defined in - -[src/roles.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L58) diff --git a/docs/api/md/interfaces/internal_.Encoding.md b/docs/api/md/interfaces/internal_.Encoding.md index b002c069b..9876200c6 100644 --- a/docs/api/md/interfaces/internal_.Encoding.md +++ b/docs/api/md/interfaces/internal_.Encoding.md @@ -28,10 +28,6 @@ `any` -#### Defined in - -[types/protomux.d.ts:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L20) - ___ ### encode @@ -49,10 +45,6 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L19) - ___ ### preencode @@ -69,7 +61,3 @@ ___ #### Returns `void` - -#### Defined in - -[types/protomux.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L18) diff --git a/docs/api/md/interfaces/internal_.EncodingState.md b/docs/api/md/interfaces/internal_.EncodingState.md index 75f65021a..aae87e383 100644 --- a/docs/api/md/interfaces/internal_.EncodingState.md +++ b/docs/api/md/interfaces/internal_.EncodingState.md @@ -18,26 +18,14 @@ • **buffer**: ``null`` \| `Buffer` -#### Defined in - -[types/protomux.d.ts:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L12) - ___ ### end • **end**: `number` -#### Defined in - -[types/protomux.d.ts:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L14) - ___ ### start • **start**: `number` - -#### Defined in - -[types/protomux.d.ts:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L13) diff --git a/docs/api/md/interfaces/internal_.HaveMsg.md b/docs/api/md/interfaces/internal_.HaveMsg.md index 0be592252..3908ad233 100644 --- a/docs/api/md/interfaces/internal_.HaveMsg.md +++ b/docs/api/md/interfaces/internal_.HaveMsg.md @@ -19,36 +19,20 @@ • **bitfield**: `Uint32Array` -#### Defined in - -[src/core-manager/index.js:522](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L522) - ___ ### discoveryKey • **discoveryKey**: `Buffer` -#### Defined in - -[src/core-manager/index.js:520](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L520) - ___ ### namespace • **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` -#### Defined in - -[src/core-manager/index.js:523](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L523) - ___ ### start • **start**: `number` - -#### Defined in - -[src/core-manager/index.js:521](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L521) diff --git a/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md b/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md index 98f26635f..a6a0bd1c4 100644 --- a/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md +++ b/docs/api/md/interfaces/internal_.Hyperblobs.BlobId.md @@ -19,36 +19,20 @@ • **blockLength**: `number` -#### Defined in - -[types/hyperblobs.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L23) - ___ ### blockOffset • **blockOffset**: `number` -#### Defined in - -[types/hyperblobs.d.ts:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L22) - ___ ### byteLength • **byteLength**: `number` -#### Defined in - -[types/hyperblobs.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L25) - ___ ### byteOffset • **byteOffset**: `number` - -#### Defined in - -[types/hyperblobs.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperblobs.d.ts#L24) diff --git a/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md b/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md index ef6077e47..d52c290d5 100644 --- a/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md +++ b/docs/api/md/interfaces/internal_.Hyperdrive.HyperdriveEntry.md @@ -18,20 +18,12 @@ • **key**: `string` -#### Defined in - -[types/hyperdrive.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L37) - ___ ### seq • **seq**: `number` -#### Defined in - -[types/hyperdrive.d.ts:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L36) - ___ ### value @@ -46,7 +38,3 @@ ___ | `executable` | `boolean` | | `linkname` | ``null`` \| `string` | | `metadata` | ``null`` \| `object` | - -#### Defined in - -[types/hyperdrive.d.ts:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L38) diff --git a/docs/api/md/interfaces/internal_.HyperdriveEvents.md b/docs/api/md/interfaces/internal_.HyperdriveEvents.md index f467f0479..4678efcc0 100644 --- a/docs/api/md/interfaces/internal_.HyperdriveEvents.md +++ b/docs/api/md/interfaces/internal_.HyperdriveEvents.md @@ -33,10 +33,6 @@ `void` -#### Defined in - -[types/hyperdrive.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L25) - ___ ### close @@ -51,10 +47,6 @@ ___ `void` -#### Defined in - -[types/hyperdrive.d.ts:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L23) - ___ ### content-key @@ -75,10 +67,6 @@ ___ `void` -#### Defined in - -[types/hyperdrive.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L26) - ___ ### ready @@ -92,7 +80,3 @@ ___ ##### Returns `void` - -#### Defined in - -[types/hyperdrive.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L24) diff --git a/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md b/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md index a6708f80c..b1c1d0bbb 100644 --- a/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md +++ b/docs/api/md/interfaces/internal_.HyperdriveGetOpts.md @@ -17,16 +17,8 @@ • `Optional` **timeout**: `number` -#### Defined in - -[types/hyperdrive.d.ts:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L31) - ___ ### wait • `Optional` **wait**: `boolean` - -#### Defined in - -[types/hyperdrive.d.ts:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L30) diff --git a/docs/api/md/interfaces/internal_.HyperdriveOptions.md b/docs/api/md/interfaces/internal_.HyperdriveOptions.md index 73ae7f979..ab94abcc2 100644 --- a/docs/api/md/interfaces/internal_.HyperdriveOptions.md +++ b/docs/api/md/interfaces/internal_.HyperdriveOptions.md @@ -23,7 +23,3 @@ ##### Returns `void` - -#### Defined in - -[types/hyperdrive.d.ts:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L9) diff --git a/docs/api/md/interfaces/internal_.MapsPluginOpts.md b/docs/api/md/interfaces/internal_.MapsPluginOpts.md index 0e6b6e3c5..7b97ff7eb 100644 --- a/docs/api/md/interfaces/internal_.MapsPluginOpts.md +++ b/docs/api/md/interfaces/internal_.MapsPluginOpts.md @@ -17,16 +17,8 @@ • **defaultOnlineStyleUrl**: `undefined` \| `string` -#### Defined in - -[src/fastify-plugins/maps/index.js:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L40) - ___ ### prefix • **prefix**: `undefined` \| `string` - -#### Defined in - -[src/fastify-plugins/maps/index.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/index.js#L39) diff --git a/docs/api/md/interfaces/internal_.MemberInfo.md b/docs/api/md/interfaces/internal_.MemberInfo.md index 8e18a128f..892b44b31 100644 --- a/docs/api/md/interfaces/internal_.MemberInfo.md +++ b/docs/api/md/interfaces/internal_.MemberInfo.md @@ -19,36 +19,20 @@ • **deviceId**: `string` -#### Defined in - -[src/member-api.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L29) - ___ ### deviceType • **deviceType**: `undefined` \| ``"UNRECOGNIZED"`` \| ``"mobile"`` \| ``"tablet"`` \| ``"desktop"`` -#### Defined in - -[src/member-api.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L32) - ___ ### name • **name**: `undefined` \| `string` -#### Defined in - -[src/member-api.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L31) - ___ ### role • **role**: [`Role`](internal_.Role.md)\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> - -#### Defined in - -[src/member-api.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/member-api.js#L30) diff --git a/docs/api/md/interfaces/internal_.Message.md b/docs/api/md/interfaces/internal_.Message.md index 8398b41c6..297d91202 100644 --- a/docs/api/md/interfaces/internal_.Message.md +++ b/docs/api/md/interfaces/internal_.Message.md @@ -22,10 +22,6 @@ • **encoding**: [`Encoding`](internal_.Encoding.md) -#### Defined in - -[types/protomux.d.ts:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L27) - ___ ### onmessage @@ -46,20 +42,12 @@ ___ `void` -#### Defined in - -[types/protomux.d.ts:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L26) - ___ ### type • **type**: `number` -#### Defined in - -[types/protomux.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L24) - ## Methods ### send @@ -75,7 +63,3 @@ ___ #### Returns `void` - -#### Defined in - -[types/protomux.d.ts:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L25) diff --git a/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md b/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md index 8eb1e8c9d..ccf63e9a7 100644 --- a/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md +++ b/docs/api/md/interfaces/internal_.OfflineFallbackMapPluginOpts.md @@ -18,26 +18,14 @@ • **prefix**: `undefined` \| `string` -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L21) - ___ ### sourcesDir • **sourcesDir**: `string` -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L23) - ___ ### styleJsonPath • **styleJsonPath**: `string` - -#### Defined in - -[src/fastify-plugins/maps/offline-fallback-map.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/offline-fallback-map.js#L22) diff --git a/docs/api/md/interfaces/internal_.PeerInfoBase.md b/docs/api/md/interfaces/internal_.PeerInfoBase.md index b7fdd3335..76b0f49ec 100644 --- a/docs/api/md/interfaces/internal_.PeerInfoBase.md +++ b/docs/api/md/interfaces/internal_.PeerInfoBase.md @@ -18,26 +18,14 @@ • **deviceId**: `string` -#### Defined in - -[src/local-peers.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L42) - ___ ### deviceType • **deviceType**: `undefined` \| `DeviceInfo_DeviceType` -#### Defined in - -[src/local-peers.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L44) - ___ ### name • **name**: `undefined` \| `string` - -#### Defined in - -[src/local-peers.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L43) diff --git a/docs/api/md/interfaces/internal_.PendingInvite.md b/docs/api/md/interfaces/internal_.PendingInvite.md index d6842658a..0ccd3c587 100644 --- a/docs/api/md/interfaces/internal_.PendingInvite.md +++ b/docs/api/md/interfaces/internal_.PendingInvite.md @@ -18,26 +18,14 @@ • **invite**: [`InviteInternal`](../modules/internal_.md#inviteinternal) -#### Defined in - -[src/invite-api.js:57](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L57) - ___ ### isAccepting • **isAccepting**: `boolean` -#### Defined in - -[src/invite-api.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L58) - ___ ### peerId • **peerId**: `string` - -#### Defined in - -[src/invite-api.js:56](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L56) diff --git a/docs/api/md/interfaces/internal_.PreEncodingState.md b/docs/api/md/interfaces/internal_.PreEncodingState.md index dfaf67909..74eee6265 100644 --- a/docs/api/md/interfaces/internal_.PreEncodingState.md +++ b/docs/api/md/interfaces/internal_.PreEncodingState.md @@ -18,26 +18,14 @@ • **buffer**: ``null`` -#### Defined in - -[types/protomux.d.ts:6](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L6) - ___ ### end • **end**: `number` -#### Defined in - -[types/protomux.d.ts:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L8) - ___ ### start • **start**: `number` - -#### Defined in - -[types/protomux.d.ts:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/protomux.d.ts#L7) diff --git a/docs/api/md/interfaces/internal_.Role.md b/docs/api/md/interfaces/internal_.Role.md index 668b170eb..824403079 100644 --- a/docs/api/md/interfaces/internal_.Role.md +++ b/docs/api/md/interfaces/internal_.Role.md @@ -26,46 +26,26 @@ • **docs**: `Record`\<``"translation"`` \| ``"track"`` \| ``"role"`` \| ``"projectSettings"`` \| ``"preset"`` \| ``"observation"`` \| ``"icon"`` \| ``"field"`` \| ``"deviceInfo"`` \| ``"coreOwnership"``, [`DocCapability`](internal_.DocCapability.md)\> -#### Defined in - -[src/roles.js:68](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L68) - ___ ### name • **name**: `string` -#### Defined in - -[src/roles.js:67](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L67) - ___ ### roleAssignment • **roleAssignment**: (``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``)[] -#### Defined in - -[src/roles.js:69](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L69) - ___ ### roleId • **roleId**: `T` -#### Defined in - -[src/roles.js:66](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L66) - ___ ### sync • **sync**: `Record`\<``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"``, ``"allowed"`` \| ``"blocked"``\> - -#### Defined in - -[src/roles.js:70](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L70) diff --git a/docs/api/md/interfaces/internal_.StartOpts.md b/docs/api/md/interfaces/internal_.StartOpts.md index da1ae1237..6de2fb071 100644 --- a/docs/api/md/interfaces/internal_.StartOpts.md +++ b/docs/api/md/interfaces/internal_.StartOpts.md @@ -17,16 +17,8 @@ • **host**: `undefined` \| `string` -#### Defined in - -[src/fastify-controller.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L7) - ___ ### port • **port**: `undefined` \| `number` - -#### Defined in - -[src/fastify-controller.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-controller.js#L8) diff --git a/docs/api/md/interfaces/internal_.State.md b/docs/api/md/interfaces/internal_.State.md index 4b6d6db59..be7668482 100644 --- a/docs/api/md/interfaces/internal_.State.md +++ b/docs/api/md/interfaces/internal_.State.md @@ -20,10 +20,6 @@ Number of connected peers -#### Defined in - -[src/sync/sync-api.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L33) - ___ ### data @@ -32,10 +28,6 @@ ___ State of data sync (observations, map data, photos, audio, video etc.) -#### Defined in - -[src/sync/sync-api.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L32) - ___ ### initial @@ -43,7 +35,3 @@ ___ • **initial**: [`SyncTypeState`](internal_.SyncTypeState.md) State of initial sync (sync of auth, metadata and project config) - -#### Defined in - -[src/sync/sync-api.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L31) diff --git a/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md b/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md index 3ef9185ab..ad8eefebd 100644 --- a/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md +++ b/docs/api/md/interfaces/internal_.StaticMapsPluginOpts.md @@ -17,16 +17,8 @@ • **prefix**: `undefined` \| `string` -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L25) - ___ ### staticRootDir • **staticRootDir**: `string` - -#### Defined in - -[src/fastify-plugins/maps/static-maps.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/fastify-plugins/maps/static-maps.js#L26) diff --git a/docs/api/md/interfaces/internal_.SvgOpts.md b/docs/api/md/interfaces/internal_.SvgOpts.md index c03220829..cec1f009d 100644 --- a/docs/api/md/interfaces/internal_.SvgOpts.md +++ b/docs/api/md/interfaces/internal_.SvgOpts.md @@ -17,16 +17,8 @@ • **mimeType**: ``"image/svg+xml"`` -#### Defined in - -[src/icon-api.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L13) - ___ ### size • **size**: `Size` - -#### Defined in - -[src/icon-api.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/icon-api.js#L14) diff --git a/docs/api/md/interfaces/internal_.SyncTypeState.md b/docs/api/md/interfaces/internal_.SyncTypeState.md index ede4c6e00..64cc0306e 100644 --- a/docs/api/md/interfaces/internal_.SyncTypeState.md +++ b/docs/api/md/interfaces/internal_.SyncTypeState.md @@ -23,10 +23,6 @@ Is there data available to sync? (want > 0 || wanted > 0) -#### Defined in - -[src/sync/sync-api.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L25) - ___ ### have @@ -35,10 +31,6 @@ ___ Number of blocks we have locally -#### Defined in - -[src/sync/sync-api.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L21) - ___ ### missing @@ -47,10 +39,6 @@ ___ Number of blocks missing (we don't have them, but connected peers don't have them either) -#### Defined in - -[src/sync/sync-api.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L24) - ___ ### syncing @@ -59,10 +47,6 @@ ___ Are we currently syncing? -#### Defined in - -[src/sync/sync-api.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L26) - ___ ### want @@ -71,10 +55,6 @@ ___ Number of blocks we want from connected peers -#### Defined in - -[src/sync/sync-api.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L22) - ___ ### wanted @@ -82,7 +62,3 @@ ___ • **wanted**: `number` Number of blocks that connected peers want from us - -#### Defined in - -[src/sync/sync-api.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L23) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md index 2527d0c7e..a807b2833 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md @@ -31,10 +31,6 @@ `void` -#### Defined in - -[src/core-manager/index.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L25) - ___ ### peer-have @@ -59,7 +55,3 @@ ___ ##### Returns `void` - -#### Defined in - -[src/core-manager/index.js:26](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L26) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md index a9644ba60..7b5aab18e 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md @@ -40,10 +40,6 @@ Emitted when a new hypercore is replicated (by a peer) to a peer protomux instan `void` -#### Defined in - -[src/local-peers.js:229](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L229) - ___ ### failed-to-handle-message @@ -67,10 +63,6 @@ Emitted when we received a message we couldn't handle for some reason. Primarily `void` -#### Defined in - -[src/local-peers.js:230](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L230) - ___ ### got-project-details @@ -94,10 +86,6 @@ Emitted when project details are received `void` -#### Defined in - -[src/local-peers.js:228](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L228) - ___ ### invite @@ -121,10 +109,6 @@ Emitted when an invite is received `void` -#### Defined in - -[src/local-peers.js:225](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L225) - ___ ### invite-cancel @@ -148,10 +132,6 @@ Emitted when we receive a cancelation for an invite `void` -#### Defined in - -[src/local-peers.js:226](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L226) - ___ ### invite-response @@ -175,10 +155,6 @@ Emitted when an invite response is received `void` -#### Defined in - -[src/local-peers.js:227](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L227) - ___ ### peer-add @@ -201,10 +177,6 @@ Emitted when a new peer is connected `void` -#### Defined in - -[src/local-peers.js:224](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L224) - ___ ### peers @@ -226,7 +198,3 @@ Emitted whenever the connection status of peers changes. An array of peerInfo ob ##### Returns `void` - -#### Defined in - -[src/local-peers.js:223](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L223) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md index 49416ee3d..fd9593108 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md @@ -15,7 +15,3 @@ ### name • **name**: `undefined` \| `string` - -#### Defined in - -[src/schema/client.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L12) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md index 507f3838e..19e1ab21c 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md @@ -20,10 +20,6 @@ known (sparse) length of the core -#### Defined in - -[src/sync/core-sync-state.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L32) - ___ ### localState @@ -32,10 +28,6 @@ ___ local state -#### Defined in - -[src/sync/core-sync-state.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L33) - ___ ### remoteStates @@ -43,7 +35,3 @@ ___ • **remoteStates**: `Object` map of state of all known peers - -#### Defined in - -[src/sync/core-sync-state.js:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L34) diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md index bfc49bd70..b735c8dce 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md +++ b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md @@ -22,46 +22,26 @@ Core length, e.g. how many blocks in the core (including blocks that are not downloaded) -#### Defined in - -[src/sync/core-sync-state.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L14) - ___ ### localState • **localState**: `PeerState` -#### Defined in - -[src/sync/core-sync-state.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L15) - ___ ### namespace • **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` -#### Defined in - -[src/sync/core-sync-state.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L18) - ___ ### peerSyncControllers • **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/internal_.PeerSyncController.md)\> -#### Defined in - -[src/sync/core-sync-state.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L17) - ___ ### remoteStates • **remoteStates**: `Map`\<`string`, `PeerState`\> - -#### Defined in - -[src/sync/core-sync-state.js:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L16) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md index 1e87ccbff..d776f04b3 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md @@ -62,16 +62,8 @@ Re-exports [Namespace](internal_.md#namespace-1) Ƭ **DuplexStream**\<\>: `Duplex` -#### Defined in - -[src/core-manager/index.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L22) - ## Variables ### kCoreManagerReplicate • `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) - -#### Defined in - -[src/core-manager/index.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L17) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md index e210cf653..0de58552b 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md @@ -41,20 +41,12 @@ Re-exports [NamespaceSchemas](internal_.md#namespaceschemas) | :------ | :------ | | `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | -#### Defined in - -[src/datastore/index.js:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L22) - ___ ### MapeoDocTablesMap Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } -#### Defined in - -[src/datatype/index.d.ts:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L24) - ___ ### OmitUnion @@ -67,7 +59,3 @@ ___ | :------ | :------ | | `T` | `T` | | `K` | extends keyof `any` | - -#### Defined in - -[src/datastore/index.js:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L27) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md index 19603e915..5530c48c9 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md @@ -64,46 +64,26 @@ Re-exports [PeerInfoDisconnected](internal_.md#peerinfodisconnected) Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) -#### Defined in - -[src/local-peers.js:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L51) - ___ ### PeerInfoConnecting Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } -#### Defined in - -[src/local-peers.js:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L46) - ___ ### PeerInfoInternal Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) \| [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) -#### Defined in - -[src/local-peers.js:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L50) - ___ ### PeerState Ƭ **PeerState**\<\>: [`PeerInfoInternal`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal)[``"status"``] -#### Defined in - -[src/local-peers.js:52](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L52) - ## Variables ### kTestOnlySendRawInvite • `Const` **kTestOnlySendRawInvite**: typeof [`kTestOnlySendRawInvite`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) - -#### Defined in - -[src/local-peers.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L38) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md index 7ed165697..f60079d04 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md @@ -73,50 +73,30 @@ Re-exports [Roles](../classes/internal_.Roles.md) Ƭ **RoleIdAssignableToAnyone**\<\>: [`ElementOf`](internal_.md#elementof)\ -#### Defined in - -[src/roles.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L44) - ___ ### RoleIdAssignableToOthers Ƭ **RoleIdAssignableToOthers**\<\>: [`ElementOf`](internal_.md#elementof)\ -#### Defined in - -[src/roles.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L38) - ___ ### RoleIdForNewInvite Ƭ **RoleIdForNewInvite**\<\>: [`ElementOf`](internal_.md#elementof)\ -#### Defined in - -[src/roles.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L32) - ## Variables ### BLOCKED\_ROLE\_ID • `Const` **BLOCKED\_ROLE\_ID**: ``"9e6d29263cba36c9"`` -#### Defined in - -[src/roles.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L10) - ___ ### COORDINATOR\_ROLE\_ID • `Const` **COORDINATOR\_ROLE\_ID**: ``"f7c150f5a3a9a855"`` -#### Defined in - -[src/roles.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L8) - ___ ### CREATOR\_ROLE @@ -127,40 +107,24 @@ This is currently the same as 'Coordinator' role, but defined separately because the creator should always have ALL powers, but we could edit the 'Coordinator' powers in the future. -#### Defined in - -[src/roles.js:80](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L80) - ___ ### CREATOR\_ROLE\_ID • `Const` **CREATOR\_ROLE\_ID**: ``"a12a6702b93bd7ff"`` -#### Defined in - -[src/roles.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L7) - ___ ### LEFT\_ROLE\_ID • `Const` **LEFT\_ROLE\_ID**: ``"8ced989b1904606b"`` -#### Defined in - -[src/roles.js:11](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L11) - ___ ### MEMBER\_ROLE\_ID • `Const` **MEMBER\_ROLE\_ID**: ``"012fd2d431c0bf60"`` -#### Defined in - -[src/roles.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L9) - ___ ### NO\_ROLE @@ -174,20 +138,12 @@ able to sync the auth and config store, because that way they may be able to receive their role record, and they can get the project config so that they can start collecting data. -#### Defined in - -[src/roles.js:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L109) - ___ ### NO\_ROLE\_ID • `Const` **NO\_ROLE\_ID**: ``"08e4251e36f6e7ed"`` -#### Defined in - -[src/roles.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L12) - ___ ### ROLES @@ -205,10 +161,6 @@ ___ | `a12a6702b93bd7ff` | [`Role`](../interfaces/internal_.Role.md)\<``"a12a6702b93bd7ff"``\> | | `f7c150f5a3a9a855` | [`Role`](../interfaces/internal_.Role.md)\<``"f7c150f5a3a9a855"``\> | -#### Defined in - -[src/roles.js:129](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L129) - ## Functions ### isRoleIdAssignableToOthers @@ -225,10 +177,6 @@ ___ value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" -#### Defined in - -[src/roles.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L42) - ___ ### isRoleIdForNewInvite @@ -244,7 +192,3 @@ ___ #### Returns value is "f7c150f5a3a9a855" \| "012fd2d431c0bf60" \| "9e6d29263cba36c9" - -#### Defined in - -[src/roles.js:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L36) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md index 59b5f1c1e..dfa654a55 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md @@ -33,36 +33,20 @@ Re-exports [DeviceInfoParam](internal_.md#deviceinfoparam) • `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/client.js:51](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L51) - ___ ### projectBacklinkTable • `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/client.js:27](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L27) - ___ ### projectKeysTable • `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/client.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L28) - ___ ### projectSettingsTable • `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/client.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L23) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md index a69b2a9fc..4111b9068 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md @@ -34,186 +34,110 @@ • `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:36](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L36) - ___ ### coreOwnershipTable • `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L20) - ___ ### coresTable • `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:41](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L41) - ___ ### deviceInfoBacklinkTable • `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:38](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L38) - ___ ### deviceInfoTable • `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:25](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L25) - ___ ### fieldBacklinkTable • `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L35) - ___ ### fieldTable • `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L19) - ___ ### iconBacklinkTable • `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L39) - ___ ### iconTable • `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:29](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L29) - ___ ### observationBacklinkTable • `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:32](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L32) - ___ ### observationTable • `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L13) - ___ ### presetBacklinkTable • `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L34) - ___ ### presetTable • `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L18) - ___ ### roleBacklinkTable • `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L37) - ___ ### roleTable • `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:24](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L24) - ___ ### trackBacklinkTable • `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L33) - ___ ### trackTable • `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L17) - ___ ### translationBacklinkTable • `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> -#### Defined in - -[src/schema/project.js:31](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L31) - ___ ### translationTable • `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> - -#### Defined in - -[src/schema/project.js:9](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/project.js#L9) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md index a8bd4f246..de7e8068d 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md @@ -50,20 +50,12 @@ Re-exports [PeerCoreState](internal_.md#peercorestate) Ƭ **Bitfield**\<\>: [`default`](../classes/internal_.default-2.md) -#### Defined in - -[src/sync/core-sync-state.js:7](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L7) - ___ ### PeerId Ƭ **PeerId**\<\>: `string` -#### Defined in - -[src/sync/core-sync-state.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L10) - ## Functions ### bitCount32 @@ -82,7 +74,3 @@ https://stackoverflow.com/a/109025/903300 #### Returns `number` - -#### Defined in - -[src/sync/core-sync-state.js:431](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L431) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md index 536f5504a..5fbaa28ce 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md @@ -24,10 +24,6 @@ Ƭ **SyncState**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } -#### Defined in - -[src/sync/namespace-sync-state.js:5](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L5) - ## Functions ### createState @@ -38,10 +34,6 @@ [`CoreState`](../interfaces/internal_.CoreState.md) -#### Defined in - -[src/sync/namespace-sync-state.js:136](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L136) - ▸ **createState**(`status`): [`PeerCoreState`](internal_.md#peercorestate) #### Parameters @@ -53,7 +45,3 @@ #### Returns [`PeerCoreState`](internal_.md#peercorestate) - -#### Defined in - -[src/sync/namespace-sync-state.js:141](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/namespace-sync-state.js#L141) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md index f5277f1ed..eb8206d24 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md +++ b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md @@ -49,20 +49,12 @@ Re-exports [OpenedNoiseStream](internal_.md#openednoisestream) Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noisestream) & \{ `destroyed`: ``true`` } -#### Defined in - -[src/utils.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L44) - ___ ### NoiseStream Ƭ **NoiseStream**\<\>: `__module` -#### Defined in - -[src/utils.js:43](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L43) - ## Functions ### assert @@ -80,10 +72,6 @@ ___ asserts condition -#### Defined in - -[src/utils.js:81](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L81) - ___ ### createMap @@ -110,10 +98,6 @@ Small helper to create a typed map `Record`\<`K`, `V` extends () => `T` ? `T` : `V`\> -#### Defined in - -[src/utils.js:189](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L189) - ___ ### deNullify @@ -140,10 +124,6 @@ defined in @mapeo/schema) \{ [KeyType in string \| number \| symbol]: RemoveNull\<\{ [KeyType in string \| number \| symbol]: (\{ [KeyType in string \| number \| symbol as Filter\]: T[KeyType] } & Partial\\>)[KeyType] }\>[KeyType] } -#### Defined in - -[src/utils.js:116](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L116) - ___ ### getDeviceId @@ -160,10 +140,6 @@ ___ `string` -#### Defined in - -[src/utils.js:177](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L177) - ___ ### hashObject @@ -184,10 +160,6 @@ create a sha256 hash of an object using json-stable-stringify for deterministic hash of the object -#### Defined in - -[src/utils.js:202](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L202) - ___ ### idToKey @@ -204,10 +176,6 @@ ___ `Buffer` \| `Uint8Array` -#### Defined in - -[src/utils.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L10) - ___ ### keyToId @@ -224,10 +192,6 @@ ___ `string` -#### Defined in - -[src/utils.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L23) - ___ ### noop @@ -238,10 +202,6 @@ ___ `void` -#### Defined in - -[src/utils.js:74](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L74) - ___ ### openedNoiseSecretStream @@ -262,10 +222,6 @@ stream is opened) `Promise`\<[`DestroyedNoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> -#### Defined in - -[src/utils.js:58](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L58) - ___ ### parseVersion @@ -287,10 +243,6 @@ ___ | `blockIndex` | `number` | | `coreId` | `string` | -#### Defined in - -[src/utils.js:35](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L35) - ___ ### projectIdToNonce @@ -309,10 +261,6 @@ ___ 24-byte nonce (same length as sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES) -#### Defined in - -[src/utils.js:169](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L169) - ___ ### projectKeyToId @@ -331,10 +279,6 @@ Create an internal ID from a project key `string` -#### Defined in - -[src/utils.js:152](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L152) - ___ ### projectKeyToPublicId @@ -353,10 +297,6 @@ Create a public ID from a project key `string` -#### Defined in - -[src/utils.js:161](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L161) - ___ ### setHas @@ -405,10 +345,6 @@ console.log(isInMySet(2)) // => true ``` -#### Defined in - -[src/utils.js:99](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L99) - ___ ### valueOf @@ -430,7 +366,3 @@ ___ #### Returns `Omit`\<`T`, ``"docId"`` \| ``"versionId"`` \| ``"links"`` \| ``"forks"`` \| ``"createdAt"`` \| ``"updatedAt"`` \| ``"createdBy"`` \| ``"deleted"``\> - -#### Defined in - -[src/utils.js:130](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L130) diff --git a/docs/api/md/modules/internal_.md b/docs/api/md/modules/internal_.md index 671cf0b97..f05c43b2e 100644 --- a/docs/api/md/modules/internal_.md +++ b/docs/api/md/modules/internal_.md @@ -209,50 +209,30 @@ Re-exports [SyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_nam | :------ | | `T` | -#### Defined in - -[src/types.ts:40](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L40) - ___ ### BitField Ƭ **BitField**: `TypedArray` -#### Defined in - -[types/quickbit-universal.d.ts:2](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L2) - ___ ### BlobDownloadStateError Ƭ **BlobDownloadStateError**\<\>: `Omit`\<[`BlobDownloadState`](../interfaces/internal_.BlobDownloadState.md), ``"error"`` \| ``"status"``\> & \{ `error`: `Error` ; `status`: ``"error"`` } -#### Defined in - -[src/blob-store/live-download.js:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/live-download.js#L18) - ___ ### BlobFilter Ƭ **BlobFilter**: `RequireAtLeastOne`\<\{ [KeyType in BlobType]: ArrayAtLeastOne\\> }\> -#### Defined in - -[src/types.ts:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L42) - ___ ### BlobId Ƭ **BlobId**: `Simplify`\<`ValueOf`\<\{ [KeyType in BlobType]: BlobIdBase\ }\>\> -#### Defined in - -[src/types.ts:34](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L34) - ___ ### BlobIdBase @@ -274,20 +254,12 @@ ___ | `type` | `T` | Type of blob | | `variant` | [`BlobVariant`](internal_.md#blobvariant)\<`T`\> | Blob variant (some blob types have smaller previews and thumbnails available) | -#### Defined in - -[src/types.ts:22](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L22) - ___ ### BlobType Ƭ **BlobType**: keyof [`SupportedBlobVariants`](internal_.md#supportedblobvariants) -#### Defined in - -[src/types.ts:17](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L17) - ___ ### BlobVariant @@ -300,10 +272,6 @@ ___ | :------ | :------ | | `TBlobType` | extends [`BlobType`](internal_.md#blobtype) | -#### Defined in - -[src/types.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L18) - ___ ### Chunk @@ -317,40 +285,24 @@ ___ | `field` | [`BitField`](internal_.md#bitfield) | | `offset` | `number` | -#### Defined in - -[types/quickbit-universal.d.ts:37](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/quickbit-universal.d.ts#L37) - ___ ### Core Ƭ **Core**\<\>: `__module` -#### Defined in - -[src/core-manager/index.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L19) - ___ ### CoreOwnershipWithSignatures Ƭ **CoreOwnershipWithSignatures**: `Extract`\<`ReturnType`\, \{ `schemaName`: ``"coreOwnership"`` }\> -#### Defined in - -[src/types.ts:55](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L55) - ___ ### CoreOwnershipWithSignaturesValue Ƭ **CoreOwnershipWithSignaturesValue**: `Omit`\<[`CoreOwnershipWithSignatures`](internal_.md#coreownershipwithsignatures), `Exclude`\\> -#### Defined in - -[src/types.ts:59](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L59) - ___ ### CoreRecord @@ -365,10 +317,6 @@ ___ | `key` | `Buffer` | | `namespace` | [`Namespace`](internal_.md#namespace-1) | -#### Defined in - -[src/core-manager/index.js:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L21) - ___ ### CoreStorage @@ -389,30 +337,18 @@ ___ `RandomAccessStorage` -#### Defined in - -[src/types.ts:114](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L114) - ___ ### DeviceInfoParam Ƭ **DeviceInfoParam**\<\>: `Omit`\<`DeviceInfoValue`, ``"schemaName"``\> -#### Defined in - -[src/schema/client.js:42](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/schema/client.js#L42) - ___ ### EditableProjectSettings Ƭ **EditableProjectSettings**\<\>: `Omit`\<`ProjectSettingsValue`, ``"schemaName"``\> -#### Defined in - -[src/mapeo-project.js:54](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-project.js#L54) - ___ ### ElementOf @@ -425,10 +361,6 @@ ___ | :------ | | `T` | -#### Defined in - -[src/roles.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L15) - ___ ### GetMapeoDocTables @@ -441,40 +373,24 @@ ___ | :------ | | `T` | -#### Defined in - -[src/datatype/index.d.ts:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L19) - ___ ### IndexedDocIds Ƭ **IndexedDocIds**\<\>: \{ [K in MapeoDoc["schemaName"]]?: string[] } -#### Defined in - -[src/index-writer/index.js:15](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/index-writer/index.js#L15) - ___ ### InternalDriveEmitter Ƭ **InternalDriveEmitter**\<\>: `TypedEmitter`\<\{ `add-drive`: (`drive`: [`"hyperdrive"`](internal_._hyperdrive_.md)) => `void` }\> -#### Defined in - -[src/blob-store/index.js:8](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L8) - ___ ### InviteInternal Ƭ **InviteInternal**\<\>: `InviteRpcMessage` & \{ `receivedAt`: `number` } -#### Defined in - -[src/invite-api.js:23](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/invite-api.js#L23) - ___ ### KeyPair @@ -488,10 +404,6 @@ ___ | `publicKey` | [`PublicKey`](internal_.md#publickey) | | `secretKey` | [`SecretKey`](internal_.md#secretkey) | -#### Defined in - -[src/types.ts:97](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L97) - ___ ### Keypair @@ -505,10 +417,6 @@ ___ | `publicKey` | `Buffer` | | `secretKey` | `Buffer` | -#### Defined in - -[src/discovery/local-discovery.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L13) - ___ ### MapBuffers @@ -523,30 +431,18 @@ Replace an object's `Buffer` values with `string`s. Useful for serialization. | :------ | | `T` | -#### Defined in - -[src/types.ts:86](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L86) - ___ ### MapeoDocMap Ƭ **MapeoDocMap**: \{ [K in MapeoDoc["schemaName"]]: Extract\ } -#### Defined in - -[src/types.ts:46](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L46) - ___ ### MapeoDocTableName Ƭ **MapeoDocTableName**: \`$\{MapeoDoc["schemaName"]}Table\` -#### Defined in - -[src/datatype/index.d.ts:18](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L18) - ___ ### MapeoDocTables @@ -555,40 +451,24 @@ ___ Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables) -#### Defined in - -[src/datatype/index.d.ts:21](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datatype/index.d.ts#L21) - ___ ### MapeoValueMap Ƭ **MapeoValueMap**: \{ [K in MapeoValue["schemaName"]]: Extract\ } -#### Defined in - -[src/types.ts:50](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L50) - ___ ### Namespace Ƭ **Namespace**\<\>: typeof [`NAMESPACES`](internal_.md#namespaces)[`number`] -#### Defined in - -[src/core-manager/index.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/core-manager/index.js#L20) - ___ ### NamespaceSchemas Ƭ **NamespaceSchemas**\<\>: typeof [`NAMESPACE_SCHEMAS`](internal_.md#namespace_schemas) -#### Defined in - -[src/datastore/index.js:44](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L44) - ___ ### OpenedNoiseStream @@ -601,70 +481,42 @@ ___ | :------ | :------ | | `T` | extends `Duplex` \| `Duplex` = `Duplex` \| `Duplex` | -#### Defined in - -[src/utils.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/utils.js#L47) - ___ ### OpenedNoiseStream Ƭ **OpenedNoiseStream**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/utils"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) -#### Defined in - -[src/discovery/local-discovery.js:14](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/discovery/local-discovery.js#L14) - ___ ### PeerCoreState Ƭ **PeerCoreState**\<\>: [`CoreState`](../interfaces/internal_.CoreState.md) & \{ `status`: ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` } -#### Defined in - -[src/sync/core-sync-state.js:28](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/core-sync-state.js#L28) - ___ ### PeerInfoConnected Ƭ **PeerInfoConnected**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `connectedAt`: `number` ; `protomux`: [`Protomux`](../classes/internal_.Protomux.md)\<`__module`\> ; `status`: ``"connected"`` } -#### Defined in - -[src/local-peers.js:47](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L47) - ___ ### PeerInfoDisconnected Ƭ **PeerInfoDisconnected**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `disconnectedAt`: `number` ; `status`: ``"disconnected"`` } -#### Defined in - -[src/local-peers.js:48](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/local-peers.js#L48) - ___ ### Primitive Ƭ **Primitive**\<\>: `string` \| `number` \| `bigint` \| `boolean` \| `undefined` \| `symbol` \| ``null`` -#### Defined in - -[src/lib/hashmap.js:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/lib/hashmap.js#L3) - ___ ### ProtocolStream Ƭ **ProtocolStream**: `Omit`\<`NoiseStream`, ``"userData"``\> & \{ `userData`: [`Protomux`](../classes/internal_.Protomux.md) } -#### Defined in - -[src/types.ts:109](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L109) - ___ ### PublicKey @@ -673,30 +525,18 @@ ___ 32 byte buffer -#### Defined in - -[src/types.ts:103](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L103) - ___ ### PublicPeerInfo Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/local-peers"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md), ``"protomux"``\> -#### Defined in - -[src/mapeo-manager.js:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/mapeo-manager.js#L65) - ___ ### Range Ƭ **Range**: \{ `end`: `number` ; `linear`: `boolean` ; `start`: `number` } \| \{ `blocks`: `number`[] } -#### Defined in - -[types/hyperdrive.d.ts:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/types/hyperdrive.d.ts#L12) - ___ ### RemoveNull @@ -709,30 +549,18 @@ ___ | :------ | | `T` | -#### Defined in - -[src/types.ts:65](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L65) - ___ ### ReplicationStream Ƭ **ReplicationStream**: `Duplex` & \{ `noiseStream`: [`ProtocolStream`](internal_.md#protocolstream) } -#### Defined in - -[src/types.ts:112](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L112) - ___ ### RoleId Ƭ **RoleId**\<\>: [`ElementOf`](internal_.md#elementof)\ -#### Defined in - -[src/roles.js:19](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L19) - ___ ### SecretKey @@ -741,60 +569,36 @@ ___ 32 byte buffer -#### Defined in - -[src/types.ts:105](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L105) - ___ ### State Ƭ **State**\<\>: `Record`\<[`"/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md), [`"/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md)\> -#### Defined in - -[src/sync/sync-state.js:12](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-state.js#L12) - ___ ### SupportedBlobVariants Ƭ **SupportedBlobVariants**: typeof [`SUPPORTED_BLOB_VARIANTS`](internal_.md#supported_blob_variants) -#### Defined in - -[src/types.ts:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/types.ts#L16) - ___ ### SyncCapability Ƭ **SyncCapability**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/roles"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md)[``"sync"``][[`Namespace`](internal_.md#namespace)] \| ``"unknown"`` -#### Defined in - -[src/sync/peer-sync-controller.js:10](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/peer-sync-controller.js#L10) - ___ ### SyncType Ƭ **SyncType**\<\>: ``"initial"`` \| ``"full"`` -#### Defined in - -[src/sync/sync-api.js:16](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/sync/sync-api.js#L16) - ## Variables ### NAMESPACES • `Const` **NAMESPACES**: readonly [``"auth"``, ``"config"``, ``"data"``, ``"blobIndex"``, ``"blob"``] -#### Defined in - -[src/constants.js:3](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/constants.js#L3) - ___ ### NAMESPACE\_SCHEMAS @@ -813,50 +617,30 @@ ___ | `config` | readonly [``"translation"``, ``"preset"``, ``"field"``, ``"projectSettings"``, ``"deviceInfo"``, ``"icon"``] | | `data` | readonly [``"observation"``, ``"track"``] | -#### Defined in - -[src/datastore/index.js:30](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/datastore/index.js#L30) - ___ ### ROLE\_IDS • `Const` **ROLE\_IDS**: `Set`\<``"a12a6702b93bd7ff"`` \| ``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"`` \| ``"08e4251e36f6e7ed"``\> -#### Defined in - -[src/roles.js:20](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L20) - ___ ### ROLE\_IDS\_ASSIGNABLE\_TO\_ANYONE • `Const` **ROLE\_IDS\_ASSIGNABLE\_TO\_ANYONE**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"`` \| ``"8ced989b1904606b"``\> -#### Defined in - -[src/roles.js:45](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L45) - ___ ### ROLE\_IDS\_ASSIGNABLE\_TO\_OTHERS • `Const` **ROLE\_IDS\_ASSIGNABLE\_TO\_OTHERS**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``\> -#### Defined in - -[src/roles.js:39](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L39) - ___ ### ROLE\_IDS\_FOR\_NEW\_INVITE • `Const` **ROLE\_IDS\_FOR\_NEW\_INVITE**: `Set`\<``"f7c150f5a3a9a855"`` \| ``"012fd2d431c0bf60"`` \| ``"9e6d29263cba36c9"``\> -#### Defined in - -[src/roles.js:33](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/roles.js#L33) - ___ ### SUPPORTED\_BLOB\_VARIANTS @@ -870,7 +654,3 @@ ___ | `audio` | readonly [``"original"``] | | `photo` | readonly [``"original"``, ``"preview"``, ``"thumbnail"``] | | `video` | readonly [``"original"``] | - -#### Defined in - -[src/blob-store/index.js:13](https://github.com/digidem/mapeo-core-next/blob/315dc9781d8d2f74f17b1fd651a3ae81272b7fac/src/blob-store/index.js#L13) diff --git a/typedoc.json b/typedoc.json index 33eb3ba1b..54b1ce012 100644 --- a/typedoc.json +++ b/typedoc.json @@ -5,5 +5,6 @@ "readme": "none", "name": "API", "excludePrivate": true, - "excludeExternals": true + "excludeExternals": true, + "disableSources": true } From 7489da9d6e9200556e9aab29a3b3ab6373c9d4ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:25:50 -0300 Subject: [PATCH 14/28] test commiting new api docs on prepublish --- .github/workflows/release.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5faed501f..256e2651e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,6 +32,15 @@ jobs: uses: actions/setup-node@v3 with: node-version: 18 + - name: Publish docs api to repo + run: | + npm ci + npm run doc + git status + git add docs/api/md + git commit -am "updated api docs" + git fetch origin main + git push origin main - uses: nearform-actions/optic-release-automation-action@v4 with: commit-message: 'Release {version}' From 6c1a966ebd0f1548536e16694ab2d419d3773b76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:31:43 -0300 Subject: [PATCH 15/28] test modifying repo docs on push (before testing on prerelease flow) --- .github/workflows/docs.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a4e0fd4fe..bf2327a26 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,6 +15,15 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: + - name: Publish docs api to repo + run: | + npm ci + npm run doc + git status + git add docs/api/md + git commit -am "updated api docs" + git fetch origin main + git push origin main - uses: actions/checkout@v4 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 From 3c4ae207262de8d4980d1320421576660f9435c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:33:35 -0300 Subject: [PATCH 16/28] add action/checkout@v4 to publish docs api to repo --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bf2327a26..79aa7b1aa 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,6 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Publish docs api to repo + uses: actions/checkout@v4 run: | npm ci npm run doc From ffe1d458743520dc48d885655c9f522eedf6a950 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:39:22 -0300 Subject: [PATCH 17/28] change order of steps to have node and npm --- .github/workflows/docs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 79aa7b1aa..60edac951 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,6 +15,11 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: + - uses: actions/checkout@v4 + - name: Use Node.js ${{ matrix.node-version }} + - uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} - name: Publish docs api to repo uses: actions/checkout@v4 run: | @@ -25,11 +30,6 @@ jobs: git commit -am "updated api docs" git fetch origin main git push origin main - - uses: actions/checkout@v4 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 - with: - node-version: ${{ matrix.node-version }} - run: npm ci - run: npm run doc:publish - id: upload-documentation From 41f13aa40cc77814b711e8b7326b967e98616110 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:40:59 -0300 Subject: [PATCH 18/28] fix stuff --- .github/workflows/docs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 60edac951..f3af5779f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,11 +17,10 @@ jobs: steps: - uses: actions/checkout@v4 - name: Use Node.js ${{ matrix.node-version }} - - uses: actions/setup-node@v3 + uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} - name: Publish docs api to repo - uses: actions/checkout@v4 run: | npm ci npm run doc From 4d247fbd9adf91f7b0635515f87cfc822a25ecb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:44:03 -0300 Subject: [PATCH 19/28] git user setup --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f3af5779f..f351943b4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,6 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + - uses: fregante/setup-git-user@v1 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: @@ -25,7 +26,7 @@ jobs: npm ci npm run doc git status - git add docs/api/md + git add -f docs/api/md git commit -am "updated api docs" git fetch origin main git push origin main From 896d664e826e238270ff7c6554653a8a4324db8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:46:52 -0300 Subject: [PATCH 20/28] remove unnecessary step, remove git fetch --- .github/workflows/docs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f351943b4..b5d4f46ce 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,9 +28,7 @@ jobs: git status git add -f docs/api/md git commit -am "updated api docs" - git fetch origin main git push origin main - - run: npm ci - run: npm run doc:publish - id: upload-documentation name: Upload Pages artifact From ce0117ca9d6c72a209dcd680813fe9a855389383 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 13:57:56 -0300 Subject: [PATCH 21/28] use external action to update repo --- .github/workflows/docs.yml | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b5d4f46ce..83e76f1a1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,22 +16,25 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: fregante/setup-git-user@v1 + - name: Set git user + uses: fregante/setup-git-user@v1 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} - - name: Publish docs api to repo + - name: Generate Api docs run: | npm ci npm run doc - git status - git add -f docs/api/md - git commit -am "updated api docs" - git push origin main - - run: npm run doc:publish + - name: Push updated markdown docs + uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: 'Update api markdown docs' + file_pattern: 'docs/api/md/*' + - name: Generate HTML documentation + run: npm run doc:publish - id: upload-documentation - name: Upload Pages artifact + name: Upload documentation to Pages uses: actions/upload-pages-artifact@v2 with: path: docs/api/html From f41d3dcd1d7a5e6457d96fe44f76587b7a737ffc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 14:00:34 -0300 Subject: [PATCH 22/28] allow gh action to write repo (!!) --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 83e76f1a1..0a8fe7cb2 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -10,6 +10,7 @@ jobs: permissions: id-token: write pages: write + contents: write environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} From cd48cad7d8cd0627645d372596df98726bd6d531 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 14 May 2024 14:22:32 -0300 Subject: [PATCH 23/28] update docs/README.md to point to md api --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 5b56b8fe9..6fc09e365 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ In most cases you'll be using the [mobile](https://github.com/digidem/mapeo-mobi ## API reference -Get detailed information about the classes, methods, function, and types of Mapeo Core in the [API docs](./api/). +Get detailed information about the classes, methods, function, and types of Mapeo Core in the [API docs](./api/md/). ## Developing From 4a624f140505fb80e61a8d56f642513e331de247 Mon Sep 17 00:00:00 2001 From: tomasciccola Date: Tue, 14 May 2024 17:26:21 +0000 Subject: [PATCH 24/28] Update api markdown docs --- .../api/md/classes/internal_.CoreSyncState.md | 4 +- docs/api/md/classes/internal_.DataType.md | 2 +- docs/api/md/classes/internal_.Peer.md | 4 +- ..._src_local_peers_.PeerDisconnectedError.md | 51 +++++++ ..._local_peers_.PeerFailedConnectionError.md | 51 +++++++ ..._next_src_local_peers_.UnknownPeerError.md | 51 +++++++ ...amespace_sync_state_.NamespaceSyncState.md | 88 +++++++++++ ...ore_next_src_utils_.ExhaustivenessError.md | 51 +++++++ ..._src_local_peers_.PeerDisconnectedError.md | 51 ------- ..._local_peers_.PeerFailedConnectionError.md | 51 ------- ..._next_src_local_peers_.UnknownPeerError.md | 51 ------- ...amespace_sync_state_.NamespaceSyncState.md | 88 ----------- ...ore_next_src_utils_.ExhaustivenessError.md | 51 ------- ...re_next_src_core_manager_index_.Events.md} | 8 +- ...next_src_local_peers_.LocalPeersEvents.md} | 24 +-- ...ore_next_src_schema_client_.ProjectInfo.md | 17 +++ ..._src_sync_core_sync_state_.DerivedState.md | 37 +++++ ...src_sync_core_sync_state_.InternalState.md | 47 ++++++ ...ore_next_src_schema_client_.ProjectInfo.md | 17 --- ..._src_sync_core_sync_state_.DerivedState.md | 37 ----- ...src_sync_core_sync_state_.InternalState.md | 47 ------ ...mapeo_core_next_src_core_manager_index_.md | 69 +++++++++ ...xt_mapeo_core_next_src_datastore_index_.md | 61 ++++++++ ...e_next_mapeo_core_next_src_local_peers_.md | 89 +++++++++++ ...o_core_next_mapeo_core_next_src_roles_.md} | 44 +++--- ...next_mapeo_core_next_src_schema_client_.md | 52 +++++++ ...ext_mapeo_core_next_src_schema_project_.md | 143 ++++++++++++++++++ ...peo_core_next_src_sync_core_sync_state_.md | 76 ++++++++++ ...ore_next_src_sync_namespace_sync_state_.md | 47 ++++++ ...o_core_next_mapeo_core_next_src_utils_.md} | 50 +++--- ...mapeo_core_next_src_core_manager_index_.md | 69 --------- ...dd_mapeo_core_next_src_datastore_index_.md | 61 -------- ...src_dd_mapeo_core_next_src_local_peers_.md | 89 ----------- ...c_dd_mapeo_core_next_src_schema_client_.md | 52 ------- ..._dd_mapeo_core_next_src_schema_project_.md | 143 ------------------ ...peo_core_next_src_sync_core_sync_state_.md | 76 ---------- ...ore_next_src_sync_namespace_sync_state_.md | 47 ------ docs/api/md/modules/internal_.md | 32 ++-- 38 files changed, 1014 insertions(+), 1014 deletions(-) create mode 100644 docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md create mode 100644 docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md create mode 100644 docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md create mode 100644 docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md create mode 100644 docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md delete mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md delete mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md delete mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md delete mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md delete mode 100644 docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md rename docs/api/md/interfaces/{internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md => internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md} (62%) rename docs/api/md/interfaces/{internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md => internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md} (67%) create mode 100644 docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md create mode 100644 docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md create mode 100644 docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md delete mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md delete mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md delete mode 100644 docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md rename docs/api/md/modules/{internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md => internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md} (61%) create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md create mode 100644 docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md rename docs/api/md/modules/{internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md => internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md} (65%) delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md delete mode 100644 docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md diff --git a/docs/api/md/classes/internal_.CoreSyncState.md b/docs/api/md/classes/internal_.CoreSyncState.md index fdb553d7e..8ccfed990 100644 --- a/docs/api/md/classes/internal_.CoreSyncState.md +++ b/docs/api/md/classes/internal_.CoreSyncState.md @@ -92,11 +92,11 @@ ___ ### getState -▸ **getState**(): [`DerivedState`](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) +▸ **getState**(): [`DerivedState`](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) #### Returns -[`DerivedState`](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) +[`DerivedState`](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) ___ diff --git a/docs/api/md/classes/internal_.DataType.md b/docs/api/md/classes/internal_.DataType.md index 4ed90b624..0d8081a5b 100644 --- a/docs/api/md/classes/internal_.DataType.md +++ b/docs/api/md/classes/internal_.DataType.md @@ -8,7 +8,7 @@ | Name | Type | | :------ | :------ | -| `TDataStore` | extends [`"/home/szgy/src/dd/mapeo-core-next/src/datastore/index"`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md) | +| `TDataStore` | extends [`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/datastore/index"`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md) | | `TTable` | extends [`MapeoDocTables`](../modules/internal_.md#mapeodoctables-1) | | `TSchemaName` | extends `TTable`[``"_"``][``"name"``] | | `TDoc` | extends [`MapeoDocMap`](../modules/internal_.md#mapeodocmap)[`TSchemaName`] | diff --git a/docs/api/md/classes/internal_.Peer.md b/docs/api/md/classes/internal_.Peer.md index b26b67244..4b09fbadb 100644 --- a/docs/api/md/classes/internal_.Peer.md +++ b/docs/api/md/classes/internal_.Peer.md @@ -65,11 +65,11 @@ ___ ### info -• `get` **info**(): [`PeerInfoInternal`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) +• `get` **info**(): [`PeerInfoInternal`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfointernal) #### Returns -[`PeerInfoInternal`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) +[`PeerInfoInternal`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfointernal) ___ diff --git a/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md new file mode 100644 index 000000000..ba72e6922 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md @@ -0,0 +1,51 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md) / PeerDisconnectedError + +# Class: PeerDisconnectedError + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md).PeerDisconnectedError + +## Hierarchy + +- `Error` + + ↳ **`PeerDisconnectedError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#constructor) + +### Properties + +- [name](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#name) + +## Constructors + +### constructor + +• **new PeerDisconnectedError**(`message?`): [`PeerDisconnectedError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerDisconnectedError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) + +#### Overrides + +Error.constructor + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name diff --git a/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md new file mode 100644 index 000000000..cfaa80c6b --- /dev/null +++ b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md @@ -0,0 +1,51 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md) / PeerFailedConnectionError + +# Class: PeerFailedConnectionError + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md).PeerFailedConnectionError + +## Hierarchy + +- `Error` + + ↳ **`PeerFailedConnectionError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#constructor) + +### Properties + +- [name](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#name) + +## Constructors + +### constructor + +• **new PeerFailedConnectionError**(`message?`): [`PeerFailedConnectionError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`PeerFailedConnectionError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) + +#### Overrides + +Error.constructor + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name diff --git a/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md new file mode 100644 index 000000000..29448a137 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md @@ -0,0 +1,51 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md) / UnknownPeerError + +# Class: UnknownPeerError + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md).UnknownPeerError + +## Hierarchy + +- `Error` + + ↳ **`UnknownPeerError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md#constructor) + +### Properties + +- [name](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md#name) + +## Constructors + +### constructor + +• **new UnknownPeerError**(`message?`): [`UnknownPeerError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`UnknownPeerError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +#### Overrides + +Error.constructor + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name diff --git a/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md new file mode 100644 index 000000000..72cefa4bf --- /dev/null +++ b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md @@ -0,0 +1,88 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md) / NamespaceSyncState + +# Class: NamespaceSyncState\ + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md).NamespaceSyncState + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | [`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index"`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md) | + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#constructor) + +### Accessors + +- [namespace](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#namespace) + +### Methods + +- [addPeer](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#addpeer) +- [getState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#getstate) + +## Constructors + +### constructor + +• **new NamespaceSyncState**\<`TNamespace`\>(`opts`): [`NamespaceSyncState`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TNamespace` | extends ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` = ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `opts` | `Object` | | +| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | | +| `opts.namespace` | `TNamespace` | | +| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | +| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](internal_.PeerSyncController.md)\> | | + +#### Returns + +[`NamespaceSyncState`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> + +## Accessors + +### namespace + +• `get` **namespace**(): `TNamespace` + +#### Returns + +`TNamespace` + +## Methods + +### addPeer + +▸ **addPeer**(`peerId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerId` | `string` | + +#### Returns + +`void` + +___ + +### getState + +▸ **getState**(): [`SyncState`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +#### Returns + +[`SyncState`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) diff --git a/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md new file mode 100644 index 000000000..d10990306 --- /dev/null +++ b/docs/api/md/classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md @@ -0,0 +1,51 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md) / ExhaustivenessError + +# Class: ExhaustivenessError + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md).ExhaustivenessError + +## Hierarchy + +- `Error` + + ↳ **`ExhaustivenessError`** + +## Table of contents + +### Constructors + +- [constructor](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md#constructor) + +### Properties + +- [name](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md#name) + +## Constructors + +### constructor + +• **new ExhaustivenessError**(`value`): [`ExhaustivenessError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `never` | + +#### Returns + +[`ExhaustivenessError`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md) + +#### Overrides + +Error.constructor + +## Properties + +### name + +• **name**: `string` + +#### Inherited from + +Error.name diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md deleted file mode 100644 index ae8284d32..000000000 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md +++ /dev/null @@ -1,51 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / PeerDisconnectedError - -# Class: PeerDisconnectedError - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).PeerDisconnectedError - -## Hierarchy - -- `Error` - - ↳ **`PeerDisconnectedError`** - -## Table of contents - -### Constructors - -- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#constructor) - -### Properties - -- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md#name) - -## Constructors - -### constructor - -• **new PeerDisconnectedError**(`message?`): [`PeerDisconnectedError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`PeerDisconnectedError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) - -#### Overrides - -Error.constructor - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md deleted file mode 100644 index 658fb0321..000000000 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md +++ /dev/null @@ -1,51 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / PeerFailedConnectionError - -# Class: PeerFailedConnectionError - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).PeerFailedConnectionError - -## Hierarchy - -- `Error` - - ↳ **`PeerFailedConnectionError`** - -## Table of contents - -### Constructors - -- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#constructor) - -### Properties - -- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md#name) - -## Constructors - -### constructor - -• **new PeerFailedConnectionError**(`message?`): [`PeerFailedConnectionError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`PeerFailedConnectionError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) - -#### Overrides - -Error.constructor - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md deleted file mode 100644 index 463fb3b55..000000000 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md +++ /dev/null @@ -1,51 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / UnknownPeerError - -# Class: UnknownPeerError - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).UnknownPeerError - -## Hierarchy - -- `Error` - - ↳ **`UnknownPeerError`** - -## Table of contents - -### Constructors - -- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md#constructor) - -### Properties - -- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md#name) - -## Constructors - -### constructor - -• **new UnknownPeerError**(`message?`): [`UnknownPeerError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`UnknownPeerError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) - -#### Overrides - -Error.constructor - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md deleted file mode 100644 index f0bb9de00..000000000 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md +++ /dev/null @@ -1,88 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md) / NamespaceSyncState - -# Class: NamespaceSyncState\ - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md).NamespaceSyncState - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | [`"/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) | - -## Table of contents - -### Constructors - -- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#constructor) - -### Accessors - -- [namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#namespace) - -### Methods - -- [addPeer](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#addpeer) -- [getState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md#getstate) - -## Constructors - -### constructor - -• **new NamespaceSyncState**\<`TNamespace`\>(`opts`): [`NamespaceSyncState`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TNamespace` | extends ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` = ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opts` | `Object` | | -| `opts.coreManager` | [`CoreManager`](internal_.CoreManager.md) | | -| `opts.namespace` | `TNamespace` | | -| `opts.onUpdate` | () => `void` | Called when a state update is available (via getState()) | -| `opts.peerSyncControllers` | `Map`\<`string`, [`PeerSyncController`](internal_.PeerSyncController.md)\> | | - -#### Returns - -[`NamespaceSyncState`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md)\<`TNamespace`\> - -## Accessors - -### namespace - -• `get` **namespace**(): `TNamespace` - -#### Returns - -`TNamespace` - -## Methods - -### addPeer - -▸ **addPeer**(`peerId`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerId` | `string` | - -#### Returns - -`void` - -___ - -### getState - -▸ **getState**(): [`SyncState`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) - -#### Returns - -[`SyncState`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) diff --git a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md b/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md deleted file mode 100644 index 7cf91cde3..000000000 --- a/docs/api/md/classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md +++ /dev/null @@ -1,51 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/utils"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) / ExhaustivenessError - -# Class: ExhaustivenessError - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/utils"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md).ExhaustivenessError - -## Hierarchy - -- `Error` - - ↳ **`ExhaustivenessError`** - -## Table of contents - -### Constructors - -- [constructor](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md#constructor) - -### Properties - -- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md#name) - -## Constructors - -### constructor - -• **new ExhaustivenessError**(`value`): [`ExhaustivenessError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `never` | - -#### Returns - -[`ExhaustivenessError`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) - -#### Overrides - -Error.constructor - -## Properties - -### name - -• **name**: `string` - -#### Inherited from - -Error.name diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md similarity index 62% rename from docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md rename to docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md index a807b2833..e904f5521 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md +++ b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md @@ -1,15 +1,15 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) / Events +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md) / Events # Interface: Events\<\> -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md).Events +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md).Events ## Table of contents ### Properties -- [add-core](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md#add-core) -- [peer-have](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md#peer-have) +- [add-core](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md#add-core) +- [peer-have](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md#peer-have) ## Properties diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md similarity index 67% rename from docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md rename to docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md index 7b5aab18e..4795454b1 100644 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md +++ b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md @@ -1,21 +1,21 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) / LocalPeersEvents +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md) / LocalPeersEvents # Interface: LocalPeersEvents\<\> -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md).LocalPeersEvents +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md).LocalPeersEvents ## Table of contents ### Properties -- [discovery-key](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#discovery-key) -- [failed-to-handle-message](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#failed-to-handle-message) -- [got-project-details](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#got-project-details) -- [invite](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite) -- [invite-cancel](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-cancel) -- [invite-response](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-response) -- [peer-add](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peer-add) -- [peers](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peers) +- [discovery-key](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#discovery-key) +- [failed-to-handle-message](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#failed-to-handle-message) +- [got-project-details](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#got-project-details) +- [invite](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite) +- [invite-cancel](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-cancel) +- [invite-response](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#invite-response) +- [peer-add](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peer-add) +- [peers](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md#peers) ## Properties @@ -181,7 +181,7 @@ ___ ### peers -• **peers**: (`peers`: [`PeerInfo`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo)[]) => `void` +• **peers**: (`peers`: [`PeerInfo`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfo)[]) => `void` Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status @@ -193,7 +193,7 @@ Emitted whenever the connection status of peers changes. An array of peerInfo ob | Name | Type | | :------ | :------ | -| `peers` | [`PeerInfo`](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo)[] | +| `peers` | [`PeerInfo`](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfo)[] | ##### Returns diff --git a/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md new file mode 100644 index 000000000..69773e4f3 --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md @@ -0,0 +1,17 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md) / ProjectInfo + +# Interface: ProjectInfo\<\> + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md).ProjectInfo + +## Table of contents + +### Properties + +- [name](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md#name) + +## Properties + +### name + +• **name**: `undefined` \| `string` diff --git a/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md new file mode 100644 index 000000000..0611020a8 --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md @@ -0,0 +1,37 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md) / DerivedState + +# Interface: DerivedState\<\> + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md).DerivedState + +## Table of contents + +### Properties + +- [coreLength](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#corelength) +- [localState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#localstate) +- [remoteStates](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#remotestates) + +## Properties + +### coreLength + +• **coreLength**: `number` + +known (sparse) length of the core + +___ + +### localState + +• **localState**: [`CoreState`](internal_.CoreState.md) + +local state + +___ + +### remoteStates + +• **remoteStates**: `Object` + +map of state of all known peers diff --git a/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md new file mode 100644 index 000000000..c55842f81 --- /dev/null +++ b/docs/api/md/interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md @@ -0,0 +1,47 @@ +[API](../README.md) / [\](../modules/internal_.md) / ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md) / InternalState + +# Interface: InternalState\<\> + +[\](../modules/internal_.md).["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md).InternalState + +## Table of contents + +### Properties + +- [length](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#length) +- [localState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#localstate) +- [namespace](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#namespace) +- [peerSyncControllers](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#peersynccontrollers) +- [remoteStates](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#remotestates) + +## Properties + +### length + +• **length**: `undefined` \| `number` + +Core length, e.g. how many blocks in the core (including blocks that are not downloaded) + +___ + +### localState + +• **localState**: `PeerState` + +___ + +### namespace + +• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` + +___ + +### peerSyncControllers + +• **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/internal_.PeerSyncController.md)\> + +___ + +### remoteStates + +• **remoteStates**: `Map`\<`string`, `PeerState`\> diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md deleted file mode 100644 index fd9593108..000000000 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md +++ /dev/null @@ -1,17 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md) / ProjectInfo - -# Interface: ProjectInfo\<\> - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md).ProjectInfo - -## Table of contents - -### Properties - -- [name](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md#name) - -## Properties - -### name - -• **name**: `undefined` \| `string` diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md deleted file mode 100644 index 19e1ab21c..000000000 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md +++ /dev/null @@ -1,37 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) / DerivedState - -# Interface: DerivedState\<\> - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md).DerivedState - -## Table of contents - -### Properties - -- [coreLength](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#corelength) -- [localState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#localstate) -- [remoteStates](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md#remotestates) - -## Properties - -### coreLength - -• **coreLength**: `number` - -known (sparse) length of the core - -___ - -### localState - -• **localState**: [`CoreState`](internal_.CoreState.md) - -local state - -___ - -### remoteStates - -• **remoteStates**: `Object` - -map of state of all known peers diff --git a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md b/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md deleted file mode 100644 index b735c8dce..000000000 --- a/docs/api/md/interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md +++ /dev/null @@ -1,47 +0,0 @@ -[API](../README.md) / [\](../modules/internal_.md) / ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) / InternalState - -# Interface: InternalState\<\> - -[\](../modules/internal_.md).["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](../modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md).InternalState - -## Table of contents - -### Properties - -- [length](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#length) -- [localState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#localstate) -- [namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#namespace) -- [peerSyncControllers](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#peersynccontrollers) -- [remoteStates](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md#remotestates) - -## Properties - -### length - -• **length**: `undefined` \| `number` - -Core length, e.g. how many blocks in the core (including blocks that are not downloaded) - -___ - -### localState - -• **localState**: `PeerState` - -___ - -### namespace - -• **namespace**: ``"blob"`` \| ``"auth"`` \| ``"config"`` \| ``"data"`` \| ``"blobIndex"`` - -___ - -### peerSyncControllers - -• **peerSyncControllers**: `Map`\<`string`, [`PeerSyncController`](../classes/internal_.PeerSyncController.md)\> - -___ - -### remoteStates - -• **remoteStates**: `Map`\<`string`, `PeerState`\> diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md new file mode 100644 index 000000000..64d7eb417 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md @@ -0,0 +1,69 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index" + +## Table of contents + +### References + +- [Core](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#core) +- [CoreManager](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#coremanager) +- [CoreRecord](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#corerecord) +- [HaveMsg](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#havemsg) +- [Namespace](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#namespace) + +### Interfaces + +- [Events](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.Events.md) + +### Type Aliases + +- [DuplexStream](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#duplexstream) + +### Variables + +- [kCoreManagerReplicate](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) + +## References + +### Core + +Re-exports [Core](internal_.md#core) + +___ + +### CoreManager + +Re-exports [CoreManager](../classes/internal_.CoreManager.md) + +___ + +### CoreRecord + +Re-exports [CoreRecord](internal_.md#corerecord) + +___ + +### HaveMsg + +Re-exports [HaveMsg](../interfaces/internal_.HaveMsg.md) + +___ + +### Namespace + +Re-exports [Namespace](internal_.md#namespace-1) + +## Type Aliases + +### DuplexStream + +Ƭ **DuplexStream**\<\>: `Duplex` + +## Variables + +### kCoreManagerReplicate + +• `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md new file mode 100644 index 000000000..b87216321 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md @@ -0,0 +1,61 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/datastore/index" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/datastore/index" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/datastore/index" + +## Table of contents + +### References + +- [DataStore](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md#datastore) +- [NamespaceSchemas](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md#namespaceschemas) + +### Type Aliases + +- [DataStoreEvents](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md#datastoreevents) +- [MapeoDocTablesMap](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md#mapeodoctablesmap) +- [OmitUnion](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md#omitunion) + +## References + +### DataStore + +Re-exports [DataStore](../classes/internal_.DataStore.md) + +___ + +### NamespaceSchemas + +Re-exports [NamespaceSchemas](internal_.md#namespaceschemas) + +## Type Aliases + +### DataStoreEvents + +Ƭ **DataStoreEvents**\<`TSchemaName`\>: \{ [S in Exclude\]: Function } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | + +___ + +### MapeoDocTablesMap + +Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } + +___ + +### OmitUnion + +Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md new file mode 100644 index 000000000..97eaacac1 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md @@ -0,0 +1,89 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers" + +## Table of contents + +### References + +- [LocalPeers](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#localpeers) +- [PeerInfoBase](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfobase) +- [PeerInfoConnected](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfoconnected) +- [PeerInfoDisconnected](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfodisconnected) + +### Classes + +- [PeerDisconnectedError](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) +- [PeerFailedConnectionError](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) +- [UnknownPeerError](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.UnknownPeerError.md) + +### Interfaces + +- [LocalPeersEvents](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.LocalPeersEvents.md) + +### Type Aliases + +- [PeerInfo](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfo) +- [PeerInfoConnecting](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) +- [PeerInfoInternal](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfointernal) +- [PeerState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerstate) + +### Variables + +- [kTestOnlySendRawInvite](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) + +## References + +### LocalPeers + +Re-exports [LocalPeers](../classes/internal_.LocalPeers.md) + +___ + +### PeerInfoBase + +Re-exports [PeerInfoBase](../interfaces/internal_.PeerInfoBase.md) + +___ + +### PeerInfoConnected + +Re-exports [PeerInfoConnected](internal_.md#peerinfoconnected) + +___ + +### PeerInfoDisconnected + +Re-exports [PeerInfoDisconnected](internal_.md#peerinfodisconnected) + +## Type Aliases + +### PeerInfo + +Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) + +___ + +### PeerInfoConnecting + +Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } + +___ + +### PeerInfoInternal + +Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) \| [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) + +___ + +### PeerState + +Ƭ **PeerState**\<\>: [`PeerInfoInternal`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#peerinfointernal)[``"status"``] + +## Variables + +### kTestOnlySendRawInvite + +• `Const` **kTestOnlySendRawInvite**: typeof [`kTestOnlySendRawInvite`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md similarity index 61% rename from docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md rename to docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md index f60079d04..c0f2f8f25 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md @@ -1,41 +1,41 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/roles" +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/roles" -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/roles" +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/roles" -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/roles" +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/roles" ## Table of contents ### References -- [DocCapability](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#doccapability) -- [ElementOf](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#elementof) -- [Role](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#role) -- [RoleId](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleid) -- [Roles](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roles) +- [DocCapability](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#doccapability) +- [ElementOf](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#elementof) +- [Role](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#role) +- [RoleId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roleid) +- [Roles](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roles) ### Type Aliases -- [RoleIdAssignableToAnyone](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidassignabletoanyone) -- [RoleIdAssignableToOthers](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidassignabletoothers) -- [RoleIdForNewInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roleidfornewinvite) +- [RoleIdAssignableToAnyone](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roleidassignabletoanyone) +- [RoleIdAssignableToOthers](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roleidassignabletoothers) +- [RoleIdForNewInvite](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roleidfornewinvite) ### Variables -- [BLOCKED\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#blocked_role_id) -- [COORDINATOR\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#coordinator_role_id) -- [CREATOR\_ROLE](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#creator_role) -- [CREATOR\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#creator_role_id) -- [LEFT\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#left_role_id) -- [MEMBER\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#member_role_id) -- [NO\_ROLE](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#no_role) -- [NO\_ROLE\_ID](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#no_role_id) -- [ROLES](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#roles-1) +- [BLOCKED\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#blocked_role_id) +- [COORDINATOR\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#coordinator_role_id) +- [CREATOR\_ROLE](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#creator_role) +- [CREATOR\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#creator_role_id) +- [LEFT\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#left_role_id) +- [MEMBER\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#member_role_id) +- [NO\_ROLE](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#no_role) +- [NO\_ROLE\_ID](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#no_role_id) +- [ROLES](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#roles-1) ### Functions -- [isRoleIdAssignableToOthers](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#isroleidassignabletoothers) -- [isRoleIdForNewInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md#isroleidfornewinvite) +- [isRoleIdAssignableToOthers](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#isroleidassignabletoothers) +- [isRoleIdForNewInvite](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md#isroleidfornewinvite) ## References diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md new file mode 100644 index 000000000..4822c6d83 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md @@ -0,0 +1,52 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client" + +## Table of contents + +### References + +- [DeviceInfoParam](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md#deviceinfoparam) + +### Interfaces + +- [ProjectInfo](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.ProjectInfo.md) + +### Variables + +- [localDeviceInfoTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md#localdeviceinfotable) +- [projectBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md#projectbacklinktable) +- [projectKeysTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md#projectkeystable) +- [projectSettingsTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md#projectsettingstable) + +## References + +### DeviceInfoParam + +Re-exports [DeviceInfoParam](internal_.md#deviceinfoparam) + +## Variables + +### localDeviceInfoTable + +• `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### projectBacklinkTable + +• `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### projectKeysTable + +• `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### projectSettingsTable + +• `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md new file mode 100644 index 000000000..b4ef8a693 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md @@ -0,0 +1,143 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/project" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/project" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/project" + +## Table of contents + +### Variables + +- [coreOwnershipBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#coreownershipbacklinktable) +- [coreOwnershipTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#coreownershiptable) +- [coresTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#corestable) +- [deviceInfoBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#deviceinfobacklinktable) +- [deviceInfoTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#deviceinfotable) +- [fieldBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#fieldbacklinktable) +- [fieldTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#fieldtable) +- [iconBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#iconbacklinktable) +- [iconTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#icontable) +- [observationBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#observationbacklinktable) +- [observationTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#observationtable) +- [presetBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#presetbacklinktable) +- [presetTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#presettable) +- [roleBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#rolebacklinktable) +- [roleTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#roletable) +- [trackBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#trackbacklinktable) +- [trackTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#tracktable) +- [translationBacklinkTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#translationbacklinktable) +- [translationTable](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md#translationtable) + +## Variables + +### coreOwnershipBacklinkTable + +• `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### coreOwnershipTable + +• `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### coresTable + +• `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### deviceInfoBacklinkTable + +• `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### deviceInfoTable + +• `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### fieldBacklinkTable + +• `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### fieldTable + +• `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### iconBacklinkTable + +• `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### iconTable + +• `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### observationBacklinkTable + +• `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### observationTable + +• `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### presetBacklinkTable + +• `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### presetTable + +• `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### roleBacklinkTable + +• `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### roleTable + +• `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### trackBacklinkTable + +• `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### trackTable + +• `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### translationBacklinkTable + +• `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> + +___ + +### translationTable + +• `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md new file mode 100644 index 000000000..3dc6bb316 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md @@ -0,0 +1,76 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state" + +## Table of contents + +### References + +- [CoreState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#corestate) +- [CoreSyncState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#coresyncstate) +- [PeerCoreState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#peercorestate) + +### Interfaces + +- [DerivedState](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) +- [InternalState](../interfaces/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.InternalState.md) + +### Type Aliases + +- [Bitfield](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#bitfield) +- [PeerId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#peerid) + +### Functions + +- [bitCount32](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md#bitcount32) + +## References + +### CoreState + +Re-exports [CoreState](../interfaces/internal_.CoreState.md) + +___ + +### CoreSyncState + +Re-exports [CoreSyncState](../classes/internal_.CoreSyncState.md) + +___ + +### PeerCoreState + +Re-exports [PeerCoreState](internal_.md#peercorestate) + +## Type Aliases + +### Bitfield + +Ƭ **Bitfield**\<\>: [`default`](../classes/internal_.default-2.md) + +___ + +### PeerId + +Ƭ **PeerId**\<\>: `string` + +## Functions + +### bitCount32 + +▸ **bitCount32**(`n`): `number` + +Apologies for the obscure code. From +https://stackoverflow.com/a/109025/903300 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +`number` diff --git a/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md new file mode 100644 index 000000000..13f36c025 --- /dev/null +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md @@ -0,0 +1,47 @@ +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state" + +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state" + +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state" + +## Table of contents + +### Classes + +- [NamespaceSyncState](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) + +### Type Aliases + +- [SyncState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) + +### Functions + +- [createState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md#createstate) + +## Type Aliases + +### SyncState + +Ƭ **SyncState**\<\>: `Omit`\<[`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } + +## Functions + +### createState + +▸ **createState**(): [`CoreState`](../interfaces/internal_.CoreState.md) + +#### Returns + +[`CoreState`](../interfaces/internal_.CoreState.md) + +▸ **createState**(`status`): [`PeerCoreState`](internal_.md#peercorestate) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `status` | ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` | + +#### Returns + +[`PeerCoreState`](internal_.md#peercorestate) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md similarity index 65% rename from docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md rename to docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md index eb8206d24..1307dfbfc 100644 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md +++ b/docs/api/md/modules/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md @@ -1,41 +1,41 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/utils" +[API](../README.md) / [\](internal_.md) / "/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils" -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/utils" +# Namespace: "/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils" -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/utils" +[\](internal_.md)."/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils" ## Table of contents ### References -- [OpenedNoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#openednoisestream) +- [OpenedNoiseStream](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#openednoisestream) ### Classes -- [ExhaustivenessError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.ExhaustivenessError.md) +- [ExhaustivenessError](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.ExhaustivenessError.md) ### Type Aliases -- [DestroyedNoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) -- [NoiseStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noisestream) +- [DestroyedNoiseStream](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#destroyednoisestream) +- [NoiseStream](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#noisestream) ### Functions -- [assert](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#assert) -- [createMap](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#createmap) -- [deNullify](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#denullify) -- [getDeviceId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#getdeviceid) -- [hashObject](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#hashobject) -- [idToKey](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#idtokey) -- [keyToId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#keytoid) -- [noop](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noop) -- [openedNoiseSecretStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#openednoisesecretstream) -- [parseVersion](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#parseversion) -- [projectIdToNonce](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectidtononce) -- [projectKeyToId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectkeytoid) -- [projectKeyToPublicId](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#projectkeytopublicid) -- [setHas](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#sethas) -- [valueOf](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#valueof) +- [assert](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#assert) +- [createMap](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#createmap) +- [deNullify](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#denullify) +- [getDeviceId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#getdeviceid) +- [hashObject](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#hashobject) +- [idToKey](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#idtokey) +- [keyToId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#keytoid) +- [noop](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#noop) +- [openedNoiseSecretStream](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#openednoisesecretstream) +- [parseVersion](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#parseversion) +- [projectIdToNonce](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#projectidtononce) +- [projectKeyToId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#projectkeytoid) +- [projectKeyToPublicId](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#projectkeytopublicid) +- [setHas](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#sethas) +- [valueOf](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#valueof) ## References @@ -47,7 +47,7 @@ Re-exports [OpenedNoiseStream](internal_.md#openednoisestream) ### DestroyedNoiseStream -Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#noisestream) & \{ `destroyed`: ``true`` } +Ƭ **DestroyedNoiseStream**\<\>: [`NoiseStream`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#noisestream) & \{ `destroyed`: ``true`` } ___ @@ -206,7 +206,7 @@ ___ ### openedNoiseSecretStream -▸ **openedNoiseSecretStream**(`stream`): `Promise`\<[`DestroyedNoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> +▸ **openedNoiseSecretStream**(`stream`): `Promise`\<[`DestroyedNoiseStream`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> Utility to await a NoiseSecretStream to open, that returns a stream with the correct types for publicKey and remotePublicKey (which can be null before @@ -220,7 +220,7 @@ stream is opened) #### Returns -`Promise`\<[`DestroyedNoiseStream`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> +`Promise`\<[`DestroyedNoiseStream`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md#destroyednoisestream) \| [`OpenedNoiseStream`](internal_.md#openednoisestream)\<`Duplex` \| `Duplex`\<`any`, `any`, `any`, `any`, ``true``, ``true``, `DuplexEvents`\<`any`, `any`\>\>\>\> ___ diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md deleted file mode 100644 index d776f04b3..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md +++ /dev/null @@ -1,69 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/core-manager/index" - -## Table of contents - -### References - -- [Core](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#core) -- [CoreManager](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#coremanager) -- [CoreRecord](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#corerecord) -- [HaveMsg](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#havemsg) -- [Namespace](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#namespace) - -### Interfaces - -- [Events](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.Events.md) - -### Type Aliases - -- [DuplexStream](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#duplexstream) - -### Variables - -- [kCoreManagerReplicate](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) - -## References - -### Core - -Re-exports [Core](internal_.md#core) - -___ - -### CoreManager - -Re-exports [CoreManager](../classes/internal_.CoreManager.md) - -___ - -### CoreRecord - -Re-exports [CoreRecord](internal_.md#corerecord) - -___ - -### HaveMsg - -Re-exports [HaveMsg](../interfaces/internal_.HaveMsg.md) - -___ - -### Namespace - -Re-exports [Namespace](internal_.md#namespace-1) - -## Type Aliases - -### DuplexStream - -Ƭ **DuplexStream**\<\>: `Duplex` - -## Variables - -### kCoreManagerReplicate - -• `Const` **kCoreManagerReplicate**: typeof [`kCoreManagerReplicate`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md#kcoremanagerreplicate) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md deleted file mode 100644 index 0de58552b..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md +++ /dev/null @@ -1,61 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/datastore/index" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/datastore/index" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/datastore/index" - -## Table of contents - -### References - -- [DataStore](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#datastore) -- [NamespaceSchemas](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#namespaceschemas) - -### Type Aliases - -- [DataStoreEvents](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#datastoreevents) -- [MapeoDocTablesMap](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#mapeodoctablesmap) -- [OmitUnion](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md#omitunion) - -## References - -### DataStore - -Re-exports [DataStore](../classes/internal_.DataStore.md) - -___ - -### NamespaceSchemas - -Re-exports [NamespaceSchemas](internal_.md#namespaceschemas) - -## Type Aliases - -### DataStoreEvents - -Ƭ **DataStoreEvents**\<`TSchemaName`\>: \{ [S in Exclude\]: Function } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TSchemaName` | extends `MapeoDoc`[``"schemaName"``] | - -___ - -### MapeoDocTablesMap - -Ƭ **MapeoDocTablesMap**: \{ [K in MapeoDocTables["\_"]["name"]]: Extract\ } - -___ - -### OmitUnion - -Ƭ **OmitUnion**\<`T`, `K`\>: `T` extends `any` ? `Omit`\<`T`, `K`\> : `never` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `K` | extends keyof `any` | diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md deleted file mode 100644 index 5530c48c9..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md +++ /dev/null @@ -1,89 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/local-peers" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/local-peers" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/local-peers" - -## Table of contents - -### References - -- [LocalPeers](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#localpeers) -- [PeerInfoBase](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfobase) -- [PeerInfoConnected](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnected) -- [PeerInfoDisconnected](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfodisconnected) - -### Classes - -- [PeerDisconnectedError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerDisconnectedError.md) -- [PeerFailedConnectionError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.PeerFailedConnectionError.md) -- [UnknownPeerError](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.UnknownPeerError.md) - -### Interfaces - -- [LocalPeersEvents](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.LocalPeersEvents.md) - -### Type Aliases - -- [PeerInfo](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfo) -- [PeerInfoConnecting](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) -- [PeerInfoInternal](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal) -- [PeerState](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerstate) - -### Variables - -- [kTestOnlySendRawInvite](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) - -## References - -### LocalPeers - -Re-exports [LocalPeers](../classes/internal_.LocalPeers.md) - -___ - -### PeerInfoBase - -Re-exports [PeerInfoBase](../interfaces/internal_.PeerInfoBase.md) - -___ - -### PeerInfoConnected - -Re-exports [PeerInfoConnected](internal_.md#peerinfoconnected) - -___ - -### PeerInfoDisconnected - -Re-exports [PeerInfoDisconnected](internal_.md#peerinfodisconnected) - -## Type Aliases - -### PeerInfo - -Ƭ **PeerInfo**\<\>: [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) - -___ - -### PeerInfoConnecting - -Ƭ **PeerInfoConnecting**\<\>: [`PeerInfoBase`](../interfaces/internal_.PeerInfoBase.md) & \{ `status`: ``"connecting"`` } - -___ - -### PeerInfoInternal - -Ƭ **PeerInfoInternal**\<\>: [`PeerInfoConnecting`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfoconnecting) \| [`PeerInfoConnected`](internal_.md#peerinfoconnected) \| [`PeerInfoDisconnected`](internal_.md#peerinfodisconnected) - -___ - -### PeerState - -Ƭ **PeerState**\<\>: [`PeerInfoInternal`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#peerinfointernal)[``"status"``] - -## Variables - -### kTestOnlySendRawInvite - -• `Const` **kTestOnlySendRawInvite**: typeof [`kTestOnlySendRawInvite`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md#ktestonlysendrawinvite) diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md deleted file mode 100644 index dfa654a55..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md +++ /dev/null @@ -1,52 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/schema/client" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/schema/client" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/schema/client" - -## Table of contents - -### References - -- [DeviceInfoParam](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#deviceinfoparam) - -### Interfaces - -- [ProjectInfo](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.ProjectInfo.md) - -### Variables - -- [localDeviceInfoTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#localdeviceinfotable) -- [projectBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectbacklinktable) -- [projectKeysTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectkeystable) -- [projectSettingsTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md#projectsettingstable) - -## References - -### DeviceInfoParam - -Re-exports [DeviceInfoParam](internal_.md#deviceinfoparam) - -## Variables - -### localDeviceInfoTable - -• `Const` **localDeviceInfoTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### projectBacklinkTable - -• `Const` **projectBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### projectKeysTable - -• `Const` **projectKeysTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### projectSettingsTable - -• `Const` **projectSettingsTable**: `SQLiteTableWithColumns`\<{}\> diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md deleted file mode 100644 index 4111b9068..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md +++ /dev/null @@ -1,143 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/schema/project" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/schema/project" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/schema/project" - -## Table of contents - -### Variables - -- [coreOwnershipBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#coreownershipbacklinktable) -- [coreOwnershipTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#coreownershiptable) -- [coresTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#corestable) -- [deviceInfoBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#deviceinfobacklinktable) -- [deviceInfoTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#deviceinfotable) -- [fieldBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#fieldbacklinktable) -- [fieldTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#fieldtable) -- [iconBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#iconbacklinktable) -- [iconTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#icontable) -- [observationBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#observationbacklinktable) -- [observationTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#observationtable) -- [presetBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#presetbacklinktable) -- [presetTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#presettable) -- [roleBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#rolebacklinktable) -- [roleTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#roletable) -- [trackBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#trackbacklinktable) -- [trackTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#tracktable) -- [translationBacklinkTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#translationbacklinktable) -- [translationTable](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md#translationtable) - -## Variables - -### coreOwnershipBacklinkTable - -• `Const` **coreOwnershipBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### coreOwnershipTable - -• `Const` **coreOwnershipTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### coresTable - -• `Const` **coresTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### deviceInfoBacklinkTable - -• `Const` **deviceInfoBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### deviceInfoTable - -• `Const` **deviceInfoTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### fieldBacklinkTable - -• `Const` **fieldBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### fieldTable - -• `Const` **fieldTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### iconBacklinkTable - -• `Const` **iconBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### iconTable - -• `Const` **iconTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### observationBacklinkTable - -• `Const` **observationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### observationTable - -• `Const` **observationTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### presetBacklinkTable - -• `Const` **presetBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### presetTable - -• `Const` **presetTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### roleBacklinkTable - -• `Const` **roleBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### roleTable - -• `Const` **roleTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### trackBacklinkTable - -• `Const` **trackBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### trackTable - -• `Const` **trackTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### translationBacklinkTable - -• `Const` **translationBacklinkTable**: `SQLiteTableWithColumns`\<{}\> - -___ - -### translationTable - -• `Const` **translationTable**: `SQLiteTableWithColumns`\<{}\> diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md deleted file mode 100644 index de7e8068d..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md +++ /dev/null @@ -1,76 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state" - -## Table of contents - -### References - -- [CoreState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#corestate) -- [CoreSyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#coresyncstate) -- [PeerCoreState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#peercorestate) - -### Interfaces - -- [DerivedState](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.DerivedState.md) -- [InternalState](../interfaces/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.InternalState.md) - -### Type Aliases - -- [Bitfield](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#bitfield) -- [PeerId](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#peerid) - -### Functions - -- [bitCount32](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md#bitcount32) - -## References - -### CoreState - -Re-exports [CoreState](../interfaces/internal_.CoreState.md) - -___ - -### CoreSyncState - -Re-exports [CoreSyncState](../classes/internal_.CoreSyncState.md) - -___ - -### PeerCoreState - -Re-exports [PeerCoreState](internal_.md#peercorestate) - -## Type Aliases - -### Bitfield - -Ƭ **Bitfield**\<\>: [`default`](../classes/internal_.default-2.md) - -___ - -### PeerId - -Ƭ **PeerId**\<\>: `string` - -## Functions - -### bitCount32 - -▸ **bitCount32**(`n`): `number` - -Apologies for the obscure code. From -https://stackoverflow.com/a/109025/903300 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | `number` | - -#### Returns - -`number` diff --git a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md b/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md deleted file mode 100644 index 5fbaa28ce..000000000 --- a/docs/api/md/modules/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md +++ /dev/null @@ -1,47 +0,0 @@ -[API](../README.md) / [\](internal_.md) / "/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" - -# Namespace: "/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" - -[\](internal_.md)."/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state" - -## Table of contents - -### Classes - -- [NamespaceSyncState](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) - -### Type Aliases - -- [SyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) - -### Functions - -- [createState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#createstate) - -## Type Aliases - -### SyncState - -Ƭ **SyncState**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md), ``"coreLength"``\> & \{ `coreCount`: `number` ; `dataToSync`: `boolean` } - -## Functions - -### createState - -▸ **createState**(): [`CoreState`](../interfaces/internal_.CoreState.md) - -#### Returns - -[`CoreState`](../interfaces/internal_.CoreState.md) - -▸ **createState**(`status`): [`PeerCoreState`](internal_.md#peercorestate) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `status` | ``"disconnected"`` \| ``"connecting"`` \| ``"connected"`` | - -#### Returns - -[`PeerCoreState`](internal_.md#peercorestate) diff --git a/docs/api/md/modules/internal_.md b/docs/api/md/modules/internal_.md index f05c43b2e..8d4dad566 100644 --- a/docs/api/md/modules/internal_.md +++ b/docs/api/md/modules/internal_.md @@ -15,15 +15,15 @@ ### Namespaces -- ["/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/datastore/index"](internal_.__home_szgy_src_dd_mapeo_core_next_src_datastore_index_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/local-peers"](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/roles"](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/schema/client"](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/schema/project"](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/sync/core-sync-state"](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_core_sync_state_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md) -- ["/home/szgy/src/dd/mapeo-core-next/src/utils"](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/datastore/index"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_datastore_index_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/roles"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/project"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/core-sync-state"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_core_sync_state_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md) +- ["/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils"](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md) - ["hyperdrive"](internal_._hyperdrive_.md) - [Hyperblobs](internal_.Hyperblobs.md) - [Hyperdrive](internal_.Hyperdrive.md) @@ -189,13 +189,13 @@ ___ ### NamespaceSyncState -Re-exports [NamespaceSyncState](../classes/internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) +Re-exports [NamespaceSyncState](../classes/internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.NamespaceSyncState.md) ___ ### SyncState -Re-exports [SyncState](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) +Re-exports [SyncState](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md#syncstate) ## Type Aliases @@ -447,7 +447,7 @@ ___ ### MapeoDocTables -Ƭ **MapeoDocTables**: [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/szgy/src/dd/mapeo-core-next/src/schema/project"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_project_.md)\> \| [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/szgy/src/dd/mapeo-core-next/src/schema/client"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_schema_client_.md)\> +Ƭ **MapeoDocTables**: [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/project"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_project_.md)\> \| [`GetMapeoDocTables`](internal_.md#getmapeodoctables)\<[`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/schema/client"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_schema_client_.md)\> Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables) @@ -485,7 +485,7 @@ ___ ### OpenedNoiseStream -Ƭ **OpenedNoiseStream**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/utils"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_utils_.md) +Ƭ **OpenedNoiseStream**\<\>: [`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/utils"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_utils_.md) ___ @@ -529,7 +529,7 @@ ___ ### PublicPeerInfo -Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`"/home/szgy/src/dd/mapeo-core-next/src/local-peers"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_local_peers_.md), ``"protomux"``\> +Ƭ **PublicPeerInfo**\<\>: `Omit`\<[`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/local-peers"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_local_peers_.md), ``"protomux"``\> ___ @@ -573,7 +573,7 @@ ___ ### State -Ƭ **State**\<\>: `Record`\<[`"/home/szgy/src/dd/mapeo-core-next/src/core-manager/index"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_core_manager_index_.md), [`"/home/szgy/src/dd/mapeo-core-next/src/sync/namespace-sync-state"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_sync_namespace_sync_state_.md)\> +Ƭ **State**\<\>: `Record`\<[`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/core-manager/index"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_core_manager_index_.md), [`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/sync/namespace-sync-state"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_sync_namespace_sync_state_.md)\> ___ @@ -585,7 +585,7 @@ ___ ### SyncCapability -Ƭ **SyncCapability**\<\>: [`"/home/szgy/src/dd/mapeo-core-next/src/roles"`](internal_.__home_szgy_src_dd_mapeo_core_next_src_roles_.md)[``"sync"``][[`Namespace`](internal_.md#namespace)] \| ``"unknown"`` +Ƭ **SyncCapability**\<\>: [`"/home/runner/work/mapeo-core-next/mapeo-core-next/src/roles"`](internal_.__home_runner_work_mapeo_core_next_mapeo_core_next_src_roles_.md)[``"sync"``][[`Namespace`](internal_.md#namespace)] \| ``"unknown"`` ___ From fa2cac771dc92d25a2a63e4c578fcf70505ab8f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 21 May 2024 09:53:02 -0300 Subject: [PATCH 25/28] remove api doc generation on every push (in docs.yml), move action to release.yml --- .github/workflows/docs.yml | 12 ------------ .github/workflows/release.yml | 15 +++++++++------ 2 files changed, 9 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0a8fe7cb2..b04dc88fa 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,22 +16,10 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - name: Set git user - uses: fregante/setup-git-user@v1 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} - - name: Generate Api docs - run: | - npm ci - npm run doc - - name: Push updated markdown docs - uses: stefanzweifel/git-auto-commit-action@v5 - with: - commit_message: 'Update api markdown docs' - file_pattern: 'docs/api/md/*' - name: Generate HTML documentation run: npm run doc:publish - id: upload-documentation diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 256e2651e..6014d2473 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,15 +32,18 @@ jobs: uses: actions/setup-node@v3 with: node-version: 18 - - name: Publish docs api to repo + - uses: actions/checkout@v4 + - name: Set git user + uses: fregante/setup-git-user@v1 + - name: Generate Api docs run: | npm ci npm run doc - git status - git add docs/api/md - git commit -am "updated api docs" - git fetch origin main - git push origin main + - name: Push updated markdown docs + uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: 'feat: update api markdown docs' + file_pattern: 'docs/api/md/*' - uses: nearform-actions/optic-release-automation-action@v4 with: commit-message: 'Release {version}' From 959713154b47bd843618475b220d2932ff6b70c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 21 May 2024 10:46:22 -0300 Subject: [PATCH 26/28] fix: accidentally removd actions/checkout on docs.yml --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b04dc88fa..7fc1a1833 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,6 +16,7 @@ jobs: url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: + - uses: actions/checkout@v4 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: From c57b0016e31edf131c9f44b737f98b18784df1e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Ciccola?= Date: Tue, 21 May 2024 11:49:42 -0300 Subject: [PATCH 27/28] forgot to add `npm ci` to docs.yml --- .github/workflows/docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7fc1a1833..54055c40d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,7 +22,9 @@ jobs: with: node-version: ${{ matrix.node-version }} - name: Generate HTML documentation - run: npm run doc:publish + run: | + npm ci + npm run doc:publish - id: upload-documentation name: Upload documentation to Pages uses: actions/upload-pages-artifact@v2 From 286adbe78ae60309c87f3dffc18599b5b9a66c0c Mon Sep 17 00:00:00 2001 From: tomasciccola <117094913+tomasciccola@users.noreply.github.com> Date: Tue, 21 May 2024 15:45:26 -0300 Subject: [PATCH 28/28] Apply suggestions from code review Co-authored-by: Evan Hahn --- .github/workflows/release.yml | 2 +- package.json | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6014d2473..cd0934981 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -42,7 +42,7 @@ jobs: - name: Push updated markdown docs uses: stefanzweifel/git-auto-commit-action@v5 with: - commit_message: 'feat: update api markdown docs' + commit_message: 'docs: update API docs' file_pattern: 'docs/api/md/*' - uses: nearform-actions/optic-release-automation-action@v4 with: diff --git a/package.json b/package.json index 3d5da0bc3..ba123739c 100644 --- a/package.json +++ b/package.json @@ -49,9 +49,6 @@ "node": true }, "extends": "eslint:recommended", - "ignorePatterns": [ - "docs/*" - ], "parserOptions": { "ecmaVersion": 13, "sourceType": "module"