@forge/realtime 0.2.3 → 0.3.0-experimental-4bd2ca0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @forge/realtime
 
+## 0.3.0
+
+### Minor Changes
+
+- 1d129f0: Allow objects in event payloads. The object must be JSON-serializable.
+- b607fd6: Remove blocker for production apps
+
+### Patch Changes
+
+- 80ed8eb: Support object payloads in published events
+
+## 0.3.0-next.2
+
+### Patch Changes
+
+- 80ed8eb: Support object payloads in published events
+
+## 0.3.0-next.1
+
+### Minor Changes
+
+- 1d129f0: Allow objects in event payloads. The object must be JSON-serializable.
+
+## 0.3.0-next.0
+
+### Minor Changes
+
+- b607fd6: Remove blocker for production apps
+
 ## 0.2.3
 
 ### Patch Changes

package/out/publish.d.ts

@@ -3,7 +3,7 @@ interface PublishOptions {
     token?: string;
     contextOverrides?: ProductContext[];
 }
-export declare const publish: (channelName: string, eventPayload: string, options?: PublishOptions) => Promise<{
+export declare const publish: <T extends Record<string, unknown>>(channelName: string, eventPayload: string | T, options?: PublishOptions) => Promise<{
     eventId: null;
     eventTimestamp: null;
     errors: any;
@@ -12,7 +12,7 @@ export declare const publish: (channelName: string, eventPayload: string, option
     eventTimestamp: any;
     errors?: undefined;
 }>;
-export declare const publishGlobal: (channelName: string, eventPayload: string, options?: PublishOptions) => Promise<{
+export declare const publishGlobal: <T extends Record<string, unknown>>(channelName: string, eventPayload: string | T, options?: PublishOptions) => Promise<{
     eventId: null;
     eventTimestamp: null;
     errors: any;

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,gBAAuB,MAAM,gBAAgB,MAAM,YAAY,cAAc;;;;;;;;EA6EhG,CAAC;AAEF,eAAO,MAAM,aAAa,gBAAuB,MAAM,gBAAgB,MAAM,YAAY,cAAc;;;;;;;;EAgEtG,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,mDACL,MAAM,sCAET,cAAc;;;;;;;;EA0EzB,CAAC;AAEF,eAAO,MAAM,aAAa,mDACX,MAAM,sCAET,cAAc;;;;;;;;EA6DzB,CAAC"}

package/out/publish.js

@@ -27,9 +27,6 @@ const graphqlBody = `mutation publishRealtimeChannel(
 }`;
 const publish = async (channelName, eventPayload, options) => {
     const { appContext, realtime } = (0, runtime_1.__getRuntime)();
-    if (appContext?.environmentType === 'PRODUCTION') {
-        throw new Error(utils_1.prodEnvErrorMessage);
-    }
     const { token, contextOverrides } = options || {};
     if (contextOverrides && !Array.isArray(contextOverrides)) {
         throw new Error('Invalid value for contextOverrides. Please provide an array of valid context properties.');
@@ -49,7 +46,7 @@ const publish = async (channelName, eventPayload, options) => {
                 installationId: appContext.installationId,
                 name: channelName,
                 context: channelContext,
-                payload: eventPayload,
+                payload: JSON.stringify(eventPayload),
                 isGlobal: false,
                 token: token
             }
@@ -90,9 +87,6 @@ const publish = async (channelName, eventPayload, options) => {
 exports.publish = publish;
 const publishGlobal = async (channelName, eventPayload, options) => {
     const { appContext } = (0, runtime_1.__getRuntime)();
-    if (appContext?.environmentType === 'PRODUCTION') {
-        throw new Error(utils_1.prodEnvErrorMessage);
-    }
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {
@@ -102,7 +96,7 @@ const publishGlobal = async (channelName, eventPayload, options) => {
             variables: {
                 installationId: appContext.installationId,
                 name: channelName,
-                payload: eventPayload,
+                payload: JSON.stringify(eventPayload),
                 isGlobal: true,
                 token: options?.token
             }

package/out/signRealtimeToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signRealtimeToken.d.ts","sourceRoot":"","sources":["../src/signRealtimeToken.ts"],"names":[],"mappings":"AA4BA,eAAO,MAAM,iBAAiB,gBAAuB,MAAM,UAAU,GAAG;;;;;;;;EA6DvE,CAAC"}
+{"version":3,"file":"signRealtimeToken.d.ts","sourceRoot":"","sources":["../src/signRealtimeToken.ts"],"names":[],"mappings":"AA2BA,eAAO,MAAM,iBAAiB,gBAAuB,MAAM,UAAU,GAAG;;;;;;;;EAuDvE,CAAC"}

package/out/signRealtimeToken.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.signRealtimeToken = void 0;
-const runtime_1 = require("./runtime");
 const utils_1 = require("./utils");
 const graphqlBody = `mutation signRealtimeToken(
   $channelName: String!
@@ -28,10 +27,6 @@ const graphqlBody = `mutation signRealtimeToken(
   }
 }`;
 const signRealtimeToken = async (channelName, claims) => {
-    const { appContext } = (0, runtime_1.__getRuntime)();
-    if (appContext?.environmentType === 'PRODUCTION') {
-        throw new Error(utils_1.prodEnvErrorMessage);
-    }
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {

package/out/utils.d.ts

@@ -1,3 +1,2 @@
 export declare const handleProxyResponseErrors: (response: Response) => void;
-export declare const prodEnvErrorMessage = "Forge realtime usage is restricted to Forge apps in a non-production environment. Please see https://developer.atlassian.com/platform/forge/cli-reference/environments/ for reference on Forge app environments.";
 //# 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;AAEF,eAAO,MAAM,mBAAmB,qNACoL,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,yBAAyB,aAAc,QAAQ,KAAG,IAK9D,CAAC"}

package/out/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prodEnvErrorMessage = exports.handleProxyResponseErrors = void 0;
+exports.handleProxyResponseErrors = void 0;
 const api_1 = require("@forge/api");
 const getForgeProxyError = (response) => response.headers.get('forge-proxy-error');
 const handleProxyResponseErrors = (response) => {
@@ -10,4 +10,3 @@ const handleProxyResponseErrors = (response) => {
     }
 };
 exports.handleProxyResponseErrors = handleProxyResponseErrors;
-exports.prodEnvErrorMessage = 'Forge realtime usage is restricted to Forge apps in a non-production environment. Please see https://developer.atlassian.com/platform/forge/cli-reference/environments/ for reference on Forge app environments.';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/realtime",
-  "version": "0.2.3",
+  "version": "0.3.0-experimental-4bd2ca0",
   "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": "6.1.5",
+    "@forge/api": "6.3.0-next.2-experimental-4bd2ca0",
     "@types/node": "20.19.1"
   },
   "publishConfig": {