Link GeoApiClient methods in docs to source code
CI / test (push) Successful in 5s

Add links from typescript-frontend-integration.md to GeoApiClient.ts
with line anchors for each constructor and method.

Made-with: Cursor
This commit is contained in:
2026-03-01 14:18:23 +00:00
parent 8a3cd2c27e
commit 89c48e5fb4
+22 -20
View File
@@ -37,31 +37,33 @@ Integration tests in `test/integration.test.ts` cover the recommended flow: regi
### Class: `GeoApiClient` ### Class: `GeoApiClient`
Source: [GeoApiClient.ts](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts)
Constructor: Constructor:
- `new GeoApiClient(baseUrl, storage, storageKey?)` - [`new GeoApiClient(baseUrl, storage, storageKey?)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L14)
Key methods: Key methods:
- `ensureKeysInStorage()` - [`ensureKeysInStorage()`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L20)
- `getStoredKeys()` - [`getStoredKeys()`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L29)
- `derivePublicKey(privateKey)` — restore public key from private key (Ed25519) - [`derivePublicKey(privateKey)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L33) — restore public key from private key (Ed25519)
- `importKeys(keys)` - [`importKeys(keys)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L37)
- `exportKeys()` - [`exportKeys()`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L41)
- `setAccessToken(token)` - [`setAccessToken(token)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L45)
- `getServicePublicKey()` - [`getServicePublicKey()`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L69)
- `createChallenge(publicKey)` - [`createChallenge(publicKey)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L73)
- `loginWithSignature(publicKey, privateKey)` - [`loginWithSignature(publicKey, privateKey)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L86)
- `registerBySigningServiceKey(publicKey, privateKey)` — register by signing the API service public key (no invitation required) - [`registerBySigningServiceKey(publicKey, privateKey)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L76) — register by signing the API service public key (no invitation required)
- `createInvitation(payload, inviterPrivateKey)` - [`createInvitation(payload, inviterPrivateKey)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L101)
- `registerWithInvitation(...)` - [`registerWithInvitation(...)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L114)
- `listCollections()` - [`listCollections()`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L133)
- `createCollection(name)` - [`createCollection(name)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L137)
- `updateCollection(collectionId, name)` - [`updateCollection(collectionId, name)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L140)
- `deleteCollection(collectionId)` - [`deleteCollection(collectionId)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L148)
- `listFeatures(collectionId)` - [`listFeatures(collectionId)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L153)
- `createPointFeature(collectionId, lon, lat, properties)` - [`createPointFeature(collectionId, lon, lat, properties)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L156)
- `deleteFeature(featureId)` - [`deleteFeature(featureId)`](https://git.produktor.io/momswap/backend/src/branch/main/libs/geo-api-client/src/GeoApiClient.ts#L172)
## Recommended integration flow ## Recommended integration flow