@atlaskit/editor-card-provider 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-card-provider
 
+## 3.0.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+- Updated dependencies
+
+## 3.0.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+- Updated dependencies
+
 ## 3.0.0
 
 ### Minor Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.0",
+	"version": "3.0.2",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.0",
+	"version": "3.0.2",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.0",
+	"version": "3.0.2",
 	"sideEffects": false
 }

package/dist/types/environments.d.ts

@@ -1,4 +1,4 @@
-export declare type EnvironmentsKeys = keyof typeof BaseUrls;
+export type EnvironmentsKeys = keyof typeof BaseUrls;
 export declare const BaseUrls: {
     dev: string;
     development: string;
@@ -8,6 +8,6 @@ export declare const BaseUrls: {
     prod: string;
     production: string;
 };
-export declare const getBaseUrl: (envKey?: "dev" | "development" | "stg" | "staging" | "prd" | "prod" | "production" | undefined) => string;
-export declare const getResolverUrl: (envKey?: "dev" | "development" | "stg" | "staging" | "prd" | "prod" | "production" | undefined, baseUrlOverride?: string | undefined) => string;
+export declare const getBaseUrl: (envKey?: keyof typeof BaseUrls) => string;
+export declare const getResolverUrl: (envKey?: EnvironmentsKeys, baseUrlOverride?: string) => string;
 export default BaseUrls;

package/dist/types/types.d.ts

@@ -2,20 +2,20 @@ import { CardAppearance } from '@atlaskit/linking-common';
 export interface CardProvider {
     resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
 }
-export declare type ORSCheckResponse = {
+export type ORSCheckResponse = {
     isSupported: boolean;
 };
-declare type DisplayViews = 'inline' | 'block' | 'embed';
-export declare type ProviderPattern = {
+type DisplayViews = 'inline' | 'block' | 'embed';
+export type ProviderPattern = {
     source: string;
     supportedViews?: DisplayViews[];
     defaultView?: DisplayViews;
 };
-declare type Provider = {
+type Provider = {
     key: string;
     patterns: ProviderPattern[];
 };
-export declare type LinkAppearance = CardAppearance | 'url';
+export type LinkAppearance = CardAppearance | 'url';
 export interface UserPreferences {
     defaultAppearance: LinkAppearance;
     appearances: {
@@ -23,7 +23,7 @@ export interface UserPreferences {
         appearance: LinkAppearance;
     }[];
 }
-export declare type ORSProvidersResponse = {
+export type ORSProvidersResponse = {
     providers: Provider[];
     userPreferences?: UserPreferences;
 };

package/dist/types-ts4.5/api.d.ts

@@ -0,0 +1,5 @@
+import { JsonLd } from 'json-ld-types';
+export declare class NetworkError extends Error {
+    constructor(error: any);
+}
+export declare function request<T = JsonLd.Response>(method: string, url: string, data?: any, headers?: HeadersInit): Promise<T>;

package/dist/types-ts4.5/environments.d.ts

@@ -0,0 +1,13 @@
+export type EnvironmentsKeys = keyof typeof BaseUrls;
+export declare const BaseUrls: {
+    dev: string;
+    development: string;
+    stg: string;
+    staging: string;
+    prd: string;
+    prod: string;
+    production: string;
+};
+export declare const getBaseUrl: (envKey?: keyof typeof BaseUrls) => string;
+export declare const getResolverUrl: (envKey?: EnvironmentsKeys, baseUrlOverride?: string) => string;
+export default BaseUrls;

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

@@ -0,0 +1 @@
+export { EditorCardProvider, editorCardProvider } from './provider';

package/dist/types-ts4.5/provider.d.ts

@@ -0,0 +1,32 @@
+import 'setimmediate';
+import { CardAdf, CardAppearance } from '@atlaskit/linking-common';
+import { CardProvider } from './types';
+import { EnvironmentsKeys } from './environments';
+export declare class EditorCardProvider implements CardProvider {
+    private baseUrl;
+    private resolverUrl;
+    private providersData?;
+    private requestHeaders;
+    private transformer;
+    private providersLoader;
+    private cardClient;
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string);
+    private batchProviders;
+    private check;
+    private fetchProvidersData;
+    private loadProviderData;
+    findPattern(url: string): Promise<boolean>;
+    private doesUrlMatchPath;
+    private findUserPreference;
+    private findPatternData;
+    private getHardCodedAppearance;
+    /**
+     * Make a /resolve call and find out if result has embed capability
+     * @param url
+     * @private
+     */
+    private canBeResolvedAsEmbed;
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<CardAdf>;
+}
+export declare const editorCardProvider: EditorCardProvider;
+export type { CardProvider } from './types';

package/dist/types-ts4.5/transformer.d.ts

@@ -0,0 +1,7 @@
+import { CardAppearance, CardAdf } from '@atlaskit/linking-common';
+export declare class Transformer {
+    private buildInlineAdf;
+    private buildBlockAdf;
+    private buildEmbedAdf;
+    toAdf(url: string, appearance: CardAppearance): CardAdf;
+}

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

@@ -0,0 +1,34 @@
+import { CardAppearance } from '@atlaskit/linking-common';
+export interface CardProvider {
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
+}
+export type ORSCheckResponse = {
+    isSupported: boolean;
+};
+type DisplayViews = 'inline' | 'block' | 'embed';
+export type ProviderPattern = {
+    source: string;
+    supportedViews?: DisplayViews[];
+    defaultView?: DisplayViews;
+};
+type Provider = {
+    key: string;
+    patterns: ProviderPattern[];
+};
+export type LinkAppearance = CardAppearance | 'url';
+export interface UserPreferences {
+    defaultAppearance: LinkAppearance;
+    appearances: {
+        urlSegment: string;
+        appearance: LinkAppearance;
+    }[];
+}
+export type ORSProvidersResponse = {
+    providers: Provider[];
+    userPreferences?: UserPreferences;
+};
+export interface ProvidersData {
+    patterns: ProviderPattern[];
+    userPreferences?: UserPreferences;
+}
+export {};

package/dist/types-ts4.5/utils.d.ts

@@ -0,0 +1,3 @@
+import { JsonLd } from 'json-ld-types';
+import { CardType } from '@atlaskit/linking-common';
+export declare const getStatus: ({ meta }: JsonLd.Response) => CardType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-card-provider",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -20,25 +20,33 @@
   "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"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/linking-common": "^2.8.0",
+    "@atlaskit/linking-common": "^2.10.0",
     "@babel/runtime": "^7.0.0",
     "dataloader": "^2.0.0",
     "json-ld-types": "3.7.0",
     "setimmediate": "^1.0.5"
   },
   "peerDependencies": {
-    "@atlaskit/link-provider": "^1.6.0",
+    "@atlaskit/link-provider": "^1.6.2",
     "react": "^16.8.0"
   },
   "devDependencies": {
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
-    "typescript": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
 }

package/report.api.md

@@ -69,7 +69,7 @@ type EnvironmentsKeys = keyof typeof BaseUrls;
 
 ```json
 {
-  "@atlaskit/link-provider": "^1.6.0",
+  "@atlaskit/link-provider": "^1.6.2",
   "react": "^16.8.0"
 }
 ```

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

@@ -0,0 +1,44 @@
+## API Report File for "@atlaskit/editor-card-provider"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CardAdf } from '@atlaskit/linking-common';
+import { CardAppearance } from '@atlaskit/linking-common';
+
+// @public (undocumented)
+const BaseUrls: {
+    dev: string;
+    development: string;
+    stg: string;
+    staging: string;
+    prd: string;
+    prod: string;
+    production: string;
+};
+
+// @public (undocumented)
+interface CardProvider {
+    // (undocumented)
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
+}
+
+// @public (undocumented)
+export class EditorCardProvider implements CardProvider {
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string);
+    // (undocumented)
+    findPattern(url: string): Promise<boolean>;
+    // (undocumented)
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<CardAdf>;
+}
+
+// @public (undocumented)
+export const editorCardProvider: EditorCardProvider;
+
+// @public (undocumented)
+type EnvironmentsKeys = keyof typeof BaseUrls;
+
+// (No @packageDocumentation comment for this package)
+
+```