@forge/realtime 0.5.1-next.0-experimental-44b7a12 → 1.0.0

package/CHANGELOG.md

@@ -1,11 +1,26 @@
 # @forge/realtime
 
-## 0.5.1-next.0-experimental-44b7a12
+## 1.0.0
+
+### Major Changes
+
+- 78fcb7f: Adds support for TypeScript 5
 
 ### Patch Changes
 
+- 8a0359e: Handle rate limit errors
 - f4a575a: Adds rate limit headers to signRealtimeToken
 
+## 1.0.0-next.1
+
+### Major Changes
+
+- 78fcb7f: Adds support for TypeScript 5
+
+### Patch Changes
+
+- 8a0359e: Handle rate limit errors
+
 ## 0.5.1-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;;;;;;;;EA2FzB,CAAC;AAEF,eAAO,MAAM,aAAa,mDACX,MAAM,sCAET,cAAc;;;;;;;;EAiFzB,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;AAuED,eAAO,MAAM,OAAO,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,aAAa,MAAM,EACnB,cAAc,MAAM,GAAG,CAAC,EACxB,UAAU,cAAc;;;;;;;;EA4BzB,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;;;;;;;;EAqBzB,CAAC"}

package/out/publish.js

@@ -25,146 +25,93 @@ const graphqlBody = `mutation publishRealtimeChannel(
     }
   }
 }`;
-const publish = async (channelName, eventPayload, options) => {
-    const { appContext, realtime } = (0, runtime_1.__getRuntime)();
-    const { token, contextOverrides } = 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 validateTokenOrReturnError = (token, channelName) => {
+    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
-        })
-        : undefined;
-    const response = await global.__forge_fetch__({
-        type: 'realtime'
-    }, '/', {
+    return null;
+};
+const executePublish = async (variables, contextToken, appId) => {
+    const response = await global.__forge_fetch__({ type: 'realtime' }, '/', {
         method: 'POST',
-        body: JSON.stringify({
-            query: graphqlBody,
-            variables: {
-                installationId: appContext.installationId,
-                name: channelName,
-                context: channelContext,
-                payload: JSON.stringify(eventPayload),
-                isGlobal: false,
-                token
-            }
-        }),
+        body: JSON.stringify({ query: graphqlBody, variables }),
         errors: [],
         headers: {
             'Content-Type': 'application/json',
-            'x-forge-context-token': realtime?.contextToken,
-            'x-rate-limit-app-id': appContext.appId,
-            'x-rate-limit-installation-id': appContext.installationId
+            'x-forge-context-token': contextToken,
+            'x-rate-limit-app-id': appId,
+            'x-rate-limit-installation-id': variables.installationId
         }
     });
     (0, utils_1.handleProxyResponseErrors)(response);
-    const awaitedResponse = await response.json();
-    const { data, errors } = awaitedResponse;
-    if (errors && errors.length > 0) {
-        return {
-            eventId: null,
-            eventTimestamp: null,
-            errors
-        };
-    }
-    if (!data) {
+    if (response.status !== 200) {
         return {
             eventId: null,
             eventTimestamp: null,
             errors: [
                 {
-                    message: 'Error publishing event to channel.'
+                    message: response.statusText === 'Too Many Requests' ? 'RATE_LIMIT_EXCEEDED' : response.statusText,
+                    status: response.status
                 }
             ]
         };
     }
-    const { eventId, eventTimestamp } = awaitedResponse.data.ecosystem.publishRealtimeChannel;
-    return {
-        eventId,
-        eventTimestamp
-    };
-};
-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'
-    }, '/', {
-        method: 'POST',
-        body: JSON.stringify({
-            query: graphqlBody,
-            variables: {
-                installationId: appContext.installationId,
-                name: channelName,
-                payload: JSON.stringify(eventPayload),
-                isGlobal: true,
-                token
-            }
-        }),
-        errors: [],
-        headers: {
-            'Content-Type': 'application/json',
-            'x-forge-context-token': realtime?.contextToken,
-            'x-rate-limit-app-id': appContext.appId,
-            'x-rate-limit-installation-id': appContext.installationId
-        }
-    });
-    (0, utils_1.handleProxyResponseErrors)(response);
     const awaitedResponse = await response.json();
     const { data, errors } = awaitedResponse;
     if (errors && errors.length > 0) {
-        return {
-            eventId: null,
-            eventTimestamp: null,
-            errors
-        };
+        return { eventId: null, eventTimestamp: null, errors };
     }
     if (!data) {
         return {
             eventId: null,
             eventTimestamp: null,
-            errors: [
-                {
-                    message: 'Error publishing event to channel.'
-                }
-            ]
+            errors: [{ message: 'Error publishing event to channel.' }]
         };
     }
     const { eventId, eventTimestamp } = data.ecosystem.publishRealtimeChannel;
-    return {
-        eventId,
-        eventTimestamp
-    };
+    return { eventId, eventTimestamp };
+};
+const publish = async (channelName, eventPayload, options) => {
+    const { appContext, realtime } = (0, runtime_1.__getRuntime)();
+    const { token, contextOverrides } = options || {};
+    if (contextOverrides && !Array.isArray(contextOverrides)) {
+        throw new Error('Invalid value for contextOverrides. Please provide an array of valid context properties.');
+    }
+    if (token) {
+        const tokenError = validateTokenOrReturnError(token, channelName);
+        if (tokenError)
+            return tokenError;
+    }
+    const channelContext = contextOverrides ? JSON.stringify({ contextOverrides }) : undefined;
+    return executePublish({
+        installationId: appContext.installationId,
+        name: channelName,
+        context: channelContext,
+        payload: JSON.stringify(eventPayload),
+        isGlobal: false,
+        token
+    }, realtime?.contextToken, appContext.appId);
+};
+exports.publish = publish;
+const publishGlobal = async (channelName, eventPayload, options) => {
+    const { appContext, realtime } = (0, runtime_1.__getRuntime)();
+    const { token } = options || {};
+    if (token) {
+        const tokenError = validateTokenOrReturnError(token, channelName);
+        if (tokenError)
+            return tokenError;
+    }
+    return executePublish({
+        installationId: appContext.installationId,
+        name: channelName,
+        payload: JSON.stringify(eventPayload),
+        isGlobal: true,
+        token
+    }, realtime?.contextToken, appContext.appId);
 };
 exports.publishGlobal = publishGlobal;

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,5 +1,5 @@
-declare type TokenPermissions = 'subscribe' | 'publish';
-export declare type RealtimeTokenPermissions = [TokenPermissions, ...TokenPermissions[]];
+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":"AA8BA,aAAK,gBAAgB,GAAG,WAAW,GAAG,SAAS,CAAC;AAChD,oBAAY,wBAAwB,GAAG,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC;AAEjF,eAAO,MAAM,iBAAiB,gBACf,MAAM,UAEX,GAAG,gBACG,wBAAwB;;;;;;;;EA6DvC,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;;;;;;;;EA0EvC,CAAC"}

package/out/signRealtimeToken.js

@@ -51,6 +51,18 @@ const signRealtimeToken = async (channelName, claims, permissions) => {
         }
     });
     (0, utils_1.handleProxyResponseErrors)(response);
+    if (response.status !== 200) {
+        return {
+            token: null,
+            expiresAt: null,
+            errors: [
+                {
+                    message: response.statusText === 'Too Many Requests' ? 'RATE_LIMIT_EXCEEDED' : response.statusText,
+                    status: response.status
+                }
+            ]
+        };
+    }
     const awaitedResponse = await response.json();
     const { data, errors } = awaitedResponse;
     if (errors && errors.length > 0) {

package/out/utils.d.ts

@@ -1,5 +1,5 @@
 export declare const handleProxyResponseErrors: (response: Response) => void;
-declare type RealtimeTokenValidationError = 'INVALID_TOKEN' | 'TOKEN_EXPIRED' | 'MISSING_PERMISSION' | 'CHANNEL_NAME_MISMATCH';
+type RealtimeTokenValidationError = 'INVALID_TOKEN' | 'TOKEN_EXPIRED' | 'MISSING_PERMISSION' | 'CHANNEL_NAME_MISMATCH';
 interface RealtimeTokenValidationResult {
     error?: RealtimeTokenValidationError;
     valid: boolean;

package/out/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,yBAAyB,aAAc,QAAQ,KAAG,IAK9D,CAAC;AAeF,aAAK,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,UAAW,MAAM,eAAe,MAAM,KAAG,6BAqBlE,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/realtime",
-  "version": "0.5.1-next.0-experimental-44b7a12",
+  "version": "1.0.0",
   "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": "^8.0.0-next.1-experimental-44b7a12",
-    "@types/node": "20.19.1"
+    "@forge/api": "^8.0.0",
+    "@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
+    }
   }
 }