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

package/data-access-assets/atlassian-app-frontend.api.md

@@ -0,0 +1,109 @@
+## 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 class AssetsObjectsService {
+    // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-assets.d.ts
+    constructor(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string);
+    // Warning: (ae-forgotten-export) The symbol "AssetsObjectTypeAttribute" needs to be exported by the entry point data-access-assets.d.ts
+    //
+    // (undocumented)
+    createObject(objectTypeId: string, objectTypeAttributes: AssetsObjectTypeAttribute[], attributeValues: Record<string, string>): Promise<MappedAssetsObject>;
+    // (undocumented)
+    createObjectType(asset: AssetType, expectedAttributes: {
+        name: string;
+        type: number;
+    }[]): Promise<string>;
+    // (undocumented)
+    deleteObject(workspaceId: string, objectId: string): Promise<void>;
+    // (undocumented)
+    getAssetTypes(schemaKeysToExclude?: string[]): Promise<AssetType[]>;
+    // Warning: (ae-forgotten-export) The symbol "AssetsObjectType" needs to be exported by the entry point data-access-assets.d.ts
+    //
+    // (undocumented)
+    getObjectType(asset: AssetType, autoCreate?: boolean): Promise<AssetsObjectType>;
+    // Warning: (ae-forgotten-export) The symbol "AssetType" needs to be exported by the entry point data-access-assets.d.ts
+    // Warning: (ae-forgotten-export) The symbol "PagedResponseValues" needs to be exported by the entry point data-access-assets.d.ts
+    // Warning: (ae-forgotten-export) The symbol "MappedAssetsObject" needs to be exported by the entry point data-access-assets.d.ts
+    //
+    // (undocumented)
+    listObjects(asset: AssetType, attributeNames: string[], aql?: string, startAt?: number, maxResults?: number): Promise<PagedResponseValues<MappedAssetsObject>>;
+    // (undocumented)
+    listObjectTypeAttributes(asset: AssetType, expectedAttributes?: {
+        name: string;
+        type?: number;
+    }[], expectedAttributesRequired?: boolean, autoCreate?: boolean): Promise<{
+        objectTypeId: string;
+        objectTypeAttributes: AssetsObjectTypeAttribute[];
+    }>;
+    // (undocumented)
+    readObject(objectId: string, expectedAttributeNames?: string[]): Promise<MappedAssetsObject>;
+    // (undocumented)
+    updateObject(object: MappedAssetsObject, allAttributeNames: string[]): Promise<MappedAssetsObject>;
+}
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectAttributeIn" needs to be exported by the entry point data-access-assets.d.ts
+// Warning: (ae-forgotten-export) The symbol "CreateAssetsObjectResponse" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function createAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, attributes: AssetsObjectAttributeIn[]): Promise<CreateAssetsObjectResponse>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectSchema" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function createAssetsObjectSchema(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, name: string, objectSchemaKey: string): Promise<AssetsObjectSchema>;
+
+// @public (undocumented)
+export function createAssetsObjectType(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectSchemaId: string, name: string, iconId: string): Promise<AssetsObjectType>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectTypeAttributeValueType" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function createAssetsObjectTypeAttribute(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, name: string, type: AssetsObjectTypeAttributeValueType, isLabelAttribute: boolean): Promise<AssetsObjectTypeAttribute>;
+
+// @public (undocumented)
+export function deleteAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<void>;
+
+// Warning: (ae-forgotten-export) The symbol "ObjectConnectedTickets" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function getAssetLinkedIssues(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<ObjectConnectedTickets>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsGlobalIcon" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function getAssetsGlobalIcons(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string): Promise<AssetsGlobalIcon[]>;
+
+// @public (undocumented)
+export function getAssetsObjectSchemas(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string): Promise<AssetsObjectSchema[]>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectTypeAttributeWithObjectType" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function getAssetsObjectTypeAttributes(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string): Promise<AssetsObjectTypeAttributeWithObjectType[]>;
+
+// @public (undocumented)
+export function getAssetsObjectTypes(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectSchemaId: string): Promise<AssetsObjectType[]>;
+
+// Warning: (ae-forgotten-export) The symbol "ObjectListInclTypeAttributesEntryResult" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function queryAssetsObjects(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, query: string, startAt?: number, maxResults?: number): Promise<ObjectListInclTypeAttributesEntryResult>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObject" needs to be exported by the entry point data-access-assets.d.ts
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectAttributeWithDefinition" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function readAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<AssetsObject<AssetsObjectAttributeWithDefinition>>;
+
+// Warning: (ae-forgotten-export) The symbol "AssetsObjectWithAttributeDefinitions" needs to be exported by the entry point data-access-assets.d.ts
+//
+// @public (undocumented)
+export function updateAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, objectId: string, attributes: AssetsObjectAttributeIn[]): Promise<AssetsObjectWithAttributeDefinitions>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/data-access-assets/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("../atlassian/jira/shared/data-access-assets/src/lib/assets-objects-service/index.cjs.js"),r=require("../atlassian/jira/shared/data-access-assets/src/lib/global-icons/index.cjs.js"),e=require("../atlassian/jira/shared/data-access-assets/src/lib/object/index.cjs.js"),A=require("../atlassian/jira/shared/data-access-assets/src/lib/object-linked-issues/index.cjs.js"),s=require("../atlassian/jira/shared/data-access-assets/src/lib/object-schema/index.cjs.js"),t=require("../atlassian/jira/shared/data-access-assets/src/lib/object-type/index.cjs.js"),c=require("../atlassian/jira/shared/data-access-assets/src/lib/object-type-attribute/index.cjs.js");exports.AssetsObjectsService=b.AssetsObjectsService;exports.getAssetsGlobalIcons=r.getAssetsGlobalIcons;exports.createAssetsObject=e.createAssetsObject;exports.deleteAssetsObject=e.deleteAssetsObject;exports.queryAssetsObjects=e.queryAssetsObjects;exports.readAssetsObject=e.readAssetsObject;exports.updateAssetsObject=e.updateAssetsObject;exports.getAssetLinkedIssues=A.getAssetLinkedIssues;exports.createAssetsObjectSchema=s.createAssetsObjectSchema;exports.getAssetsObjectSchemas=s.getAssetsObjectSchemas;exports.createAssetsObjectType=t.createAssetsObjectType;exports.getAssetsObjectTypes=t.getAssetsObjectTypes;exports.createAssetsObjectTypeAttribute=c.createAssetsObjectTypeAttribute;exports.getAssetsObjectTypeAttributes=c.getAssetsObjectTypeAttributes;

package/data-access-assets/index.d.ts

@@ -0,0 +1,316 @@
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+declare interface AssetsGlobalIcon {
+    id: string;
+    name: string;
+    url16: string;
+    url48: string;
+}
+
+declare interface AssetsObject<T extends AssetsObjectAttribute = AssetsObjectAttribute> {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    label: string;
+    objectKey: string;
+    avatar: unknown;
+    objectType: AssetsObjectType;
+    created: string;
+    updated: string;
+    hasAvatar: boolean;
+    timestamp: number;
+    attributes: T[];
+    _links: {
+        self: string;
+    };
+}
+
+declare interface AssetsObjectAttribute {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    objectTypeAttributeId: string;
+    /**
+     * The actual values of the object attribute.
+     * The size of the values array is determined by the cardinality constraints
+     * on the object type attribute as well as how many values are associated
+     * with the object attribute
+     */
+    objectAttributeValues: AssetsObjectAttributeValue[];
+}
+
+declare interface AssetsObjectAttributeIn {
+    objectTypeAttributeId: string;
+    objectAttributeValues: [{
+        value: string;
+    }];
+}
+
+declare interface AssetsObjectAttributeValue {
+    value: string;
+    displayValue: string;
+    searchValue: string;
+}
+
+declare interface AssetsObjectAttributeWithDefinition extends AssetsObjectAttribute {
+    objectTypeAttribute: AssetsObjectTypeAttribute;
+}
+
+declare interface AssetsObjectSchema {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    name: string;
+    objectSchemaKey: string;
+    status: string;
+    description?: string;
+    created: string;
+    updated: string;
+    objectCount: number;
+    objectTypeCount: number;
+    canManage: boolean;
+}
+
+export declare class AssetsObjectsService {
+    private fetch;
+    private workspaceId;
+    constructor(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string);
+    listObjects(asset: AssetType, attributeNames: string[], aql?: string, startAt?: number, maxResults?: number): Promise<PagedResponseValues<MappedAssetsObject>>;
+    readObject(objectId: string, expectedAttributeNames?: string[]): Promise<MappedAssetsObject>;
+    createObject(objectTypeId: string, objectTypeAttributes: AssetsObjectTypeAttribute[], attributeValues: Record<string, string>): Promise<MappedAssetsObject>;
+    updateObject(object: MappedAssetsObject, allAttributeNames: string[]): Promise<MappedAssetsObject>;
+    deleteObject(workspaceId: string, objectId: string): Promise<void>;
+    private mapObject;
+    getObjectType(asset: AssetType, autoCreate?: boolean): Promise<AssetsObjectType>;
+    listObjectTypeAttributes(asset: AssetType, expectedAttributes?: {
+        name: string;
+        type?: number;
+    }[], expectedAttributesRequired?: boolean, autoCreate?: boolean): Promise<{
+        objectTypeId: string;
+        objectTypeAttributes: AssetsObjectTypeAttribute[];
+    }>;
+    createObjectType(asset: AssetType, expectedAttributes: {
+        name: string;
+        type: number;
+    }[]): Promise<string>;
+    private matchToExpectedAttributes;
+    private getAttributeIdsForObjectTypeId;
+    getAssetTypes(schemaKeysToExclude?: string[]): Promise<AssetType[]>;
+}
+
+declare interface AssetsObjectType {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    name: string;
+    icon: {
+        id: string;
+        name: string;
+        url16: string;
+        url48: string;
+    };
+    type: number;
+    position: number;
+    created: string;
+    updated: string;
+    objectCount: number;
+    objectSchemaId: string;
+    inherited: boolean;
+    abstractObjectType: boolean;
+    parentObjectTypeInherited: boolean;
+}
+
+declare interface AssetsObjectTypeAttribute {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    name: string;
+    label: boolean;
+    type: number;
+    defaultType: {
+        id: number;
+        name: string;
+    };
+    editable: boolean;
+    system: boolean;
+    sortable: boolean;
+    summable: boolean;
+    indexed: boolean;
+    minimumCardinality: 1;
+    maximumCardinality: 1;
+    removable: boolean;
+    hidden: boolean;
+    includeChildObjectTypes: boolean;
+    uniqueAttribute: boolean;
+    options: string;
+    position: number;
+    description?: string;
+}
+
+declare enum AssetsObjectTypeAttributeValueType {
+    None = -1,
+    Text = 0,
+    Integer = 1,
+    Boolean = 2,
+    Double = 3,
+    Date = 4,
+    Time = 5,
+    DateTime = 6,
+    Url = 7,
+    Email = 8,
+    Textarea = 9,
+    Select = 10,
+    IP_Address = 11
+}
+
+declare interface AssetsObjectTypeAttributeWithObjectType extends AssetsObjectTypeAttribute {
+    objectType: AssetsObjectType;
+}
+
+declare type AssetsObjectWithAttributeDefinitions = AssetsObject<AssetsObjectAttributeWithDefinition>;
+
+declare interface AssetType {
+    schemaName: string;
+    schemaKey: string;
+    objectTypeName: string;
+    labelAttributeName: string;
+}
+
+declare interface AtlassianProductFetchService<P extends Product> {
+    productType: P;
+    fetch: FetchSignature;
+    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
+    rawFetch: RequestProductMethod;
+    fullUrl: (path: string) => string;
+}
+
+export declare function createAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, attributes: AssetsObjectAttributeIn[]): Promise<CreateAssetsObjectResponse>;
+
+declare interface CreateAssetsObjectResponse {
+    workspaceId: string;
+    globalId: string;
+    id: string;
+    label: string;
+    objectKey: string;
+    avatar: unknown;
+    objectType: AssetsObjectType;
+    created: string;
+    updated: string;
+    hasAvatar: boolean;
+    timestamp: number;
+    _links: {
+        self: string;
+    };
+    name: string;
+}
+
+export declare function createAssetsObjectSchema(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, name: string, objectSchemaKey: string): Promise<AssetsObjectSchema>;
+
+export declare function createAssetsObjectType(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectSchemaId: string, name: string, iconId: string): Promise<AssetsObjectType>;
+
+export declare function createAssetsObjectTypeAttribute(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, name: string, type: AssetsObjectTypeAttributeValueType, isLabelAttribute: boolean): Promise<AssetsObjectTypeAttribute>;
+
+export declare function deleteAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<void>;
+
+declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+declare interface FetchRequest {
+    method: FetchMethod;
+    url: FetchRoute;
+    responseType?: 'json' | 'text';
+    allowExperimental?: boolean;
+}
+
+declare type FetchRoute = {
+    readonly value: string;
+};
+
+declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+
+export declare function getAssetLinkedIssues(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<ObjectConnectedTickets>;
+
+export declare function getAssetsGlobalIcons(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string): Promise<AssetsGlobalIcon[]>;
+
+export declare function getAssetsObjectSchemas(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string): Promise<AssetsObjectSchema[]>;
+
+export declare function getAssetsObjectTypeAttributes(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string): Promise<AssetsObjectTypeAttributeWithObjectType[]>;
+
+export declare function getAssetsObjectTypes(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectSchemaId: string): Promise<AssetsObjectType[]>;
+
+declare interface MappedAssetsObject {
+    workspaceId: string;
+    id: string;
+    objectTypeId: string;
+    globalId: string;
+    attributes: Record<string, MappedAssetsObjectAttribute>;
+}
+
+declare interface MappedAssetsObjectAttribute {
+    objectTypeAttributeId: string;
+    value: string;
+}
+
+declare interface ObjectConnectedTickets {
+    tickets?: Ticket[];
+    allTicketsQuery: string;
+}
+
+declare interface ObjectListInclTypeAttributesEntryResult {
+    startAt: number;
+    maxResults: number;
+    total: number;
+    isLast: boolean;
+    values: AssetsObject[];
+    objectTypeAttributes: AssetsObjectTypeAttribute[];
+}
+
+declare interface PagedResponseValues<T> {
+    startAt: number;
+    maxResults: number;
+    total: number;
+    isLast: boolean;
+    values: T[];
+}
+
+declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+export declare function queryAssetsObjects(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, query: string, startAt?: number, maxResults?: number): Promise<ObjectListInclTypeAttributesEntryResult>;
+
+export declare function readAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectId: string): Promise<AssetsObject<AssetsObjectAttributeWithDefinition>>;
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+declare interface Ticket {
+    workspaceId: string;
+    globalId: string;
+    key?: string;
+    id: string;
+    reporter: string;
+    created: string;
+    updated: string;
+    title?: string;
+    status?: TicketStatus;
+    type: TicketType;
+    priority: TicketPriority;
+}
+
+declare interface TicketPriority {
+    name?: string;
+    iconUrl?: string;
+}
+
+declare interface TicketStatus {
+    name?: string;
+    description?: string;
+    colorName?: string;
+}
+
+declare interface TicketType {
+    name?: string;
+    description?: string;
+    iconUrl?: string;
+}
+
+export declare function updateAssetsObject(fetch: AtlassianProductFetchService<'jira'>, workspaceId: string, objectTypeId: string, objectId: string, attributes: AssetsObjectAttributeIn[]): Promise<AssetsObjectWithAttributeDefinitions>;
+
+export { }

package/data-access-assets/index.es.js

@@ -0,0 +1,23 @@
+import { AssetsObjectsService as t } from "../atlassian/jira/shared/data-access-assets/src/lib/assets-objects-service/index.es.js";
+import { getAssetsGlobalIcons as c } from "../atlassian/jira/shared/data-access-assets/src/lib/global-icons/index.es.js";
+import { createAssetsObject as A, deleteAssetsObject as b, queryAssetsObjects as j, readAssetsObject as p, updateAssetsObject as O } from "../atlassian/jira/shared/data-access-assets/src/lib/object/index.es.js";
+import { getAssetLinkedIssues as m } from "../atlassian/jira/shared/data-access-assets/src/lib/object-linked-issues/index.es.js";
+import { createAssetsObjectSchema as x, getAssetsObjectSchemas as g } from "../atlassian/jira/shared/data-access-assets/src/lib/object-schema/index.es.js";
+import { createAssetsObjectType as y, getAssetsObjectTypes as d } from "../atlassian/jira/shared/data-access-assets/src/lib/object-type/index.es.js";
+import { createAssetsObjectTypeAttribute as T, getAssetsObjectTypeAttributes as l } from "../atlassian/jira/shared/data-access-assets/src/lib/object-type-attribute/index.es.js";
+export {
+  t as AssetsObjectsService,
+  A as createAssetsObject,
+  x as createAssetsObjectSchema,
+  y as createAssetsObjectType,
+  T as createAssetsObjectTypeAttribute,
+  b as deleteAssetsObject,
+  m as getAssetLinkedIssues,
+  c as getAssetsGlobalIcons,
+  g as getAssetsObjectSchemas,
+  l as getAssetsObjectTypeAttributes,
+  d as getAssetsObjectTypes,
+  j as queryAssetsObjects,
+  p as readAssetsObject,
+  O as updateAssetsObject
+};

package/data-access-assets/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"
+    }
+  ]
+}