@forge/realtime 1.0.0-next.1 → 1.0.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @forge/realtime
 
+## 1.0.1-next.0
+
+### Patch Changes
+
+- 283c442: Tidy rate limit headers
+
+## 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

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;AAuED,eAAO,MAAM,OAAO,mDACL,MAAM,sCAET,cAAc;;;;;;;;EA4BzB,CAAC;AAEF,eAAO,MAAM,aAAa,mDACX,MAAM,sCAET,cAAc;;;;;;;;EAqBzB,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;AAqED,eAAO,MAAM,OAAO,GAAU,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,aAAa,MAAM,EACnB,cAAc,MAAM,GAAG,CAAC,EACxB,UAAU,cAAc;;;;;;;;EA2BzB,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;;;;;;;;EAoBzB,CAAC"}

package/out/publish.js

@@ -36,16 +36,14 @@ const validateTokenOrReturnError = (token, channelName) => {
     }
     return null;
 };
-const executePublish = async (variables, contextToken, appId) => {
+const executePublish = async (variables, contextToken) => {
     const response = await global.__forge_fetch__({ type: 'realtime' }, '/', {
         method: 'POST',
         body: JSON.stringify({ query: graphqlBody, variables }),
         errors: [],
         headers: {
             'Content-Type': 'application/json',
-            'x-forge-context-token': contextToken,
-            'x-rate-limit-app-id': appId,
-            'x-rate-limit-installation-id': variables.installationId
+            'x-forge-context-token': contextToken
         }
     });
     (0, utils_1.handleProxyResponseErrors)(response);
@@ -95,7 +93,7 @@ const publish = async (channelName, eventPayload, options) => {
         payload: JSON.stringify(eventPayload),
         isGlobal: false,
         token
-    }, realtime?.contextToken, appContext.appId);
+    }, realtime?.contextToken);
 };
 exports.publish = publish;
 const publishGlobal = async (channelName, eventPayload, options) => {
@@ -112,6 +110,6 @@ const publishGlobal = async (channelName, eventPayload, options) => {
         payload: JSON.stringify(eventPayload),
         isGlobal: true,
         token
-    }, realtime?.contextToken, appContext.appId);
+    }, realtime?.contextToken);
 };
 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;;;;;;;;EA0EvC,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;;;;;;;;EAsEvC,CAAC"}

package/out/signRealtimeToken.js

@@ -2,7 +2,6 @@
 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!
@@ -30,7 +29,6 @@ const graphqlBody = `mutation signRealtimeToken(
   }
 }`;
 const signRealtimeToken = async (channelName, claims, permissions) => {
-    const { appContext } = (0, runtime_1.__getRuntime)();
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {
@@ -45,9 +43,7 @@ const signRealtimeToken = async (channelName, claims, permissions) => {
         }),
         errors: [],
         headers: {
-            'Content-Type': 'application/json',
-            'x-rate-limit-app-id': appContext.appId,
-            'x-rate-limit-installation-id': appContext.installationId
+            'Content-Type': 'application/json'
         }
     });
     (0, utils_1.handleProxyResponseErrors)(response);

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": "1.0.0-next.1",
+  "version": "1.0.1-next.0",
   "description": "Forge realtime",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -14,7 +14,7 @@
   },
   "devDependencies": {
     "@atlassian/metrics-interface": "4.0.0",
-    "@forge/api": "^8.0.0-next.2",
+    "@forge/api": "^8.0.3-next.0",
     "@types/node": "20.19.1",
     "typescript": "5.9.2"
   },