@atlaskit/node-data-provider 4.1.2 → 4.2.0

package/dist/types/plugin-hooks.d.ts

@@ -1,32 +0,0 @@
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { NodeDataProvider } from './index';
-/**
- *
- *
- * This hook is intended to simplify accessing data via the one tick providers.
- *
- * ```ts
- * const value = useNodeDataProviderGet(emojiProvider, emojiNode);
- *
- * if (value.state === 'loading') {
- *   return <Loading />;
- * }
- * if (value.state === 'failed') {
- *  return <Fallback />;
- * }
- * return <Emoji properties=(value.result) />
- * ```
- */
-export declare function useNodeDataProviderGet<_NodeDataProvider extends NodeDataProvider<any, any>>(options: {
-    provider: _NodeDataProvider;
-    node: PMNode;
-}): {
-    state: 'loading';
-    result: undefined;
-} | {
-    state: 'failed';
-    result: undefined;
-} | {
-    state: 'resolved';
-    result: _NodeDataProvider['cache'][string];
-};

package/dist/types/providers/emoji.d.ts

@@ -1,10 +0,0 @@
-import { type EmojiAttributes } from '@atlaskit/adf-schema';
-import type { EmojiDescriptionWithVariations, EmojiProvider } from '@atlaskit/emoji';
-import { NodeDataProvider } from '../index';
-export declare function createEmojiNodeDataProvider({ emojiProvider, existingCache, }: {
-    emojiProvider: Promise<EmojiProvider>;
-    existingCache?: Record<string, EmojiDescriptionWithVariations>;
-}): EmojiNodeDataProvider;
-export type EmojiNodeDataProvider = NodeDataProvider<{
-    attrs: EmojiAttributes;
-}, EmojiDescriptionWithVariations>;

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

@@ -1,61 +0,0 @@
-import type { DocNode } from '@atlaskit/adf-schema';
-import { type AnyNodeDataProvider } from './internal-types';
-import { type EmojiNodeDataProvider } from './providers/emoji';
-export type NodeDataProvidersCache = {
-    [nodeName: string]: Record<string, any>;
-};
-export type NodeDataProviders = {
-    emoji: EmojiNodeDataProvider;
-    [nodeName: string]: AnyNodeDataProvider;
-};
-/**
- * Builds {@link NodeDataProvider}s caches for a document.
- *
- * It will traverse the document and call the resolve method for each node.
- * When all promises are resolved, NodeDataProviders will have their caches populated.
- *
- * The providers will then be ready for use with an Editor.
- *
- * To limit the time spent building the cache, a signal can be provided to abort the request.
- *
- * ## Usage
- *
- * @example
- * ```ts
- * buildCaches({
- *  adf: doc,
- *  nodeDataProviders: { emoji: emojiNodeDataProvider, ... },
- *  signal: AbortSignal.timeout(5000),
- * });
- * ```
- *
- * ### Using caches
- *
- * To make use of a cache in another provider (ie. for a cache created on the server), you can retrieve the cache
- * from the provider and pass it to the new provider.
- *
- * @example
- * ```tsx
- * // SSR env
- * const ssrProvidersCaches = await buildCaches({adf, nodeDataProviders: { emoji }})
- *
- * // Client env (providersCaches is the cache from the server)
- * <ContentNodeDataProviders ... existingProvidersCache={ssrProvidersCaches} />
- * ```
- *
- * *Note:* On the client - buildCache is not expected to be used directly.
- *
- * @see {@link ContentNodeDataProviders} for expected client usage.
- */
-export declare function buildCaches({ adf, nodeDataProviders, signal, existingProvidersCache, }: {
-    adf?: DocNode;
-    /**
-     * Providers to build caches for
-     */
-    nodeDataProviders: NodeDataProviders;
-    /**
-     * Signal to abort cache building -- the caches will be built up to the point of abort.
-     */
-    signal?: AbortSignal;
-    existingProvidersCache?: NodeDataProvidersCache;
-}): Promise<NodeDataProvidersCache>;

package/dist/types-ts4.5/consumption/_global-ndp-caches.d.ts

@@ -1,8 +0,0 @@
-import { type NodeDataProviders } from '../cache';
-import { type LRUCache } from './_lru-cache';
-type GlobalNdpCachesContextValue = {
-    [contentType: string]: LRUCache<NodeDataProviders>;
-};
-export declare function useGlobalNdpCachesContext(): GlobalNdpCachesContextValue;
-export declare function _resetGlobalNdpCachesContext(): void;
-export {};

package/dist/types-ts4.5/consumption/_internal-context.d.ts

@@ -1,32 +0,0 @@
-import { type DocNode } from '@atlaskit/adf-schema';
-import { type NodeDataProviders, type NodeDataProvidersCache } from '../cache';
-/**
- * Sets up nodeview data providers for a content node.
- *
- * This will return the cached node data providers if they exist, otherwise it will call the provided getNodeDataProviders function.
- *
- * Note: Calling this has side effects where caches for the nodeview data providers will continue to be built
- * in the background after this resolves to a set of nodeview data providers that can be used.
- */
-export declare function useContentNodeDataProvidersSetup(content: {
-    /**
-     * The type of content.
-     */
-    contentType: 'page';
-    contentId: string;
-}, 
-/**
- * Note: changes to this object will not be reflected in the cache.
- */
-setupOptions: {
-    /**
-     * Note: this will only be used if no existing NodeDataProviders are found for the content.
-     */
-    adfToUpdateWith?: DocNode;
-    existingProvidersCache?: NodeDataProvidersCache;
-    getNodeDataProviders: () => NodeDataProviders;
-    onCacheWarmed?: (_: {
-        warmedNodeDataProvidersCache: NodeDataProvidersCache;
-        nodeDataProviders: NodeDataProviders;
-    }) => void;
-}): NodeDataProviders | undefined;

package/dist/types-ts4.5/consumption/_lru-cache.d.ts

@@ -1,7 +0,0 @@
-export declare class LRUCache<T> {
-    private capacity;
-    private cache;
-    constructor(capacity: number);
-    get(key: string): T | undefined;
-    set(key: string, value: T): void;
-}

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

@@ -1,65 +0,0 @@
-import React from 'react';
-import { type DocNode } from '@atlaskit/adf-schema';
-import { type NodeDataProviders, type NodeDataProvidersCache } from '../cache';
-import { _resetGlobalNdpCachesContext } from './_global-ndp-caches';
-/**
- *
- * @example
- * ```tsx
- * <ContentNodeDataProviders
- * 	contentType="page" contentId="9001"
- * 	adf={doc}
- * 	placeholder={<Spinner />}
- * 	existingProvidersCache={ssrProvidersCache}
- * 	getNodeDataProviders={getPageNodeDataProviders}
- * 	onCacheWarmed={trackCacheWarmed}
- * >
- * 	 <Editor />
- * </ContentNodeDataProviders>
- * ```
- */
-export declare function ContentNodeDataProviders(props: {
-    /**
-     * The type of content, this is used to group the resulting providers cache
-     *
-     * Note: Providers Caches are stored in an internal LRU cache, are grouped by content type.
-     */
-    contentType: 'page';
-    /**
-     * The type of content, this is used to group the resulting providers cache
-     *
-     */
-    contentId: string;
-    /**
-     * This is optional - when passed the caches in the data providers will be warmed
-     * based on this document.
-     */
-    adf?: DocNode;
-    /**
-     * This is optional, and supports passing in an existing providers cache.
-     *
-     * An example of this is when you have a server-side rendered providers cache that you want to use on the client.
-     */
-    existingProvidersCache?: NodeDataProvidersCache;
-    /**
-     * Returns a set of `NodeDataProviders` which are put in context for use when creating an editor or renderer.
-     * These will be pre-warmed if adf is passed in.
-     */
-    getNodeDataProviders: () => NodeDataProviders;
-    /**
-     * Called when the cache is warmed.
-     */
-    onCacheWarmed?: (_: {
-        warmedNodeDataProvidersCache: NodeDataProvidersCache;
-        nodeDataProviders: NodeDataProviders;
-    }) => void;
-    children: React.ReactNode;
-}): React.JSX.Element;
-export declare function useContentNodeDataProviders(): NodeDataProviders | undefined;
-export { 
-/**
- * Exported for testing purposes only.
- *
- * This API will change.
- */
-_resetGlobalNdpCachesContext as __testOnly_resetGlobalNdpCachesContext, };

package/dist/types-ts4.5/get-providers/confluence-page.d.ts

@@ -1,6 +0,0 @@
-import type { EmojiProvider } from '@atlaskit/emoji';
-export declare function getConfluencePageProviders({ emojiProvider, }: {
-    emojiProvider: Promise<EmojiProvider>;
-}): {
-    emoji: import("../providers/emoji").EmojiNodeDataProvider;
-};

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

@@ -1,2 +0,0 @@
-import { type NodeDataProvider } from './index';
-export type AnyNodeDataProvider = NodeDataProvider<any, Record<string, any>>;

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

@@ -1,32 +0,0 @@
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { NodeDataProvider } from './index';
-/**
- *
- *
- * This hook is intended to simplify accessing data via the one tick providers.
- *
- * ```ts
- * const value = useNodeDataProviderGet(emojiProvider, emojiNode);
- *
- * if (value.state === 'loading') {
- *   return <Loading />;
- * }
- * if (value.state === 'failed') {
- *  return <Fallback />;
- * }
- * return <Emoji properties=(value.result) />
- * ```
- */
-export declare function useNodeDataProviderGet<_NodeDataProvider extends NodeDataProvider<any, any>>(options: {
-    provider: _NodeDataProvider;
-    node: PMNode;
-}): {
-    state: 'loading';
-    result: undefined;
-} | {
-    state: 'failed';
-    result: undefined;
-} | {
-    state: 'resolved';
-    result: _NodeDataProvider['cache'][string];
-};

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

@@ -1,10 +0,0 @@
-import { type EmojiAttributes } from '@atlaskit/adf-schema';
-import type { EmojiDescriptionWithVariations, EmojiProvider } from '@atlaskit/emoji';
-import { NodeDataProvider } from '../index';
-export declare function createEmojiNodeDataProvider({ emojiProvider, existingCache, }: {
-    emojiProvider: Promise<EmojiProvider>;
-    existingCache?: Record<string, EmojiDescriptionWithVariations>;
-}): EmojiNodeDataProvider;
-export type EmojiNodeDataProvider = NodeDataProvider<{
-    attrs: EmojiAttributes;
-}, EmojiDescriptionWithVariations>;

package/emoji-provider/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "@atlaskit/node-data-provider/emoji-provider",
-  "main": "../dist/cjs/providers/emoji.js",
-  "module": "../dist/esm/providers/emoji.js",
-  "module:es2019": "../dist/es2019/providers/emoji.js",
-  "sideEffects": false,
-  "types": "../dist/types/providers/emoji.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.4": {
-      "*": [
-        "../dist/types-ts4.5/providers/emoji.d.ts"
-      ]
-    }
-  }
-}

package/get-confluence-page-providers/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "@atlaskit/node-data-provider/get-confluence-page-providers",
-  "main": "../dist/cjs/get-providers/confluence-page.js",
-  "module": "../dist/esm/get-providers/confluence-page.js",
-  "module:es2019": "../dist/es2019/get-providers/confluence-page.js",
-  "sideEffects": false,
-  "types": "../dist/types/get-providers/confluence-page.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.4": {
-      "*": [
-        "../dist/types-ts4.5/get-providers/confluence-page.d.ts"
-      ]
-    }
-  }
-}

package/plugin-hooks/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "@atlaskit/node-data-provider/plugin-hooks",
-  "main": "../dist/cjs/plugin-hooks.js",
-  "module": "../dist/esm/plugin-hooks.js",
-  "module:es2019": "../dist/es2019/plugin-hooks.js",
-  "sideEffects": false,
-  "types": "../dist/types/plugin-hooks.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.4": {
-      "*": [
-        "../dist/types-ts4.5/plugin-hooks.d.ts"
-      ]
-    }
-  }
-}