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

package/util-atlassian-product-fetch/atlassian-app-frontend.api.md

@@ -0,0 +1,97 @@
+## 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 function addAuthHeader(authToken: string, headers: HeadersInit): {
+    Authorization: string;
+};
+
+// @public (undocumented)
+export type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+// @public (undocumented)
+export interface AtlassianProductFetchService<P extends Product> {
+    // (undocumented)
+    fetch: FetchSignature;
+    // (undocumented)
+    fullUrl: (path: string) => string;
+    // (undocumented)
+    productType: P;
+    // (undocumented)
+    rawFetch: RequestProductMethod;
+    // (undocumented)
+    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
+}
+
+// @public (undocumented)
+export function bearerAuthFetch<T>(authToken: string, url: string, method: FetchMethod, body?: Record<string, unknown>, responseType?: 'json' | 'text', headers?: Record<string, string>): Promise<T>;
+
+// @public (undocumented)
+export function bearerAuthFetchRaw(authToken: string, url: string, init: RequestInit): Promise<Response>;
+
+// @public (undocumented)
+export class FetchError extends Error {
+    constructor(statusText: string, statusCode?: number | undefined, message?: string);
+    // (undocumented)
+    readonly statusCode?: number | undefined;
+    // (undocumented)
+    readonly statusText: string;
+    // (undocumented)
+    toJSON(): {
+        statusCode: number | undefined;
+        statusText: string;
+    };
+}
+
+// @public (undocumented)
+export type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+// @public (undocumented)
+export interface FetchRequest {
+    // (undocumented)
+    allowExperimental?: boolean;
+    // (undocumented)
+    method: FetchMethod;
+    // (undocumented)
+    responseType?: 'json' | 'text';
+    // (undocumented)
+    url: FetchRoute;
+}
+
+// @public (undocumented)
+export type FetchRoute = {
+    readonly value: string;
+};
+
+// @public (undocumented)
+export type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+
+// @public (undocumented)
+export function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text'): Promise<T>;
+
+// @public (undocumented)
+export interface PagedResponseValues<T> {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: T[];
+}
+
+// @public (undocumented)
+export type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+// @public (undocumented)
+export type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/util-atlassian-product-fetch/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../shared/util-fetch/src/lib/shared-util-fetch/index.cjs.js");exports.FetchError=e.FetchError;exports.addAuthHeader=e.addAuthHeader;exports.bearerAuthFetch=e.bearerAuthFetch;exports.bearerAuthFetchRaw=e.bearerAuthFetchRaw;exports.jsonFetch=e.jsonFetch;

package/util-atlassian-product-fetch/index.d.ts

@@ -0,0 +1,58 @@
+export declare function addAuthHeader(authToken: string, headers: HeadersInit): {
+    Authorization: string;
+};
+
+export declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+export 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 bearerAuthFetch<T>(authToken: string, url: string, method: FetchMethod, body?: Record<string, unknown>, responseType?: 'json' | 'text', headers?: Record<string, string>): Promise<T>;
+
+export declare function bearerAuthFetchRaw(authToken: string, url: string, init: RequestInit): Promise<Response>;
+
+export declare class FetchError extends Error {
+    readonly statusText: string;
+    readonly statusCode?: number | undefined;
+    constructor(statusText: string, statusCode?: number | undefined, message?: string);
+    toJSON(): {
+        statusCode: number | undefined;
+        statusText: string;
+    };
+}
+
+export declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+export declare interface FetchRequest {
+    method: FetchMethod;
+    url: FetchRoute;
+    responseType?: 'json' | 'text';
+    allowExperimental?: boolean;
+}
+
+export declare type FetchRoute = {
+    readonly value: string;
+};
+
+export declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+
+export declare function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text'): Promise<T>;
+
+export declare interface PagedResponseValues<T> {
+    startAt: number;
+    maxResults: number;
+    total: number;
+    isLast: boolean;
+    values: T[];
+}
+
+export declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+export declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+export { }

package/util-atlassian-product-fetch/index.es.js

@@ -0,0 +1,8 @@
+import { FetchError as t, addAuthHeader as h, bearerAuthFetch as a, bearerAuthFetchRaw as c, jsonFetch as o } from "../shared/util-fetch/src/lib/shared-util-fetch/index.es.js";
+export {
+  t as FetchError,
+  h as addAuthHeader,
+  a as bearerAuthFetch,
+  c as bearerAuthFetchRaw,
+  o as jsonFetch
+};

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