@forge/realtime 0.1.2-next.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @forge/realtime
 
+## 0.2.0
+
+### Minor Changes
+
+- 8e77d28: Add contextOverrides property to Realtime channel options
+
+### Patch Changes
+
+- 8ef80d7: Add npmignore file
+
+## 0.2.0-next.1
+
+### Minor Changes
+
+- 8e77d28: Add contextOverrides property to Realtime channel options
+
 ## 0.1.2-next.0
 
 ### Patch Changes

package/out/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/productContext.d.ts.map

@@ -0,0 +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,cAAc,GAAG,IAAI,CAAC"}

package/out/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/publish.d.ts

@@ -1,5 +1,7 @@
+import { ProductContext } from './productContext';
 interface PublishOptions {
     token?: string;
+    contextOverrides?: ProductContext[];
 }
 export declare const publish: (channelName: string, eventPayload: string, options?: PublishOptions) => Promise<{
     eventId: null;

package/out/publish.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../src/publish.ts"],"names":[],"mappings":"AAwBA,UAAU,cAAc;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,OAAO,gBAAuB,MAAM,gBAAgB,MAAM,YAAY,cAAc;;;;;;;;EAiEhG,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,gBAAuB,MAAM,gBAAgB,MAAM,YAAY,cAAc;;;;;;;;EA6EhG,CAAC;AAEF,eAAO,MAAM,aAAa,gBAAuB,MAAM,gBAAgB,MAAM,YAAY,cAAc;;;;;;;;EAgEtG,CAAC"}

package/out/publish.js

@@ -7,6 +7,7 @@ const graphqlBody = `mutation publishRealtimeChannel(
   $installationId: ID!
   $name: String!
   $payload: String!
+  $context: String
   $isGlobal: Boolean
   $token: String
 ){
@@ -15,6 +16,7 @@ const graphqlBody = `mutation publishRealtimeChannel(
       installationId: $installationId
       name: $name
       payload: $payload
+      context: $context
       isGlobal: $isGlobal
       token: $token
     ) {
@@ -28,6 +30,15 @@ const publish = async (channelName, eventPayload, options) => {
     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.');
+    }
+    const channelContext = contextOverrides
+        ? JSON.stringify({
+            contextOverrides
+        })
+        : undefined;
     const response = await global.__forge_fetch__({
         type: 'realtime'
     }, '/', {
@@ -37,9 +48,10 @@ const publish = async (channelName, eventPayload, options) => {
             variables: {
                 installationId: appContext.installationId,
                 name: channelName,
+                context: channelContext,
                 payload: eventPayload,
                 isGlobal: false,
-                token: options?.token
+                token: token
             }
         }),
         errors: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/realtime",
-  "version": "0.1.2-next.0",
+  "version": "0.2.0",
   "description": "Forge realtime",
   "main": "out/index.js",
   "types": "out/index.d.ts",