glass-easel-miniprogram-adapter 0.1.0

package/dist/types/src/types.d.ts

@@ -0,0 +1,77 @@
+import { DeepCopyKind, typeUtils as utils } from 'glass-easel';
+import type { DefinitionFilter, GeneralBehavior, Behavior } from './behavior';
+export { typeUtils as utils } from 'glass-easel';
+export declare const enum StyleIsolation {
+    Isolated = "isolated",
+    ApplyShared = "apply-shared",
+    Shared = "shared",
+    PageIsolated = "page-isolated",
+    PageApplyShared = "page-apply-shared",
+    PageShared = "page-shared"
+}
+export type ComponentStaticConfig = {
+    component?: boolean;
+    usingComponents?: {
+        [name: string]: string;
+    };
+    generics?: {
+        [name: string]: true | {
+            default?: string;
+        };
+    };
+    placeholder?: {
+        [name: string]: string;
+    };
+    styleIsolation?: StyleIsolation;
+    /** @obsolete */
+    addGlobalClass?: boolean;
+    pureDataPattern?: string;
+};
+export type ComponentDefinitionOptions = {
+    multipleSlots?: boolean;
+    pureDataPattern?: RegExp;
+    virtualHost?: boolean;
+    dataDeepCopy?: DeepCopyKind;
+    propertyPassingDeepCopy?: DeepCopyKind;
+    propertyEarlyInit?: boolean;
+};
+type ComponentMethod = utils.ComponentMethod;
+export type BehaviorDefinition<TData extends utils.DataList, TProperty extends utils.PropertyList, TMethod extends utils.MethodList> = {
+    behaviors?: Behavior<any, any, any, any>[];
+    properties?: TProperty;
+    data?: TData | (() => TData);
+    observers?: ({
+        fields?: string;
+        observer: ComponentMethod;
+    })[] | {
+        [fields: string]: ComponentMethod;
+    };
+    methods?: TMethod;
+    created?: ComponentMethod;
+    attached?: ComponentMethod;
+    ready?: ComponentMethod;
+    moved?: ComponentMethod;
+    detached?: ComponentMethod;
+    lifetimes?: {
+        [name: string]: ComponentMethod;
+    };
+    pageLifetimes?: {
+        [name: string]: ComponentMethod;
+    };
+    relations?: utils.RelationParamsWithKey;
+    externalClasses?: string[];
+    definitionFilter?: DefinitionFilter;
+};
+export type ComponentDefinition<TData extends utils.DataList, TProperty extends utils.PropertyList, TMethod extends utils.MethodList, TComponentExport> = {
+    options?: ComponentDefinitionOptions;
+    export?: () => TComponentExport;
+} & BehaviorDefinition<TData, TProperty, TMethod>;
+export type GeneralComponentDefinition = ComponentDefinition<any, any, any, any>;
+export type PageDefinition<TData extends utils.DataList, TExtraFields extends {
+    [k: PropertyKey]: any;
+}> = TExtraFields & {
+    options?: ComponentDefinitionOptions;
+    behaviors?: GeneralBehavior[];
+    data?: TData;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,IAAI,KAAK,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE7E,OAAO,EAAE,SAAS,IAAI,KAAK,EAAE,MAAM,aAAa,CAAA;AAEhD,0BAAkB,cAAc;IAC9B,QAAQ,aAAa;IACrB,WAAW,iBAAiB;IAC5B,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,eAAe,sBAAsB;IACrC,UAAU,gBAAgB;CAC3B;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,eAAe,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,QAAQ,CAAC,EAAE;QACT,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG;YAAE,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAC5C,CAAA;IACD,WAAW,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACxC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,gBAAgB;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,uBAAuB,CAAC,EAAE,YAAY,CAAC;IACvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAA;AAED,KAAK,eAAe,GAAG,KAAK,CAAC,eAAe,CAAA;AAE5C,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,KAAK,CAAC,QAAQ,EAC5B,SAAS,SAAS,KAAK,CAAC,YAAY,EACpC,OAAO,SAAS,KAAK,CAAC,UAAU,IAC9B;IACF,SAAS,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAC3C,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,IAAI,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;IAC7B,SAAS,CAAC,EACR,CAAC;QACC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,eAAe,CAAC;KAC3B,CAAC,EAAE,GACF;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAA;IACzC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;IAChD,aAAa,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;IACpD,SAAS,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC;IACxC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAA;AAED,MAAM,MAAM,mBAAmB,CAC7B,KAAK,SAAS,KAAK,CAAC,QAAQ,EAC5B,SAAS,SAAS,KAAK,CAAC,YAAY,EACpC,OAAO,SAAS,KAAK,CAAC,UAAU,EAChC,gBAAgB,IACd;IACF,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,gBAAgB,CAAC;CACjC,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;AAEjD,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAEhF,MAAM,MAAM,cAAc,CACxB,KAAK,SAAS,KAAK,CAAC,QAAQ,EAC5B,YAAY,SAAS;IAAE,CAAC,CAAC,EAAE,WAAW,GAAG,GAAG,CAAA;CAAE,IAC5C,YAAY,GAAG;IACjB,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAA"}

package/dist/types/src/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const guid: () => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,QAAO,MAEb,CAAA"}

package/dist/types/tests/base/env.d.ts

@@ -0,0 +1,3 @@
+import * as glassEasel from 'glass-easel';
+export declare const tmpl: (src: string) => glassEasel.template.ComponentTemplate;
+//# sourceMappingURL=env.d.ts.map

package/dist/types/tests/base/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../../../tests/base/env.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,UAAU,MAAM,aAAa,CAAA;AAGzC,eAAO,MAAM,IAAI,QAAS,MAAM,KAAG,WAAW,QAAQ,CAAC,iBAatD,CAAA"}

package/dist/types/tests/data_update.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data_update.test.d.ts.map

package/dist/types/tests/data_update.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data_update.test.d.ts","sourceRoot":"","sources":["../../../tests/data_update.test.ts"],"names":[],"mappings":""}

package/dist/types/tests/env.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=env.test.d.ts.map

package/dist/types/tests/env.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.test.d.ts","sourceRoot":"","sources":["../../../tests/env.test.ts"],"names":[],"mappings":""}

package/dist/types/tests/selector.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=selector.test.d.ts.map

package/dist/types/tests/selector.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selector.test.d.ts","sourceRoot":"","sources":["../../../tests/selector.test.ts"],"names":[],"mappings":""}

package/dist/types/tests/space.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=space.test.d.ts.map

package/dist/types/tests/space.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space.test.d.ts","sourceRoot":"","sources":["../../../tests/space.test.ts"],"names":[],"mappings":""}

package/dist/types/tests/trait_behavior.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=trait_behavior.test.d.ts.map

package/dist/types/tests/trait_behavior.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trait_behavior.test.d.ts","sourceRoot":"","sources":["../../../tests/trait_behavior.test.ts"],"names":[],"mappings":""}

package/jest.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  preset: 'ts-jest/presets/js-with-babel',
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.json',
+    },
+  },
+  roots: ['tests'],
+  testEnvironment: 'jsdom',
+  "collectCoverageFrom": [
+    "src/**/*.ts"
+  ],
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "glass-easel-miniprogram-adapter",
+  "description": "The MiniProgram interface adapter of the glass-easel project",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wechat-miniprogram/glass-easel.git"
+  },
+  "keywords": ["glass-easel"],
+  "author": "wechat-miniprogram",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/wechat-miniprogram/glass-easel/issues"
+  },
+  "homepage": "https://github.com/wechat-miniprogram/glass-easel",
+  "main": "dist/glass_easel_miniprogram_adapter.js",
+  "scripts": {
+    "doc": "typedoc src/index.ts --excludePrivate --excludeProtected --excludeInternal",
+    "build": "webpack --config webpack.config.js",
+    "dev": "webpack --config webpack.config.js --watch",
+    "lint": "eslint src/**/*.ts",
+    "test": "jest -c jest.config.js",
+    "coverage": "jest -c jest.config.js --collect-coverage"
+  },
+  "peerDependencies": {
+    "glass-easel": "*"
+  },
+  "devDependencies": {
+    "glass-easel": "*",
+    "glass-easel-template-compiler": "*"
+  }
+}

package/src/backend.ts

@@ -0,0 +1,106 @@
+import * as glassEasel from 'glass-easel'
+import { MiniProgramEnv, StyleIsolation } from '.'
+import { CodeSpace } from './space'
+
+/**
+ * A backend context that has been associated to an environment
+ */
+export class AssociatedBackend {
+  private _$env: MiniProgramEnv
+  /** @internal */
+  _$: glassEasel.GeneralBackendContext
+
+  /** @internal */
+  constructor(env: MiniProgramEnv, backendContext: glassEasel.GeneralBackendContext) {
+    this._$env = env
+    this._$ = backendContext
+  }
+
+  /**
+   * Register a style sheet resource
+   *
+   * Some backend cannot load style sheet URL.
+   * In this cases, the content should be registered here.
+   */
+  registerStyleSheetContent(url: string, content: any) {
+    this._$.registerStyleSheetContent(url, content)
+  }
+
+  /**
+   * Create a root component in specified backend
+   *
+   * The component is searched in the `codeSpace` with `url` .
+   * If `url` contains "?" params, it will be parsed and try to set to component properties.
+   */
+  createRoot(
+    tagName: string,
+    codeSpace: CodeSpace,
+    url: string,
+    genericTargets?: { [key: string]: string },
+  ): Root {
+    if (this._$env !== codeSpace._$env) throw new Error('The code space is not in the same environment as the backend')
+    return new Root(this._$, tagName, codeSpace, url, genericTargets)
+  }
+}
+
+/**
+ * A root component
+ */
+export class Root {
+  private _$comp: glassEasel.GeneralComponent
+
+  /** @internal */
+  constructor(
+    backendContext: glassEasel.GeneralBackendContext,
+    tagName: string,
+    codeSpace: CodeSpace,
+    url: string,
+    genericTargets?: { [key: string]: string },
+  ) {
+    this._$comp = codeSpace.getComponentSpace().createComponentByUrl(
+      tagName,
+      url,
+      genericTargets || null,
+      backendContext,
+    )
+    if (codeSpace.isMainSpace()) {
+      const globalStyleSheet = codeSpace.getStyleSheet('app')
+      if (globalStyleSheet !== undefined) {
+        const styleIsolation = codeSpace._$styleIsolationMap[this._$comp.is]
+        if (
+          styleIsolation === StyleIsolation.Isolated
+          || styleIsolation === StyleIsolation.ApplyShared
+          || styleIsolation === StyleIsolation.Shared
+        ) {
+          backendContext.appendStyleSheetPath(globalStyleSheet, codeSpace._$sharedStyleScope)
+        }
+      }
+    }
+    const addStyleSheet = (comp: glassEasel.GeneralComponentDefinition) => {
+      const { styleScope } = comp.getComponentOptions()
+      const path = codeSpace.getStyleSheet(comp.is)
+      if (path !== undefined) {
+        backendContext.appendStyleSheetPath(path, styleScope)
+      }
+    }
+    this._$comp.getRootBehavior().getComponentDependencies().forEach(addStyleSheet)
+    addStyleSheet(this._$comp.getComponentDefinition())
+  }
+
+  /**
+   * Get the underlying component
+   */
+  getComponent(): glassEasel.GeneralComponent {
+    return this._$comp
+  }
+
+  /**
+   * Attach the root component to the backend
+   *
+   * This component, the `parent` and the `placeholder` MUST be in the same context.
+   * The `parent` MUST be a parent node of the `placeholder` .
+   */
+  attach(parent: glassEasel.GeneralBackendElement, placeholder: glassEasel.GeneralBackendElement) {
+    glassEasel.Element.replaceDocumentElement(this._$comp, parent, placeholder)
+  }
+}

package/src/behavior.ts

@@ -0,0 +1,101 @@
+import * as glassEasel from 'glass-easel'
+import {
+  GeneralComponentDefinition,
+  utils as typeUtils,
+} from './types'
+
+type DataList = typeUtils.DataList
+type PropertyList = typeUtils.PropertyList
+type MethodList = typeUtils.MethodList
+type ChainingFilterType = typeUtils.ChainingFilterType
+
+export type DefinitionFilter =
+(
+  target: GeneralComponentDefinition,
+  childFilters: (
+    ((target: GeneralComponentDefinition) => void)
+    | null
+  )[],
+) => void
+
+export type GeneralBehavior = Behavior<
+  Record<string, any>,
+  Record<string, any>,
+  Record<string, any>,
+  any
+>
+
+export class Behavior<
+  TData extends DataList,
+  TProperty extends PropertyList,
+  TMethod extends MethodList,
+  TChainingFilter extends ChainingFilterType,
+> {
+  /** @internal */
+  _$: glassEasel.GeneralBehavior
+  /** @internal */
+  _$bindedDefinitionFilter?: ((target: GeneralComponentDefinition) => void)
+
+  /** @internal */
+  constructor(
+    inner: glassEasel.Behavior<
+      TData,
+      TProperty,
+      TMethod,
+      TChainingFilter
+    >,
+    parents: GeneralBehavior[],
+    definitionFilter: DefinitionFilter | undefined,
+  ) {
+    this._$ = inner as glassEasel.GeneralBehavior
+
+    // processing definition filter
+    if (definitionFilter !== undefined) {
+      const definitionFilterArgs = parents.map((p) => p._$bindedDefinitionFilter ?? null)
+      this._$bindedDefinitionFilter = (childDef) => {
+        definitionFilter(childDef, definitionFilterArgs)
+      }
+    }
+  }
+}
+
+export class ComponentType<
+  TData extends DataList,
+  TProperty extends PropertyList,
+  TMethod extends MethodList,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  TComponentExport,
+> {
+  /** @internal */
+  _$: glassEasel.ComponentDefinition<
+    TData,
+    TProperty,
+    TMethod
+  >
+
+  /** @internal */
+  constructor(
+    inner: glassEasel.ComponentDefinition<
+      TData,
+      TProperty,
+      TMethod
+    >,
+  ) {
+    this._$ = inner
+  }
+}
+
+export class TraitBehavior<
+  TIn extends { [key: string]: any },
+  TOut extends { [key: string]: any } = TIn,
+> {
+  /** @internal */
+  _$: glassEasel.TraitBehavior<TIn, TOut>
+
+  /** @internal */
+  constructor(inner: glassEasel.TraitBehavior<TIn>)
+  constructor(inner: glassEasel.TraitBehavior<TIn, TOut>)
+  constructor(inner: glassEasel.TraitBehavior<TIn, TOut>) {
+    this._$ = inner
+  }
+}