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

package/util-assets/atlassian-app-frontend.api.md

@@ -0,0 +1,418 @@
+## 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 AssetsGlobalIcon {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    url16: string;
+    // (undocumented)
+    url48: string;
+}
+
+// @public (undocumented)
+export interface AssetsObject<T extends AssetsObjectAttribute = AssetsObjectAttribute> {
+    // (undocumented)
+    attributes: T[];
+    // (undocumented)
+    avatar: unknown;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    hasAvatar: boolean;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    label: string;
+    // (undocumented)
+    _links: {
+        self: string;
+    };
+    // (undocumented)
+    objectKey: string;
+    // (undocumented)
+    objectType: AssetsObjectType;
+    // (undocumented)
+    timestamp: number;
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectAttribute {
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    id: string;
+    objectAttributeValues: AssetsObjectAttributeValue[];
+    // (undocumented)
+    objectTypeAttributeId: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectAttributeIn {
+    // (undocumented)
+    objectAttributeValues: [{
+        value: string;
+    }];
+    // (undocumented)
+    objectTypeAttributeId: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectAttributeValue {
+    // (undocumented)
+    displayValue: string;
+    // (undocumented)
+    searchValue: string;
+    // (undocumented)
+    value: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectAttributeWithDefinition extends AssetsObjectAttribute {
+    // (undocumented)
+    objectTypeAttribute: AssetsObjectTypeAttribute;
+}
+
+// @public (undocumented)
+export interface AssetsObjectSchema {
+    // (undocumented)
+    canManage: boolean;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    objectCount: number;
+    // (undocumented)
+    objectSchemaKey: string;
+    // (undocumented)
+    objectTypeCount: number;
+    // (undocumented)
+    status: string;
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectType {
+    // (undocumented)
+    abstractObjectType: boolean;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    icon: {
+        id: string;
+        name: string;
+        url16: string;
+        url48: string;
+    };
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    inherited: boolean;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    objectCount: number;
+    // (undocumented)
+    objectSchemaId: string;
+    // (undocumented)
+    parentObjectTypeInherited: boolean;
+    // (undocumented)
+    position: number;
+    // (undocumented)
+    type: number;
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface AssetsObjectTypeAttribute {
+    // (undocumented)
+    defaultType: {
+        id: number;
+        name: string;
+    };
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    editable: boolean;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    hidden: boolean;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    includeChildObjectTypes: boolean;
+    // (undocumented)
+    indexed: boolean;
+    // (undocumented)
+    label: boolean;
+    // (undocumented)
+    maximumCardinality: 1;
+    // (undocumented)
+    minimumCardinality: 1;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    options: string;
+    // (undocumented)
+    position: number;
+    // (undocumented)
+    removable: boolean;
+    // (undocumented)
+    sortable: boolean;
+    // (undocumented)
+    summable: boolean;
+    // (undocumented)
+    system: boolean;
+    // (undocumented)
+    type: number;
+    // (undocumented)
+    uniqueAttribute: boolean;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export enum AssetsObjectTypeAttributeValueType {
+    // (undocumented)
+    Boolean = 2,
+    // (undocumented)
+    Date = 4,
+    // (undocumented)
+    DateTime = 6,
+    // (undocumented)
+    Double = 3,
+    // (undocumented)
+    Email = 8,
+    // (undocumented)
+    Integer = 1,
+    // (undocumented)
+    IP_Address = 11,
+    // (undocumented)
+    None = -1,
+    // (undocumented)
+    Select = 10,
+    // (undocumented)
+    Text = 0,
+    // (undocumented)
+    Textarea = 9,
+    // (undocumented)
+    Time = 5,
+    // (undocumented)
+    Url = 7
+}
+
+// @public (undocumented)
+export interface AssetsObjectTypeAttributeWithObjectType extends AssetsObjectTypeAttribute {
+    // (undocumented)
+    objectType: AssetsObjectType;
+}
+
+// @public (undocumented)
+export type AssetsObjectWithAttributeDefinitions = AssetsObject<AssetsObjectAttributeWithDefinition>;
+
+// @public (undocumented)
+export interface AssetsPaginatedObjectSchemaResult {
+    // (undocumented)
+    isLast: true;
+    // (undocumented)
+    _links: {
+        self: string;
+        base: string;
+        context: string;
+    };
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: AssetsObjectSchema[];
+}
+
+// @public (undocumented)
+export interface AssetType {
+    // (undocumented)
+    labelAttributeName: string;
+    // (undocumented)
+    objectTypeName: string;
+    // (undocumented)
+    schemaKey: string;
+    // (undocumented)
+    schemaName: string;
+}
+
+// @public (undocumented)
+export function convertDataSourceType(type: string): AssetsObjectTypeAttributeValueType.Text | AssetsObjectTypeAttributeValueType.Integer;
+
+// @public (undocumented)
+export function createAssetsObjectAttributeIn(id: string, value: string): AssetsObjectAttributeIn;
+
+// @public (undocumented)
+export interface CreateAssetsObjectResponse {
+    // (undocumented)
+    avatar: unknown;
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    hasAvatar: boolean;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    label: string;
+    // (undocumented)
+    _links: {
+        self: string;
+    };
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    objectKey: string;
+    // (undocumented)
+    objectType: AssetsObjectType;
+    // (undocumented)
+    timestamp: number;
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export const DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME = "Name";
+
+// @public (undocumented)
+export interface MappedAssetsObject {
+    // (undocumented)
+    attributes: Record<string, MappedAssetsObjectAttribute>;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    objectTypeId: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface MappedAssetsObjectAttribute {
+    // (undocumented)
+    objectTypeAttributeId: string;
+    // (undocumented)
+    value: string;
+}
+
+// @public (undocumented)
+export interface ObjectConnectedTickets {
+    // (undocumented)
+    allTicketsQuery: string;
+    // (undocumented)
+    tickets?: Ticket[];
+}
+
+// @public (undocumented)
+export interface ObjectListInclTypeAttributesEntryResult {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    objectTypeAttributes: AssetsObjectTypeAttribute[];
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: AssetsObject[];
+}
+
+// @public (undocumented)
+export interface Ticket {
+    // (undocumented)
+    created: string;
+    // (undocumented)
+    globalId: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    key?: string;
+    // (undocumented)
+    priority: TicketPriority;
+    // (undocumented)
+    reporter: string;
+    // (undocumented)
+    status?: TicketStatus;
+    // (undocumented)
+    title?: string;
+    // (undocumented)
+    type: TicketType;
+    // (undocumented)
+    updated: string;
+    // (undocumented)
+    workspaceId: string;
+}
+
+// @public (undocumented)
+export interface TicketPriority {
+    // (undocumented)
+    iconUrl?: string;
+    // (undocumented)
+    name?: string;
+}
+
+// @public (undocumented)
+export interface TicketStatus {
+    // (undocumented)
+    colorName?: string;
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    name?: string;
+}
+
+// @public (undocumented)
+export interface TicketType {
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    iconUrl?: string;
+    // (undocumented)
+    name?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/util-assets/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("../atlassian/jira/shared/util-assets/src/lib/asset-type/index.cjs.js"),r=require("../atlassian/jira/shared/util-assets/src/lib/object/index.cjs.js"),e=require("../atlassian/jira/shared/util-assets/src/lib/object-type-attribute/index.cjs.js");exports.DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME=t.DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME;exports.createAssetsObjectAttributeIn=r.createAssetsObjectAttributeIn;exports.AssetsObjectTypeAttributeValueType=e.AssetsObjectTypeAttributeValueType;exports.convertDataSourceType=e.convertDataSourceType;

package/util-assets/index.d.ts

@@ -0,0 +1,245 @@
+export declare interface AssetsGlobalIcon {
+    id: string;
+    name: string;
+    url16: string;
+    url48: string;
+}
+
+export 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;
+    };
+}
+
+export 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[];
+}
+
+export declare interface AssetsObjectAttributeIn {
+    objectTypeAttributeId: string;
+    objectAttributeValues: [{
+        value: string;
+    }];
+}
+
+export declare interface AssetsObjectAttributeValue {
+    value: string;
+    displayValue: string;
+    searchValue: string;
+}
+
+export declare interface AssetsObjectAttributeWithDefinition extends AssetsObjectAttribute {
+    objectTypeAttribute: AssetsObjectTypeAttribute;
+}
+
+export 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 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;
+}
+
+export 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;
+}
+
+export 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
+}
+
+export declare interface AssetsObjectTypeAttributeWithObjectType extends AssetsObjectTypeAttribute {
+    objectType: AssetsObjectType;
+}
+
+export declare type AssetsObjectWithAttributeDefinitions = AssetsObject<AssetsObjectAttributeWithDefinition>;
+
+export declare interface AssetsPaginatedObjectSchemaResult {
+    maxResults: number;
+    startAt: number;
+    total: number;
+    isLast: true;
+    _links: {
+        self: string;
+        base: string;
+        context: string;
+    };
+    values: AssetsObjectSchema[];
+}
+
+export declare interface AssetType {
+    schemaName: string;
+    schemaKey: string;
+    objectTypeName: string;
+    labelAttributeName: string;
+}
+
+export declare function convertDataSourceType(type: string): AssetsObjectTypeAttributeValueType.Text | AssetsObjectTypeAttributeValueType.Integer;
+
+export declare function createAssetsObjectAttributeIn(id: string, value: string): AssetsObjectAttributeIn;
+
+export 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 const DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME = "Name";
+
+export declare interface MappedAssetsObject {
+    workspaceId: string;
+    id: string;
+    objectTypeId: string;
+    globalId: string;
+    attributes: Record<string, MappedAssetsObjectAttribute>;
+}
+
+export declare interface MappedAssetsObjectAttribute {
+    objectTypeAttributeId: string;
+    value: string;
+}
+
+export declare interface ObjectConnectedTickets {
+    tickets?: Ticket[];
+    allTicketsQuery: string;
+}
+
+export declare interface ObjectListInclTypeAttributesEntryResult {
+    startAt: number;
+    maxResults: number;
+    total: number;
+    isLast: boolean;
+    values: AssetsObject[];
+    objectTypeAttributes: AssetsObjectTypeAttribute[];
+}
+
+export 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;
+}
+
+export declare interface TicketPriority {
+    name?: string;
+    iconUrl?: string;
+}
+
+export declare interface TicketStatus {
+    name?: string;
+    description?: string;
+    colorName?: string;
+}
+
+export declare interface TicketType {
+    name?: string;
+    description?: string;
+    iconUrl?: string;
+}
+
+export { }

package/util-assets/index.es.js

@@ -0,0 +1,9 @@
+import { DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME as r } from "../atlassian/jira/shared/util-assets/src/lib/asset-type/index.es.js";
+import { createAssetsObjectAttributeIn as A } from "../atlassian/jira/shared/util-assets/src/lib/object/index.es.js";
+import { AssetsObjectTypeAttributeValueType as T, convertDataSourceType as p } from "../atlassian/jira/shared/util-assets/src/lib/object-type-attribute/index.es.js";
+export {
+  T as AssetsObjectTypeAttributeValueType,
+  r as DEFAULT_ASSET_OBJECT_TYPE_LABEL_FIELD_NAME,
+  p as convertDataSourceType,
+  A as createAssetsObjectAttributeIn
+};

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