@valiantys/atlassian-app-frontend 3.0.0-alpha-10 → 3.0.0-alpha-17

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

@@ -483,6 +483,84 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianProxyFetchRequest:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AtlassianProxyFetchRequest "
+            }
+          ],
+          "fileUrlPath": "../../shared/util-atlassian-product-fetch/src/lib/atlassian-product-fetch-service.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianProxyFetchRequest",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianProxyFetchRequest#body:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "body?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "body",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianProxyFetchRequest#request:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "request: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FetchRequest",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!FetchRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "request",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@valiantys/atlassian-app-frontend!bearerAuthFetch:function(1)",
@@ -769,11 +847,11 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", statusCode?: "
+                  "text": ", statusCode: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -806,7 +884,7 @@
                     "startIndex": 3,
                     "endIndex": 4
                   },
-                  "isOptional": true
+                  "isOptional": false
                 },
                 {
                   "parameterName": "message",
@@ -825,11 +903,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly statusCode?: "
+                  "text": "readonly statusCode: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -837,7 +915,7 @@
                 }
               ],
               "isReadonly": true,
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "statusCode",
               "propertyTypeTokenRange": {
@@ -889,7 +967,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        statusCode: number | undefined;\n        statusText: string;\n    }"
+                  "text": "{\n        statusCode: number;\n        statusText: string;\n    }"
                 },
                 {
                   "kind": "Content",
@@ -1116,16 +1194,7 @@
             },
             {
               "kind": "Content",
-              "text": ", body?: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Record",
-              "canonicalReference": "!Record:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<string, any>) => "
+              "text": ", body?: any) => "
             },
             {
               "kind": "Reference",
@@ -1146,7 +1215,7 @@
           "name": "FetchSignature",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 8
+            "endIndex": 6
           }
         },
         {
@@ -1213,6 +1282,15 @@
               "kind": "Content",
               "text": "'json' | 'text'"
             },
+            {
+              "kind": "Content",
+              "text": ", includeCredentials?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RequestCredentials",
+              "canonicalReference": "!RequestCredentials:type"
+            },
             {
               "kind": "Content",
               "text": "): "
@@ -1233,8 +1311,8 @@
           ],
           "fileUrlPath": "../../../shared/util-fetch/src/lib/shared-util-fetch.d.ts",
           "returnTypeTokenRange": {
-            "startIndex": 15,
-            "endIndex": 17
+            "startIndex": 17,
+            "endIndex": 19
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -1278,6 +1356,14 @@
                 "endIndex": 14
               },
               "isOptional": true
+            },
+            {
+              "parameterName": "includeCredentials",
+              "parameterTypeTokenRange": {
+                "startIndex": 15,
+                "endIndex": 16
+              },
+              "isOptional": true
             }
           ],
           "typeParameters": [

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

@@ -26,6 +26,14 @@ export interface AtlassianProductFetchService<P extends Product> {
     route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
 }
 
+// @public (undocumented)
+export interface AtlassianProxyFetchRequest {
+    // (undocumented)
+    body?: Record<string, any>;
+    // (undocumented)
+    request: FetchRequest;
+}
+
 // @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>;
 
@@ -34,14 +42,14 @@ export function bearerAuthFetchRaw(authToken: string, url: string, init: Request
 
 // @public (undocumented)
 export class FetchError extends Error {
-    constructor(statusText: string, statusCode?: number | undefined, message?: string);
+    constructor(statusText: string, statusCode: number, message?: string);
     // (undocumented)
-    readonly statusCode?: number | undefined;
+    readonly statusCode: number;
     // (undocumented)
     readonly statusText: string;
     // (undocumented)
     toJSON(): {
-        statusCode: number | undefined;
+        statusCode: number;
         statusText: string;
     };
 }
@@ -67,10 +75,10 @@ export type FetchRoute = {
 };
 
 // @public (undocumented)
-export type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+export type FetchSignature = <T>(request: FetchRequest, body?: 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>;
+export function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text', includeCredentials?: RequestCredentials): Promise<T>;
 
 // @public (undocumented)
 export interface PagedResponseValues<T> {

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

@@ -12,16 +12,21 @@ export declare interface AtlassianProductFetchService<P extends Product> {
     fullUrl: (path: string) => string;
 }
 
+export declare interface AtlassianProxyFetchRequest {
+    request: FetchRequest;
+    body?: Record<string, any>;
+}
+
 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);
+    readonly statusCode: number;
+    constructor(statusText: string, statusCode: number, message?: string);
     toJSON(): {
-        statusCode: number | undefined;
+        statusCode: number;
         statusText: string;
     };
 }
@@ -39,9 +44,9 @@ export declare type FetchRoute = {
     readonly value: string;
 };
 
-export declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+export declare type FetchSignature = <T>(request: FetchRequest, body?: 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 function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text', includeCredentials?: RequestCredentials): Promise<T>;
 
 export declare interface PagedResponseValues<T> {
     startAt: number;