@forge/bridge 5.4.1 → 5.5.0-experimental-6de6b19

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @forge/bridge
 
+## 5.5.0-experimental-6de6b19
+
+### Minor Changes
+
+- 01521ac: add usePermissions hook
+
+## 5.5.0
+
+### Minor Changes
+
+- 8e77d28: Add contextOverrides property to Realtime channel options
+
+### Patch Changes
+
+- 185f844: Fix package exports
+
+## 5.5.0-next.1
+
+### Patch Changes
+
+- 185f844: Fix package exports
+
+## 5.5.0-next.0
+
+### Minor Changes
+
+- 8e77d28: Add contextOverrides property to Realtime channel options
+
 ## 5.4.1
 
 ### Patch Changes

package/out/index.d.ts

@@ -9,4 +9,5 @@ export * from './flag';
 export * from './events';
 export * from './realtime';
 export * as i18n from './i18n';
+export { type FullContext } from './types';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC"}

package/out/realtime/index.d.ts

@@ -1,2 +1,3 @@
-export * from './realtime';
+export { type SubscriptionOptions, type PublishOptions, type PublishResult, realtime } from './realtime';
+export { Jira } from './productContext';
 //# sourceMappingURL=index.d.ts.map

package/out/realtime/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/realtime/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/realtime/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzG,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC"}

package/out/realtime/index.js

@@ -1,4 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./realtime"), exports);
+exports.Jira = exports.realtime = void 0;
+var realtime_1 = require("./realtime");
+Object.defineProperty(exports, "realtime", { enumerable: true, get: function () { return realtime_1.realtime; } });
+var productContext_1 = require("./productContext");
+Object.defineProperty(exports, "Jira", { enumerable: true, get: function () { return productContext_1.Jira; } });

package/out/realtime/productContext.d.ts

@@ -0,0 +1,7 @@
+export declare enum Jira {
+    Board = "board",
+    Issue = "issue",
+    Project = "project"
+}
+export declare type ProductContext = Jira;
+//# sourceMappingURL=productContext.d.ts.map

package/out/realtime/productContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"productContext.d.ts","sourceRoot":"","sources":["../../src/realtime/productContext.ts"],"names":[],"mappings":"AAEA,oBAAY,IAAI;IACd,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,oBAAY,cAAc,GAAG,IAAI,CAAC"}

package/out/realtime/productContext.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Jira = void 0;
+var Jira;
+(function (Jira) {
+    Jira["Board"] = "board";
+    Jira["Issue"] = "issue";
+    Jira["Project"] = "project";
+})(Jira = exports.Jira || (exports.Jira = {}));

package/out/realtime/realtime.d.ts

@@ -1,17 +1,25 @@
+import { ProductContext } from './productContext';
 export interface SubscriptionOptions {
     replaySeconds?: number;
     token?: string;
+    contextOverrides?: ProductContext[];
 }
 export interface PublishOptions {
     token?: string;
+    contextOverrides?: ProductContext[];
+}
+export interface PublishResult {
+    eventId?: string | null;
+    eventTimestamp?: string | null;
+    errors?: string[];
 }
 interface Subscription {
     unsubscribe: () => Promise<void>;
 }
 export declare const realtime: {
-    publish: (channel: string, payload: any, options?: PublishOptions) => Promise<void>;
+    publish: (channel: string, payload: any, options?: PublishOptions) => Promise<PublishResult>;
     subscribe: (channel: string, callback: (payload?: any) => any, options?: SubscriptionOptions) => Promise<Subscription>;
-    publishGlobal: (channel: string, payload: any, options?: PublishOptions) => Promise<void>;
+    publishGlobal: (channel: string, payload: any, options?: PublishOptions) => Promise<PublishResult>;
     subscribeGlobal: (channel: string, callback: (payload?: any) => any, options?: SubscriptionOptions) => Promise<Subscription>;
 };
 export {};

package/out/realtime/realtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../../src/realtime/realtime.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mBAAmB;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,YAAY;IACpB,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC;AAiCD,eAAO,MAAM,QAAQ;uBA7BK,MAAM,WAAW,GAAG,YAAY,cAAc,KAAG,QAAQ,IAAI,CAAC;yBAK7E,MAAM,uBACM,GAAG,KAAK,GAAG,YACtB,mBAAmB,KAC5B,QAAQ,YAAY,CAAC;6BAIQ,MAAM,WAAW,GAAG,YAAY,cAAc,KAAG,QAAQ,IAAI,CAAC;+BAKnF,MAAM,uBACM,GAAG,KAAK,GAAG,YACtB,mBAAmB,KAC5B,QAAQ,YAAY,CAAC;CAcvB,CAAC"}
+{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../../src/realtime/realtime.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,WAAW,mBAAmB;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,UAAU,YAAY;IACpB,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC;AAiCD,eAAO,MAAM,QAAQ;uBA7BK,MAAM,WAAW,GAAG,YAAY,cAAc,KAAG,QAAQ,aAAa,CAAC;yBAKtF,MAAM,uBACM,GAAG,KAAK,GAAG,YACtB,mBAAmB,KAC5B,QAAQ,YAAY,CAAC;6BAIQ,MAAM,WAAW,GAAG,YAAY,cAAc,KAAG,QAAQ,aAAa,CAAC;+BAK5F,MAAM,uBACM,GAAG,KAAK,GAAG,YACtB,mBAAmB,KAC5B,QAAQ,YAAY,CAAC;CAcvB,CAAC"}

package/out/types.d.ts

@@ -1,9 +1,10 @@
 import { type ForgeSupportedLocaleCode } from '@forge/i18n';
 import { type ThemeState } from '@atlaskit/tokens';
+import { type Scopes, type External } from '@forge/manifest';
 export declare type InvokePayload = {
     [key in number | string]: any;
 };
-export declare type InvokeResponse = Record<string, any> | void;
+export declare type InvokeResponse = Record<string, unknown> | void;
 export declare type ProductFetchResponse = {
     body?: string;
     headers: {
@@ -37,9 +38,10 @@ export interface FullContext {
     theme?: Partial<ThemeState> | null;
     surfaceColor?: string | null;
     userAccess?: UserAccessDetails;
+    permissions?: RuntimePermissions;
 }
 interface ExtensionData {
-    [k: string]: any;
+    [k: string]: unknown;
 }
 declare enum EcosystemLicenseMode {
     USER_ACCESS = "USER_ACCESS"
@@ -59,5 +61,9 @@ export interface LicenseDetails {
 export declare type Subscription = {
     unsubscribe: () => void;
 };
+export interface RuntimePermissions {
+    scopes?: Scopes;
+    external?: External;
+}
 export {};
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,oBAAY,oBAAoB;IAC9B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAED,aAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEhE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,aAAa,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,wBAAwB,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AAED,aAAK,oBAAoB;IACvB,WAAW,gBAAgB;CAC5B;AACD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE7D,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;AAE5D,oBAAY,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,oBAAY,oBAAoB;IAC9B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAED,aAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEhE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,aAAa,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;IACjC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,wBAAwB,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,aAAK,oBAAoB;IACvB,WAAW,gBAAgB;CAC5B;AACD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC;AAQF,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.4.1",
+  "version": "5.5.0-experimental-6de6b19",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -14,15 +14,26 @@
   },
   "dependencies": {
     "@atlaskit/tokens": "^1.58.0",
-    "@types/history": "^4.7.11",
     "@forge/i18n": "0.0.7",
-    "@forge/resolver": "1.7.0"
+    "@forge/manifest": "10.6.0",
+    "@forge/resolver": "1.7.0",
+    "@types/history": "^4.7.11"
   },
   "devDependencies": {
     "history": "5.3.0",
     "isomorphic-fetch": "^3.0.0",
     "jest-date-mock": "^1.0.10"
   },
+  "exports": {
+    ".": {
+      "types": "./out/index.d.ts",
+      "default": "./out/index.js"
+    },
+    "./realtime": {
+      "types": "./out/realtime/index.d.ts",
+      "default": "./out/realtime/index.js"
+    }
+  },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"
   }