@vtj/renderer 0.7.0

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@vtj/renderer",
+  "private": false,
+  "version": "0.7.0",
+  "type": "module",
+  "scripts": {
+    "build": "vue-tsc && vite build",
+    "test": "vitest run",
+    "vitest": "vitest",
+    "coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@vtj/core": "^0.7.0",
+    "@vtj/icons": "^0.7.0",
+    "@vtj/ui": "^0.7.0",
+    "@vtj/utils": "^0.7.0",
+    "zen-logger": "~1.1.4"
+  },
+  "devDependencies": {
+    "@vtj/cli": "^0.7.0",
+    "vue": "~3.4.14",
+    "vue-router": "~4.2.5"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./types/index.d.ts",
+  "files": [
+    "dist",
+    "types"
+  ],
+  "gitHead": "b65d1b19322cbd0721173d094db1b5ece018d980",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/constants.d.ts

@@ -0,0 +1,32 @@
+import { type BlockPropDataType } from '@vtj/core';
+export declare enum ContextMode {
+    /**
+     * 运行时
+     */
+    Runtime = "Runtime",
+    /**
+     * 设计模式
+     */
+    Design = "Design",
+    /**
+     * 源码模式
+     */
+    Raw = "Raw",
+    /**
+     * 虚拟节点
+     */
+    VNode = "VNode"
+}
+/**
+ * vue 组件实例提供的属性名
+ */
+export declare const CONTEXT_HOST: string[];
+export declare const LIFE_CYCLES_LIST: string[];
+/**
+ * 内置指令
+ */
+export declare const BUILDIN_DIRECTIVES: string[];
+/**
+ * 数据类型
+ */
+export declare const DATA_TYPES: Record<BlockPropDataType, any>;

package/types/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './mask';

package/types/hooks/mask.d.ts

@@ -0,0 +1,7 @@
+import { Ref } from 'vue';
+import { type MenuDataItem } from '@vtj/ui';
+export declare function useMask(): {
+    disabled: Ref<boolean>;
+    title: string;
+    menus: MenuDataItem[];
+};

package/types/index.d.ts

@@ -0,0 +1,7 @@
+export { version as VTJ_RENDERER_VERSION } from './version';
+export * from './constants';
+export * from './utils';
+export * from './provider';
+export * from './render';
+export * from './services';
+export * from './hooks';

package/types/provider/apis.d.ts

@@ -0,0 +1,5 @@
+import { type ApiSchema } from '@vtj/core';
+import { type IRequestConfig } from '@vtj/utils';
+import { type ProvideAdapter } from './provider';
+export declare function createSchemaApi(schema: ApiSchema, adapter: ProvideAdapter): ((query?: Record<string, any>) => Promise<any>) | ((data: any, opts?: IRequestConfig) => Promise<any>);
+export declare function createSchemaApis(schema: ApiSchema[] | undefined, adapter: ProvideAdapter): Record<string, any>;

package/types/provider/defaults.d.ts

@@ -0,0 +1,2 @@
+import { IStaticRequest } from '@vtj/utils';
+export declare const request: IStaticRequest;

package/types/provider/index.d.ts

@@ -0,0 +1,2 @@
+export * from './provider';
+export * from './apis';

package/types/provider/page.d.ts

@@ -0,0 +1,10 @@
+import { LocationQuery } from 'vue-router';
+import { PageFile } from '@vtj/core';
+import { Provider } from './provider';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ExtractPropTypes } from 'vue';
+export declare const PageContainer: DefineComponent<{}, {
+    provider: Provider;
+    component: any;
+    file: PageFile | null;
+    query: LocationQuery;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<{}>>, {}, {}>;

package/types/provider/provider.d.ts

@@ -0,0 +1,53 @@
+import { type App, type InjectionKey } from 'vue';
+import { type Router } from 'vue-router';
+import { type ProjectSchema, type PageFile, type BlockFile, type Service, type BlockSchema, Base } from '@vtj/core';
+import { type IStaticRequest, type Jsonp } from '@vtj/utils';
+import { ContextMode } from '../constants';
+export declare const providerKey: InjectionKey<Provider>;
+export interface ProviderOptions {
+    service: Service;
+    project?: Partial<ProjectSchema>;
+    modules?: Record<string, () => Promise<any>>;
+    mode?: ContextMode;
+    adapter?: Partial<ProvideAdapter>;
+    router?: Router;
+    dependencies?: Record<string, () => Promise<any>>;
+    materials?: Record<string, () => Promise<any>>;
+    globals?: Record<string, any>;
+}
+export interface ProvideAdapter {
+    request: IStaticRequest;
+    jsonp: Jsonp;
+}
+export declare class Provider extends Base {
+    mode: ContextMode;
+    globals: Record<string, any>;
+    modules: Record<string, () => Promise<any>>;
+    adapter: ProvideAdapter;
+    apis: Record<string, (...args: any[]) => Promise<any>>;
+    dependencies: Record<string, () => Promise<any>>;
+    materials: Record<string, () => Promise<any>>;
+    library: Record<string, any>;
+    service: Service;
+    project: ProjectSchema | null;
+    components: Record<string, any>;
+    private router;
+    constructor(options: ProviderOptions);
+    load(project: ProjectSchema): Promise<void>;
+    private initRouter;
+    install(app: App): void;
+    getFile(id: string): PageFile | BlockFile | null;
+    getPage(id: string): PageFile | null;
+    getHomepage(): PageFile | null;
+    getDsl(id: string): Promise<BlockSchema | null>;
+    getRenderComponent(id: string): Promise<any>;
+}
+export declare function createProvider(options: ProviderOptions): {
+    provider: Provider;
+    onReady: (callback: () => void) => void;
+};
+export interface UseProviderOptions {
+    id?: string;
+    version?: string;
+}
+export declare function useProvider(options?: UseProviderOptions): Provider;

package/types/render/block.d.ts

@@ -0,0 +1,20 @@
+import { type BlockSchema, type DataSourceSchema } from '@vtj/core';
+import { ContextMode } from '../constants';
+import { Context } from './context';
+import { type BlockLoader } from './loader';
+export type DataSourceHandler = (...args: any[]) => Promise<any>;
+export interface CreateRendererOptions {
+    Vue?: any;
+    mode?: ContextMode;
+    dsl?: BlockSchema;
+    components?: Record<string, any>;
+    libs?: Record<string, any>;
+    apis?: Record<string, any>;
+    loader?: BlockLoader;
+    window?: Window;
+}
+export declare function createRenderer(options: CreateRendererOptions): {
+    renderer: any;
+    context: Context;
+};
+export declare function createDataSources(dataSources: Record<string, DataSourceSchema>, context: Context): Record<string, DataSourceHandler>;

package/types/render/context.d.ts

@@ -0,0 +1,46 @@
+import { ContextMode } from '../constants';
+import { type BlockSchema, type JSFunction, type JSExpression } from '@vtj/core';
+export interface ContextOptions {
+    mode: ContextMode;
+    dsl?: BlockSchema;
+    attrs?: ContextAttrs;
+}
+export interface ContextAttrs {
+    $components?: Record<string, any>;
+    $libs?: Record<string, any>;
+    $apis?: Record<string, any>;
+    [key: string]: any;
+}
+export declare class Context {
+    __id: string | null;
+    __mode: ContextMode;
+    __instance: any | null;
+    __contextRefs: Record<string, Context>;
+    __refs: Record<string, any>;
+    context: Record<string, any>;
+    state: Record<string, any>;
+    $props: Record<string, any>;
+    $refs: Record<string, any>;
+    $el: any;
+    $emit: any;
+    $nextTick: any;
+    $parent: any;
+    $root: any;
+    $attrs: any;
+    $slots: any;
+    $watch: any;
+    $options: any;
+    $forceUpdate: any;
+    $components: Record<string, any>;
+    $libs: Record<string, any>;
+    $apis: Record<string, any>;
+    private __transform;
+    constructor(options: ContextOptions);
+    setup(attrs: Record<string, any>, Vue?: any): void;
+    private __proxy;
+    private __cleanup;
+    __parseFunction(code?: JSFunction): Function | undefined;
+    __parseExpression(code?: JSExpression | JSFunction): any;
+    __ref(id?: string | null, ref?: string | Function): ((el: any) => any) | undefined;
+    __clone(context?: Record<string, any>): Context;
+}

package/types/render/index.d.ts

@@ -0,0 +1,4 @@
+export * from './context';
+export * from './node';
+export * from './block';
+export * from './loader';

package/types/render/loader.d.ts

@@ -0,0 +1,10 @@
+import type { DefineComponent } from 'vue';
+import type { NodeFrom, BlockSchema } from '@vtj/core';
+import { type CreateRendererOptions } from './block';
+export type BlockLoader = (name: string, from?: NodeFrom, Vue?: any) => string | DefineComponent;
+export declare const defaultLoader: BlockLoader;
+export interface CreateLoaderOptions {
+    getDsl: (id: string) => Promise<BlockSchema | null>;
+    options: Partial<CreateRendererOptions>;
+}
+export declare function createLoader(opts: CreateLoaderOptions): BlockLoader;

package/types/render/node.d.ts

@@ -0,0 +1,6 @@
+import type { VNode } from 'vue';
+import { type NodeSchema, type NodeModifiers } from '@vtj/core';
+import { type Context } from './context';
+import { type BlockLoader } from './loader';
+export declare function nodeRender(dsl: NodeSchema, context: Context, Vue?: any, loader?: BlockLoader): VNode | VNode[] | null;
+export declare function getModifiers(modifiers?: NodeModifiers, isToString?: boolean): string[];

package/types/services/base.d.ts

@@ -0,0 +1,20 @@
+import { type ProjectSchema, type PageFile, type BlockFile, type BlockSchema, type MaterialDescription, type HistorySchema, type HistoryItem, type Service } from '@vtj/core';
+export declare class BaseService implements Service {
+    protected api: (type: string, data: any) => Promise<any>;
+    constructor();
+    init(project: ProjectSchema): Promise<ProjectSchema>;
+    saveProject(project: ProjectSchema): Promise<boolean>;
+    saveMaterials(project: ProjectSchema, materials: Map<string, MaterialDescription>): Promise<boolean>;
+    saveFile(file: BlockSchema): Promise<boolean>;
+    getFile(id: string): Promise<BlockSchema>;
+    removeFile(id: string): Promise<boolean>;
+    saveHistory(history: HistorySchema): Promise<boolean>;
+    removeHistory(id: string): Promise<boolean>;
+    getHistory(id: string): Promise<HistorySchema>;
+    getHistoryItem(fId: string, id: string): Promise<HistoryItem>;
+    saveHistoryItem(fId: string, item: HistoryItem): Promise<boolean>;
+    removeHistoryItem(fId: string, ids: string[]): Promise<boolean>;
+    publish(project: ProjectSchema): Promise<boolean>;
+    publishFile(project: ProjectSchema, file: PageFile | BlockFile): Promise<boolean>;
+    getRaw(project: ProjectSchema, dsl: BlockSchema): Promise<string>;
+}

package/types/services/index.d.ts

@@ -0,0 +1,4 @@
+export * from './base';
+export * from './storage';
+export * from './memory';
+export * from './local';

package/types/services/local.d.ts

@@ -0,0 +1,16 @@
+import { type ProjectSchema, type BlockSchema, type HistorySchema, type HistoryItem, type MaterialDescription } from '@vtj/core';
+import { BaseService } from './base';
+export declare class LocalService extends BaseService {
+    init(project: ProjectSchema): Promise<ProjectSchema>;
+    saveProject(project: ProjectSchema): Promise<boolean>;
+    saveMaterials(project: ProjectSchema, materials: Map<string, MaterialDescription>): Promise<boolean>;
+    saveFile(file: BlockSchema): Promise<boolean>;
+    getFile(id: string): Promise<BlockSchema>;
+    removeFile(id: string): Promise<boolean>;
+    saveHistory(history: HistorySchema): Promise<boolean>;
+    removeHistory(id: string): Promise<boolean>;
+    getHistory(id: string): Promise<HistorySchema>;
+    getHistoryItem(fId: string, id: string): Promise<HistoryItem>;
+    saveHistoryItem(fId: string, item: HistoryItem): Promise<boolean>;
+    removeHistoryItem(fId: string, ids: string[]): Promise<boolean>;
+}

package/types/services/memory.d.ts

@@ -0,0 +1,22 @@
+import { type ProjectSchema, type BlockSchema, type HistorySchema, type HistoryItem, type MaterialDescription } from '@vtj/core';
+import { BaseService } from './base';
+export declare class MemoryService extends BaseService {
+    private projects;
+    private materials;
+    private files;
+    private histories;
+    private historyItems;
+    init(project: ProjectSchema): Promise<ProjectSchema>;
+    saveProject(project: ProjectSchema): Promise<boolean>;
+    saveMaterials(project: ProjectSchema, materials: Map<string, MaterialDescription>): Promise<boolean>;
+    saveFile(file: BlockSchema): Promise<boolean>;
+    getFile(id: string): Promise<BlockSchema>;
+    removeFile(id: string): Promise<boolean>;
+    saveHistory(history: HistorySchema): Promise<boolean>;
+    removeHistory(id: string): Promise<boolean>;
+    getHistory(id: string): Promise<HistorySchema>;
+    getHistoryItem(fId: string, id: string): Promise<HistoryItem>;
+    saveHistoryItem(fId: string, item: HistoryItem): Promise<boolean>;
+    removeHistoryItem(fId: string, ids: string[]): Promise<boolean>;
+}
+export declare function createMemoryService(): MemoryService;

package/types/services/storage.d.ts

@@ -0,0 +1,16 @@
+import { type ProjectSchema, type BlockSchema, type HistorySchema, type HistoryItem, type MaterialDescription } from '@vtj/core';
+import { BaseService } from './base';
+export declare class StorageService extends BaseService {
+    init(project: ProjectSchema): Promise<ProjectSchema>;
+    saveProject(project: ProjectSchema): Promise<boolean>;
+    saveMaterials(project: ProjectSchema, materials: Map<string, MaterialDescription>): Promise<boolean>;
+    saveFile(file: BlockSchema): Promise<boolean>;
+    getFile(id: string): Promise<BlockSchema>;
+    removeFile(id: string): Promise<boolean>;
+    saveHistory(history: HistorySchema): Promise<boolean>;
+    removeHistory(id: string): Promise<boolean>;
+    getHistory(id: string): Promise<HistorySchema>;
+    getHistoryItem(fId: string, id: string): Promise<HistoryItem>;
+    saveHistoryItem(fId: string, item: HistoryItem): Promise<boolean>;
+    removeHistoryItem(fId: string, ids: string[]): Promise<boolean>;
+}

package/types/utils/deps.d.ts

@@ -0,0 +1,15 @@
+import type { Dependencie, MaterialDescription } from '@vtj/core';
+export declare function isCSSUrl(url: string): boolean;
+export declare function isJSUrl(url: string): boolean;
+export declare function createAssetScripts(scripts: string[]): string;
+export declare function createAssetsCss(css?: string[]): string;
+export declare function parseDeps(deps: Dependencie[]): {
+    scripts: string[];
+    css: string[];
+    materials: string[];
+    libraryExports: string[];
+    materialExports: string[];
+    materialMapLibrary: Record<string, string>;
+    libraryMap: Record<string, string[]>;
+};
+export declare function getRawComponent(desc: MaterialDescription, lib: any): any;

package/types/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './deps';
+export * from './util';
+export * from './logger';
+export * from './parser';

package/types/utils/logger.d.ts

@@ -0,0 +1,7 @@
+import Logger, { type Level } from 'zen-logger';
+export declare function getLogger(config: {
+    level: Level;
+    bizName: string;
+}): Logger;
+declare const logger: Logger;
+export { Logger, logger };

package/types/utils/parser.d.ts

@@ -0,0 +1,7 @@
+import type { JSExpression, JSFunction } from '@vtj/core';
+export declare function parseExpression(str: JSExpression | JSFunction, self: any, thisRequired?: boolean, throwError?: boolean): any;
+export declare function parseFunction(str: JSFunction, self: any, thisRequired?: boolean, throwError?: boolean): Function;
+export declare function isJSExpression(data: any): data is JSExpression;
+export declare function isJSFunction(x: any): x is JSFunction;
+export declare function isJSCode(data: unknown): data is JSExpression | JSFunction;
+export declare function JSCodeToString(data: unknown): string;

package/types/utils/util.d.ts

@@ -0,0 +1,5 @@
+import type { Plugin } from 'vue';
+export declare function toString(value: any): string;
+export declare function adoptedStyleSheets(global: Window, id: string, css: string): void;
+export declare function loadCss(id: string, url: string): Promise<void>;
+export declare function isVuePlugin(value: unknown): value is Plugin;

package/types/version.d.ts

@@ -0,0 +1,8 @@
+/**!
+ * Copyright (c) 2024, VTJ.PRO All rights reserved.
+ * @name @vtj/renderer
+ * @author CHC chenhuachun1549@dingtalk.com
+ * @version 0.7.0
+ * @license <a href="https://vtj.pro/license.html">MIT License</a>
+ */
+export declare const version = "0.7.0";