@forge/storage 2.0.2 → 2.0.3-experimental-04cc2b9

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2025 Atlassian
+Copyright (c) 2026 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:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/storage",
-  "version": "2.0.2",
+  "version": "2.0.3-experimental-04cc2b9",
   "description": "Forge Storage methods",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -16,9 +16,18 @@
   },
   "devDependencies": {
     "@atlassian/metrics-interface": "4.0.0",
-    "@types/node": "20.19.1"
+    "@types/node": "20.19.1",
+    "typescript": "5.9.2"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   }
 }

package/README.md

@@ -1,50 +0,0 @@
-Common library for both Forge environment and Harmonised Connect app environment.
-
-Usage example:
-
-```javascript
-import fetch, { RequestInit } from 'node-fetch';
-
-import { GlobalStorage } from './global-storage';
-import { APIResponse, getStorageInstanceWithQuery } from './index';
-import { getMetrics } from './runtime/fetch-and-storage';
-
-const API_BASE = 'https://api.atlassian.com';
-
-// For user agent header
-const version = '0.0.1';
-const appAri = 'ari:cloud:ecosystem::app/...';
-
-// For Storage service auth
-const appContextAri = 'ari:cloud:jira::site/...';
-const token = '...';
-
-async function apiClient(path: string, init: RequestInit): Promise<APIResponse> {
-  const url = API_BASE + path;
-
-  const extraHeaders = {
-    // See add-forge-user-agent.ts
-    'User-Agent': `H11n/${version} ${appAri}`,
-
-    Authorization: `Bearer ${token}`
-
-    // Only required when accessing Storage service via the GraphQL gateway
-    // https://api.atlassian.com/graphql
-    // 'X-ExperimentalApi': 'AppEntityStorage'
-  };
-
-  init.headers = Object.assign(init.headers!, extraHeaders);
-  return fetch(url, init);
-}
-
-const adapter = new GlobalStorage(() => appContextAri, apiClient, getMetrics);
-const storage = getStorageInstanceWithQuery(adapter);
-
-async function demo() {
-  await storage.set('key', 'value');
-  console.log(await storage.get('key'));
-  await storage.delete('key');
-}
-
-demo();
-```

package/out/__test__/errors.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=errors.test.d.ts.map

package/out/__test__/errors.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.test.d.ts","sourceRoot":"","sources":["../../src/__test__/errors.test.ts"],"names":[],"mappings":""}

package/out/__test__/errors.test.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("../errors");
-describe('APIError', () => {
-    describe('forStatus', () => {
-        it.each([
-            [400, 'Bad request'],
-            [413, 'Bad request'],
-            [401, 'Authentication error'],
-            [403, 'Permissions error or key does not exist'],
-            [404, 'Permissions error or key does not exist'],
-            [409, 'Conflicting update occurred'],
-            [500, 'Internal server error']
-        ])('should contain the correct error message for a code of %s', (status, message) => {
-            expect(errors_1.APIError.forStatus(status).message).toEqual(message);
-        });
-        it('should return a generic error message for unexpected status codes', () => {
-            expect(errors_1.APIError.forStatus(100).message).toEqual("Unknown error. Received status code '100'");
-        });
-    });
-    describe('forErrorCode', () => {
-        it('should return contain the provided message if the error code is in the allow list', () => {
-            expect(errors_1.APIError.forErrorCode('INVALID_CURSOR', 'this is an error message').message).toEqual('this is an error message');
-        });
-        it('should return the error code if no message was provided', () => {
-            expect(errors_1.APIError.forErrorCode('INVALID_CURSOR', null).message).toEqual('INVALID_CURSOR');
-        });
-    });
-    describe('forUnexpected', () => {
-        it('should return an APIError with a message provided', () => {
-            expect(errors_1.APIError.forUnexpected('test').message).toEqual('test');
-        });
-    });
-});

package/out/__test__/global-storage.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=global-storage.test.d.ts.map

package/out/__test__/global-storage.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"global-storage.test.d.ts","sourceRoot":"","sources":["../../src/__test__/global-storage.test.ts"],"names":[],"mappings":""}