@valiantys/atlassian-app-frontend 2.0.0 → 3.0.0-alpha-1

package/util-jira-v3-api/atlassian-app-frontend.api.md

@@ -0,0 +1,408 @@
+## API Report File for "@valiantys/atlassian-app-frontend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export interface AvatarUrls {
+    // (undocumented)
+    '16x16': string;
+    // (undocumented)
+    '24x24': string;
+    // (undocumented)
+    '32x32': string;
+    // (undocumented)
+    '48x48': string;
+}
+
+// @public (undocumented)
+export type CustomFields = Record<string, unknown>;
+
+// @public (undocumented)
+export interface EntityProperty {
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    value: unknown;
+}
+
+// @public (undocumented)
+export const FIX_VERSIONS_FIELD = "fixVersions";
+
+// @public (undocumented)
+export type FixVersions = {
+    description: string;
+    id: string;
+    name: string;
+    releaseDate?: string;
+    released: boolean;
+    self: string;
+}[];
+
+// @public (undocumented)
+export interface Issue {
+    // (undocumented)
+    expand?: string;
+    // (undocumented)
+    fields: IssueFields;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    self?: string;
+}
+
+// @public (undocumented)
+export type IssueFields = CustomFields & StaticIssueFields;
+
+// @public (undocumented)
+export interface IssueLink {
+    // (undocumented)
+    inwardIssue?: Issue;
+    // (undocumented)
+    outwardIssue?: Issue;
+}
+
+// @public (undocumented)
+export interface IssueStatus {
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    iconUrl: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    statusCategory: {
+        self: string;
+        id: number;
+        key: string;
+        colorName: string;
+        name: string;
+    };
+    // (undocumented)
+    untranslatedName?: string;
+}
+
+// @public (undocumented)
+export interface IssueTypeDetails {
+    // (undocumented)
+    avatarId: number;
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    hierarchyLevel: number;
+    // (undocumented)
+    iconUrl: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    subtask: boolean;
+}
+
+// @public (undocumented)
+export type Precomputation = {
+    id: string;
+    value: string;
+    functionKey: string;
+    functionName: string;
+    field: string;
+    operator: 'not in' | 'in';
+    arguments: string[];
+    created: string;
+    updated: string;
+    used: string;
+};
+
+// @public (undocumented)
+export type PrecomputationPayload = {
+    precomputationId: string;
+    clause: {
+        field: string;
+        type: string[];
+        operator: string;
+        functionName: string;
+        arguments: string[];
+    };
+    context?: {
+        cloudId: string;
+        moduleKey: string;
+    };
+    contextToken?: string;
+};
+
+// @public (undocumented)
+export interface PrecomputationResponse {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: Precomputation[];
+}
+
+// @public (undocumented)
+export type PrecomputationUpdate = {
+    id: string;
+    value: string;
+} | {
+    id: string;
+    error: string;
+};
+
+// @public (undocumented)
+export interface Project {
+    // (undocumented)
+    archived: boolean;
+    // (undocumented)
+    avatarUrls: AvatarUrls;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    projectTypeKey: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    simplified: boolean;
+}
+
+// @public (undocumented)
+export interface ProjectVersion {
+    // (undocumented)
+    archived: boolean;
+    // (undocumented)
+    description: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    overdue?: boolean;
+    // (undocumented)
+    projectId?: number;
+    // (undocumented)
+    released: boolean;
+    // (undocumented)
+    releaseDate?: number;
+    // (undocumented)
+    releaseDateSet?: boolean;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    startDateSet?: boolean;
+    // (undocumented)
+    userReleaseDate?: string;
+}
+
+// @public (undocumented)
+export interface StaticIssueFields {
+    // (undocumented)
+    aggregatetimespent: number;
+    // (undocumented)
+    assignee?: User;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    creator: User;
+    // (undocumented)
+    description?: {
+        type: 'doc';
+        version: 1;
+        content: {
+            type: 'paragraph';
+            content: {
+                type: 'text';
+                text: string;
+            }[];
+        }[];
+    };
+    // (undocumented)
+    fixVersions: FixVersions;
+    // (undocumented)
+    issuelinks?: IssueLink[];
+    // (undocumented)
+    issuetype: {
+        self: string;
+        id: string;
+        description: string;
+        iconUrl: string;
+        name: string;
+        subtask: boolean;
+        avatarId: number;
+        hierarchyLevel: number;
+    };
+    // (undocumented)
+    labels: string[];
+    // (undocumented)
+    lastViewed: string;
+    // (undocumented)
+    priority: {
+        self: string;
+        iconUrl: string;
+        name: string;
+        id: string;
+    };
+    // (undocumented)
+    project: Project;
+    // (undocumented)
+    reporter?: User;
+    // (undocumented)
+    resolution: unknown;
+    // (undocumented)
+    resolutiondate?: string;
+    // (undocumented)
+    status: IssueStatus;
+    // (undocumented)
+    statuscategorychangedate: string;
+    // (undocumented)
+    summary: string;
+    // (undocumented)
+    timeestimate: number;
+    // (undocumented)
+    timespent: number;
+    // (undocumented)
+    timetracking: {
+        remainingEstimate: string;
+        timeSpent: string;
+        remainingEstimateSeconds: number;
+        timeSpentSeconds: number;
+    };
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    watches: {
+        self: string;
+        watchCount: number;
+        isWatching: boolean;
+    };
+    // (undocumented)
+    worklog: {
+        total: number;
+        startAt: number;
+        maxResults: number;
+        worklogs: Worklog[];
+    };
+    // (undocumented)
+    workratio: number;
+}
+
+// @public (undocumented)
+export interface User {
+    // (undocumented)
+    accountId: string;
+    // (undocumented)
+    accountType?: string;
+    // (undocumented)
+    active: boolean;
+    // (undocumented)
+    avatarUrls?: AvatarUrls;
+    // (undocumented)
+    displayName: string;
+    // (undocumented)
+    emailAddress?: string;
+    // (undocumented)
+    self?: string;
+    // (undocumented)
+    timeZone: string;
+}
+
+// @public (undocumented)
+export interface UserPickerQueryResponse {
+    // (undocumented)
+    header: string;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    users: UserPickerUser[];
+}
+
+// @public (undocumented)
+export interface UserPickerUser {
+    // (undocumented)
+    accountId: string;
+    // (undocumented)
+    accountType: string;
+    // (undocumented)
+    displayName: string;
+    // (undocumented)
+    html?: string;
+}
+
+// @public (undocumented)
+export interface Worklog extends WorklogCreateRequest {
+    // (undocumented)
+    author: User;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    issueId: string;
+    // (undocumented)
+    self: string;
+    // (undocumented)
+    updateAuthor: User;
+    // (undocumented)
+    updated: string;
+}
+
+// @public
+export interface WorklogComment {
+    // (undocumented)
+    content: [
+        {
+        type: 'paragraph';
+        content: [
+            {
+            type: 'text';
+            text: string;
+        }
+        ];
+    }
+    ];
+    // (undocumented)
+    type: 'doc';
+    // (undocumented)
+    version: 1;
+}
+
+// @public (undocumented)
+export interface WorklogCreateRequest {
+    // (undocumented)
+    comment?: WorklogComment;
+    // (undocumented)
+    properties?: EntityProperty[];
+    // (undocumented)
+    started: string;
+    // (undocumented)
+    timeSpent?: string;
+    // (undocumented)
+    timeSpentSeconds?: number;
+    // (undocumented)
+    visibility?: {
+        identifier: string;
+        type: string;
+        value: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/util-jira-v3-api/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js");exports.FIX_VERSIONS_FIELD=e.FIX_VERSIONS_FIELD;

package/util-jira-v3-api/index.d.ts

@@ -0,0 +1,271 @@
+export declare interface AvatarUrls {
+    '48x48': string;
+    '24x24': string;
+    '16x16': string;
+    '32x32': string;
+}
+
+export declare type CustomFields = Record<string, unknown>;
+
+export declare interface EntityProperty {
+    key: string;
+    value: unknown;
+}
+
+export declare const FIX_VERSIONS_FIELD = "fixVersions";
+
+export declare type FixVersions = {
+    description: string;
+    id: string;
+    name: string;
+    releaseDate?: string;
+    released: boolean;
+    self: string;
+}[];
+
+export declare interface Issue {
+    id: string;
+    expand?: string;
+    key: string;
+    self?: string;
+    fields: IssueFields;
+}
+
+export declare type IssueFields = CustomFields & StaticIssueFields;
+
+export declare interface IssueLink {
+    outwardIssue?: Issue;
+    inwardIssue?: Issue;
+}
+
+export 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 IssueTypeDetails {
+    avatarId: number;
+    description: string;
+    hierarchyLevel: number;
+    iconUrl: string;
+    id: string;
+    name: string;
+    self: string;
+    subtask: boolean;
+}
+
+export declare type Precomputation = {
+    id: string;
+    value: string;
+    functionKey: string;
+    functionName: string;
+    field: string;
+    operator: 'not in' | 'in';
+    arguments: string[];
+    created: string;
+    updated: string;
+    used: string;
+};
+
+export declare type PrecomputationPayload = {
+    precomputationId: string;
+    clause: {
+        field: string;
+        type: string[];
+        operator: string;
+        functionName: string;
+        arguments: string[];
+    };
+    context?: {
+        cloudId: string;
+        moduleKey: string;
+    };
+    contextToken?: string;
+};
+
+export declare interface PrecomputationResponse {
+    startAt: number;
+    isLast: boolean;
+    maxResults: number;
+    total: number;
+    values: Precomputation[];
+}
+
+export declare type PrecomputationUpdate = {
+    id: string;
+    value: string;
+} | {
+    id: string;
+    error: string;
+};
+
+export declare interface Project {
+    self: string;
+    id: string;
+    key: string;
+    name: string;
+    projectTypeKey: string;
+    simplified: boolean;
+    avatarUrls: AvatarUrls;
+    archived: boolean;
+}
+
+export declare interface ProjectVersion {
+    archived: boolean;
+    description: string;
+    id: string;
+    name: string;
+    overdue?: boolean;
+    projectId?: number;
+    releaseDate?: number;
+    releaseDateSet?: boolean;
+    released: boolean;
+    self: string;
+    startDateSet?: boolean;
+    userReleaseDate?: string;
+}
+
+export declare interface StaticIssueFields {
+    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?: {
+        type: 'doc';
+        version: 1;
+        content: {
+            type: 'paragraph';
+            content: {
+                type: 'text';
+                text: string;
+            }[];
+        }[];
+    };
+    timetracking: {
+        remainingEstimate: string;
+        timeSpent: string;
+        remainingEstimateSeconds: number;
+        timeSpentSeconds: number;
+    };
+    summary: string;
+    status: IssueStatus;
+    creator: User;
+    assignee?: User;
+    reporter?: User;
+    issuelinks?: IssueLink[];
+}
+
+export declare interface User {
+    accountId: string;
+    active: boolean;
+    displayName: string;
+    emailAddress?: string;
+    timeZone: string;
+    avatarUrls?: AvatarUrls;
+    accountType?: string;
+    self?: string;
+}
+
+export declare interface UserPickerQueryResponse {
+    users: UserPickerUser[];
+    total: number;
+    header: string;
+}
+
+export declare interface UserPickerUser {
+    accountId: string;
+    accountType: string;
+    displayName: string;
+    html?: string;
+}
+
+export 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.
+ */
+export declare interface WorklogComment {
+    type: 'doc';
+    version: 1;
+    content: [
+        {
+        type: 'paragraph';
+        content: [
+            {
+            type: 'text';
+            text: string;
+        }
+        ];
+    }
+    ];
+}
+
+export declare interface WorklogCreateRequest {
+    comment?: WorklogComment;
+    properties?: EntityProperty[];
+    started: string;
+    timeSpent?: string;
+    timeSpentSeconds?: number;
+    visibility?: {
+        identifier: string;
+        type: string;
+        value: string;
+    };
+}
+
+export { }

package/util-jira-v3-api/index.es.js

@@ -0,0 +1,4 @@
+import { FIX_VERSIONS_FIELD as r } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
+export {
+  r as FIX_VERSIONS_FIELD
+};

package/util-jira-v3-api/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"
+    }
+  ]
+}