@atlaskit/editor-card-provider 3.0.1 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @atlaskit/editor-card-provider
2
2
 
3
+ ## 3.0.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
8
+ - Updated dependencies
9
+
3
10
  ## 3.0.1
4
11
 
5
12
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-card-provider",
3
- "version": "3.0.1",
3
+ "version": "3.0.2",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-card-provider",
3
- "version": "3.0.1",
3
+ "version": "3.0.2",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-card-provider",
3
- "version": "3.0.1",
3
+ "version": "3.0.2",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,5 @@
1
+ import { JsonLd } from 'json-ld-types';
2
+ export declare class NetworkError extends Error {
3
+ constructor(error: any);
4
+ }
5
+ export declare function request<T = JsonLd.Response>(method: string, url: string, data?: any, headers?: HeadersInit): Promise<T>;
@@ -0,0 +1,13 @@
1
+ export type EnvironmentsKeys = keyof typeof BaseUrls;
2
+ export declare const BaseUrls: {
3
+ dev: string;
4
+ development: string;
5
+ stg: string;
6
+ staging: string;
7
+ prd: string;
8
+ prod: string;
9
+ production: string;
10
+ };
11
+ export declare const getBaseUrl: (envKey?: keyof typeof BaseUrls) => string;
12
+ export declare const getResolverUrl: (envKey?: EnvironmentsKeys, baseUrlOverride?: string) => string;
13
+ export default BaseUrls;
@@ -0,0 +1 @@
1
+ export { EditorCardProvider, editorCardProvider } from './provider';
@@ -0,0 +1,32 @@
1
+ import 'setimmediate';
2
+ import { CardAdf, CardAppearance } from '@atlaskit/linking-common';
3
+ import { CardProvider } from './types';
4
+ import { EnvironmentsKeys } from './environments';
5
+ export declare class EditorCardProvider implements CardProvider {
6
+ private baseUrl;
7
+ private resolverUrl;
8
+ private providersData?;
9
+ private requestHeaders;
10
+ private transformer;
11
+ private providersLoader;
12
+ private cardClient;
13
+ constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string);
14
+ private batchProviders;
15
+ private check;
16
+ private fetchProvidersData;
17
+ private loadProviderData;
18
+ findPattern(url: string): Promise<boolean>;
19
+ private doesUrlMatchPath;
20
+ private findUserPreference;
21
+ private findPatternData;
22
+ private getHardCodedAppearance;
23
+ /**
24
+ * Make a /resolve call and find out if result has embed capability
25
+ * @param url
26
+ * @private
27
+ */
28
+ private canBeResolvedAsEmbed;
29
+ resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<CardAdf>;
30
+ }
31
+ export declare const editorCardProvider: EditorCardProvider;
32
+ export type { CardProvider } from './types';
@@ -0,0 +1,7 @@
1
+ import { CardAppearance, CardAdf } from '@atlaskit/linking-common';
2
+ export declare class Transformer {
3
+ private buildInlineAdf;
4
+ private buildBlockAdf;
5
+ private buildEmbedAdf;
6
+ toAdf(url: string, appearance: CardAppearance): CardAdf;
7
+ }
@@ -0,0 +1,34 @@
1
+ import { CardAppearance } from '@atlaskit/linking-common';
2
+ export interface CardProvider {
3
+ resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
4
+ }
5
+ export type ORSCheckResponse = {
6
+ isSupported: boolean;
7
+ };
8
+ type DisplayViews = 'inline' | 'block' | 'embed';
9
+ export type ProviderPattern = {
10
+ source: string;
11
+ supportedViews?: DisplayViews[];
12
+ defaultView?: DisplayViews;
13
+ };
14
+ type Provider = {
15
+ key: string;
16
+ patterns: ProviderPattern[];
17
+ };
18
+ export type LinkAppearance = CardAppearance | 'url';
19
+ export interface UserPreferences {
20
+ defaultAppearance: LinkAppearance;
21
+ appearances: {
22
+ urlSegment: string;
23
+ appearance: LinkAppearance;
24
+ }[];
25
+ }
26
+ export type ORSProvidersResponse = {
27
+ providers: Provider[];
28
+ userPreferences?: UserPreferences;
29
+ };
30
+ export interface ProvidersData {
31
+ patterns: ProviderPattern[];
32
+ userPreferences?: UserPreferences;
33
+ }
34
+ export {};
@@ -0,0 +1,3 @@
1
+ import { JsonLd } from 'json-ld-types';
2
+ import { CardType } from '@atlaskit/linking-common';
3
+ export declare const getStatus: ({ meta }: JsonLd.Response) => CardType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-card-provider",
3
- "version": "3.0.1",
3
+ "version": "3.0.2",
4
4
  "description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -34,14 +34,14 @@
34
34
  ".": "./src/index.ts"
35
35
  },
36
36
  "dependencies": {
37
- "@atlaskit/linking-common": "^2.9.0",
37
+ "@atlaskit/linking-common": "^2.10.0",
38
38
  "@babel/runtime": "^7.0.0",
39
39
  "dataloader": "^2.0.0",
40
40
  "json-ld-types": "3.7.0",
41
41
  "setimmediate": "^1.0.5"
42
42
  },
43
43
  "peerDependencies": {
44
- "@atlaskit/link-provider": "^1.6.1",
44
+ "@atlaskit/link-provider": "^1.6.2",
45
45
  "react": "^16.8.0"
46
46
  },
47
47
  "devDependencies": {
package/report.api.md CHANGED
@@ -69,7 +69,7 @@ type EnvironmentsKeys = keyof typeof BaseUrls;
69
69
 
70
70
  ```json
71
71
  {
72
- "@atlaskit/link-provider": "^1.6.1",
72
+ "@atlaskit/link-provider": "^1.6.2",
73
73
  "react": "^16.8.0"
74
74
  }
75
75
  ```