@forge/kvs 0.0.2-next.0

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Atlassian
+Permission is hereby granted to use this software in accordance with the terms 
+and conditions outlined in the Atlassian Developer Terms, which can be found 
+at the following URL:
+https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
+By using this software, you agree to comply with these terms and conditions. 
+If you do not agree with these terms, you are not permitted to use this software.

package/README.md

@@ -0,0 +1,41 @@
+Library for Forge KVS.
+
+Usage example:
+```typescript
+import kvs, { Conditions, Sort, Filter } from "@forge/kvs";
+
+await kvs.set<string>('example-key', 'bar');
+await kvs.get<string>('example-key');
+await kvs.delete('example-key');
+await kvs.query().where('key', Conditions.beginsWith('example'))
+
+type Employee = {
+  surname: string;
+  age: number;
+  employmentyear: number;
+  gender: string;
+  nationality: string;
+}
+
+await kvs.entity<Employee>("employee").set('example-key', {
+    surname: "Davis",
+    age: 30,
+    employmentyear: 2022,
+    gender: "male",
+    nationality: "Australian"
+});
+await kvs.entity<Employee>("employee").get('example-key');
+await kvs.entity('employee').delete('example-key');
+await kvs
+  .entity<Employee>('employee')
+  .query()
+  .index('by-age')
+  .where(Conditions.greaterThan(30))
+  .filters(new Filter<Employee>().and('employmentyear', Conditions.equalTo(2025)))
+  .sort(Sort.DESC)
+  .getMany()
+
+await kvs.setSecret('example-key', 'Hello world');
+await kvs.getSecret('example-key');
+await kvs.deleteSecret('example-key');
+```

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@forge/kvs",
+  "version": "0.0.2-next.0",
+  "description": "Forge Key Value Store SDK",
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "files": [
+    "out"
+  ],
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v",
+    "postbuild": "yarn bolt w forge-scripts preserve-deprecated-tags ../forge-kvs"
+  },
+  "devDependencies": {
+    "@types/node": "14.18.63"
+  },
+  "dependencies": {
+    "@forge/api": "^5.0.2-next.0"
+  }
+}