@functional-systems/memdrive 0.1.0 → 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/README.md +37 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -8,8 +8,31 @@ 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
38
|
npm install @functional-systems/memdrive@0.1.0 @functional-systems/lambdadb@0.12.0
|
|
@@ -18,10 +41,12 @@ npm install @functional-systems/memdrive@0.1.0 @functional-systems/lambdadb@0.12
|
|
|
18
41
|
An unqualified install follows the stable `latest` channel. Use `@rc` to follow
|
|
19
42
|
release candidates, `@dev` for development builds, or an exact version for
|
|
20
43
|
reproducibility.
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
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.
|
|
25
50
|
|
|
26
51
|
```ts
|
|
27
52
|
import { LambdaDBClient } from '@functional-systems/lambdadb';
|
|
@@ -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
|
}
|