@e-mc/document 0.8.2 → 0.8.4

package/README.md

@@ -1,7 +1,99 @@
-### @e-mc/document
+# @e-mc/document
 
-https://e-mc.readthedocs.io
+* NodeJS 14
+* ES2020
 
-### LICENSE
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/index.d.ts
+
+```typescript
+import type { DataSource, ViewEngine } from "./squared";
+
+import type { IFileManager, IScopeOrigin } from "./index";
+import type { ExternalAsset, FileCommand, IFileThread, OutputFinalize } from "./asset";
+import type { HostInitConfig, IClient } from "./core";
+import type { AsSourceFileOptions, ConfigOrTransformer, CustomizeOptions, GenerateLintTableOptions, LintMessage, PluginConfig, SourceCode, SourceInput, SourceMap, SourceMapOptions, TransformAction, TransformCallback, TransformOutput, TransformResult, UpdateGradleOptions } from "./document";
+import type { PostFinalizeCallback } from "./filemanager";
+import type { LogComponent } from "./logger";
+import type { DocumentComponent, DocumentComponentOption, DocumentModule } from "./settings";
+import type { IFileGroup, WatchInitResult } from "./watch";
+
+interface IDocument extends IClient<IFileManager, DocumentModule, TransformCallback<IFileManager, ExternalAsset>> {
+    Db: IDb | null;
+    assets: ExternalAsset[];
+    config: Record<string, any>;
+    init(assets: ExternalAsset[], config?: HostInitConfig): this;
+    customize(options?: CustomizeOptions): void;
+    findConfig(data: object, name: string, type?: string): PluginConfig;
+    loadConfig(data: object, name: string): ConfigOrTransformer | null | undefined;
+    asSourceFile(value: string, options?: AsSourceFileOptions | boolean): unknown;
+    findVersion(name: string | string[], fallback?: string): string;
+    findSourceScope(uri: string, imports: Record<string, unknown>): Record<string, string | undefined>[];
+    findSourceRoot(uri: string, imports?: Record<string, string | undefined>): string | undefined;
+    resolveDir(name: string, ...paths: string[]): string | undefined;
+    locateSourceFiles(file: ExternalAsset, code?: string, bundleContent?: string[]): (imports?: Record<string, string | undefined>) => SourceInput | undefined;
+    resolveSourceFile(file: ExternalAsset): (code?: string, imports?: Record<string, string | undefined>) => SourceInput<string> | undefined;
+    tryParse(source: string, format: string, options?: Record<string | number | symbol, unknown>): unknown;
+    forDb(item: DataSource): boolean;
+    hasEval(name: string): boolean;
+    settingsOf(name: keyof DocumentComponent, option: keyof DocumentComponentOption): unknown;
+    parseTemplate(viewEngine: ViewEngine | string, template: string, data: unknown[]): Promise<string | null>;
+    transform(type: string, code: string, format: string | string[], options?: TransformOutput & TransformAction): Promise<TransformResult | void>;
+    abort(name?: keyof DocumentComponent | Error, reason?: unknown): void;
+    restart(): void;
+    using?(data: IFileThread): Promise<unknown>;
+    setLocalUri?(file: ExternalAsset, replace?: boolean): void;
+    resolveUri?(file: ExternalAsset, source: string): string;
+    resolveUri?(file: ExternalAsset, source: string, trailing: string): [string, string];
+    resolveImports?(file: ExternalAsset, code: string, baseFile?: string | ExternalAsset): string | undefined;
+    replaceContent?(source: string, statement: RegExpExecArray | string, mimeType?: string): string | undefined;
+    addCopy?(data: FileCommand<ExternalAsset>, saveAs: string, replace?: boolean): string | undefined;
+    writeImage?(output: OutputFinalize<ExternalAsset>): boolean;
+    cloudInit?(state: IScopeOrigin<IFileManager, ICloud>): void;
+    cloudObject?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset): boolean;
+    cloudUpload?(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, url: string, active: boolean): Promise<boolean>;
+    cloudFinalize?(state: IScopeOrigin<IFileManager, ICloud>): Promise<unknown[]>;
+    watchInit?(watch: IFileGroup<ExternalAsset>, assets: ExternalAsset[], sanitize?: boolean): WatchInitResult | undefined;
+    watchModified?(watch: IFileGroup<ExternalAsset>, assets?: ExternalAsset[]): PostFinalizeCallback;
+    set dataSource(value: DataSource[]);
+    get dataSource(): DataSource[];
+    set imports(value);
+    get imports(): Record<string, string | undefined>;
+    get watching(): boolean;
+}
+
+interface DocumentConstructor extends ModuleConstructor {
+    finalize(this: IFileManager, instance: IDocument): Promise<unknown>;
+    createSourceMap(code: string, remove: boolean): SourceMap;
+    createSourceMap(code: string, uri?: string, remove?: boolean): SourceMap;
+    writeSourceMap(uri: string, data: SourceCode, options?: SourceMapOptions): string | undefined;
+    updateGradle(source: string, namespaces: string[], value: string, options?: UpdateGradleOptions | boolean): string;
+    generateLintTable(messages: LintMessage[], options: GenerateLintTableOptions): LogComponent[];
+    /* @deprecated - IDocument.using */
+    using?(this: IFileManager, instance: IDocument, file: ExternalAsset): Promise<unknown>;
+    cleanup?(this: IFileManager, instance: IDocument): Promise<unknown>;
+    sanitizeAssets?(assets: ExternalAsset[], exclusions?: ExternalAsset[]): ExternalAsset[];
+    readonly prototype: IDocument;
+    new(module?: DocumentModule, ...args: unknown[]): IDocument;
+}
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/document.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.4/lib/watch.d.ts
+
+## LICENSE
 
 BSD 3-Clause

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/document",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "description": "Document constructor for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/anpham6/e-mc.git",
+    "url": "git+https://github.com/anpham6/e-mc.git",
     "directory": "src/document"
   },
   "keywords": [
@@ -20,11 +20,11 @@
   "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.8.2",
-    "@e-mc/db": "0.8.2",
-    "@e-mc/types": "0.8.2",
+    "@e-mc/core": "0.8.4",
+    "@e-mc/db": "0.8.4",
+    "@e-mc/types": "0.8.4",
     "chalk": "4.1.2",
-    "htmlparser2": "^9.0.0",
+    "htmlparser2": "^9.1.0",
     "js-yaml": "^4.1.0",
     "picomatch": "^3.0.1"
   }

package/parse/types/index.d.ts

@@ -1,8 +1,6 @@
 import type { XmlTagNode as IXmlTagNode, TagAppend, TagData } from '../../../types/lib/squared';
 
-// @ts-ignore
 import type { ParserOptions } from 'htmlparser2';
-// @ts-ignore
 import type { AnyNode, Element } from 'domhandler';
 
 export interface IGNORE_FLAG {