@atlaskit/util-service-support 6.1.2 → 6.1.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/util-service-support
 
+## 6.1.3
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 6.1.2
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.1.2"
+	"version": "6.1.3"
 }

package/dist/es2019/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.1.2"
+	"version": "6.1.3"
 }

package/dist/esm/version.json

@@ -1,4 +1,4 @@
 {
 	"name": "@atlaskit/util-service-support",
-	"version": "6.1.2"
+	"version": "6.1.3"
 }

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './serviceResources';
+import * as serviceUtils from './serviceUtils';
+export declare const utils: typeof serviceUtils;

package/dist/types-ts4.0/serviceResources.d.ts

@@ -0,0 +1,12 @@
+import { OnProviderChange, Provider } from './types';
+export declare abstract class AbstractResource<Q, R, E, I, O> implements Provider<Q, R, E, I, O> {
+    private lastResult;
+    private listeners;
+    abstract filter(query?: Q, options?: O): void;
+    subscribe(onChange: OnProviderChange<R, E, I>): void;
+    unsubscribe(onChange: OnProviderChange<R, E, I>): void;
+    protected notifyResult(result: R): void;
+    protected notifyError(error: E): void;
+    protected notifyInfo(info: I): void;
+    protected notifyNotReady(): void;
+}

package/dist/types-ts4.0/serviceUtils.d.ts

@@ -0,0 +1,5 @@
+import { RequestServiceOptions, ServiceConfig } from './types';
+/**
+ * @returns Promise containing the json response
+ */
+export declare const requestService: <T>(serviceConfig: ServiceConfig, options?: RequestServiceOptions | undefined) => Promise<T>;

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,80 @@
+export interface OnProviderChange<R, E, I> {
+    /**
+     * Normal callback on a search result, or updated search result.
+     */
+    result(result: R): void;
+    /**
+     * When something goes wrong, e.g. underlying service is not available.
+     */
+    error?(error: E): void;
+    /**
+     * Information to display, e.g. due to slow searches, initial message, etc.
+     */
+    info?(info: I): void;
+    /**
+     * Notifies if the Resource is not ready and won't respond to searches
+     * in a timely manner. Note searches that occur while not ready Will
+     * eventually be fulfilled.
+     */
+    notReady?(): void;
+}
+/**
+ * Defines a typical Resource.
+ *
+ * Q = query type
+ * R = result type
+ * E = error type
+ * I = info type
+ * O = options that filter can accept
+ */
+export interface Provider<Q, R, E, I, O> {
+    /**
+     * Results are returned to the OnSearchResult
+     * in the subscriber.
+     *
+     * There may not be a 1-on-1 relationship between a search
+     * and a callback.
+     *
+     * For example, multiple queries may result in one callback if the
+     * responses are out of order (i.e. old responses are dropped). Or
+     * multiple callbacks may be fired, for example if the underlying data
+     * set to search has changed, the last search may be executed again
+     * with updated results.
+     */
+    filter(query?: Q, options?: O): void;
+    subscribe(onChange: OnProviderChange<R, E, I>): void;
+    unsubscribe(onChange: OnProviderChange<R, E, I>): void;
+}
+export interface KeyValues {
+    [index: string]: any;
+}
+export interface SecurityOptions {
+    params?: KeyValues;
+    headers?: KeyValues;
+    omitCredentials?: boolean;
+}
+export declare const buildCredentials: (secOptions?: SecurityOptions | undefined) => "omit" | "include";
+/**
+ * Returns a promise to a SecurityOptions that has just been forcibly refreshed with a
+ * new token. Will be used for single retry per request if a 401 is returned.
+ */
+export interface RefreshSecurityProvider {
+    (): Promise<SecurityOptions>;
+}
+/**
+ * Returns the current SecurityOptions for the mentions service.
+ */
+export interface SecurityProvider {
+    (): SecurityOptions;
+}
+export interface ServiceConfig {
+    url: string;
+    securityProvider?: SecurityProvider;
+    refreshedSecurityProvider?: RefreshSecurityProvider;
+}
+export interface RequestServiceOptions {
+    path?: string;
+    queryParams?: KeyValues;
+    requestInit?: RequestInit;
+    ignoreResponsePayload?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/util-service-support",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "description": "A library of support classes for integrating React components with REST HTTP services",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "deprecatedAutoEntryPoints": true,
@@ -30,7 +37,7 @@
     "es6-promise": "^4.0.5",
     "fetch-mock": "^8.0.0",
     "sinon": "^2.2.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "keywords": [
     "fabric",

package/report.api.md

@@ -1,127 +1,117 @@
-## API Report File for "@atlaskit/util-service-support".
+## API Report File for "@atlaskit/util-service-support"
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+<!--
+	Generated API Report version: 2.0
+-->
 
 [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ```ts
-export declare abstract class AbstractResource<Q, R, E, I, O>
+// @public (undocumented)
+export abstract class AbstractResource<Q, R, E, I, O>
   implements Provider<Q, R, E, I, O> {
-  private lastResult;
-  private listeners;
+  // (undocumented)
   abstract filter(query?: Q, options?: O): void;
-  subscribe(onChange: OnProviderChange<R, E, I>): void;
-  unsubscribe(onChange: OnProviderChange<R, E, I>): void;
-  protected notifyResult(result: R): void;
+  // (undocumented)
   protected notifyError(error: E): void;
+  // (undocumented)
   protected notifyInfo(info: I): void;
+  // (undocumented)
   protected notifyNotReady(): void;
+  // (undocumented)
+  protected notifyResult(result: R): void;
+  // (undocumented)
+  subscribe(onChange: OnProviderChange<R, E, I>): void;
+  // (undocumented)
+  unsubscribe(onChange: OnProviderChange<R, E, I>): void;
 }
 
-export declare const buildCredentials: (
+// @public (undocumented)
+export const buildCredentials: (
   secOptions?: SecurityOptions | undefined,
 ) => 'omit' | 'include';
 
-export declare interface KeyValues {
+// @public (undocumented)
+export interface KeyValues {
+  // (undocumented)
   [index: string]: any;
 }
 
-export declare interface OnProviderChange<R, E, I> {
-  /**
-   * Normal callback on a search result, or updated search result.
-   */
-  result(result: R): void;
-  /**
-   * When something goes wrong, e.g. underlying service is not available.
-   */
+// @public (undocumented)
+export interface OnProviderChange<R, E, I> {
   error?(error: E): void;
-  /**
-   * Information to display, e.g. due to slow searches, initial message, etc.
-   */
   info?(info: I): void;
-  /**
-   * Notifies if the Resource is not ready and won't respond to searches
-   * in a timely manner. Note searches that occur while not ready Will
-   * eventually be fulfilled.
-   */
   notReady?(): void;
+  result(result: R): void;
 }
 
-/**
- * Defines a typical Resource.
- *
- * Q = query type
- * R = result type
- * E = error type
- * I = info type
- * O = options that filter can accept
- */
-export declare interface Provider<Q, R, E, I, O> {
-  /**
-   * Results are returned to the OnSearchResult
-   * in the subscriber.
-   *
-   * There may not be a 1-on-1 relationship between a search
-   * and a callback.
-   *
-   * For example, multiple queries may result in one callback if the
-   * responses are out of order (i.e. old responses are dropped). Or
-   * multiple callbacks may be fired, for example if the underlying data
-   * set to search has changed, the last search may be executed again
-   * with updated results.
-   */
+// @public
+export interface Provider<Q, R, E, I, O> {
   filter(query?: Q, options?: O): void;
+  // (undocumented)
   subscribe(onChange: OnProviderChange<R, E, I>): void;
+  // (undocumented)
   unsubscribe(onChange: OnProviderChange<R, E, I>): void;
 }
 
-/**
- * Returns a promise to a SecurityOptions that has just been forcibly refreshed with a
- * new token. Will be used for single retry per request if a 401 is returned.
- */
-export declare interface RefreshSecurityProvider {
+// @public
+export interface RefreshSecurityProvider {
+  // (undocumented)
   (): Promise<SecurityOptions>;
 }
 
-/**
- * @returns Promise containing the json response
- */
-declare const requestService: <T>(
+// @public (undocumented)
+const requestService: <T>(
   serviceConfig: ServiceConfig,
   options?: RequestServiceOptions | undefined,
 ) => Promise<T>;
 
-export declare interface RequestServiceOptions {
+// @public (undocumented)
+export interface RequestServiceOptions {
+  // (undocumented)
+  ignoreResponsePayload?: boolean;
+  // (undocumented)
   path?: string;
+  // (undocumented)
   queryParams?: KeyValues;
+  // (undocumented)
   requestInit?: RequestInit;
-  ignoreResponsePayload?: boolean;
 }
 
-export declare interface SecurityOptions {
-  params?: KeyValues;
+// @public (undocumented)
+export interface SecurityOptions {
+  // (undocumented)
   headers?: KeyValues;
+  // (undocumented)
   omitCredentials?: boolean;
+  // (undocumented)
+  params?: KeyValues;
 }
 
-/**
- * Returns the current SecurityOptions for the mentions service.
- */
-export declare interface SecurityProvider {
+// @public
+export interface SecurityProvider {
+  // (undocumented)
   (): SecurityOptions;
 }
 
-export declare interface ServiceConfig {
-  url: string;
-  securityProvider?: SecurityProvider;
+// @public (undocumented)
+export interface ServiceConfig {
+  // (undocumented)
   refreshedSecurityProvider?: RefreshSecurityProvider;
+  // (undocumented)
+  securityProvider?: SecurityProvider;
+  // (undocumented)
+  url: string;
 }
 
 declare namespace serviceUtils {
   export { requestService };
 }
 
-export declare const utils: typeof serviceUtils;
+// @public (undocumented)
+export const utils: typeof serviceUtils;
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```

package/serviceResources/package.json

@@ -3,5 +3,12 @@
   "main": "../dist/cjs/serviceResources.js",
   "module": "../dist/esm/serviceResources.js",
   "module:es2019": "../dist/es2019/serviceResources.js",
-  "types": "../dist/types/serviceResources.d.ts"
+  "types": "../dist/types/serviceResources.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/serviceResources.d.ts"
+      ]
+    }
+  }
 }

package/serviceUtils/package.json

@@ -3,5 +3,12 @@
   "main": "../dist/cjs/serviceUtils.js",
   "module": "../dist/esm/serviceUtils.js",
   "module:es2019": "../dist/es2019/serviceUtils.js",
-  "types": "../dist/types/serviceUtils.d.ts"
+  "types": "../dist/types/serviceUtils.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/serviceUtils.d.ts"
+      ]
+    }
+  }
 }

package/types/package.json

@@ -3,5 +3,12 @@
   "main": "../dist/cjs/types.js",
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }