@forge/realtime 0.0.2-next.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @forge/realtime
+
+## 0.0.2-next.0
+
+### Patch Changes
+
+- 6cc16d6: Initial package release.

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Atlassian
+Permission is hereby granted to use this software in accordance with the terms 
+and conditions outlined in the Atlassian Developer Terms, which can be found 
+at the following URL:
+https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
+By using this software, you agree to comply with these terms and conditions. 
+If you do not agree with these terms, you are not permitted to use this software.

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@forge/realtime",
+  "version": "0.0.2-next.0",
+  "description": "Forge realtime",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "author": "Atlassian",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v",
+    "postbuild": "yarn bolt w forge-scripts preserve-deprecated-tags ../forge-realtime"
+  },
+  "devDependencies": {
+    "@forge/api": "6.0.0-next.0",
+    "@forge/util": "^1.4.9",
+    "@types/node": "20.19.0"
+  },
+  "publishConfig": {
+    "registry": "https://packages.atlassian.com/api/npm/npm-public/"
+  }
+}

package/src/__test__/publish.test.ts

@@ -0,0 +1,34 @@
+import * as runtime from '../runtime';
+import { publish } from '../publish';
+import { FORGE_RUNTIME } from './utils';
+
+describe('publish', () => {
+  it('should publish an event', async () => {
+    jest.spyOn(runtime, '__getRuntime').mockReturnValue(FORGE_RUNTIME);
+
+    const mockForgeFetch = jest.fn().mockResolvedValue({
+      text: async () => 'Hello Magic',
+      status: 200,
+      headers: { get: () => undefined }
+    });
+
+    (global as any).__forge_fetch__ = mockForgeFetch;
+
+    const response = await publish('my-channel', 'this is an event payload');
+
+    expect(response.status).toBe(200)
+    expect(mockForgeFetch).toHaveBeenCalledWith(
+      {
+        type: 'realtime'
+      },
+      '/',
+      {
+        method: 'POST',
+        body: '{"query":"mutation publishRealtimeChannel{\\n        ecosystem {\\n          publishRealtimeChannel(\\n            context: \\"{\\\\\\"appId\\\\\\":\\\\\\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\\\\\\",\\\\\\"contextAri\\\\\\":\\\\\\"ari:cloud:jira::site/ffffffff-ffff-ffff-ffff-ffffffffffff\\\\\\"}\\"\\n            installationId: \\"iiiiiiii-iiii-iiii-iiii-iiiiiiiiiiii\\"\\n            name: \\"my-channel\\"\\n            payload: \\"this is an event payload\\"\\n          ) {\\n              eventId,\\n              eventTimestamp\\n          }\\n        }\\n      }"}',
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      }
+    );
+  });
+});

package/src/__test__/runtime.test.ts

@@ -0,0 +1,13 @@
+import { __getRuntime } from '../runtime';
+import { FORGE_RUNTIME } from './utils';
+
+describe('__getRuntime', () => {
+  it('should return the runtime object', async () => {
+    (global as any).__forge_runtime__ = FORGE_RUNTIME;
+
+    const runtime = __getRuntime();
+
+    expect(runtime.appContext.appId).toBe('aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa');
+    expect(runtime.contextAri).toBe('ari:cloud:jira::site/ffffffff-ffff-ffff-ffff-ffffffffffff');
+  });
+});

package/src/__test__/utils.ts

@@ -0,0 +1,31 @@
+import type { ForgeRuntime } from '@forge/api';
+import { NoMetrics } from '@forge/util/packages/metrics-interface';
+
+export const FORGE_RUNTIME: ForgeRuntime = {
+  container: { runtime: 'node', region: 'us-west-2' },
+  proxy: { url: 'https://foo', token: 'token' },
+  contextAri: 'ari:cloud:jira::site/ffffffff-ffff-ffff-ffff-ffffffffffff',
+  appContext: {
+    appId: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa',
+    environmentId: 'eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee',
+    environmentType: 'DEVELOPMENT',
+    invocationId: '33333',
+    installationId: 'iiiiiiii-iiii-iiii-iiii-iiiiiiiiiiii',
+    appVersion: '1.2.3',
+    functionKey: 'functionKey',
+    moduleType: 'moduleType',
+    moduleKey: 'moduleKey',
+    license: { isActive: true }
+  },
+  tracing: {
+    traceId: 'traceId',
+    spanId: 'spanId'
+  },
+  allowedEgress: [],
+  lambdaContext: {
+    awsRequestId: '123',
+    getRemainingTimeInMillis: jest.fn()
+  },
+  metrics: new NoMetrics(),
+  featureFlags: jest.fn()
+};

package/src/index.ts

@@ -0,0 +1 @@
+export { publish } from './publish';

package/src/publish.ts

@@ -0,0 +1,36 @@
+import { __getRuntime } from './runtime';
+
+export const publish = async (channelName: string, eventPayload: string) => {
+  const { contextAri, appContext } = __getRuntime();
+
+  // Do not change the whitespace of the context object it has to be this exactly to match https://bitbucket.org/atlassian/app-client-events-service/src/master/
+  const graphqlBody = JSON.stringify({
+    query: `mutation publishRealtimeChannel{
+        ecosystem {
+          publishRealtimeChannel(
+            context: "{\\"appId\\":\\"${appContext.appId}\\",\\"contextAri\\":\\"${contextAri}\\"}"
+            installationId: "${appContext.installationId}"
+            name: "${channelName}"
+            payload: "${eventPayload}"
+          ) {
+              eventId,
+              eventTimestamp
+          }
+        }
+      }`
+  });
+
+  return await (global as any).__forge_fetch__(
+    {
+      type: 'realtime'
+    },
+    '/',
+    {
+      method: 'POST',
+      body: graphqlBody,
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    }
+  );
+};

package/src/runtime.ts

@@ -0,0 +1,9 @@
+import type { ForgeRuntime } from '@forge/api';
+
+export function __getRuntime(): ForgeRuntime {
+  const runtime = (global as any).__forge_runtime__;
+  if (!runtime) {
+    throw new Error('Forge runtime not found.');
+  }
+  return runtime as ForgeRuntime;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig-base.json",
+  "compilerOptions": {
+    "lib": [
+      "es2017",
+      "DOM"
+    ],
+    "outDir": "./out",
+    "rootDir": "src",
+    "composite": true,
+    "moduleResolution": "node"
+  },
+  "references": [
+    {
+      "path": "../forge-api"
+    }
+  ]
+}