@forge/object-store 1.1.0-next.1

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,76 @@
+Library for Forge environment.
+
+Usage example:
+```typescript
+import fos from "@forge/object-store";
+```
+
+Types exported:
+```typescript
+export interface ObjectReference {
+  key: string;
+  checksum: string;
+  size: number;
+  createdAt?: string;
+  currentVersion?: string;
+  contentType?: string;
+}
+
+export interface UploadUrlBody {
+  key: string;
+  length: number;
+  checksum: string;
+  checksumType: 'SHA1' | 'SHA256' | 'CRC32' | 'CRC32C';
+  ttlSeconds?: number;
+  overwrite?: boolean;
+}
+
+export interface PresignedUrlResponse {
+  url: string;
+}
+```
+
+Example upload & download:
+
+```typescript
+// Create a buffer from some object and then calculate the SHA256 checksum for it
+const buffer = Buffer.from(object);
+const checksum = crypto.createHash('sha256').update(buffer).digest('base64');
+const key = 'your-object-id';
+
+const payload = {
+  key,
+  checksum,
+  checksumType: 'SHA256',
+  length: buffer.length,
+}
+
+// Create a pre-signed upload url
+const uploadUrlResponse = await fos.createUploadUrl(payload);
+const uploadUrl = uploadUrlResponse.url;
+
+// Both standard fetch or api.fetch can be used to upload the buffer
+const response = await fetch(url, {
+      method: 'PUT',
+      headers: {
+        'content-type': 'application/octet-stream', // or the actual content type of your object
+      },
+      body: buffer,
+    });
+
+// Check the object metadata
+const metadata = await fos.get(key);
+console.log(metadata);
+
+// Download the object by creating a pre-signed link first and then download the object
+const downloadUrlResponse = await fos.createDownloadUrl(key);
+const downloadRes = await fetch(downloadUrlResponse.url);
+
+// These buffers should be equal
+const downloaded = Buffer.from(await downloadRes.arrayBuffer());
+const message = buffer.equals(downloaded)
+  ? "\x1b[32m✅  Files are identical.\x1b[0m"
+  : "\x1b[31m❌  Files differ!\x1b[0m"
+
+console.log(message);
+```

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@forge/object-store",
+  "version": "1.1.0-next.1",
+  "description": "Forge Object Store SDK",
+  "author": "Atlassian",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "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"
+  },
+  "devDependencies": {
+    "@types/node": "20.19.1",
+    "expect-type": "^0.17.3",
+    "jest-when": "^3.6.0"
+  },
+  "dependencies": {
+    "@forge/api": "^6.4.0-next.0"
+  },
+  "publishConfig": {
+    "registry": "https://packages.atlassian.com/api/npm/npm-public/"
+  }
+}