@valiantys/atlassian-app-frontend 3.1.0-alpha-4 → 3.1.0-alpha-5

package/atlassian/jira/shared/data-access-serverinfo/src/lib/jira-server-info-service/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("../../../../util-jira-v3-api/src/lib/jira-server-info/index.cjs.js"),r=class r{constructor(t){this.fetchSvc=t}async getServerInfo(){return this.fetchSvc.fetch({url:this.fetchSvc.route`/rest/api/3/serverInfo`,method:"GET"})}async switchAtlassianApiUrlToUseSiteUrl(t){const s=(await this.getServerInfo()).baseUrl;return i.switchAtlassianApiUrlToUseSiteUrl(s,t)}};r.serverInfoUrl="/rest/api/3/serverInfo";let e=r;exports.JiraServerInfoService=e;

package/atlassian/jira/shared/data-access-serverinfo/src/lib/jira-server-info-service/index.es.js

@@ -0,0 +1,21 @@
+import { switchAtlassianApiUrlToUseSiteUrl as i } from "../../../../util-jira-v3-api/src/lib/jira-server-info/index.es.js";
+const s = class s {
+  constructor(t) {
+    this.fetchSvc = t;
+  }
+  async getServerInfo() {
+    return this.fetchSvc.fetch({
+      url: this.fetchSvc.route`/rest/api/3/serverInfo`,
+      method: "GET"
+    });
+  }
+  async switchAtlassianApiUrlToUseSiteUrl(t) {
+    const r = (await this.getServerInfo()).baseUrl;
+    return i(r, t);
+  }
+};
+s.serverInfoUrl = "/rest/api/3/serverInfo";
+let e = s;
+export {
+  e as JiraServerInfoService
+};

package/data-access-serverinfo/atlassian-app-frontend-data-access-serverinfo.api.json

@@ -0,0 +1,366 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.8",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@valiantys/atlassian-app-frontend!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app-frontend",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app-frontend!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Class",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfoService:class",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class JiraServerInfoService "
+            }
+          ],
+          "fileUrlPath": "../../jira/shared/data-access-serverinfo/src/lib/jira-server-info-service.d.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "JiraServerInfoService",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfoService:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `JiraServerInfoService` class\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(fetchSvc: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianProductFetchService",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianProductFetchService:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<'jira'>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "fetchSvc",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ]
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfoService#getServerInfo:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getServerInfo(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "JiraServerInfo",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~JiraServerInfo:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getServerInfo"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfoService.serverInfoUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly serverInfoUrl = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"/rest/api/3/serverInfo\""
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "serverInfoUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfoService#switchAtlassianApiUrlToUseSiteUrl:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "switchAtlassianApiUrlToUseSiteUrl(apiDotAtlassianUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "apiDotAtlassianUrl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "switchAtlassianApiUrlToUseSiteUrl"
+            }
+          ],
+          "implementsTokenRanges": []
+        }
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,23 @@
+## 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 JiraServerInfoService {
+    // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-serverinfo.d.ts
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // Warning: (ae-forgotten-export) The symbol "JiraServerInfo" needs to be exported by the entry point data-access-serverinfo.d.ts
+    //
+    // (undocumented)
+    getServerInfo(): Promise<JiraServerInfo>;
+    // (undocumented)
+    static readonly serverInfoUrl = "/rest/api/3/serverInfo";
+    // (undocumented)
+    switchAtlassianApiUrlToUseSiteUrl(apiDotAtlassianUrl: string): Promise<string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/data-access-serverinfo/src/lib/jira-server-info-service/index.cjs.js");exports.JiraServerInfoService=e.JiraServerInfoService;

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

@@ -0,0 +1,61 @@
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+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;
+}
+
+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?: any) => Promise<T>;
+
+declare interface HealthCheckResult {
+    description: string;
+    name: string;
+    passed: boolean;
+}
+
+declare interface JiraServerInfo {
+    baseUrl: string;
+    buildDate: string;
+    buildNumber: number;
+    deploymentType: string;
+    displayUrl: string;
+    displayUrlConfluence: string;
+    displayUrlServicedeskHelpCenter: string;
+    healthChecks: HealthCheckResult[];
+    scmInfo: string;
+    serverTime: string;
+    serverTimeZone: string;
+    serverTitle: string;
+    version: string;
+    versionNumbers: number[];
+}
+
+export declare class JiraServerInfoService {
+    private fetchSvc;
+    static readonly serverInfoUrl = "/rest/api/3/serverInfo";
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    getServerInfo(): Promise<JiraServerInfo>;
+    switchAtlassianApiUrlToUseSiteUrl(apiDotAtlassianUrl: string): Promise<string>;
+}
+
+declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+export { }

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

@@ -0,0 +1,4 @@
+import { JiraServerInfoService as o } from "../atlassian/jira/shared/data-access-serverinfo/src/lib/jira-server-info-service/index.es.js";
+export {
+  o as JiraServerInfoService
+};

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app-frontend",
-  "version": "3.1.0-alpha-4",
+  "version": "3.1.0-alpha-5",
   "description": "This library provides an Atlassian Forge Custom UI wrapper component that handles all the setup necessary to support an app that can run deployed or in standalone mode",
   "exports": {
     "./atlassian-app": {
@@ -53,6 +53,11 @@
       "require": "./data-access-resources/index.cjs.js",
       "types": "./data-access-resources/index.d.ts"
     },
+    "./data-access-serverinfo": {
+      "import": "./data-access-serverinfo/index.es.js",
+      "require": "./data-access-serverinfo/index.cjs.js",
+      "types": "./data-access-serverinfo/index.d.ts"
+    },
     "./data-access-workspaces": {
       "import": "./data-access-workspaces/index.es.js",
       "require": "./data-access-workspaces/index.cjs.js",