@forge/teamwork-graph 0.1.0-next.0

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/README.md

@@ -0,0 +1,198 @@
+# Forge Graph Client
+
+A client for interacting with the Forge Graph API.
+
+## Installation
+
+```bash
+npm install @forge/teamwork-graph
+```
+
+## Usage Examples
+
+### Document Entity
+
+```typescript
+import { graph } from '@forge/teamwork-graph';
+import type { EntityPayload, DocumentCategory } from '@forge/teamwork-graph';
+
+const documentPayload: EntityPayload = {
+  // Required base fields
+  schemaVersion: '1.0',
+  id: 'doc-123',
+  updateSequenceNumber: Date.now(),
+  displayName: 'Project Requirements Doc',
+  url: 'https://example.com/docs/requirements',
+  
+  // Optional base fields
+  description: 'Project requirements and specifications',
+  createdAt: new Date().toISOString(),
+  createdBy: {
+    accountId: 'acc-123',
+    email: 'creator@example.com'
+  },
+  lastUpdatedAt: new Date().toISOString(),
+  lastUpdatedBy: {
+    accountId: 'acc-456',
+    email: 'updater@example.com'
+  },
+
+  // Document ownership
+  owners: [
+    {
+      accountId: 'acc-123',
+      email: 'owner@example.com'
+    }
+  ],
+
+  // Document preview
+  thumbnail: {
+    externalUrl: 'https://example.com/thumbnail.png'
+  },
+
+  // Hierarchical relationships
+  parentKey: {
+    type: 'atlassian:document',
+    value: {
+      entityId: 'parent-folder-id'
+    }
+  },
+  containerKey: {
+    type: 'atlassian:space',
+    value: {
+      entityId: 'space-123'
+    }
+  },
+
+  // Access control
+  permissions: {
+    accessControls: [
+      {
+        principals: [
+          { type: 'USER', id: 'user-123' },
+          { type: 'GROUP', id: 'group-456' },
+          { type: 'EVERYONE' }
+        ]
+      }
+    ],
+    smartLinkViewedBy: [
+      {
+        principalUser: {
+          type: 'USER',
+          id: 'user-789'
+        }
+      }
+    ]
+  },
+
+  // Relationships
+  associations: {
+    set: [
+      {
+        associationType: 'issueIdOrKeys',
+        values: ['PROJ-123', 'PROJ-456']
+      }
+    ]
+  },
+
+  // Document-specific attributes
+  'atlassian:document': {
+    type: {
+      category: 'document',
+      mimeType: 'text/plain',
+      iconUrl: 'https://example.com/icon.png',
+      fileExtension: 'txt'
+    },
+    content: {
+      mimeType: 'text/plain',
+      text: 'Document content...',
+      // binary: 'base64EncodedContent...' // Alternative to text
+    },
+    byteSize: 1234,
+    exportLinks: [
+      {
+        mimeType: 'application/pdf',
+        url: 'https://example.com/export/pdf'
+      }
+    ],
+    collaborators: [
+      { email: 'collaborator1@example.com' },
+      { email: 'collaborator2@example.com' }
+    ]
+  }
+};
+
+// Send the document to the API
+await graph.setEntity(documentPayload);
+```
+
+### Delete Operations
+
+```typescript
+// Delete an entity
+await graph.deleteEntity('entity-123', {
+  target: 'TargetContainer',
+  token: 'auth-token'
+});
+
+// Delete a user
+await graph.deleteUser('user-123');
+
+// Delete a group
+await graph.deleteGroup('group-123');
+```
+
+## Error Handling
+
+The client throws `ForgeGraphAPIError` for API errors. Error types include:
+
+```typescript
+import { errorCodes } from '@forge/teamwork-graph';
+
+// Available error codes
+errorCodes.INVALID_REQUEST_BODY   // 400 Bad Request
+errorCodes.INSUFFICIENT_SCOPE     // 403 Forbidden
+errorCodes.TOO_MANY_REQUESTS      // 429 Rate Limit
+errorCodes.UNKNOWN_ERROR          // Other errors
+
+try {
+  await graph.setEntity(/* ... */);
+} catch (error) {
+  if (error instanceof ForgeGraphAPIError) {
+    console.error(error.code, error.message);
+  }
+}
+```
+
+## Available Types
+
+```typescript
+import type {
+  // Entity-related
+  EntityPayload,
+  DocumentAttributes,
+  DocumentCategory,
+  DocumentType,
+  DocumentContent,
+  ExportLink,
+
+  // User and Group
+  UserObject,
+  GroupPayload,
+
+  // Common types
+  Permissions,
+  AccessControl,
+  Principal,
+  Thumbnail,
+  
+  // Relationships
+  ParentKeyObject,
+  ContainerKeyObject,
+  Associations,
+  AssociationObject,
+  
+  // Operations
+  DeleteContext
+} from '@forge/teamwork-graph';
+```

package/out/__test__/error-handling.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=error-handling.test.d.ts.map

package/out/__test__/error-handling.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handling.test.d.ts","sourceRoot":"","sources":["../../src/__test__/error-handling.test.ts"],"names":[],"mappings":""}

package/out/__test__/error-handling.test.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fetch_1 = require("node-fetch");
+const error_handling_1 = require("../error-handling");
+const errors_1 = require("../utils/errors");
+describe('checkResponseError in @forge/teamwork-graph', () => {
+    const traceId = 'trace-id';
+    describe('when response has JSON body', () => {
+        const baseErrorShape = {
+            responseDetails: {
+                status: 400,
+                statusText: 'Bad Request',
+                traceId
+            }
+        };
+        it('should use provided code and message', async () => {
+            const mockResponse = new node_fetch_1.Response(JSON.stringify({ code: 'CUSTOM_ERROR', message: 'Custom error message' }), {
+                status: 400,
+                statusText: 'Bad Request',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse)).rejects.toMatchObject({
+                ...baseErrorShape,
+                code: 'CUSTOM_ERROR',
+                message: 'Custom error message'
+            });
+        });
+        it('should use status-based code when no code provided', async () => {
+            const mockResponse = new node_fetch_1.Response(JSON.stringify({ message: 'Error message' }), {
+                status: 400,
+                statusText: 'Bad Request',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse)).rejects.toMatchObject({
+                ...baseErrorShape,
+                code: errors_1.errorCodes.INVALID_REQUEST_BODY,
+                message: 'Error message'
+            });
+        });
+        it('should use default message when no message provided', async () => {
+            const mockResponse = new node_fetch_1.Response(JSON.stringify({ code: 'CUSTOM_ERROR' }), {
+                status: 400,
+                statusText: 'Bad Request',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse, 'Default message')).rejects.toMatchObject({
+                ...baseErrorShape,
+                code: 'CUSTOM_ERROR',
+                message: 'Default message'
+            });
+        });
+        it('should include context if provided', async () => {
+            const mockResponse = new node_fetch_1.Response(JSON.stringify({
+                code: 'CUSTOM_ERROR',
+                message: 'Error message',
+                context: { details: 'Additional info' }
+            }), {
+                status: 400,
+                statusText: 'Bad Request',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse)).rejects.toMatchObject({
+                ...baseErrorShape,
+                code: 'CUSTOM_ERROR',
+                message: 'Error message',
+                context: { details: 'Additional info' }
+            });
+        });
+    });
+    describe('when response has invalid or no body', () => {
+        const serverErrorShape = {
+            responseDetails: {
+                status: 500,
+                statusText: 'Internal Server Error',
+                traceId
+            }
+        };
+        it('should handle invalid JSON', async () => {
+            const mockResponse = new node_fetch_1.Response('Invalid JSON', {
+                status: 500,
+                statusText: 'Internal Server Error',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse, 'Default message')).rejects.toMatchObject({
+                ...serverErrorShape,
+                code: errors_1.errorCodes.UNKNOWN_ERROR,
+                message: 'Default message',
+                context: { responseText: 'Invalid JSON' }
+            });
+        });
+        it('should handle empty response', async () => {
+            const mockResponse = new node_fetch_1.Response('', {
+                status: 500,
+                statusText: 'Internal Server Error',
+                headers: { 'x-trace-id': traceId }
+            });
+            await expect((0, error_handling_1.handleResponseError)(mockResponse)).rejects.toMatchObject({
+                ...serverErrorShape,
+                code: errors_1.errorCodes.UNKNOWN_ERROR,
+                message: 'Failed to parse error response',
+                context: { responseText: '' }
+            });
+        });
+    });
+});

package/out/__test__/graph.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=graph.test.d.ts.map

package/out/__test__/graph.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.test.d.ts","sourceRoot":"","sources":["../../src/__test__/graph.test.ts"],"names":[],"mappings":""}

package/out/__test__/graph.test.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("@forge/api");
+const graph_1 = require("../graph");
+const errors_1 = require("../utils/errors");
+jest.mock('@forge/api');
+describe('Teamwork Graph Client', () => {
+    let graphClient;
+    let mockFetch;
+    beforeEach(() => {
+        graphClient = new graph_1.TeamWorkGraphClient();
+        mockFetch = jest.fn();
+        api_1.__fetchProduct.mockReturnValue(mockFetch);
+        jest.clearAllMocks();
+    });
+    describe('setEntity', () => {
+        const entityPayload = {
+            id: 'test-entity-123',
+            type: 'test-type',
+            schemaVersion: '1',
+            updateSequenceNumber: 1,
+            displayName: 'Test Entity',
+            url: 'https://example.com/entity/123',
+            createdAt: new Date().toISOString(),
+            properties: { name: 'Test Entity' }
+        };
+        it('should successfully post entity data', async () => {
+            const expectedResponse = { success: true, entity: entityPayload };
+            mockFetch.mockResolvedValueOnce({
+                ok: true,
+                json: () => Promise.resolve(expectedResponse)
+            });
+            const result = await graphClient.setEntity(entityPayload);
+            expect(mockFetch).toHaveBeenCalledWith('/graph/connector/api/v1/entity', {
+                method: 'POST',
+                body: JSON.stringify(entityPayload),
+                redirect: 'follow',
+                headers: { 'Content-Type': 'application/json' }
+            });
+            expect(result).toEqual(expectedResponse);
+        });
+        it('should throw ForgeGraphAPIError when request fails', async () => {
+            const errorResponse = {
+                ok: false,
+                status: 400,
+                statusText: 'Bad Request',
+                headers: {
+                    get: () => null
+                },
+                text: () => Promise.resolve(JSON.stringify({
+                    code: errors_1.errorCodes.INVALID_REQUEST_BODY,
+                    message: 'Invalid entity payload'
+                }))
+            };
+            mockFetch.mockResolvedValueOnce(errorResponse);
+            await expect(graphClient.setEntity(entityPayload)).rejects.toThrow(errors_1.ForgeGraphAPIError);
+        });
+    });
+});

package/out/error-handling.d.ts

@@ -0,0 +1,3 @@
+import { APIResponse } from '@forge/api';
+export declare function handleResponseError(response: APIResponse, defaultMessage?: string): Promise<void>;
+//# sourceMappingURL=error-handling.d.ts.map

package/out/error-handling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../src/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAUzC,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAwBvG"}

package/out/error-handling.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleResponseError = void 0;
+const errors_1 = require("./utils/errors");
+async function handleResponseError(response, defaultMessage) {
+    const details = {
+        status: response.status,
+        statusText: response.statusText,
+        traceId: response.headers.get('x-b3-traceid') || response.headers.get('x-trace-id')
+    };
+    const responseText = await response.text();
+    try {
+        const body = JSON.parse(responseText);
+        const code = body.code || getErrorCodeFromStatus(response.status);
+        const message = body.message || defaultMessage || 'Unknown error occurred';
+        throw new errors_1.ForgeGraphAPIError(details, code, message, body.context);
+    }
+    catch (error) {
+        if (error instanceof errors_1.ForgeGraphAPIError)
+            throw error;
+        throw new errors_1.ForgeGraphAPIError(details, errors_1.errorCodes.UNKNOWN_ERROR, defaultMessage || 'Failed to parse error response', { responseText });
+    }
+}
+exports.handleResponseError = handleResponseError;
+function getErrorCodeFromStatus(status) {
+    switch (status) {
+        case 400:
+            return errors_1.errorCodes.INVALID_REQUEST_BODY;
+        case 403:
+            return errors_1.errorCodes.INSUFFICIENT_SCOPE;
+        case 429:
+            return errors_1.errorCodes.TOO_MANY_REQUESTS;
+        default:
+            return errors_1.errorCodes.UNKNOWN_ERROR;
+    }
+}

package/out/graph.d.ts

@@ -0,0 +1,15 @@
+import { Result } from '@forge/api';
+import { EntityPayload, UserObject, GroupObject, DeleteContext, TeamWorkGraph } from './utils/types';
+export declare class TeamWorkGraphClient implements TeamWorkGraph {
+    setEntity: (entity: EntityPayload) => Promise<Result>;
+    deleteEntity: (entityId: string, context: DeleteContext) => Promise<Result>;
+    setUser: (user: UserObject) => Promise<Result>;
+    deleteUser: (userId: string) => Promise<Result>;
+    setGroup: (group: GroupObject) => Promise<Result>;
+    deleteGroup: (groupId: string) => Promise<Result>;
+    private sendPostRequest;
+    private sendDeleteRequest;
+    private sendRequest;
+}
+export declare const teamworkgraph: TeamWorkGraphClient;
+//# sourceMappingURL=graph.d.ts.map

package/out/graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph.d.ts","sourceRoot":"","sources":["../src/graph.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,MAAM,EAAe,MAAM,YAAY,CAAC;AAE9E,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGrG,qBAAa,mBAAoB,YAAW,aAAa;IACvD,SAAS,WAAkB,aAAa,KAAG,QAAQ,MAAM,CAAC,CAExD;IAEF,YAAY,aAAoB,MAAM,WAAW,aAAa,KAAG,QAAQ,MAAM,CAAC,CAE9E;IAEF,OAAO,SAAgB,UAAU,KAAG,QAAQ,MAAM,CAAC,CAEjD;IAEF,UAAU,WAAkB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAElD;IAEF,QAAQ,UAAiB,WAAW,KAAG,QAAQ,MAAM,CAAC,CAEpD;IAEF,WAAW,YAAmB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAEpD;YAEY,eAAe;YAaf,iBAAiB;YAajB,WAAW;CAY1B;AAED,eAAO,MAAM,aAAa,qBAA4B,CAAC"}

package/out/graph.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.teamworkgraph = exports.TeamWorkGraphClient = void 0;
+const api_1 = require("@forge/api");
+const error_handling_1 = require("./error-handling");
+const starGateBase = '/graph/connector';
+class TeamWorkGraphClient {
+    setEntity = async (entity) => {
+        return this.sendPostRequest('/api/v1/entity', entity);
+    };
+    deleteEntity = async (entityId, context) => {
+        return this.sendDeleteRequest('/api/v1/entity', { id: entityId, context });
+    };
+    setUser = async (user) => {
+        return this.sendPostRequest('/api/v1/user', user);
+    };
+    deleteUser = async (userId) => {
+        return this.sendDeleteRequest('/api/v1/user', { id: userId });
+    };
+    setGroup = async (group) => {
+        return this.sendPostRequest('/api/v1/group', group);
+    };
+    deleteGroup = async (groupId) => {
+        return this.sendDeleteRequest('/api/v1/group', { id: groupId });
+    };
+    async sendPostRequest(path, body) {
+        const response = await this.sendRequest(path, {
+            method: 'POST',
+            body: JSON.stringify(body)
+        });
+        if (!response.ok) {
+            await (0, error_handling_1.handleResponseError)(response, `Error posting to ${path}`);
+        }
+        return response.json();
+    }
+    async sendDeleteRequest(path, body) {
+        const response = await this.sendRequest(path, {
+            method: 'DELETE',
+            body: JSON.stringify(body)
+        });
+        if (!response.ok) {
+            await (0, error_handling_1.handleResponseError)(response, `Error deleting from ${path}`);
+        }
+        return response.json();
+    }
+    async sendRequest(path, options) {
+        const reqPath = starGateBase + path;
+        const response = await (0, api_1.__fetchProduct)({ provider: 'app', remote: 'stargate' })(reqPath, {
+            ...options,
+            redirect: 'follow',
+            headers: {
+                ...options?.headers,
+                'Content-Type': 'application/json'
+            }
+        });
+        return response;
+    }
+}
+exports.TeamWorkGraphClient = TeamWorkGraphClient;
+exports.teamworkgraph = new TeamWorkGraphClient();

package/out/index.d.ts

@@ -0,0 +1,5 @@
+import { teamworkgraph } from './graph';
+import { errorCodes, ForgeGraphAPIError } from './utils/errors';
+export { errorCodes, teamworkgraph as graph, ForgeGraphAPIError };
+export default teamworkgraph;
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,aAAa,IAAI,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAElE,eAAe,aAAa,CAAC"}

package/out/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeGraphAPIError = exports.graph = exports.errorCodes = void 0;
+const graph_1 = require("./graph");
+Object.defineProperty(exports, "graph", { enumerable: true, get: function () { return graph_1.teamworkgraph; } });
+const errors_1 = require("./utils/errors");
+Object.defineProperty(exports, "errorCodes", { enumerable: true, get: function () { return errors_1.errorCodes; } });
+Object.defineProperty(exports, "ForgeGraphAPIError", { enumerable: true, get: function () { return errors_1.ForgeGraphAPIError; } });
+exports.default = graph_1.teamworkgraph;

package/out/utils/errors.d.ts

@@ -0,0 +1,18 @@
+export declare const errorCodes: {
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+    readonly INVALID_REQUEST_BODY: "INVALID_REQUEST_BODY";
+    readonly INSUFFICIENT_SCOPE: "INSUFFICIENT_SCOPE";
+    readonly TOO_MANY_REQUESTS: "TOO_MANY_REQUESTS";
+};
+export interface APIErrorResponseDetails {
+    status: number;
+    statusText: string;
+    traceId?: string | null;
+}
+export declare class ForgeGraphAPIError extends Error {
+    readonly responseDetails: APIErrorResponseDetails;
+    readonly code: string;
+    readonly context?: Record<string, unknown> | undefined;
+    constructor(responseDetails: APIErrorResponseDetails, code: string, message: string, context?: Record<string, unknown> | undefined);
+}
+//# sourceMappingURL=errors.d.ts.map

package/out/utils/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;;CAKb,CAAC;AASX,MAAM,WAAW,uBAAuB;IAEtC,MAAM,EAAE,MAAM,CAAC;IAGf,UAAU,EAAE,MAAM,CAAC;IAGnB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAMD,qBAAa,kBAAmB,SAAQ,KAAK;aAEzB,eAAe,EAAE,uBAAuB;aACxC,IAAI,EAAE,MAAM;aAEZ,OAAO,CAAC;gBAHR,eAAe,EAAE,uBAAuB,EACxC,IAAI,EAAE,MAAM,EAC5B,OAAO,EAAE,MAAM,EACC,OAAO,CAAC,qCAAyB;CAKpD"}

package/out/utils/errors.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeGraphAPIError = exports.errorCodes = void 0;
+exports.errorCodes = {
+    UNKNOWN_ERROR: 'UNKNOWN_ERROR',
+    INVALID_REQUEST_BODY: 'INVALID_REQUEST_BODY',
+    INSUFFICIENT_SCOPE: 'INSUFFICIENT_SCOPE',
+    TOO_MANY_REQUESTS: 'TOO_MANY_REQUESTS'
+};
+class ForgeGraphAPIError extends Error {
+    responseDetails;
+    code;
+    context;
+    constructor(responseDetails, code, message, context) {
+        super(message);
+        this.responseDetails = responseDetails;
+        this.code = code;
+        this.context = context;
+        this.name = 'ForgeGraphAPIError';
+    }
+}
+exports.ForgeGraphAPIError = ForgeGraphAPIError;

package/out/utils/types.d.ts

@@ -0,0 +1,110 @@
+import { Result } from '@forge/api';
+export declare type UserObject = {
+    accountId?: string;
+    id?: string;
+    email: string;
+    externalId?: string;
+};
+export declare type Thumbnail = {
+    externalUrl: string;
+};
+export declare type Principal = {
+    type: 'USER' | 'GROUP' | 'EVERYONE' | 'ATLASSIAN_WORKSPACE' | 'CONTAINER';
+    id?: string | null;
+};
+export declare type AccessControl = {
+    principals: Principal[];
+};
+export declare type SmartLinkViewedByUser = {
+    principalUser: Principal;
+};
+export declare type Permissions = {
+    accessControls?: AccessControl[];
+    smartLinkViewedBy?: SmartLinkViewedByUser[];
+};
+export declare type DocumentCategory = 'folder' | 'document' | 'presentation' | 'spreadsheet' | 'image' | 'audio' | 'video' | 'pdf' | 'shortcut' | 'code' | 'archive' | 'form' | 'web-page' | 'other';
+export declare type DocumentType = {
+    category?: DocumentCategory;
+    mimeType?: string;
+    iconUrl?: string;
+    fileExtension?: string;
+};
+export declare type DocumentContent = {
+    mimeType?: string;
+    text?: string;
+    binary?: string;
+};
+export declare type ExportLink = {
+    mimeType: string;
+    url: string;
+};
+export declare type DocumentAttributes = {
+    collaborators?: Partial<UserObject>[];
+    type: DocumentType;
+    content: DocumentContent;
+    byteSize?: number;
+    exportLinks?: ExportLink[];
+};
+export declare type ContainerKeyObject = {
+    type: string;
+    value: {
+        entityId: string;
+    };
+};
+export declare type ParentKeyObject = {
+    type: string;
+    value: {
+        entityId: string;
+    };
+};
+export declare type EntityPayload = {
+    schemaVersion: string;
+    id: string;
+    updateSequenceNumber: number;
+    displayName: string;
+    description?: string;
+    url: string;
+    createdAt: string;
+    createdBy?: Partial<UserObject>;
+    lastUpdatedAt?: string;
+    lastUpdatedBy?: Partial<UserObject>;
+    owners?: Partial<UserObject>[];
+    thumbnail?: Thumbnail;
+    parentKey?: ParentKeyObject | string;
+    containerKey?: ContainerKeyObject | string;
+    permissions?: Permissions;
+    associations?: Associations;
+    'atlassian:document'?: DocumentAttributes;
+};
+export declare type GroupObject = {
+    id?: string;
+    email?: string;
+    name?: string;
+    description?: string;
+    adminCreated?: boolean;
+    directMembersCount?: string;
+    kind?: string;
+    etag?: string;
+    aliases?: string[];
+    nonEditableAliases?: string[];
+};
+export declare type DeleteContext = {
+    target: string;
+    token: string;
+};
+export declare type AssociationObject = {
+    associationType: string;
+    values: string[];
+};
+export declare type Associations = {
+    set: AssociationObject[];
+};
+export interface TeamWorkGraph {
+    setEntity(entity: EntityPayload): Promise<Result>;
+    deleteEntity(entityId: string, context: DeleteContext): Promise<Result>;
+    setUser(user: UserObject): Promise<Result>;
+    deleteUser(userId: string): Promise<Result>;
+    setGroup(group: GroupObject): Promise<Result>;
+    deleteGroup(groupId: string): Promise<Result>;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGpC,oBAAY,UAAU,GAAG;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAY,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,oBAAY,aAAa,GAAG;IAC1B,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,aAAa,EAAE,SAAS,CAAC;CAC1B,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC7C,CAAC;AAGF,oBAAY,gBAAgB,GACxB,QAAQ,GACR,UAAU,GACV,cAAc,GACd,aAAa,GACb,OAAO,GACP,OAAO,GACP,OAAO,GACP,KAAK,GACL,UAAU,GACV,MAAM,GACN,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,CAAC;AAEZ,oBAAY,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B,aAAa,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;IACtC,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B,CAAC;AAGF,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAGF,oBAAY,aAAa,GAAG;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACrC,YAAY,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC3C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oBAAoB,CAAC,EAAE,kBAAkB,CAAC;CAC3C,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAGF,oBAAY,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,GAAG,EAAE,iBAAiB,EAAE,CAAC;CAC1B,CAAC;AAGF,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxE,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3C,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/C"}

package/out/utils/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@forge/teamwork-graph",
+  "version": "0.1.0-next.0",
+  "description": "Forge TeamworkGraph SDK",
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "files": [
+    "out"
+  ],
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v"
+  },
+  "devDependencies": {
+    "@types/node": "14.18.63",
+    "@types/node-fetch": "^2.6.11",
+    "expect-type": "^0.17.3",
+    "node-fetch": "2.7.0",
+    "jest-when": "^3.6.0"
+  },
+  "dependencies": {
+    "@forge/api": "^5.1.0-next.2"
+  }
+}