@valiantys/atlassian-app 3.2.0-alpha-18 → 3.2.0-alpha-20

package/atlassian/jira/shared/data-access-project/src/lib/jira-project-service/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("../../../../../../../shared/util-fetch/src/lib/shared-util-fetch/index.cjs.js"),h=class h{constructor(t){this.fetchSvc=t}getVersions(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/versions`})}getProject(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}`})}async getAllProjects(){return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project`})||[]}async projectSearchByIds(t){var e;if(t.length>50)throw new Error("Too many project ids, max allowed is 50.");const r=this.fetchSvc.route`/rest/api/3/project/search?${t.map(c=>"id="+c).join("&")}`;return(e=await this.fetchSvc.fetch({method:"GET",url:r}))==null?void 0:e.values}async projectSearchByKeys(t){var e;if(t.length>50)throw new Error("Too many project keys, max allowed is 50.");const r=this.fetchSvc.route`/rest/api/3/project/search?${t.map(c=>"key="+c).join("&")}`;return(e=await this.fetchSvc.fetch({method:"GET",url:r}))==null?void 0:e.values}async getProjectIssueTypes(t){return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetype/project?projectId=${t}`})||[]}getProjectStatuses(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/statuses`})}async getProjectProperty(t,r){try{return(await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/properties/${r}`})).value}catch(e){if(e instanceof o.FetchError&&e.statusCode===404)return;throw e}}setProjectProperty(t,r,e){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/project/${t}/properties/${r}`},e)}};h.projectUrl="/rest/api/3/project";let s=h;exports.JiraProjectService=s;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("../../../../../../../shared/util-fetch/src/lib/shared-util-fetch/index.cjs.js"),h=class h{constructor(t){this.fetchSvc=t}getVersions(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/versions`})}getProject(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}`})}async getAllProjects(){return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project`})||[]}async projectSearchByIds(t){var e;if(t.length>50)throw new Error("Too many project ids, max allowed is 50.");const r=this.fetchSvc.route`/rest/api/3/project/search?${t.map(c=>"id="+c).join("&")}`;return(e=await this.fetchSvc.fetch({method:"GET",url:r}))==null?void 0:e.values}async projectSearchByKeys(t){var e;if(t.length>50)throw new Error("Too many project keys, max allowed is 50.");const r=this.fetchSvc.route`/rest/api/3/project/search?${t.map(c=>"key="+c).join("&")}`;return(e=await this.fetchSvc.fetch({method:"GET",url:r}))==null?void 0:e.values}async projectSearchByQuery(t){var c;const r=new URLSearchParams({query:t}),e=this.fetchSvc.route`/rest/api/3/project/search?${r}`;return(c=await this.fetchSvc.fetch({method:"GET",url:e}))==null?void 0:c.values}async getProjectIssueTypes(t){return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetype/project?projectId=${t}`})||[]}getProjectStatuses(t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/statuses`})}async getProjectProperty(t,r){try{return(await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/project/${t}/properties/${r}`})).value}catch(e){if(e instanceof o.FetchError&&e.statusCode===404)return;throw e}}setProjectProperty(t,r,e){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/project/${t}/properties/${r}`},e)}};h.projectUrl="/rest/api/3/project";let s=h;exports.JiraProjectService=s;

package/atlassian/jira/shared/data-access-project/src/lib/jira-project-service/index.es.js

@@ -44,6 +44,14 @@ const s = class s {
       url: r
     })) == null ? void 0 : e.values;
   }
+  async projectSearchByQuery(t) {
+    var c;
+    const r = new URLSearchParams({ query: t }), e = this.fetchSvc.route`/rest/api/3/project/search?${r}`;
+    return (c = await this.fetchSvc.fetch({
+      method: "GET",
+      url: e
+    })) == null ? void 0 : c.values;
+  }
   async getProjectIssueTypes(t) {
     return await this.fetchSvc.fetch({
       method: "GET",

package/data-access-project/atlassian-app-data-access-project.api.json

@@ -715,6 +715,68 @@
               "isAbstract": false,
               "name": "projectSearchByKeys"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app!JiraProjectService#projectSearchByQuery:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "projectSearchByQuery(query: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Project",
+                  "canonicalReference": "@valiantys/atlassian-app!~Project:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "query",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "projectSearchByQuery"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@valiantys/atlassian-app!JiraProjectService.projectUrl:member",

package/data-access-project/atlassian-app.api.md

@@ -31,6 +31,8 @@ export class JiraProjectService {
     // (undocumented)
     projectSearchByKeys(projectKeys: string[]): Promise<Project[]>;
     // (undocumented)
+    projectSearchByQuery(query: string): Promise<Project[]>;
+    // (undocumented)
     static readonly projectUrl = "/rest/api/3/project";
     // (undocumented)
     setProjectProperty<T>(projectIdOrKey: string, propertyKey: string, value: T): Promise<T>;

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

@@ -53,6 +53,7 @@ export declare class JiraProjectService {
     getAllProjects(): Promise<Project[]>;
     projectSearchByIds(projectIds: string[]): Promise<Project[]>;
     projectSearchByKeys(projectKeys: string[]): Promise<Project[]>;
+    projectSearchByQuery(query: string): Promise<Project[]>;
     getProjectIssueTypes(projectId: string): Promise<IssueTypeDetails[]>;
     getProjectStatuses(projectIdOrKey: string): Promise<unknown>;
     getProjectProperty<T>(projectIdOrKey: string, propertyKey: string): Promise<T | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app",
-  "version": "3.2.0-alpha-18",
+  "version": "3.2.0-alpha-20",
   "description": "This library provides Atlassian Forge components, wrappers, and utilities to support writing Forge apps that can run deployed or in standalone mode",
   "exports": {
     "./frontend-app": {
@@ -178,6 +178,11 @@
       "require": "./ui-forge-feature-flags/index.cjs.js",
       "types": "./ui-forge-feature-flags/index.d.ts"
     },
+    "./ui-debounce-hook": {
+      "import": "./ui-debounce-hook/index.es.js",
+      "require": "./ui-debounce-hook/index.cjs.js",
+      "types": "./ui-debounce-hook/index.d.ts"
+    },
     "./ui-drop-target": {
       "import": "./ui-drop-target/index.es.js",
       "require": "./ui-drop-target/index.cjs.js",

package/shared/frontend-ui-debounce-hook/src/lib/shared-frontend-ui-debounce-hook/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("lodash/debounce"),u=require("react");function o(n,r=600){const e=u.useRef();return u.useEffect(()=>{e.current=n},[n]),u.useMemo(()=>c(()=>{var t;(t=e.current)==null||t.call(e)},r),[r])}exports.useDebounce=o;

package/shared/frontend-ui-debounce-hook/src/lib/shared-frontend-ui-debounce-hook/index.es.js

@@ -0,0 +1,14 @@
+import o from "lodash/debounce";
+import { useRef as t, useEffect as c, useMemo as f } from "react";
+function i(u, n = 600) {
+  const e = t();
+  return c(() => {
+    e.current = u;
+  }, [u]), f(() => o(() => {
+    var r;
+    (r = e.current) == null || r.call(e);
+  }, n), [n]);
+}
+export {
+  i as useDebounce
+};

package/ui-debounce-hook/atlassian-app-ui-debounce-hook.api.json

@@ -0,0 +1,248 @@
+{
+  "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!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app!useDebounce:function(1)",
+          "docComment": "/**\n * Debounce calls to a function on some change.\n *\n * @param callback - The function to call after the debounce time has elapsed.\n *\n * @param wait - How many seconds to wait before invoking callback.  @return A wrapped version of the callback function that will handle the details of debouncing. You may call this wrapper on every change.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useDebounce(callback: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => void"
+            },
+            {
+              "kind": "Content",
+              "text": ", wait?: "
+            },
+            {
+              "kind": "Content",
+              "text": "number"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "import('lodash')."
+            },
+            {
+              "kind": "Reference",
+              "text": "DebouncedFunc",
+              "canonicalReference": "@types/lodash!\"\\\"../index\\\"\".DebouncedFunc:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<() => void>"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../../shared/frontend-ui-debounce-hook/src/lib/shared-frontend-ui-debounce-hook.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "callback",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "wait",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "useDebounce"
+        }
+      ]
+    }
+  ]
+}

package/ui-debounce-hook/atlassian-app.api.md

@@ -0,0 +1,14 @@
+## 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 { DebouncedFunc } from 'lodash';
+
+// @public
+export function useDebounce(callback: () => void, wait?: number): DebouncedFunc<() => void>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/ui-debounce-hook/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../shared/frontend-ui-debounce-hook/src/lib/shared-frontend-ui-debounce-hook/index.cjs.js");exports.useDebounce=e.useDebounce;

package/ui-debounce-hook/index.d.ts

@@ -0,0 +1,16 @@
+import { DebouncedFunc } from 'lodash';
+
+/**
+ * This hook is taken from an example by Nadia Makarevich:
+ * https://www.developerway.com/posts/debouncing-in-react
+ */
+/**
+ * Debounce calls to a function on some change.
+ * @param callback The function to call after the debounce time has elapsed.
+ * @param wait How many seconds to wait before invoking callback.
+ * @return A wrapped version of the callback function that will handle the details
+ * of debouncing. You may call this wrapper on every change.
+ */
+export declare function useDebounce(callback: () => void, wait?: number): DebouncedFunc<() => void>;
+
+export { }

package/ui-debounce-hook/index.es.js

@@ -0,0 +1,4 @@
+import { useDebounce as r } from "../shared/frontend-ui-debounce-hook/src/lib/shared-frontend-ui-debounce-hook/index.es.js";
+export {
+  r as useDebounce
+};

package/ui-debounce-hook/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"
+    }
+  ]
+}