@haklex/rich-renderer-linkcard 0.0.1

package/LICENSE

@@ -0,0 +1,28 @@
+MIT License
+
+Copyright (c) 2024 Innei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+Additional Terms and Conditions
+
+----------------
+
+Use of this software is governed by the terms of MIT and, in addition, by the terms and conditions described in the additional file (ADDITIONAL_TERMS.md). By using this software, you agree to abide by these additional terms and conditions.

package/README.md

@@ -0,0 +1,67 @@
+# @haklex/rich-renderer-linkcard
+
+链接卡片渲染器，支持多平台元数据获取。
+
+## 安装
+
+```bash
+pnpm add @haklex/rich-renderer-linkcard @haklex/rich-editor
+```
+
+## 导出
+
+```ts
+// 渲染器
+export { LinkCardRenderer } from './LinkCardRenderer'
+export { LinkCardEditNode, linkCardEditNodes } from './LinkCardEditNode'
+export { LinkCardSkeleton } from './LinkCardSkeleton'
+
+// Hooks
+export { useUrlMatcher } from './hooks/useUrlMatcher'
+
+// 插件
+export { plugins, pluginMap, getPluginByName } from './plugins'
+export { 
+  githubRepoPlugin, githubPrPlugin, githubIssuePlugin,
+  githubCommitPlugin, githubDiscussionPlugin,
+  arxivPlugin, tmdbPlugin, bangumiPlugin,
+  leetcodePlugin, mxSpacePlugin, createMxSpacePlugin,
+  neteaseMusicPlugin, qqMusicPlugin 
+} from './plugins'
+
+// 工具
+export { 
+  fetchGitHubApi, fetchJsonWithContext,
+  camelcaseKeys, generateColor, LanguageToColorMap 
+} from './utils'
+
+// 类型
+export type { 
+  LinkCardData, LinkCardPlugin, LinkCardTypeClass,
+  LinkCardApiAdapter, LinkCardFetchContext,
+  PluginRegistry, UrlMatchResult, UrlMatchInfo,
+  EnhancedLinkCardProps, MxSpacePluginConfig 
+} from './types'
+```
+
+## 内置插件
+
+- GitHub: repo, pr, issue, commit, discussion
+- 学术: arxiv, leetcode
+- 媒体: tmdb, bangumi, netease-music, qq-music
+- 自定义: mx-space
+
+## 使用
+
+```tsx
+import { LinkCardRenderer } from '@haklex/rich-renderer-linkcard'
+import type { RendererConfig } from '@haklex/rich-editor'
+
+const config: RendererConfig = {
+  LinkCard: LinkCardRenderer,
+}
+```
+
+## License
+
+MIT

package/dist/LinkCardEditDecorator.d.ts

@@ -0,0 +1,10 @@
+import { LinkCardNodePayload } from '@haklex/rich-editor';
+import { ReactElement } from 'react';
+interface LinkCardEditDecoratorProps {
+    nodeKey: string;
+    payload: LinkCardNodePayload;
+    children: ReactElement;
+}
+export declare function LinkCardEditDecorator({ nodeKey, payload, children, }: LinkCardEditDecoratorProps): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=LinkCardEditDecorator.d.ts.map

package/dist/LinkCardEditDecorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkCardEditDecorator.d.ts","sourceRoot":"","sources":["../src/LinkCardEditDecorator.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAK/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAGzC,UAAU,0BAA0B;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,mBAAmB,CAAA;IAC5B,QAAQ,EAAE,YAAY,CAAA;CACvB;AAED,wBAAgB,qBAAqB,CAAC,EACpC,OAAO,EACP,OAAO,EACP,QAAQ,GACT,EAAE,0BAA0B,2CAoH5B"}

package/dist/LinkCardEditNode.d.ts

@@ -0,0 +1,10 @@
+import { LinkCardNode, SerializedLinkCardNode } from '@haklex/rich-editor';
+import { EditorConfig, Klass, LexicalEditor, LexicalNode } from 'lexical';
+import { ReactElement } from 'react';
+export declare class LinkCardEditNode extends LinkCardNode {
+    static clone(node: LinkCardEditNode): LinkCardEditNode;
+    static importJSON(serializedNode: SerializedLinkCardNode): LinkCardEditNode;
+    decorate(_editor: LexicalEditor, _config: EditorConfig): ReactElement;
+}
+export declare const linkCardEditNodes: Array<Klass<LexicalNode>>;
+//# sourceMappingURL=LinkCardEditNode.d.ts.map

package/dist/LinkCardEditNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkCardEditNode.d.ts","sourceRoot":"","sources":["../src/LinkCardEditNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAEZ,KAAK,sBAAsB,EAC5B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAKzC,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,gBAAgB,GAAG,gBAAgB;IAatD,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,sBAAsB,GAAG,gBAAgB;IAU3E,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,GAAG,YAAY;CAmBtE;AAED,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAsB,CAAA"}

package/dist/LinkCardRenderer.d.ts

@@ -0,0 +1,12 @@
+import { LinkCardRendererProps } from '@haklex/rich-editor';
+import { ComponentType } from 'react';
+import { LinkCardFetchContext, PluginRegistry } from './types';
+export interface EnhancedLinkCardProps extends LinkCardRendererProps {
+    source?: string;
+    id?: string;
+    className?: string;
+    plugins?: PluginRegistry;
+    fetchContext?: LinkCardFetchContext;
+}
+export declare const LinkCardRenderer: ComponentType<EnhancedLinkCardProps>;
+//# sourceMappingURL=LinkCardRenderer.d.ts.map

package/dist/LinkCardRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkCardRenderer.d.ts","sourceRoot":"","sources":["../src/LinkCardRenderer.tsx"],"names":[],"mappings":"AAAA,OAAO,cAAc,CAAA;AAErB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAO1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEnE,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,YAAY,CAAC,EAAE,oBAAoB,CAAA;CACpC;AAgBD,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC,qBAAqB,CAqJjE,CAAA"}

package/dist/LinkCardSkeleton.d.ts

@@ -0,0 +1,5 @@
+export declare function LinkCardSkeleton({ source, className, }: {
+    source?: string;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=LinkCardSkeleton.d.ts.map

package/dist/LinkCardSkeleton.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkCardSkeleton.d.ts","sourceRoot":"","sources":["../src/LinkCardSkeleton.tsx"],"names":[],"mappings":"AAEA,wBAAgB,gBAAgB,CAAC,EAC/B,MAAM,EACN,SAAS,GACV,EAAE;IACD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,2CAsBA"}

package/dist/hooks/useCardFetcher.d.ts

@@ -0,0 +1,19 @@
+import { LinkCardData, LinkCardFetchContext, LinkCardPlugin } from '../types';
+export interface UseCardFetcherOptions {
+    source?: string;
+    plugin?: LinkCardPlugin;
+    id: string;
+    fallbackUrl?: string;
+    enabled?: boolean;
+    context?: LinkCardFetchContext;
+}
+export interface UseCardFetcherResult {
+    loading: boolean;
+    isError: boolean;
+    cardInfo: LinkCardData | undefined;
+    fullUrl: string;
+    isValid: boolean;
+    ref: (node?: Element | null) => void;
+}
+export declare function useCardFetcher(options: UseCardFetcherOptions): UseCardFetcherResult;
+//# sourceMappingURL=useCardFetcher.d.ts.map

package/dist/hooks/useCardFetcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCardFetcher.d.ts","sourceRoot":"","sources":["../../src/hooks/useCardFetcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACf,MAAM,UAAU,CAAA;AAEjB,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,oBAAoB,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,YAAY,GAAG,SAAS,CAAA;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CACrC;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,qBAAqB,GAC7B,oBAAoB,CAiDtB"}

package/dist/hooks/useUrlMatcher.d.ts

@@ -0,0 +1,7 @@
+import { LinkCardPlugin, PluginRegistry, UrlMatchResult } from '../types';
+export interface UrlMatchInfo {
+    plugin: LinkCardPlugin;
+    match: UrlMatchResult;
+}
+export declare function useUrlMatcher(url: string | undefined, pluginRegistry?: PluginRegistry): UrlMatchInfo | null;
+//# sourceMappingURL=useUrlMatcher.d.ts.map

package/dist/hooks/useUrlMatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUrlMatcher.d.ts","sourceRoot":"","sources":["../../src/hooks/useUrlMatcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE9E,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,cAAc,CAAA;IACtB,KAAK,EAAE,cAAc,CAAA;CACtB;AAED,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,cAAc,GAAE,cAA+B,GAC9C,YAAY,GAAG,IAAI,CAcrB"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export type { UrlMatchInfo } from './hooks/useUrlMatcher';
+export { useUrlMatcher } from './hooks/useUrlMatcher';
+export { LinkCardEditDecorator } from './LinkCardEditDecorator';
+export { LinkCardEditNode, linkCardEditNodes } from './LinkCardEditNode';
+export type { EnhancedLinkCardProps } from './LinkCardRenderer';
+export { LinkCardRenderer } from './LinkCardRenderer';
+export { LinkCardSkeleton } from './LinkCardSkeleton';
+export { getPluginByName, pluginMap, plugins } from './plugins';
+export { arxivPlugin, bangumiPlugin, githubCommitPlugin, githubDiscussionPlugin, githubIssuePlugin, githubPrPlugin, githubRepoPlugin, leetcodePlugin, mxSpacePlugin, neteaseMusicPlugin, qqMusicPlugin, tmdbPlugin, } from './plugins';
+export { createMxSpacePlugin } from './plugins';
+export type { MxSpacePluginConfig } from './plugins/self';
+export type { LinkCardApiAdapter, LinkCardData, LinkCardFetchContext, LinkCardPlugin, LinkCardTypeClass, PluginRegistry, UrlMatchResult, } from './types';
+export { camelcaseKeys, fetchGitHubApi, fetchJsonWithContext, generateColor, LanguageToColorMap, } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACxE,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAC/D,OAAO,EACL,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,UAAU,GACX,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAC/C,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACzD,YAAY,EACV,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,GACf,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,kBAAkB,GACnB,MAAM,SAAS,CAAA"}