@djvlc/runtime-host-vue 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,287 @@
+import * as vue from 'vue';
+import { Ref, ShallowRef, PropType, InjectionKey, Plugin } from 'vue';
+import * as _djvlc_runtime_core from '@djvlc/runtime-core';
+import { RuntimeOptions, DjvlcRuntime, RuntimePhase, PageResolveResult, RuntimeError, HostAPI, RuntimeState } from '@djvlc/runtime-core';
+export { HostAPI, PageResolveResult, RuntimeError, RuntimeOptions, RuntimePhase, RuntimeState } from '@djvlc/runtime-core';
+import * as _djvlc_contracts_types from '@djvlc/contracts-types';
+
+/**
+ * Vue 运行时封装
+ * 将核心运行时封装为 Vue 友好的 API
+ */
+
+/**
+ * Vue 运行时选项
+ */
+interface VueRuntimeOptions extends Omit<RuntimeOptions, 'container'> {
+    /** 容器元素引用 */
+    containerRef?: Ref<HTMLElement | null>;
+}
+/**
+ * Vue 运行时返回值
+ */
+interface VueRuntimeReturn {
+    /** 运行时实例 */
+    runtime: ShallowRef<DjvlcRuntime | null>;
+    /** 加载状态 */
+    loading: Ref<boolean>;
+    /** 当前阶段 */
+    phase: Ref<RuntimePhase>;
+    /** 页面数据 */
+    page: ShallowRef<PageResolveResult | null>;
+    /** 错误信息 */
+    error: ShallowRef<RuntimeError | null>;
+    /** Host API */
+    hostApi: ShallowRef<HostAPI | null>;
+    /** 初始化 */
+    init: () => Promise<void>;
+    /** 加载页面 */
+    load: () => Promise<PageResolveResult>;
+    /** 渲染页面 */
+    render: () => Promise<void>;
+    /** 销毁 */
+    destroy: () => void;
+    /** 设置变量 */
+    setVariable: (key: string, value: unknown) => void;
+    /** 刷新数据 */
+    refreshData: (queryId: string) => Promise<void>;
+}
+/**
+ * 创建 Vue 运行时
+ */
+declare function createVueRuntime(options: VueRuntimeOptions): VueRuntimeReturn;
+
+/**
+ * DJV 渲染器 Props
+ */
+interface DJVRendererProps {
+    /** 页面 UID */
+    pageUid: string;
+    /** API 基础 URL */
+    apiBaseUrl: string;
+    /** CDN 基础 URL */
+    cdnBaseUrl: string;
+    /** 渠道 */
+    channel?: 'preview' | 'prod' | 'gray';
+    /** 用户 ID */
+    userId?: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 认证 Token */
+    authToken?: string;
+    /** 预览 Token */
+    previewToken?: string;
+    /** 调试模式 */
+    debug?: boolean;
+    /** 是否启用 SRI */
+    enableSRI?: boolean;
+}
+/**
+ * DJV 渲染器组件
+ */
+declare const DJVRenderer: vue.DefineComponent<vue.ExtractPropTypes<{
+    pageUid: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    cdnBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    channel: {
+        type: PropType<"preview" | "prod" | "gray">;
+        default: string;
+    };
+    userId: StringConstructor;
+    deviceId: StringConstructor;
+    authToken: StringConstructor;
+    previewToken: StringConstructor;
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    enableSRI: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("ready" | "error" | "load")[], "ready" | "error" | "load", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    pageUid: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    cdnBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    channel: {
+        type: PropType<"preview" | "prod" | "gray">;
+        default: string;
+    };
+    userId: StringConstructor;
+    deviceId: StringConstructor;
+    authToken: StringConstructor;
+    previewToken: StringConstructor;
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    enableSRI: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onError?: ((...args: any[]) => any) | undefined;
+    onReady?: ((...args: any[]) => any) | undefined;
+    onLoad?: ((...args: any[]) => any) | undefined;
+}>, {
+    channel: "preview" | "prod" | "gray";
+    debug: boolean;
+    enableSRI: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+/**
+ * DJV Provider Props
+ */
+interface DJVProviderProps {
+    /** 运行时实例 */
+    runtime: DjvlcRuntime | null;
+    /** Host API */
+    hostApi: HostAPI | null;
+}
+/**
+ * DJV Provider 组件
+ * 用于手动控制运行时时使用
+ */
+declare const DJVProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    runtime: {
+        type: PropType<DjvlcRuntime | null>;
+        default: null;
+    };
+    hostApi: {
+        type: PropType<HostAPI | null>;
+        default: null;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    runtime: {
+        type: PropType<DjvlcRuntime | null>;
+        default: null;
+    };
+    hostApi: {
+        type: PropType<HostAPI | null>;
+        default: null;
+    };
+}>> & Readonly<{}>, {
+    runtime: DjvlcRuntime | null;
+    hostApi: HostAPI | null;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+/**
+ * 运行时上下文
+ */
+interface RuntimeContextValue {
+    runtime: DjvlcRuntime | null;
+    state: RuntimeState;
+    hostApi: HostAPI | null;
+}
+/**
+ * 运行时注入 Key
+ */
+declare const RuntimeContextKey: InjectionKey<Ref<RuntimeContextValue>>;
+/**
+ * 提供运行时上下文
+ */
+declare function provideRuntime(value: Ref<RuntimeContextValue>): void;
+/**
+ * 注入运行时上下文
+ */
+declare function injectRuntime(): Ref<RuntimeContextValue>;
+/**
+ * 使用运行时
+ */
+declare function useDJVRuntime(): {
+    runtime: vue.ComputedRef<DjvlcRuntime | null>;
+    state: vue.ComputedRef<RuntimeState>;
+    loading: vue.ComputedRef<boolean>;
+    phase: vue.ComputedRef<_djvlc_runtime_core.RuntimePhase>;
+    error: vue.ComputedRef<_djvlc_contracts_types.RuntimeError | null>;
+    page: vue.ComputedRef<_djvlc_contracts_types.PageResolveResult | null>;
+};
+/**
+ * 使用 Host API
+ */
+declare function useHostApi(): HostAPI;
+/**
+ * 使用运行时状态
+ */
+declare function useRuntimeState<T = unknown>(key: string): Ref<T | undefined>;
+/**
+ * 使用可写状态
+ */
+declare function useRuntimeStateWritable<T = unknown>(key: string, defaultValue?: T): [Ref<T>, (value: T) => void];
+/**
+ * 使用查询结果
+ */
+declare function useQuery<T = unknown>(queryId: string): {
+    data: Ref<T | undefined>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    refetch: () => Promise<void>;
+};
+/**
+ * 使用动作
+ */
+declare function useAction<T = unknown, P = Record<string, unknown>>(actionType: string): {
+    execute: (params?: P) => Promise<T | undefined>;
+    loading: Ref<boolean>;
+    result: Ref<T | undefined>;
+    error: Ref<Error | null>;
+};
+/**
+ * 使用数据请求
+ */
+declare function useData<T = unknown, P = Record<string, unknown>>(queryId: string, params?: P, options?: {
+    immediate?: boolean;
+}): {
+    data: Ref<T | undefined>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    refetch: (newParams?: P) => Promise<void>;
+};
+/**
+ * 使用事件监听
+ */
+declare function useRuntimeEvent<T = unknown>(eventType: string, handler: (data: T) => void): void;
+
+/**
+ * Vue 插件
+ * 全局注册 DJVLC 组件
+ */
+
+/**
+ * 插件选项
+ */
+interface DJVPluginOptions {
+    /** 全局配置 */
+    defaultApiBaseUrl?: string;
+    defaultCdnBaseUrl?: string;
+    /** 是否注册全局组件 */
+    registerComponents?: boolean;
+}
+/**
+ * DJVLC Vue 插件
+ */
+declare const DJVPlugin: Plugin;
+
+export { DJVPlugin, type DJVPluginOptions, DJVProvider, type DJVProviderProps, DJVRenderer, type DJVRendererProps, RuntimeContextKey, type RuntimeContextValue, type VueRuntimeOptions, type VueRuntimeReturn, createVueRuntime, injectRuntime, provideRuntime, useAction, useDJVRuntime, useData, useHostApi, useQuery, useRuntimeEvent, useRuntimeState, useRuntimeStateWritable };

package/dist/index.d.ts

@@ -0,0 +1,287 @@
+import * as vue from 'vue';
+import { Ref, ShallowRef, PropType, InjectionKey, Plugin } from 'vue';
+import * as _djvlc_runtime_core from '@djvlc/runtime-core';
+import { RuntimeOptions, DjvlcRuntime, RuntimePhase, PageResolveResult, RuntimeError, HostAPI, RuntimeState } from '@djvlc/runtime-core';
+export { HostAPI, PageResolveResult, RuntimeError, RuntimeOptions, RuntimePhase, RuntimeState } from '@djvlc/runtime-core';
+import * as _djvlc_contracts_types from '@djvlc/contracts-types';
+
+/**
+ * Vue 运行时封装
+ * 将核心运行时封装为 Vue 友好的 API
+ */
+
+/**
+ * Vue 运行时选项
+ */
+interface VueRuntimeOptions extends Omit<RuntimeOptions, 'container'> {
+    /** 容器元素引用 */
+    containerRef?: Ref<HTMLElement | null>;
+}
+/**
+ * Vue 运行时返回值
+ */
+interface VueRuntimeReturn {
+    /** 运行时实例 */
+    runtime: ShallowRef<DjvlcRuntime | null>;
+    /** 加载状态 */
+    loading: Ref<boolean>;
+    /** 当前阶段 */
+    phase: Ref<RuntimePhase>;
+    /** 页面数据 */
+    page: ShallowRef<PageResolveResult | null>;
+    /** 错误信息 */
+    error: ShallowRef<RuntimeError | null>;
+    /** Host API */
+    hostApi: ShallowRef<HostAPI | null>;
+    /** 初始化 */
+    init: () => Promise<void>;
+    /** 加载页面 */
+    load: () => Promise<PageResolveResult>;
+    /** 渲染页面 */
+    render: () => Promise<void>;
+    /** 销毁 */
+    destroy: () => void;
+    /** 设置变量 */
+    setVariable: (key: string, value: unknown) => void;
+    /** 刷新数据 */
+    refreshData: (queryId: string) => Promise<void>;
+}
+/**
+ * 创建 Vue 运行时
+ */
+declare function createVueRuntime(options: VueRuntimeOptions): VueRuntimeReturn;
+
+/**
+ * DJV 渲染器 Props
+ */
+interface DJVRendererProps {
+    /** 页面 UID */
+    pageUid: string;
+    /** API 基础 URL */
+    apiBaseUrl: string;
+    /** CDN 基础 URL */
+    cdnBaseUrl: string;
+    /** 渠道 */
+    channel?: 'preview' | 'prod' | 'gray';
+    /** 用户 ID */
+    userId?: string;
+    /** 设备 ID */
+    deviceId?: string;
+    /** 认证 Token */
+    authToken?: string;
+    /** 预览 Token */
+    previewToken?: string;
+    /** 调试模式 */
+    debug?: boolean;
+    /** 是否启用 SRI */
+    enableSRI?: boolean;
+}
+/**
+ * DJV 渲染器组件
+ */
+declare const DJVRenderer: vue.DefineComponent<vue.ExtractPropTypes<{
+    pageUid: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    cdnBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    channel: {
+        type: PropType<"preview" | "prod" | "gray">;
+        default: string;
+    };
+    userId: StringConstructor;
+    deviceId: StringConstructor;
+    authToken: StringConstructor;
+    previewToken: StringConstructor;
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    enableSRI: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("ready" | "error" | "load")[], "ready" | "error" | "load", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    pageUid: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    cdnBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    channel: {
+        type: PropType<"preview" | "prod" | "gray">;
+        default: string;
+    };
+    userId: StringConstructor;
+    deviceId: StringConstructor;
+    authToken: StringConstructor;
+    previewToken: StringConstructor;
+    debug: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    enableSRI: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onError?: ((...args: any[]) => any) | undefined;
+    onReady?: ((...args: any[]) => any) | undefined;
+    onLoad?: ((...args: any[]) => any) | undefined;
+}>, {
+    channel: "preview" | "prod" | "gray";
+    debug: boolean;
+    enableSRI: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+/**
+ * DJV Provider Props
+ */
+interface DJVProviderProps {
+    /** 运行时实例 */
+    runtime: DjvlcRuntime | null;
+    /** Host API */
+    hostApi: HostAPI | null;
+}
+/**
+ * DJV Provider 组件
+ * 用于手动控制运行时时使用
+ */
+declare const DJVProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    runtime: {
+        type: PropType<DjvlcRuntime | null>;
+        default: null;
+    };
+    hostApi: {
+        type: PropType<HostAPI | null>;
+        default: null;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    runtime: {
+        type: PropType<DjvlcRuntime | null>;
+        default: null;
+    };
+    hostApi: {
+        type: PropType<HostAPI | null>;
+        default: null;
+    };
+}>> & Readonly<{}>, {
+    runtime: DjvlcRuntime | null;
+    hostApi: HostAPI | null;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+/**
+ * 运行时上下文
+ */
+interface RuntimeContextValue {
+    runtime: DjvlcRuntime | null;
+    state: RuntimeState;
+    hostApi: HostAPI | null;
+}
+/**
+ * 运行时注入 Key
+ */
+declare const RuntimeContextKey: InjectionKey<Ref<RuntimeContextValue>>;
+/**
+ * 提供运行时上下文
+ */
+declare function provideRuntime(value: Ref<RuntimeContextValue>): void;
+/**
+ * 注入运行时上下文
+ */
+declare function injectRuntime(): Ref<RuntimeContextValue>;
+/**
+ * 使用运行时
+ */
+declare function useDJVRuntime(): {
+    runtime: vue.ComputedRef<DjvlcRuntime | null>;
+    state: vue.ComputedRef<RuntimeState>;
+    loading: vue.ComputedRef<boolean>;
+    phase: vue.ComputedRef<_djvlc_runtime_core.RuntimePhase>;
+    error: vue.ComputedRef<_djvlc_contracts_types.RuntimeError | null>;
+    page: vue.ComputedRef<_djvlc_contracts_types.PageResolveResult | null>;
+};
+/**
+ * 使用 Host API
+ */
+declare function useHostApi(): HostAPI;
+/**
+ * 使用运行时状态
+ */
+declare function useRuntimeState<T = unknown>(key: string): Ref<T | undefined>;
+/**
+ * 使用可写状态
+ */
+declare function useRuntimeStateWritable<T = unknown>(key: string, defaultValue?: T): [Ref<T>, (value: T) => void];
+/**
+ * 使用查询结果
+ */
+declare function useQuery<T = unknown>(queryId: string): {
+    data: Ref<T | undefined>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    refetch: () => Promise<void>;
+};
+/**
+ * 使用动作
+ */
+declare function useAction<T = unknown, P = Record<string, unknown>>(actionType: string): {
+    execute: (params?: P) => Promise<T | undefined>;
+    loading: Ref<boolean>;
+    result: Ref<T | undefined>;
+    error: Ref<Error | null>;
+};
+/**
+ * 使用数据请求
+ */
+declare function useData<T = unknown, P = Record<string, unknown>>(queryId: string, params?: P, options?: {
+    immediate?: boolean;
+}): {
+    data: Ref<T | undefined>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    refetch: (newParams?: P) => Promise<void>;
+};
+/**
+ * 使用事件监听
+ */
+declare function useRuntimeEvent<T = unknown>(eventType: string, handler: (data: T) => void): void;
+
+/**
+ * Vue 插件
+ * 全局注册 DJVLC 组件
+ */
+
+/**
+ * 插件选项
+ */
+interface DJVPluginOptions {
+    /** 全局配置 */
+    defaultApiBaseUrl?: string;
+    defaultCdnBaseUrl?: string;
+    /** 是否注册全局组件 */
+    registerComponents?: boolean;
+}
+/**
+ * DJVLC Vue 插件
+ */
+declare const DJVPlugin: Plugin;
+
+export { DJVPlugin, type DJVPluginOptions, DJVProvider, type DJVProviderProps, DJVRenderer, type DJVRendererProps, RuntimeContextKey, type RuntimeContextValue, type VueRuntimeOptions, type VueRuntimeReturn, createVueRuntime, injectRuntime, provideRuntime, useAction, useDJVRuntime, useData, useHostApi, useQuery, useRuntimeEvent, useRuntimeState, useRuntimeStateWritable };