@forge/bridge 5.7.0-next.8 → 5.7.0-next.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 5.7.0-next.9
+
+### Patch Changes
+
+- a03c9c5: Adds new bridge method objectStore.getMetadata
+
 ## 5.7.0-next.8
 
 ### Minor Changes

package/out/object-store/download.d.ts

@@ -1,6 +1,6 @@
-import type { DownloadResult, FilterAndGenerateUrls } from './types';
-export declare const download: ({ filterAndGenerateDownloadUrls, objectKeys }: {
-    filterAndGenerateDownloadUrls: FilterAndGenerateUrls;
-    objectKeys: string[];
+import type { DownloadResult } from './types';
+export declare const download: ({ functionKey, keys }: {
+    functionKey: string;
+    keys: string[];
 }) => Promise<DownloadResult[]>;
 //# sourceMappingURL=download.d.ts.map

package/out/object-store/download.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/object-store/download.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAsB,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAUzF,eAAO,MAAM,QAAQ;mCAIY,qBAAqB;gBACxC,MAAM,EAAE;MAClB,QAAQ,cAAc,EAAE,CAqD3B,CAAC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/object-store/download.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAsB,MAAM,SAAS,CAAC;AAUlE,eAAO,MAAM,QAAQ;iBAIN,MAAM;UACb,MAAM,EAAE;MACZ,QAAQ,cAAc,EAAE,CAqD3B,CAAC"}

package/out/object-store/download.js

@@ -3,20 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.download = void 0;
 const invoke_1 = require("../invoke");
 const errors_1 = require("../errors");
-const download = async ({ filterAndGenerateDownloadUrls, objectKeys }) => {
-    if (!(filterAndGenerateDownloadUrls === null || filterAndGenerateDownloadUrls === void 0 ? void 0 : filterAndGenerateDownloadUrls.function)) {
-        throw new errors_1.BridgeAPIError('filterAndGenerateDownloadUrls.function is required');
+const download = async ({ functionKey, keys }) => {
+    if (!functionKey || functionKey.length === 0) {
+        throw new errors_1.BridgeAPIError('functionKey is required to filter and generate download URLs');
     }
-    if (!Array.isArray(objectKeys) || objectKeys.length === 0) {
-        throw new errors_1.BridgeAPIError('objectKeys array is required and must not be empty');
+    if (!Array.isArray(keys) || keys.length === 0) {
+        throw new errors_1.BridgeAPIError('keys array is required and must not be empty');
     }
-    const downloadUrlsToObjectKeys = (await (0, invoke_1.invoke)(filterAndGenerateDownloadUrls.function, {
-        objectKeys
+    const downloadUrlsTokeys = (await (0, invoke_1.invoke)(functionKey, {
+        keys
     }));
-    if (!downloadUrlsToObjectKeys || typeof downloadUrlsToObjectKeys !== 'object') {
-        throw new errors_1.BridgeAPIError('Invalid response from filterAndGenerateDownloadUrls function');
+    if (!downloadUrlsTokeys || typeof downloadUrlsTokeys !== 'object') {
+        throw new errors_1.BridgeAPIError('Invalid response from functionKey');
     }
-    const downloadPromises = Object.entries(downloadUrlsToObjectKeys).map(async ([downloadUrl, key]) => {
+    const downloadPromises = Object.entries(downloadUrlsTokeys).map(async ([downloadUrl, key]) => {
         try {
             const response = await fetch(downloadUrl, {
                 method: 'GET'
@@ -24,7 +24,7 @@ const download = async ({ filterAndGenerateDownloadUrls, objectKeys }) => {
             if (!response.ok) {
                 return {
                     success: false,
-                    objectKey: key,
+                    key: key,
                     status: response.status,
                     error: `Download failed with status ${response.status}`
                 };
@@ -32,7 +32,7 @@ const download = async ({ filterAndGenerateDownloadUrls, objectKeys }) => {
             const blob = await response.blob();
             return {
                 success: true,
-                objectKey: key,
+                key: key,
                 blob,
                 status: response.status
             };
@@ -40,7 +40,7 @@ const download = async ({ filterAndGenerateDownloadUrls, objectKeys }) => {
         catch (error) {
             return {
                 success: false,
-                objectKey: key,
+                key: key,
                 status: 503,
                 error: error instanceof Error ? error.message : 'Download failed'
             };

package/out/object-store/getMetadata.d.ts

@@ -0,0 +1,6 @@
+import type { GetMetadataResult } from './types';
+export declare const getMetadata: ({ functionKey, keys }: {
+    functionKey: string;
+    keys: string[];
+}) => Promise<GetMetadataResult[]>;
+//# sourceMappingURL=getMetadata.d.ts.map

package/out/object-store/getMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMetadata.d.ts","sourceRoot":"","sources":["../../src/object-store/getMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAUjD,eAAO,MAAM,WAAW;iBAIT,MAAM;UACb,MAAM,EAAE;MACZ,QAAQ,iBAAiB,EAAE,CAyB9B,CAAC"}

package/out/object-store/getMetadata.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadata = void 0;
+const invoke_1 = require("../invoke");
+const errors_1 = require("../errors");
+const getMetadata = async ({ functionKey, keys }) => {
+    if (!functionKey || functionKey.length === 0) {
+        throw new errors_1.BridgeAPIError('functionKey is required to filter and generate object metadata');
+    }
+    if (!Array.isArray(keys) || keys.length === 0) {
+        throw new errors_1.BridgeAPIError('keys array is required and must not be empty');
+    }
+    const results = await Promise.all(keys.map(async (key) => {
+        const result = (await (0, invoke_1.invoke)(functionKey, { key }));
+        if (!result || typeof result !== 'object') {
+            return {
+                key: key,
+                error: 'Invalid response from functionKey'
+            };
+        }
+        return result;
+    }));
+    return results;
+};
+exports.getMetadata = getMetadata;

package/out/object-store/types.d.ts

@@ -3,9 +3,6 @@ export declare type ObjectMetadata = {
     checksum: string;
     checksumType: string;
 };
-export declare type FilterAndGenerateUrls = {
-    function: string;
-};
 export declare type FileMetadata = ObjectMetadata & {
     key: string;
     ttlSeconds?: number;
@@ -13,13 +10,13 @@ export declare type FileMetadata = ObjectMetadata & {
 };
 export declare type UploadResult = {
     success: boolean;
-    objectKey: string;
+    key: string;
     status?: number;
     error?: string;
 };
 export declare type DownloadResult = {
     success: boolean;
-    objectKey: string;
+    key: string;
     blob?: Blob;
     status?: number;
     error?: string;
@@ -30,4 +27,12 @@ export declare type PresignedURLMapping = {
 export declare type DownloadURLMapping = {
     [url: string]: string;
 };
+export declare type GetMetadataResult = {
+    key: string;
+    checksum?: string;
+    size?: number;
+    createdAt?: string;
+    currentVersion?: string;
+    error?: string;
+};
 //# sourceMappingURL=types.d.ts.map

package/out/object-store/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object-store/types.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,GAAG,cAAc,GAAG;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object-store/types.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,YAAY,GAAG,cAAc,GAAG;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAE3D,oBAAY,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/out/object-store/upload.d.ts

@@ -1,6 +1,6 @@
-import type { FilterAndGenerateUrls, UploadResult } from './types';
-export declare const upload: ({ filterAndGenerateUrls, objects }: {
-    filterAndGenerateUrls: FilterAndGenerateUrls;
+import type { UploadResult } from './types';
+export declare const upload: ({ functionKey, objects }: {
+    functionKey: string;
     objects: Blob[];
 }) => Promise<UploadResult[]>;
 //# sourceMappingURL=upload.d.ts.map

package/out/object-store/upload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/object-store/upload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAuC,qBAAqB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AA8BxG,eAAO,MAAM,MAAM;2BAIM,qBAAqB;aACnC,IAAI,EAAE;MACb,QAAQ,YAAY,EAAE,CAkEzB,CAAC"}
+{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/object-store/upload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAuC,YAAY,EAAE,MAAM,SAAS,CAAC;AA8BjF,eAAO,MAAM,MAAM;iBAIJ,MAAM;aACV,IAAI,EAAE;MACb,QAAQ,YAAY,EAAE,CAkEzB,CAAC"}

package/out/object-store/upload.js

@@ -16,19 +16,19 @@ const getObjectMetadata = async (blob) => {
         checksumType
     };
 };
-const upload = async ({ filterAndGenerateUrls, objects }) => {
-    if (!(filterAndGenerateUrls === null || filterAndGenerateUrls === void 0 ? void 0 : filterAndGenerateUrls.function)) {
-        throw new errors_1.BridgeAPIError('filterAndGenerateUrls.function is required');
+const upload = async ({ functionKey, objects }) => {
+    if (!functionKey || functionKey.length === 0) {
+        throw new errors_1.BridgeAPIError('functionKey is required to filter and generate presigned URLs');
     }
     if (!Array.isArray(objects) || objects.length === 0) {
         throw new errors_1.BridgeAPIError('objects array is required and must not be empty');
     }
     const allObjectMetadata = await Promise.all(objects.map((obj) => getObjectMetadata(obj)));
-    const presignedURLsToObjectMetadata = (await (0, invoke_1.invoke)(filterAndGenerateUrls.function, {
+    const presignedURLsToObjectMetadata = (await (0, invoke_1.invoke)(functionKey, {
         allObjectMetadata
     }));
     if (!presignedURLsToObjectMetadata || typeof presignedURLsToObjectMetadata !== 'object') {
-        throw new errors_1.BridgeAPIError('Invalid response from filterAndGenerateUrls function');
+        throw new errors_1.BridgeAPIError('Invalid response from functionKey');
     }
     const checksumToBlobMap = new Map();
     objects.forEach((blob, index) => {
@@ -41,7 +41,7 @@ const upload = async ({ filterAndGenerateUrls, objects }) => {
         if (!object) {
             return {
                 success: false,
-                objectKey: key,
+                key: key,
                 error: `Blob not found for checksum ${checksum}`
             };
         }
@@ -56,7 +56,7 @@ const upload = async ({ filterAndGenerateUrls, objects }) => {
             });
             return {
                 success: response.ok,
-                objectKey: key,
+                key: key,
                 status: response.status,
                 error: response.ok ? undefined : `Upload failed with status ${response.status}`
             };
@@ -64,7 +64,7 @@ const upload = async ({ filterAndGenerateUrls, objects }) => {
         catch (error) {
             return {
                 success: false,
-                objectKey: key,
+                key: key,
                 status: 503,
                 error: error instanceof Error ? error.message : 'Upload failed'
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.7.0-next.8",
+  "version": "5.7.0-next.9",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",