@atlaskit/util-service-support 6.2.0 → 6.2.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/util-service-support
 
+## 6.2.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
+## 6.2.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 6.2.0
 
 ### Minor Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/dist/types/serviceUtils.d.ts

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

package/dist/types/types.d.ts

@@ -53,7 +53,7 @@ export interface SecurityOptions {
     headers?: KeyValues;
     omitCredentials?: boolean;
 }
-export declare const buildCredentials: (secOptions?: SecurityOptions | undefined) => "omit" | "include";
+export declare const buildCredentials: (secOptions?: SecurityOptions) => "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.

package/dist/types-ts4.5/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.5/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.5/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) => Promise<T>;

package/dist/types-ts4.5/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) => "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.2.0",
+  "version": "6.2.2",
   "description": "A library of support classes for integrating React components with REST HTTP services",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "deprecatedAutoEntryPoints": true,
@@ -30,7 +38,7 @@
     "es6-promise": "^4.0.5",
     "fetch-mock": "^8.0.0",
     "sinon": "^2.2.0",
-    "typescript": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "keywords": [
     "fabric",

package/report.api.md

@@ -37,7 +37,7 @@ export abstract class AbstractResource<Q, R, E, I, O>
 
 // @public (undocumented)
 export const buildCredentials: (
-  secOptions?: SecurityOptions | undefined,
+  secOptions?: SecurityOptions,
 ) => 'include' | 'omit';
 
 // @public (undocumented)
@@ -72,7 +72,7 @@ export interface RefreshSecurityProvider {
 // @public (undocumented)
 const requestService: <T>(
   serviceConfig: ServiceConfig,
-  options?: RequestServiceOptions | undefined,
+  options?: RequestServiceOptions,
 ) => Promise<T>;
 
 // @public (undocumented)

package/serviceResources/package.json

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

package/serviceUtils/package.json

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

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,109 @@
+## API Report File for "@atlaskit/util-service-support"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export abstract class AbstractResource<Q, R, E, I, O> implements Provider<Q, R, E, I, O> {
+    // (undocumented)
+    abstract filter(query?: Q, options?: O): 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;
+}
+
+// @public (undocumented)
+export const buildCredentials: (secOptions?: SecurityOptions) => "include" | "omit";
+
+// @public (undocumented)
+export interface KeyValues {
+    // (undocumented)
+    [index: string]: any;
+}
+
+// @public (undocumented)
+export interface OnProviderChange<R, E, I> {
+    error?(error: E): void;
+    info?(info: I): void;
+    notReady?(): void;
+    result(result: R): void;
+}
+
+// @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;
+}
+
+// @public
+export interface RefreshSecurityProvider {
+    // (undocumented)
+    (): Promise<SecurityOptions>;
+}
+
+// @public (undocumented)
+const requestService: <T>(serviceConfig: ServiceConfig, options?: RequestServiceOptions) => Promise<T>;
+
+// @public (undocumented)
+export interface RequestServiceOptions {
+    // (undocumented)
+    ignoreResponsePayload?: boolean;
+    // (undocumented)
+    path?: string;
+    // (undocumented)
+    queryParams?: KeyValues;
+    // (undocumented)
+    requestInit?: RequestInit;
+}
+
+// @public (undocumented)
+export interface SecurityOptions {
+    // (undocumented)
+    headers?: KeyValues;
+    // (undocumented)
+    omitCredentials?: boolean;
+    // (undocumented)
+    params?: KeyValues;
+}
+
+// @public
+export interface SecurityProvider {
+    // (undocumented)
+    (): SecurityOptions;
+}
+
+// @public (undocumented)
+export interface ServiceConfig {
+    // (undocumented)
+    refreshedSecurityProvider?: RefreshSecurityProvider;
+    // (undocumented)
+    securityProvider?: SecurityProvider;
+    // (undocumented)
+    url: string;
+}
+
+declare namespace serviceUtils {
+    export {
+        requestService
+    }
+}
+
+// @public (undocumented)
+export const utils: typeof serviceUtils;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/types/package.json

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