@forge/teamwork-graph 5.3.3-next.0-experimental-65945d2 → 5.4.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,11 +1,10 @@
1
1
  # @forge/teamwork-graph
2
2
 
3
- ## 5.3.3-next.0-experimental-65945d2
3
+ ## 5.4.0-next.1
4
4
 
5
- ### Patch Changes
5
+ ### Minor Changes
6
6
 
7
- - Updated dependencies [e865360]
8
- - @forge/api@8.4.1-next.1-experimental-65945d2
7
+ - e89e40b: Expose native Atlassian USER permissions through atlassianAccountId and document its mutual exclusivity with external id.
9
8
 
10
9
  ## 5.3.3-next.0
11
10
 
package/README.md CHANGED
@@ -29,9 +29,7 @@ const document: DocumentObject = {
29
29
  accessControls: [
30
30
  {
31
31
  principals: [
32
- {
33
- { type: 'USER', id: 'user-123' }
34
- }
32
+ { type: 'USER', id: 'user-123' }
35
33
  ]
36
34
  }
37
35
  ]
@@ -63,6 +61,24 @@ if (result.success) {
63
61
  }
64
62
  ```
65
63
 
64
+ ### User permissions
65
+
66
+ For a native Atlassian user, use their Atlassian account ID and omit `id`:
67
+
68
+ ```typescript
69
+ import { types } from '@forge/teamwork-graph';
70
+
71
+ const permissions: types.Permissions = {
72
+ accessControls: [{ principals: [{ type: 'USER', atlassianAccountId: 'account-123' }] }]
73
+ };
74
+ ```
75
+
76
+ For an external provider user, keep using `{ type: 'USER', id: 'external-user-123' }`
77
+ and the existing user mapping APIs. A `USER` principal requires exactly one non-empty
78
+ identifier: `id` or `atlassianAccountId`, never both. `atlassianAccountId` is only
79
+ supported for `USER`. Native user ACLs do not require an external user mapping;
80
+ normal connection, ingestion and read authorization checks still apply.
81
+
66
82
  ## Core Operations
67
83
 
68
84
  ### Object Management
@@ -114,6 +114,33 @@ describe('TeamWorkGraphClient - setObjects', () => {
114
114
  expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.BULK), expect.objectContaining({ method: 'POST' }));
115
115
  expect(result).toEqual(expected);
116
116
  });
117
+ it.each([
118
+ { type: 'USER', atlassianAccountId: 'native-account-123' },
119
+ { type: 'USER', id: 'external-user-123' }
120
+ ])('retains the USER principal %j in the Forge HTTP body', async (principal) => {
121
+ const permissions = { accessControls: [{ principals: [principal] }] };
122
+ const document = {
123
+ schemaVersion: '1.0',
124
+ id: 'acl-document',
125
+ displayName: 'ACL document',
126
+ updateSequenceNumber: 1,
127
+ url: 'https://example.com/acl-document',
128
+ createdAt: '2026-11-03T00:00:00Z',
129
+ lastUpdatedAt: '2026-11-03T00:00:00Z',
130
+ permissions,
131
+ 'atlassian:document': { type: { category: 'DOCUMENT' }, content: { mimeType: 'text/plain', text: 'ACL fixture' } }
132
+ };
133
+ mockFetch.mockResolvedValueOnce({ ok: true, json: async () => ({ accepted: [] }) });
134
+ await graphClient.setObjects({ objects: [document], connectionId: TEST_CONNECTION_ID });
135
+ expect(api_1.__fetchProduct).toHaveBeenCalledWith({ provider: 'app', remote: 'stargate', type: 'fpp' });
136
+ expect(mockFetch).toHaveBeenCalledWith((0, endpoints_1.getFullPath)(endpoints_1.ENDPOINTS.OBJECTS.BULK), expect.objectContaining({
137
+ method: 'POST',
138
+ headers: expect.objectContaining({ 'Atl-Connection-Id': TEST_CONNECTION_ID }),
139
+ body: JSON.stringify({ entities: [document] })
140
+ }));
141
+ const body = JSON.parse(mockFetch.mock.calls[0][1].body);
142
+ expect(body.entities[0].permissions.accessControls[0].principals).toEqual([principal]);
143
+ });
117
144
  it('posts message entities to /api/v1/entities/bulk and returns response', async () => {
118
145
  const messageObject = {
119
146
  schemaVersion: '2.0',
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=principal-types.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"principal-types.test.d.ts","sourceRoot":"","sources":["../../src/__test__/principal-types.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const expect_type_1 = require("expect-type");
4
+ describe('Principal contract', () => {
5
+ it('accepts native Atlassian users and existing external principals', () => {
6
+ (0, expect_type_1.expectTypeOf)().toMatchTypeOf();
7
+ (0, expect_type_1.expectTypeOf)().toMatchTypeOf();
8
+ (0, expect_type_1.expectTypeOf)().toMatchTypeOf();
9
+ (0, expect_type_1.expectTypeOf)().toMatchTypeOf();
10
+ (0, expect_type_1.expectTypeOf)().toMatchTypeOf();
11
+ });
12
+ it('rejects non-string identity values', () => {
13
+ (0, expect_type_1.expectTypeOf)().not.toMatchTypeOf();
14
+ (0, expect_type_1.expectTypeOf)().not.toMatchTypeOf();
15
+ (0, expect_type_1.expectTypeOf)().not.toMatchTypeOf();
16
+ });
17
+ });
@@ -5,6 +5,7 @@ export type Action = 'READ' | 'SEARCH';
5
5
  export type Principal = {
6
6
  type: 'USER' | 'GROUP' | 'EVERYONE' | 'ATLASSIAN_WORKSPACE' | 'CONTAINER';
7
7
  id?: string | null;
8
+ atlassianAccountId?: string | null;
8
9
  };
9
10
  export type AccessControl = {
10
11
  principals: Principal[];
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/types/objects/common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvC,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,qBAAqB,GAAG,WAAW,CAAC;IAC1E,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAGF,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;IAClC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,YAAY,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC3C,WAAW,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;IACzC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,GAAG,QAAQ,EAAE,CAAC;AAEnG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,QAAQ,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,iBAAiB,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnH,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,8BAA8B,CAAC;IAClD,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/types/objects/common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvC,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,qBAAqB,GAAG,WAAW,CAAC;IAC1E,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAGF,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;IAClC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,YAAY,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC3C,WAAW,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC;IACzC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,GAAG,QAAQ,EAAE,CAAC;AAEnG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,QAAQ,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,iBAAiB,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnH,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,8BAA8B,CAAC;IAClD,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/teamwork-graph",
3
- "version": "5.3.3-next.0-experimental-65945d2",
3
+ "version": "5.4.0-next.1",
4
4
  "description": "Forge TeamworkGraph SDK",
5
5
  "author": "Atlassian",
6
6
  "license": "UNLICENSED",
@@ -20,7 +20,7 @@
20
20
  "typescript": "5.9.2"
21
21
  },
22
22
  "dependencies": {
23
- "@forge/api": "^8.4.1-next.1-experimental-65945d2"
23
+ "@forge/api": "^8.4.1-next.0"
24
24
  },
25
25
  "publishConfig": {
26
26
  "registry": "https://packages.atlassian.com/api/npm/npm-public/"