@valiantys/atlassian-app 3.2.0-alpha-1

package/util-trigger/atlassian-app.api.md

@@ -0,0 +1,84 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { WebTriggerRequest } from '@forge/api/out/webTrigger';
+import { WebTriggerResponse } from '@forge/api/out/webTrigger';
+
+// @public (undocumented)
+export interface JiraIssueChange {
+    // (undocumented)
+    field: string;
+    // (undocumented)
+    fieldId: string;
+    // (undocumented)
+    fieldtype: string;
+    // (undocumented)
+    from?: string;
+    // (undocumented)
+    fromString?: string;
+    // (undocumented)
+    to?: string;
+    // (undocumented)
+    toString?: string;
+}
+
+// @public (undocumented)
+export interface JiraIssueChangelog {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    items: JiraIssueChange[];
+}
+
+// @public (undocumented)
+export type JiraIssueEvent = {
+    eventType: string;
+    issue: {
+        key: string;
+        fields: {
+            summary: string;
+            project: {
+                key: string;
+            };
+        };
+    };
+    atlassianId: string;
+};
+
+// @public (undocumented)
+export interface JiraIssueEventPayload {
+    // Warning: (ae-forgotten-export) The symbol "User" needs to be exported by the entry point util-trigger.d.ts
+    //
+    // (undocumented)
+    associatedUsers?: User[];
+    // (undocumented)
+    atlassianId?: string;
+    // (undocumented)
+    eventType: 'avi:jira:created:issue' | 'avi:jira:updated:issue' | 'avi:jira:deleted:issue';
+    // Warning: (ae-forgotten-export) The symbol "Issue" needs to be exported by the entry point util-trigger.d.ts
+    //
+    // (undocumented)
+    issue: Issue;
+}
+
+// @public (undocumented)
+export interface JiraUpdatedIssuePayload extends JiraIssueEventPayload {
+    // Warning: (ae-forgotten-export) The symbol "IssueStatus" needs to be exported by the entry point util-trigger.d.ts
+    //
+    // (undocumented)
+    associatedStatuses?: IssueStatus[];
+    // (undocumented)
+    changelog: JiraIssueChangelog;
+    // (undocumented)
+    eventType: 'avi:jira:updated:issue';
+}
+
+// @public (undocumented)
+export type WebTriggerFunction = (req: WebTriggerRequest) => Promise<WebTriggerResponse>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/util-trigger/index.cjs.js

@@ -0,0 +1 @@
+"use strict";

package/util-trigger/index.d.ts

@@ -0,0 +1,266 @@
+import { WebTriggerRequest } from '@forge/api/out/webTrigger';
+import { WebTriggerResponse } from '@forge/api/out/webTrigger';
+
+declare interface AtlassianDocumentFormat {
+    type: 'doc';
+    version: number;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatBlockNode {
+    type: string;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatInlineNode {
+    type: string;
+}
+
+declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
+declare interface AvatarUrls {
+    '48x48': string;
+    '24x24': string;
+    '16x16': string;
+    '32x32': string;
+}
+
+declare type CustomFields = Record<string, unknown>;
+
+declare interface EntityProperty {
+    key: string;
+    value: unknown;
+}
+
+declare interface FixVersion {
+    description?: string;
+    id: string;
+    name: string;
+    releaseDate?: string;
+    released?: boolean;
+    self?: string;
+}
+
+declare type FixVersions = FixVersion[];
+
+declare interface Issue<T = AtlassianDocumentFormat> {
+    id: string;
+    expand?: string;
+    key: string;
+    self?: string;
+    fields: IssueFields<T>;
+    renderedFields?: IssueFields<string>;
+}
+
+declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+
+declare interface IssueLink {
+    id: string;
+    self: string;
+    outwardIssue?: Issue;
+    inwardIssue?: Issue;
+    type: {
+        id: string;
+        name: string;
+        inward: string;
+        outward: string;
+        self: string;
+    };
+}
+
+declare interface IssueStatus {
+    self: string;
+    description: string;
+    iconUrl: string;
+    name: string;
+    untranslatedName?: string;
+    id: string;
+    statusCategory: {
+        self: string;
+        id: number;
+        key: string;
+        colorName: string;
+        name: string;
+    };
+}
+
+export declare interface JiraIssueChange {
+    field: string;
+    fieldId: string;
+    fieldtype: string;
+    from?: string;
+    fromString?: string;
+    to?: string;
+    toString?: string;
+}
+
+export declare interface JiraIssueChangelog {
+    id: string;
+    items: JiraIssueChange[];
+}
+
+export declare type JiraIssueEvent = {
+    eventType: string;
+    issue: {
+        key: string;
+        fields: {
+            summary: string;
+            project: {
+                key: string;
+            };
+        };
+    };
+    atlassianId: string;
+};
+
+export declare interface JiraIssueEventPayload {
+    eventType: 'avi:jira:created:issue' | 'avi:jira:updated:issue' | 'avi:jira:deleted:issue';
+    issue: Issue;
+    atlassianId?: string;
+    associatedUsers?: User[];
+}
+
+export declare interface JiraUpdatedIssuePayload extends JiraIssueEventPayload {
+    eventType: 'avi:jira:updated:issue';
+    changelog: JiraIssueChangelog;
+    associatedStatuses?: IssueStatus[];
+}
+
+declare interface Project {
+    self?: string;
+    id: string;
+    key?: string;
+    name?: string;
+    projectTypeKey?: string;
+    simplified?: boolean;
+    avatarUrls?: AvatarUrls;
+    archived?: boolean;
+    lead?: User;
+}
+
+declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
+    statuscategorychangedate?: string;
+    fixVersions?: FixVersions;
+    resolution?: unknown;
+    worklog?: {
+        total: number;
+        startAt: number;
+        maxResults: number;
+        worklogs: Worklog[];
+    };
+    issuetype?: {
+        self?: string;
+        id: string;
+        description?: string;
+        iconUrl?: string;
+        name?: string;
+        subtask?: boolean;
+        avatarId?: number;
+        hierarchyLevel?: number;
+    };
+    timespent?: number;
+    project?: Project;
+    aggregatetimespent?: number;
+    resolutiondate?: string;
+    lastViewed?: string;
+    priority?: {
+        self: string;
+        iconUrl: string;
+        name: string;
+        id: string;
+    };
+    labels?: string[];
+    timeestimate?: number;
+    workratio?: number;
+    watches?: {
+        self: string;
+        watchCount: number;
+        isWatching: boolean;
+    };
+    created?: string;
+    updated?: string;
+    description?: T;
+    timetracking?: {
+        remainingEstimate: string;
+        timeSpent: string;
+        remainingEstimateSeconds: number;
+        timeSpentSeconds: number;
+    };
+    summary?: string;
+    status?: IssueStatus;
+    creator?: User;
+    assignee?: User;
+    reporter?: User;
+    issuelinks?: IssueLink[];
+    components?: {
+        id: string;
+        name: string;
+    }[];
+}
+
+declare interface User {
+    accountId: string;
+    active: boolean;
+    displayName: string;
+    emailAddress?: string;
+    timeZone: string;
+    avatarUrls?: AvatarUrls;
+    accountType?: string;
+    self?: string;
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+}
+
+declare interface UserGroupName {
+    groupId: string;
+    name: string;
+    self: string;
+}
+
+export declare type WebTriggerFunction = (req: WebTriggerRequest) => Promise<WebTriggerResponse>;
+
+declare interface Worklog extends WorklogCreateRequest {
+    self: string;
+    id: string;
+    author: User;
+    created: string;
+    issueId: string;
+    updateAuthor: User;
+    updated: string;
+}
+
+/**
+ * A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
+ */
+declare interface WorklogComment {
+    type: 'doc';
+    version: 1;
+    content: [
+        {
+        type: 'paragraph';
+        content: [
+            {
+            type: 'text';
+            text: string;
+        }
+        ];
+    }
+    ];
+}
+
+declare interface WorklogCreateRequest {
+    comment?: WorklogComment;
+    properties?: EntityProperty[];
+    started: string;
+    timeSpent?: string;
+    timeSpentSeconds?: number;
+    visibility?: {
+        identifier: string;
+        type: string;
+        value: string;
+    };
+}
+
+export { }

package/util-trigger/index.es.js

@@ -0,0 +1 @@
+

package/util-trigger/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}