@pi-r/chrome 0.0.1

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@pi-r/chrome",
+  "version": "0.0.1",
+  "description": "Chrome document constructor for E-mc.",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anpham6/pi-r.git",
+    "directory": "src/module/chrome"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/cloud": "^0.4.0",
+    "@e-mc/core": "^0.4.0",
+    "@e-mc/document": "^0.4.0",
+    "@e-mc/types": "^0.4.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,118 @@
+import type { LocationUri, XmlTagNode } from '@e-mc/types/lib/squared';
+
+import type { DocumentConstructor, IDocument, IFileManager } from '@e-mc/types/lib';
+import type { DocumentAsset as IDocumentAsset } from '@e-mc/types/lib/document';
+import type { LogTime } from '@e-mc/types/lib/logger';
+import type { DbSourceDataType, DocumentComponentOption, DocumentComponent as IDocumentComponent, DocumentComponentOptions as IDocumentComponentOptions, DocumentDirectory as IDocumentDirectory, DocumentEval as IDocumentEval, DocumentModule as IDocumentModule, DocumentSettings as IDocumentSettings } from '@e-mc/types/lib/settings';
+
+import type { CloudScopeOrigin } from '@e-mc/cloud/types';
+import type { IDomWriter, IXmlElement } from '@e-mc/document/parse/types';
+
+import type { ChromeAsset, CssRuleData, DataSource, DocumentOutput } from './squared';
+
+interface DocumentDirectory extends IDocumentDirectory {
+    template?: string;
+    data?: string;
+    export?: string;
+    schema?: string;
+    sql?: string;
+}
+
+interface DocumentComponentExtended<T> extends DbSourceDataType<T> {
+    uri?: T;
+    local?: T;
+    export?: T;
+}
+
+interface DocumentComponentOptions<T> extends IDocumentComponentOptions, DocumentComponentExtended<DocumentComponentOption<T>> {}
+
+interface DocumentEval extends IDocumentEval {
+    template?: boolean;
+    userconfig?: boolean;
+}
+
+interface ChromeDocumentSettings extends IDocumentSettings {
+    directory?: DocumentDirectory;
+    options?: DocumentComponentOptions<boolean | number>;
+    export?: ObjectMap<string | FunctionType>;
+}
+
+type OutputType = "useUnsafeReplace" | "productionRelease" | "productionIncremental" | "templateMap";
+
+export interface FormatUri extends Partial<LocationUri> {
+    dictionary?: string;
+}
+
+export interface FinalizeProcessing<T extends IFileManager<U>, U extends DocumentAsset = DocumentAsset> {
+    readonly host: T;
+    readonly startTime: LogTime;
+    readonly hashed: Set<DocumentAsset>;
+    readonly contentMap: StringMap;
+    readonly bufferMap: ObjectMap<BufferContent>;
+    readonly cacheMiss: string[];
+    readonly productionRelease: Undef<true>;
+}
+
+export interface DocumentComponent<T = boolean> extends IDocumentComponent<T, T>, DocumentComponentExtended<T> {}
+
+export interface DocumentModule extends IDocumentModule {
+    eval?: DocumentEval;
+    format?: PlainObject & { uuid?: FormatUri };
+    settings?: ChromeDocumentSettings;
+}
+
+export interface DocumentAsset extends IDocumentAsset, ChromeAsset {
+    relativeUrl?: string;
+    inlineFilename?: string;
+    srcSet?: string[];
+    inlineUrl?: string;
+    inlineUrlMap?: StringMap;
+    inlineUrlCloud?: string;
+    inlineUrlCloudMap?: StringMap;
+    inlineBase64?: string;
+    modified?: boolean;
+}
+
+export interface UserConfig extends CssRuleData, Omit<DocumentOutput, OutputType> {
+    useUnsafeHtmlReplace?: boolean;
+    useUnsafeCssReplace?: boolean;
+}
+
+export interface IChromeDocument<T extends IFileManager<U>, U extends DocumentAsset = DocumentAsset> extends IDocument<T, U, DocumentModule, DocumentComponent>, Pick<DocumentOutput, OutputType> {
+    htmlFile: Null<U>;
+    cssFiles: U[];
+    jsFiles: U[];
+    svgFiles: U[];
+    baseDirectory: string;
+    baseUrl: string;
+    config: UserConfig;
+    related: Map<U, Set<U>>;
+    replaced: U[];
+    formatMap?: ObjectMap<FormatUri>;
+    setElementSrc(asset: U, element: IXmlElement, value: string): void;
+    findDataValue(name: string): Undef<string>;
+    setInlinedAttributes(processing: FinalizeProcessing<T>): void;
+    applyTransforms(processing: FinalizeProcessing<T>): Promise<void>;
+    rewriteHtml(processing: FinalizeProcessing<T>): Promise<void>;
+    setElementAttributes(processing: FinalizeProcessing<T>, domBase: IDomWriter): Promise<void>;
+    applyDataSource(processing: FinalizeProcessing<T>, domBase: IDomWriter): Promise<void>;
+    setProductionAttributes(processing: FinalizeProcessing<T>): void;
+    removeUnusedStyles(source: string, options?: UserConfig): Undef<string>;
+    removeServerRoot(value: string): string;
+    replaceContent(source: string, match: RegExpExecArray | string, mimeType?: string): Undef<string>;
+    cloudInit(state: CloudScopeOrigin<T, U>): void;
+    cloudObject(state: CloudScopeOrigin<T, U>, file: U): boolean;
+    cloudUpload(state: CloudScopeOrigin<T, U>, file: U, url: string, active: boolean): Promise<boolean>;
+    cloudFinalize(state: CloudScopeOrigin<T, U>): Promise<unknown[]>;
+    get settings(): ChromeDocumentSettings;
+    get editing(): U[];
+    get dataSource(): DataSource[];
+    get elements(): XmlTagNode[];
+}
+
+export interface ChromeDocumentConstructor<T extends IFileManager<U>, U extends DocumentAsset = DocumentAsset> extends DocumentConstructor<T, U> {
+    INTERNAL_ASSIGNUUID: string;
+    INTERNAL_SERVERROOT: string;
+    readonly prototype: IChromeDocument<T, U>;
+    new(module?: DocumentModule, ...args: unknown[]): IChromeDocument<T, U>;
+}

package/types/squared.d.ts

@@ -0,0 +1,106 @@
+import type { AttributeAction, ConditionProperty, CssConditionData, ElementAction, ExcludeAction, FileAsset, FromAction, HashAction, DataSource as IDataSource, ImportAction, MetadataAction, ViewEngine, XmlTagNode } from '@e-mc/types/lib/squared';
+
+import type { UploadAction } from '@e-mc/types/lib/cloud';
+import type { CascadeAction, DbSource } from '@e-mc/types/lib/db';
+import type { RequestData as IRequestData } from '@e-mc/types/lib/node';
+
+interface ImportFrom {
+    placeholder: string;
+    original: string;
+    uri: string;
+    type?: string;
+    dynamic?: boolean;
+}
+
+interface DataObject extends CascadeAction {
+    format?: string;
+    options?: PlainObject;
+}
+
+export interface DocumentOutput {
+    productionRelease?: boolean | string;
+    productionIncremental?: boolean;
+    useOriginalHtmlPage?: boolean | string;
+    useUnsafeReplace?: ArrayOf<"html" | "css"> | boolean;
+    stripCommentsAndCDATA?: boolean | string;
+    normalizeHtmlOutput?: boolean | string;
+    escapeReservedCharacters?: boolean;
+    ignoreServerCodeBlocks?: string[];
+    webBundle?: {
+        rootDirAlias?: string;
+        baseUrl?: string;
+        primaryUrl?: string;
+        copyTo?: string;
+        rewriteHtmlPage?: boolean | string;
+        excludeHtmlPage?: boolean;
+        excludeTransforms?: boolean;
+        includeScopes?: string[];
+        excludeScopes?: string[];
+    };
+    templateMap?: TemplateMap;
+}
+
+export interface RequestData extends IRequestData<ChromeAsset>, Readonly<DocumentOutput>, Readonly<CssRuleData> {}
+
+export interface ChromeAsset extends FileAsset, AttributeAction, ElementAction, MetadataAction<PlainObject>, UploadAction, HashAction, ExcludeAction, ImportAction<ImportFrom[] | boolean>, FromAction {
+    preserve?: boolean;
+    static?: boolean;
+    editing?: boolean;
+    inlineContent?: string;
+    originAddress?: boolean;
+}
+
+export interface TemplateMap extends PlainObject {
+    html?: ObjectMap<StringMap>;
+    js?: ObjectMap<StringMap>;
+    css?: ObjectMap<StringMap>;
+    data?: StringMap;
+}
+
+export interface CssRuleData {
+    usedVariables?: string[];
+    usedFontFace?: string[];
+    usedKeyframes?: string[];
+    unusedStyles?: string[];
+    unusedMedia?: string[];
+    unusedContainer?: string[];
+    unusedSupports?: string[];
+    unusedAtRules?: UnusedAtRule[];
+}
+
+export interface UnusedAtRule {
+    selector?: string;
+    media?: ConditionProperty;
+    supports?: ConditionProperty;
+    container?: CssConditionData & Partial<ConditionProperty>;
+    layer?: string[];
+}
+
+export interface DataSource<T = string> extends IDataSource<T>, ElementAction {
+    source: "cloud" | "uri" | "local" | "export" | DbSource;
+    element?: XmlTagNode;
+    type?: "text" | "attribute" | "display";
+    dynamic?: boolean;
+    value?: StringOfArray | ObjectMap<unknown>;
+    template?: string;
+    viewEngine?: ViewEngine | string;
+    ignoreEmpty?: boolean;
+}
+
+export interface UriDataSource extends DataSource, DataObject {
+    source: "uri";
+}
+
+export interface LocalDataSource extends DataSource, DataObject {
+    source: "local";
+    pathname?: string;
+}
+
+export interface ExportDataSource extends DataSource, CascadeAction {
+    source: "export";
+    execute?: FunctionType;
+    pathname?: string;
+    settings?: string;
+    params?: unknown;
+    persist?: boolean;
+}