@forge/realtime 0.4.2-next.0 → 0.5.0-experimental-04cc2b9

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @forge/realtime
 
+## 0.5.0-experimental-04cc2b9
+
+### Major Changes
+
+- d9ef926: Adds support for TypeScript 5
+
+### Patch Changes
+
+- f4a575a: Adds rate limit headers to signRealtimeToken
+
+## 0.5.0
+
+### Minor Changes
+
+- 68e1229: Adds pre validation for the forge realtime token in publish methods
+
+### Patch Changes
+
+- 4c69f6e: Add headers for rate limits
+- 64e72aa: Updates error return to be consistent
+
+## 0.5.0-next.2
+
+### Patch Changes
+
+- 64e72aa: Updates error return to be consistent
+
+## 0.5.0-next.1
+
+### Minor Changes
+
+- 68e1229: Adds pre validation for the forge realtime token in publish methods
+
 ## 0.4.2-next.0
 
 ### Patch Changes

package/out/productContext.d.ts

@@ -11,5 +11,5 @@ export declare enum Bitbucket {
     Repository = "repository",
     PullRequest = "pullRequest"
 }
-export declare type ProductContext = Jira | Confluence | Bitbucket;
+export type ProductContext = Jira | Confluence | Bitbucket;
 //# sourceMappingURL=productContext.d.ts.map

package/out/productContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"productContext.d.ts","sourceRoot":"","sources":["../src/productContext.ts"],"names":[],"mappings":"AAGA,oBAAY,IAAI;IACd,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,SAAS;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAED,oBAAY,cAAc,GAAG,IAAI,GAAG,UAAU,GAAG,SAAS,CAAC"}
+{"version":3,"file":"productContext.d.ts","sourceRoot":"","sources":["../src/productContext.ts"],"names":[],"mappings":"AAGA,oBAAY,IAAI;IACd,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,SAAS;IACnB,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,UAAU,GAAG,SAAS,CAAC"}

package/out/productContext.js

@@ -6,14 +6,14 @@ var Jira;
     Jira["Board"] = "board";
     Jira["Issue"] = "issue";
     Jira["Project"] = "project";
-})(Jira = exports.Jira || (exports.Jira = {}));
+})(Jira || (exports.Jira = Jira = {}));
 var Confluence;
 (function (Confluence) {
     Confluence["Content"] = "content";
     Confluence["Space"] = "space";
-})(Confluence = exports.Confluence || (exports.Confluence = {}));
+})(Confluence || (exports.Confluence = Confluence = {}));
 var Bitbucket;
 (function (Bitbucket) {
     Bitbucket["Repository"] = "repository";
     Bitbucket["PullRequest"] = "pullRequest";
-})(Bitbucket = exports.Bitbucket || (exports.Bitbucket = {}));
+})(Bitbucket || (exports.Bitbucket = Bitbucket = {}));

package/out/publish.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../src/publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA2BlD,UAAU,cAAc;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;CACrC;AAED,eAAO,MAAM,OAAO,mDACL,MAAM,sCAET,cAAc;;;;;;;;EA4EzB,CAAC;AAEF,eAAO,MAAM,aAAa,mDACX,MAAM,sCAET,cAAc;;;;;;;;EAgEzB,CAAC"}
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../src/publish.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA2BlD,UAAU,cAAc;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;CACrC;AAED,eAAO,MAAM,OAAO,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,aAAa,MAAM,EACnB,cAAc,MAAM,GAAG,CAAC,EACxB,UAAU,cAAc;;;;;;;;EA2FzB,CAAC;AAEF,eAAO,MAAM,aAAa,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnE,aAAa,MAAM,EACnB,cAAc,MAAM,GAAG,CAAC,EACxB,UAAU,cAAc;;;;;;;;EAiFzB,CAAC"}

package/out/publish.js

@@ -31,6 +31,20 @@ const publish = async (channelName, eventPayload, options) => {
     if (contextOverrides && !Array.isArray(contextOverrides)) {
         throw new Error('Invalid value for contextOverrides. Please provide an array of valid context properties.');
     }
+    if (token) {
+        const { valid, error } = (0, utils_1.validateToken)(token, channelName);
+        if (!valid) {
+            return {
+                eventId: null,
+                eventTimestamp: null,
+                errors: [
+                    {
+                        message: `Realtime token validation failed: ${error}`
+                    }
+                ]
+            };
+        }
+    }
     const channelContext = contextOverrides
         ? JSON.stringify({
             contextOverrides
@@ -48,7 +62,7 @@ const publish = async (channelName, eventPayload, options) => {
                 context: channelContext,
                 payload: JSON.stringify(eventPayload),
                 isGlobal: false,
-                token: token
+                token
             }
         }),
         errors: [],
@@ -89,6 +103,21 @@ const publish = async (channelName, eventPayload, options) => {
 exports.publish = publish;
 const publishGlobal = async (channelName, eventPayload, options) => {
     const { appContext, realtime } = (0, runtime_1.__getRuntime)();
+    const { token } = options || {};
+    if (token) {
+        const { valid, error } = (0, utils_1.validateToken)(token, channelName);
+        if (!valid) {
+            return {
+                eventId: null,
+                eventTimestamp: null,
+                errors: [
+                    {
+                        message: `Realtime token validation failed: ${error}`
+                    }
+                ]
+            };
+        }
+    }
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {
@@ -100,7 +129,7 @@ const publishGlobal = async (channelName, eventPayload, options) => {
                 name: channelName,
                 payload: JSON.stringify(eventPayload),
                 isGlobal: true,
-                token: options?.token
+                token
             }
         }),
         errors: [],
@@ -127,7 +156,7 @@ const publishGlobal = async (channelName, eventPayload, options) => {
             eventTimestamp: null,
             errors: [
                 {
-                    message: 'Error publishing global event to channel.'
+                    message: 'Error publishing event to channel.'
                 }
             ]
         };

package/out/runtime.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__getRuntime = void 0;
+exports.__getRuntime = __getRuntime;
 function __getRuntime() {
     const runtime = global.__forge_runtime__;
     if (!runtime) {
@@ -8,4 +8,3 @@ function __getRuntime() {
     }
     return runtime;
 }
-exports.__getRuntime = __getRuntime;

package/out/signRealtimeToken.d.ts

@@ -1,4 +1,5 @@
-declare type RealtimeTokenPermissions = ['subscribe'] | ['publish'] | ['subscribe', 'publish'] | ['publish', 'subscribe'];
+type TokenPermissions = 'subscribe' | 'publish';
+export type RealtimeTokenPermissions = [TokenPermissions, ...TokenPermissions[]];
 export declare const signRealtimeToken: (channelName: string, claims: any, permissions?: RealtimeTokenPermissions) => Promise<{
     token: null;
     expiresAt: null;

package/out/signRealtimeToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signRealtimeToken.d.ts","sourceRoot":"","sources":["../src/signRealtimeToken.ts"],"names":[],"mappings":"AA6BA,aAAK,wBAAwB,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAElH,eAAO,MAAM,iBAAiB,gBACf,MAAM,UAEX,GAAG,gBACG,wBAAwB;;;;;;;;EAyDvC,CAAC"}
+{"version":3,"file":"signRealtimeToken.d.ts","sourceRoot":"","sources":["../src/signRealtimeToken.ts"],"names":[],"mappings":"AA8BA,KAAK,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAC;AAChD,MAAM,MAAM,wBAAwB,GAAG,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC;AAEjF,eAAO,MAAM,iBAAiB,GAC5B,aAAa,MAAM,EAEnB,QAAQ,GAAG,EACX,cAAc,wBAAwB;;;;;;;;EA6DvC,CAAC"}

package/out/signRealtimeToken.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.signRealtimeToken = void 0;
 const utils_1 = require("./utils");
+const runtime_1 = require("./runtime");
 const graphqlBody = `mutation signRealtimeToken(
   $channelName: String!
   $claims: JSON!
@@ -29,6 +30,7 @@ const graphqlBody = `mutation signRealtimeToken(
   }
 }`;
 const signRealtimeToken = async (channelName, claims, permissions) => {
+    const { appContext } = (0, runtime_1.__getRuntime)();
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {
@@ -43,7 +45,9 @@ const signRealtimeToken = async (channelName, claims, permissions) => {
         }),
         errors: [],
         headers: {
-            'Content-Type': 'application/json'
+            'Content-Type': 'application/json',
+            'x-rate-limit-app-id': appContext.appId,
+            'x-rate-limit-installation-id': appContext.installationId
         }
     });
     (0, utils_1.handleProxyResponseErrors)(response);
@@ -62,7 +66,7 @@ const signRealtimeToken = async (channelName, claims, permissions) => {
             expiresAt: null,
             errors: [
                 {
-                    message: 'Error signing realtime token.'
+                    message: 'Error signing realtime token'
                 }
             ]
         };

package/out/utils.d.ts

@@ -1,2 +1,9 @@
 export declare const handleProxyResponseErrors: (response: Response) => void;
+type RealtimeTokenValidationError = 'INVALID_TOKEN' | 'TOKEN_EXPIRED' | 'MISSING_PERMISSION' | 'CHANNEL_NAME_MISMATCH';
+interface RealtimeTokenValidationResult {
+    error?: RealtimeTokenValidationError;
+    valid: boolean;
+}
+export declare const validateToken: (token: string, channelName: string) => RealtimeTokenValidationResult;
+export {};
 //# sourceMappingURL=utils.d.ts.map

package/out/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,yBAAyB,aAAc,QAAQ,KAAG,IAK9D,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,yBAAyB,GAAI,UAAU,QAAQ,KAAG,IAK9D,CAAC;AAeF,KAAK,4BAA4B,GAAG,eAAe,GAAG,eAAe,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;AAEvH,UAAU,6BAA6B;IACrC,KAAK,CAAC,EAAE,4BAA4B,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;CAChB;AAuBD,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,EAAE,aAAa,MAAM,KAAG,6BAqBlE,CAAC"}

package/out/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleProxyResponseErrors = void 0;
+exports.validateToken = exports.handleProxyResponseErrors = void 0;
 const api_1 = require("@forge/api");
 const getForgeProxyError = (response) => response.headers.get('forge-proxy-error');
 const handleProxyResponseErrors = (response) => {
@@ -10,3 +10,31 @@ const handleProxyResponseErrors = (response) => {
     }
 };
 exports.handleProxyResponseErrors = handleProxyResponseErrors;
+const decodeTokenPayload = (token) => {
+    const parts = token.split('.');
+    if (parts.length !== 3) {
+        throw new Error('Invalid token format.');
+    }
+    const base64 = parts[1].replace(/-/g, '+').replace(/_/g, '/');
+    return JSON.parse(Buffer.from(base64, 'base64').toString('utf-8'));
+};
+const validateToken = (token, channelName) => {
+    let decodedToken;
+    try {
+        decodedToken = decodeTokenPayload(token);
+    }
+    catch {
+        return { valid: false, error: 'INVALID_TOKEN' };
+    }
+    if (typeof decodedToken.exp === 'number' && Date.now() / 1000 >= decodedToken.exp) {
+        return { valid: false, error: 'TOKEN_EXPIRED' };
+    }
+    if (decodedToken.channel.name !== channelName) {
+        return { valid: false, error: 'CHANNEL_NAME_MISMATCH' };
+    }
+    if (decodedToken.permissions && !decodedToken.permissions?.includes('publish')) {
+        return { valid: false, error: 'MISSING_PERMISSION' };
+    }
+    return { valid: true };
+};
+exports.validateToken = validateToken;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/realtime",
-  "version": "0.4.2-next.0",
+  "version": "0.5.0-experimental-04cc2b9",
   "description": "Forge realtime",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -14,10 +14,19 @@
   },
   "devDependencies": {
     "@atlassian/metrics-interface": "4.0.0",
-    "@forge/api": "^7.2.1",
-    "@types/node": "20.19.1"
+    "@forge/api": "^7.2.2-experimental-04cc2b9",
+    "@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
+    }
   }
 }