@forge/bridge 5.17.0 → 5.18.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @forge/bridge
 
+## 5.18.0-next.1
+
+### Patch Changes
+
+- Updated dependencies [8ac7dd3]
+  - @forge/manifest@12.10.0-next.1
+
+## 5.18.0-next.0
+
+### Minor Changes
+
+- b0b69a2: **Experimental — not yet ready for use.** Add a new `frontendCustomMetrics` namespace providing `frontendCustomMetrics.counter(name)` with `incr()` and `incrBy(value)` for emitting frontend custom metrics. `incrBy(value)` rejects if `value <= 0`. The metric name must exactly match a metric registered in the Forge Dev Console.
+
+### Patch Changes
+
+- 561f8f4: Remove "storage" module from "@forge/api"
+- Updated dependencies [814b8fe]
+- Updated dependencies [55c1371]
+- Updated dependencies [1a461c3]
+  - @forge/manifest@12.9.1-next.0
+
 ## 5.17.0
 
 ### Minor Changes

package/out/frontendCustomMetrics/frontendCustomMetrics.d.ts

@@ -0,0 +1,17 @@
+export interface Counter {
+    incr: () => Promise<void>;
+    incrBy: (value: number) => Promise<void>;
+}
+/**
+ * Public namespace for emitting Forge frontend custom metrics from a Forge UI app.
+ *
+ * @example
+ * import { frontendCustomMetrics } from '@forge/bridge';
+ * const c = frontendCustomMetrics.counter('button-click');
+ * c.incr();        // increment by 1
+ * c.incrBy(5);     // increment by 5 (rejects if value <= 0)
+ */
+export declare const frontendCustomMetrics: {
+    counter: (name: string) => Counter;
+};
+//# sourceMappingURL=frontendCustomMetrics.d.ts.map

package/out/frontendCustomMetrics/frontendCustomMetrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontendCustomMetrics.d.ts","sourceRoot":"","sources":["../../src/frontendCustomMetrics/frontendCustomMetrics.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C;AAkDD;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;oBAvBX,MAAM,KAAG,OAAO;CAuBS,CAAC"}

package/out/frontendCustomMetrics/frontendCustomMetrics.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.frontendCustomMetrics = void 0;
+const bridge_1 = require("../bridge");
+const errors_1 = require("../errors");
+const callBridge = (0, bridge_1.getCallBridge)();
+const emit = async (customMetricName, value) => {
+    await callBridge('emitFrontendCustomMetric', {
+        customMetricName,
+        value
+    });
+};
+const MAX_METRIC_NAME_LENGTH = 50;
+// Must start and end with an alphanumeric character and may only contain
+// letters, numbers, dots (.) and hyphens (-) in between.
+const METRIC_NAME_REGEX = /^[a-zA-Z0-9]([a-zA-Z0-9.-]*[a-zA-Z0-9])?$/;
+/**
+ * Validates a custom metric name against the same rules enforced when
+ * registering a metric in the developer console. Throws synchronously so
+ * developer errors fail fast without a wasted bridge round-trip.
+ *
+ * Note: this is a best-effort, client-side convenience check. The metric name
+ * must still match a custom metric registered in the developer console, which
+ * remains the source of truth and is validated by the backend.
+ */
+const validateMetricName = (name) => {
+    if (name.trim().length === 0) {
+        throw new errors_1.BridgeAPIError('Custom metric name cannot be empty');
+    }
+    if (name.length > MAX_METRIC_NAME_LENGTH) {
+        throw new errors_1.BridgeAPIError(`Custom metric name cannot exceed ${MAX_METRIC_NAME_LENGTH} characters`);
+    }
+    if (!METRIC_NAME_REGEX.test(name)) {
+        throw new errors_1.BridgeAPIError('Custom metric name must start and end with alphanumeric characters and can only contain letters, numbers, dots (.), and hyphens (-)');
+    }
+    if (name.includes('..') || name.includes('--')) {
+        throw new errors_1.BridgeAPIError('Custom metric name cannot contain consecutive dots or hyphens');
+    }
+};
+const counter = (name) => {
+    validateMetricName(name);
+    return {
+        incr: () => emit(name, 1),
+        incrBy: (value) => {
+            if (value <= 0) {
+                throw new errors_1.BridgeAPIError('Counter value must be a positive number');
+            }
+            return emit(name, value);
+        }
+    };
+};
+/**
+ * Public namespace for emitting Forge frontend custom metrics from a Forge UI app.
+ *
+ * @example
+ * import { frontendCustomMetrics } from '@forge/bridge';
+ * const c = frontendCustomMetrics.counter('button-click');
+ * c.incr();        // increment by 1
+ * c.incrBy(5);     // increment by 5 (rejects if value <= 0)
+ */
+exports.frontendCustomMetrics = { counter };

package/out/frontendCustomMetrics/index.d.ts

@@ -0,0 +1,2 @@
+export * from './frontendCustomMetrics';
+//# sourceMappingURL=index.d.ts.map

package/out/frontendCustomMetrics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/frontendCustomMetrics/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/out/frontendCustomMetrics/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./frontendCustomMetrics"), exports);

package/out/index.d.ts

@@ -14,4 +14,5 @@ export * from './permissions';
 export * from './object-store';
 export { type FullContext } from './types';
 export * from './featureFlags';
+export * from './frontendCustomMetrics';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}

package/out/index.js

@@ -18,3 +18,4 @@ exports.i18n = tslib_1.__importStar(require("./i18n"));
 tslib_1.__exportStar(require("./permissions"), exports);
 tslib_1.__exportStar(require("./object-store"), exports);
 tslib_1.__exportStar(require("./featureFlags"), exports);
+tslib_1.__exportStar(require("./frontendCustomMetrics"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.17.0",
+  "version": "5.18.0-next.1",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -19,7 +19,7 @@
     "@forge/i18n": "0.0.7",
     "@forge/resolver": "1.8.0",
     "@types/history": "^4.7.11",
-    "@forge/manifest": "12.9.0",
+    "@forge/manifest": "12.10.0-next.1",
     "@types/iframe-resizer": "^3.5.8",
     "iframe-resizer": "^4.4.5"
   },