Release v2.3.1

digidem · Jan 23, 2025 · 1928e7a · 1928e7a
1 parent 36d2463
commit 1928e7a
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 156 deletions.
diff --git a/docs/api/md/-internal-/README.md b/docs/api/md/-internal-/README.md
@@ -10,7 +10,6 @@
 
 ### Namespaces
 
-- ["/home/runner/work/comapeo-core/comapeo-core/src/datastore/index"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md)
 - ["/home/runner/work/comapeo-core/comapeo-core/src/local-peers"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_local-peers/README.md)
 - ["/home/runner/work/comapeo-core/comapeo-core/src/schema/client"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)
 - ["/home/runner/work/comapeo-core/comapeo-core/src/schema/project"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)
@@ -71,7 +70,6 @@
 - [BitmapOpts](interfaces/BitmapOpts.md)
 - [Channel](interfaces/Channel.md)
 - [CorestoreEvents](interfaces/CorestoreEvents.md)
-- [DataTypeEvents](interfaces/DataTypeEvents.md)
 - [DocCapability](interfaces/DocCapability.md)
 - [HaveMsg](interfaces/HaveMsg.md)
 - [HyperdriveEvents](interfaces/HyperdriveEvents.md)
@@ -125,10 +123,8 @@
 - [Keypair](type-aliases/Keypair.md)
 - [KeyPair](type-aliases/KeyPair-1.md)
 - [MapBuffers](type-aliases/MapBuffers.md)
-- [MapeoDocMap](type-aliases/MapeoDocMap.md)
 - [MapeoDocTableName](type-aliases/MapeoDocTableName.md)
 - [MapeoDocTables](type-aliases/MapeoDocTables.md)
-- [MapeoValueMap](type-aliases/MapeoValueMap.md)
 - [Namespace](type-aliases/Namespace.md)
 - [NamespaceSchemas](type-aliases/NamespaceSchemas.md)
 - [OpenedNetNoiseStream](type-aliases/OpenedNetNoiseStream.md)

diff --git a/docs/api/md/-internal-/classes/DataType.md b/docs/api/md/-internal-/classes/DataType.md
@@ -8,45 +8,45 @@
 
 ## Extends
 
-- `TypedEmitter`\<[`DataTypeEvents`](../interfaces/DataTypeEvents.md)\<`TDoc`\>\>
+- `TypedEmitter`
 
 ## Type Parameters
 
-• **TDataStore** *extends* [`"/home/runner/work/comapeo-core/comapeo-core/src/datastore/index"`](../namespaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md)
+• **TDataStore**
 
-• **TTable** *extends* [`MapeoDocTables`](../type-aliases/MapeoDocTables.md)
+• **TTable**
 
-• **TSchemaName** *extends* `TTable`\[`"_"`\]\[`"name"`\]
+• **TSchemaName**
 
-• **TDoc** *extends* [`MapeoDocMap`](../type-aliases/MapeoDocMap.md)\[`TSchemaName`\]
+• **TDoc**
 
-• **TValue** *extends* [`MapeoValueMap`](../type-aliases/MapeoValueMap.md)\[`TSchemaName`\]
+• **TValue**
 
 ## Constructors
 
 ### new DataType()
 
-> **new DataType**\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>(`__namedParameters`): [`DataType`](DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>
+> **new DataType**\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>(`opts`): [`DataType`](DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>
 
 #### Parameters
 
-• **\_\_namedParameters**
+• **opts**
 
-• **\_\_namedParameters.dataStore**: `TDataStore`
+• **opts.dataStore**: `TDataStore`
 
-• **\_\_namedParameters.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\>
+• **opts.db**: `BetterSQLite3Database`\<`Record`\<`string`, `never`\>\>
 
-• **\_\_namedParameters.getTranslations**
+• **opts.getTranslations**
 
-• **\_\_namedParameters.table**: `TTable`
+• **opts.table**: `TTable`
 
 #### Returns
 
 [`DataType`](DataType.md)\<`TDataStore`, `TTable`, `TSchemaName`, `TDoc`, `TValue`\>
 
 #### Overrides
 
-`TypedEmitter<DataTypeEvents<TDoc>>.constructor`
+`TypedEmitter.constructor`
 
 ## Accessors
 
@@ -72,11 +72,11 @@
 
 ### namespace
 
-> `get` **namespace**(): `namespace`
+> `get` **namespace**(): `TDataStore`\[`"namespace"`\]
 
 #### Returns
 
-`namespace`
+`TDataStore`\[`"namespace"`\]
 
 ***
 
@@ -92,14 +92,20 @@
 
 ### \[kCreateWithDocId\]()
 
-> **\[kCreateWithDocId\]**(`docId`, `value`): `Promise`\<`TDoc` & `object`\>
+> **\[kCreateWithDocId\]**(`docId`, `value`, `opts`?): `Promise`\<`TDoc` & `object`\>
 
 #### Parameters
 
 • **docId**: `string`
 
 • **value**: `Exclude`\<`TValue`, `object`\> \| [`CoreOwnershipWithSignaturesValue`](../type-aliases/CoreOwnershipWithSignaturesValue.md)
 
+• **opts?** = `{}`
+
+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`\<`TDoc` & `object`\>
@@ -108,11 +114,11 @@
 
 ### \[kSelect\]()
 
-> **\[kSelect\]**(): `Promise`\<`any`\>
+> **\[kSelect\]**(): `Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, `{ [K in string]: { [Key in string]: SelectResultField<GetSelectTableSelection<(...)>[Key], true> }[K] }`[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\>
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`\<`Omit`\<`SQLiteSelectBase`\<`GetSelectTableName`\<`TTable`\>, `"sync"`, `RunResult`, `GetSelectTableSelection`\<`TTable`\>, `"single"`, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`, `false`, `never`, `{ [K in string]: { [Key in string]: SelectResultField<GetSelectTableSelection<(...)>[Key], true> }[K] }`[], `BuildSubquerySelection`\<`GetSelectTableSelection`\<`TTable`\>, `GetSelectTableName`\<`TTable`\> *extends* `string` ? `Record`\<`string` & `GetSelectTableName`\<`TTable`\>, `"not-null"`\> : `object`\>\>, `"then"` \| `"catch"` \| `"finally"`\> & `object`\>
 
 ***
 
@@ -150,42 +156,22 @@
 
 ### getByDocId()
 
-#### getByDocId(docId, opts)
+> **getByDocId**(`docId`, `options`?): `Promise`\<`TDoc` & `object`\>
 
-> **getByDocId**(`docId`, `opts`?): `Promise`\<`TDoc` & `object`\>
-
-##### Parameters
+#### Parameters
 
 • **docId**: `string`
 
-• **opts?**
+• **options?**
 
-• **opts.lang?**: `string`
+• **options.lang?**: `undefined` \| `string`
 
-• **opts.mustBeFound?**: `true`
+• **options.mustBeFound?**: `undefined` \| `true`
 
-##### Returns
+#### Returns
 
 `Promise`\<`TDoc` & `object`\>
 
-#### getByDocId(docId, opts)
-
-> **getByDocId**(`docId`, `opts`?): `Promise`\<`null` \| `TDoc` & `object`\>
-
-##### Parameters
-
-• **docId**: `string`
-
-• **opts?**
-
-• **opts.lang?**: `string`
-
-• **opts.mustBeFound?**: `boolean`
-
-##### Returns
-
-`Promise`\<`null` \| `TDoc` & `object`\>
-
 ***
 
 ### getByVersionId()
@@ -196,7 +182,7 @@
 
 • **versionId**: `string`
 
-• **opts?**
+• **opts?** = `{}`
 
 • **opts.lang?**: `string`
 
@@ -208,15 +194,15 @@
 
 ### getMany()
 
-> **getMany**(`opts`?): `Promise`\<`TDoc` & `object`[]\>
+> **getMany**(`opts`): `Promise`\<`TDoc` & `object`[]\>
 
 #### Parameters
 
-• **opts?**
+• **opts** = `{}`
 
-• **opts.includeDeleted?**: `boolean`
+• **opts.includeDeleted**: `undefined` \| `boolean` = `false`
 
-• **opts.lang?**: `string`
+• **opts.lang**: `undefined` \| `string`
 
 #### Returns
 

diff --git a/docs/api/md/-internal-/interfaces/DataTypeEvents.md b/docs/api/md/-internal-/interfaces/DataTypeEvents.md
diff --git a/...spaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md b/...spaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md
diff --git a/...k_comapeo-core_comapeo-core_src_datastore_index/type-aliases/DataStoreEvents.md b/...k_comapeo-core_comapeo-core_src_datastore_index/type-aliases/DataStoreEvents.md
diff --git a/...er_work_comapeo-core_comapeo-core_src_datastore_index/type-aliases/OmitUnion.md b/...er_work_comapeo-core_comapeo-core_src_datastore_index/type-aliases/OmitUnion.md
diff --git a/docs/api/md/-internal-/type-aliases/MapeoDocMap.md b/docs/api/md/-internal-/type-aliases/MapeoDocMap.md
diff --git a/docs/api/md/-internal-/type-aliases/MapeoDocTableName.md b/docs/api/md/-internal-/type-aliases/MapeoDocTableName.md
@@ -6,4 +6,6 @@
 
 # Type Alias: MapeoDocTableName
 
-> **MapeoDocTableName**: \`$\{MapeoDoc\["schemaName"\]\}Table\`
+> **MapeoDocTableName**\<\>: \`$\{MapeoDoc\["schemaName"\]\}Table\`
+
+## Type Parameters
diff --git a/docs/api/md/-internal-/type-aliases/MapeoDocTables.md b/docs/api/md/-internal-/type-aliases/MapeoDocTables.md
@@ -6,6 +6,6 @@
 
 # Type Alias: MapeoDocTables
 
-> **MapeoDocTables**: [`GetMapeoDocTables`](GetMapeoDocTables.md)\<[`"/home/runner/work/comapeo-core/comapeo-core/src/schema/project"`](../namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)\> \| [`GetMapeoDocTables`](GetMapeoDocTables.md)\<[`"/home/runner/work/comapeo-core/comapeo-core/src/schema/client"`](../namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)\>
+> **MapeoDocTables**\<\>: [`GetMapeoDocTables`](GetMapeoDocTables.md)\<[`"/home/runner/work/comapeo-core/comapeo-core/src/schema/project"`](../namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)\> \| [`GetMapeoDocTables`](GetMapeoDocTables.md)\<[`"/home/runner/work/comapeo-core/comapeo-core/src/schema/client"`](../namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)\>
 
-Union of Drizzle schema tables that correspond to MapeoDoc types (e.g. excluding backlink tables and other utility tables)
+## Type Parameters
diff --git a/docs/api/md/-internal-/type-aliases/MapeoValueMap.md b/docs/api/md/-internal-/type-aliases/MapeoValueMap.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@comapeo/core",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Offline p2p mapping library",
   "main": "src/index.js",
   "types": "dist/index.d.ts",