@functional-systems/memdrive 0.1.0-rc.1 → 0.1.1-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +42 -11
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.0
|
|
4
|
+
|
|
5
|
+
First stable release of the standalone MemDrive SDK. The public API and storage
|
|
6
|
+
format are unchanged from 0.1.0-rc.1; the LambdaDB TypeScript client remains pinned
|
|
7
|
+
to 0.12.0.
|
|
8
|
+
|
|
9
|
+
- Provide memory storage, vector and hybrid retrieval, complete-original reads, metadata inspection, branches and portable agent tools.
|
|
10
|
+
- Wait for npm registry metadata to become visible after a successful publication, without retrying publication; verify archive identity and report channel state on reruns.
|
|
11
|
+
- Document stable installation and the `latest`, `rc` and `dev` channels.
|
|
12
|
+
|
|
3
13
|
## 0.1.0-rc.1
|
|
4
14
|
|
|
5
15
|
First release candidate of the standalone MemDrive SDK, backed by the pinned
|
package/README.md
CHANGED
|
@@ -8,19 +8,45 @@ LambdaDB client; the caller owns connection credentials and transport.
|
|
|
8
8
|
|
|
9
9
|
The package is `@functional-systems/memdrive`, licensed under Apache-2.0.
|
|
10
10
|
It builds ESM and CommonJS with TypeScript declarations and supports Node.js
|
|
11
|
-
20.12+ and browser bundlers.
|
|
12
|
-
|
|
11
|
+
20.12+ and browser bundlers.
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
### 1. Set up LambdaDB
|
|
16
|
+
|
|
17
|
+
1. [Create a LambdaDB account](https://app.lambdadb.ai/auth/signup), or sign in
|
|
18
|
+
to [LambdaDB Cloud](https://app.lambdadb.ai) if you already have one.
|
|
19
|
+
2. Create a project and choose an AWS region for your data.
|
|
20
|
+
3. Open the project's **API Keys** tab, select **Create key** (or
|
|
21
|
+
**Create your first key**), enter a name, and create the key. Creating a
|
|
22
|
+
project does not automatically issue an API key.
|
|
23
|
+
4. Save the key securely when it appears; the full value is shown only once.
|
|
24
|
+
Copy the project's region-specific **base URL** and **project name** from
|
|
25
|
+
the console as well.
|
|
26
|
+
|
|
27
|
+
In the example below, use the base URL as `baseUrl`, the project name as
|
|
28
|
+
`projectName`, and the API key as `projectApiKey`. Keep the API key out of source
|
|
29
|
+
control and load it from your application's secret configuration. See the
|
|
30
|
+
[LambdaDB setup guide](https://docs.lambdadb.ai/guides/get-started/quickstart)
|
|
31
|
+
for account setup and API key management details.
|
|
32
|
+
|
|
33
|
+
### 2. Install the packages
|
|
34
|
+
|
|
35
|
+
Install this stable release and the LambdaDB client used to initialize it:
|
|
13
36
|
|
|
14
37
|
```sh
|
|
15
|
-
npm install @functional-systems/memdrive@0.1.0
|
|
38
|
+
npm install @functional-systems/memdrive@0.1.0 @functional-systems/lambdadb@0.12.0
|
|
16
39
|
```
|
|
17
40
|
|
|
18
|
-
|
|
19
|
-
candidates, `@dev` for development builds, or an exact version for
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
41
|
+
An unqualified install follows the stable `latest` channel. Use `@rc` to follow
|
|
42
|
+
release candidates, `@dev` for development builds, or an exact version for
|
|
43
|
+
reproducibility.
|
|
44
|
+
|
|
45
|
+
### 3. Store and recall a memory
|
|
46
|
+
|
|
47
|
+
Replace the connection placeholders below with your project's values.
|
|
48
|
+
The `create` call sets up the MemDrive collection; no manual collection setup
|
|
49
|
+
is needed in the console.
|
|
24
50
|
|
|
25
51
|
```ts
|
|
26
52
|
import { LambdaDBClient } from '@functional-systems/lambdadb';
|
|
@@ -171,8 +197,7 @@ Recalls share a default concurrency bound of five across branch views; the
|
|
|
171
197
|
caller may configure it. Batch request count is not artificially capped by the
|
|
172
198
|
SDK; a hosted MCP wrapper can impose its own exposed tool limit.
|
|
173
199
|
|
|
174
|
-
The
|
|
175
|
-
after incompatible layout changes. MemDrive uses LambdaDB SDK 0.12.0. Build
|
|
200
|
+
The storage format is `mems-v0`. MemDrive uses LambdaDB SDK 0.12.0. Build
|
|
176
201
|
artifacts are generated with `npm run build`; browser applications bundle the
|
|
177
202
|
public package entry point with their own build tools.
|
|
178
203
|
|
|
@@ -231,3 +256,9 @@ orchestration and final prompt assembly. The standalone API no longer accepts
|
|
|
231
256
|
`mode` or `agent`; consumers of the earlier prototype must remove those options
|
|
232
257
|
and move any agent loop to the application. SDK unit and package checks do not establish
|
|
233
258
|
benchmark answer quality or live service compatibility.
|
|
259
|
+
|
|
260
|
+
## Development
|
|
261
|
+
|
|
262
|
+
To build locally, run `npm ci`, `npm run build`, and `npm pack`, then install the
|
|
263
|
+
resulting tarball in the consumer project. See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
264
|
+
for development and [RELEASING.md](RELEASING.md) for the release policy.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@functional-systems/memdrive",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1-dev.1",
|
|
4
4
|
"description": "Source-linked memory storage and retrieval backed by LambdaDB.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -97,5 +97,5 @@
|
|
|
97
97
|
"publishConfig": {
|
|
98
98
|
"access": "public"
|
|
99
99
|
},
|
|
100
|
-
"memdriveSourceCommit": "
|
|
100
|
+
"memdriveSourceCommit": "66aa00c06cc5d3d658738a990f002da9c4072ddd"
|
|
101
101
|
}
|