@forge/teamwork-graph 5.2.1-next.0-experimental-13c2f8d → 5.3.0-next.1

package/CHANGELOG.md

@@ -1,10 +1,10 @@
 # @forge/teamwork-graph
 
-## 5.2.1-next.0-experimental-13c2f8d
+## 5.3.0-next.1
 
-### Patch Changes
+### Minor Changes
 
-- @forge/api@8.1.1-next.0-experimental-13c2f8d
+- 4138007: Export response types for Forge connector connection validation, including predefined administrator-fixable reason codes.
 
 ## 5.2.1-next.0
 

package/README.md

@@ -446,6 +446,30 @@ import type {
 } from '@forge/teamwork-graph';
 ```
 
+### Connection Validation Response
+
+Forge connectors can use the exported response type for their `validateConnection` function:
+
+```typescript
+import { types } from '@forge/teamwork-graph';
+
+const response: types.ValidateConnectionResponse = {
+  success: false,
+  reasonCode: types.CONNECTION_VALIDATION_REASON_CODES.INVALID_CREDENTIALS,
+  message: 'Connection validation failed'
+};
+```
+
+The supported administrator-fixable reason codes are:
+
+- `INVALID_CREDENTIALS`
+- `INSUFFICIENT_PERMISSIONS`
+- `INVALID_CONFIGURATION`
+
+Use `success: false` for deterministic authentication, permission, or configuration problems. Throw transient
+provider, network, or rate-limit errors instead. The `reasonCode` field is optional, so existing
+`{ success, message }` responses remain valid.
+
 ## Configuration
 
 The SDK automatically handles authentication and configuration through the Forge platform. No additional setup is required.

package/out/types/connection-validation.d.ts

@@ -0,0 +1,15 @@
+export declare const CONNECTION_VALIDATION_REASON_CODES: {
+    readonly INVALID_CREDENTIALS: "INVALID_CREDENTIALS";
+    readonly INSUFFICIENT_PERMISSIONS: "INSUFFICIENT_PERMISSIONS";
+    readonly INVALID_CONFIGURATION: "INVALID_CONFIGURATION";
+};
+export type ConnectionValidationReasonCode = (typeof CONNECTION_VALIDATION_REASON_CODES)[keyof typeof CONNECTION_VALIDATION_REASON_CODES];
+export type ValidateConnectionResponse = {
+    success: true;
+    message?: string;
+} | {
+    success: false;
+    reasonCode?: ConnectionValidationReasonCode;
+    message?: string;
+};
+//# sourceMappingURL=connection-validation.d.ts.map

package/out/types/connection-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection-validation.d.ts","sourceRoot":"","sources":["../../src/types/connection-validation.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,kCAAkC;;;;CAIrC,CAAC;AAEX,MAAM,MAAM,8BAA8B,GACxC,CAAC,OAAO,kCAAkC,CAAC,CAAC,MAAM,OAAO,kCAAkC,CAAC,CAAC;AAU/F,MAAM,MAAM,0BAA0B,GAClC;IACE,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,OAAO,EAAE,KAAK,CAAC;IACf,UAAU,CAAC,EAAE,8BAA8B,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/out/types/connection-validation.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONNECTION_VALIDATION_REASON_CODES = void 0;
+exports.CONNECTION_VALIDATION_REASON_CODES = {
+    INVALID_CREDENTIALS: 'INVALID_CREDENTIALS',
+    INSUFFICIENT_PERMISSIONS: 'INSUFFICIENT_PERMISSIONS',
+    INVALID_CONFIGURATION: 'INVALID_CONFIGURATION'
+};

package/out/types/index.d.ts

@@ -5,5 +5,6 @@ export * from './users';
 export * from './groups';
 export * from './relationships';
 export * from './orchestration';
+export * from './connection-validation';
 export * from './graph';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC;AAGjC,cAAc,WAAW,CAAC;AAG1B,cAAc,YAAY,CAAC;AAG3B,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC;AAGzB,cAAc,iBAAiB,CAAC;AAGhC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC;AAGjC,cAAc,WAAW,CAAC;AAG1B,cAAc,YAAY,CAAC;AAG3B,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC;AAGzB,cAAc,iBAAiB,CAAC;AAGhC,cAAc,iBAAiB,CAAC;AAGhC,cAAc,yBAAyB,CAAC;AAExC,cAAc,SAAS,CAAC"}

package/out/types/index.js

@@ -8,4 +8,5 @@ tslib_1.__exportStar(require("./users"), exports);
 tslib_1.__exportStar(require("./groups"), exports);
 tslib_1.__exportStar(require("./relationships"), exports);
 tslib_1.__exportStar(require("./orchestration"), exports);
+tslib_1.__exportStar(require("./connection-validation"), exports);
 tslib_1.__exportStar(require("./graph"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/teamwork-graph",
-  "version": "5.2.1-next.0-experimental-13c2f8d",
+  "version": "5.3.0-next.1",
   "description": "Forge TeamworkGraph SDK",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -20,7 +20,7 @@
     "typescript": "5.9.2"
   },
   "dependencies": {
-    "@forge/api": "^8.1.1-next.0-experimental-13c2f8d"
+    "@forge/api": "^8.1.1-next.0"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"