@mantou/gem 1.7.11 → 2.0.0-alpha.0

package/lib/decorators.d.ts

@@ -1,34 +1,25 @@
+import type { createCSSSheet, Metadata, TemplateResult } from './element';
 import { GemElement } from './element';
-import { Store } from './store';
-import { Sheet } from './utils';
-type GemElementPrototype = GemElement<any>;
-export type RefObject<T = HTMLElement> = {
-    ref: string;
-    element: T | undefined;
-};
+import type { Store } from './store';
+import * as elementExports from './element';
+import * as decoratorsExports from './decorators';
+import * as storeExports from './store';
+import * as versionExports from './version';
 /**
- * 引用元素，只有第一个标记 ref 的元素有效
+ * 定义一个响应式的 attribute，驼峰字段名将自动映射到烤串 attribute，默认值为空字符串；不要覆盖定义
  *
  * For example
  * ```ts
  *  class App extends GemElement {
- *    @refobject childRef: RefObject<Children>;
- *    loadHandle = () => {
- *      const { element } = this.childRef;
- *      console.log(element);
- *    };
- *    render() {
- *      render html`<div ref=${this.childRef.ref}><div>`;
- *    }
+ *    @attribute attr: string;
  *  }
  * ```
  */
-export declare function refobject(target: GemElementPrototype, prop: string): void;
-export declare function attribute(target: GemElementPrototype, prop: string): void;
-export declare function boolattribute(target: GemElementPrototype, prop: string): void;
-export declare function numattribute(target: GemElementPrototype, prop: string): void;
+export declare function attribute<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, string>): (this: any, initValue: any) => any;
+export declare function boolattribute<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, boolean>): (this: any, initValue: any) => any;
+export declare function numattribute<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, number>): (this: any, initValue: any) => any;
 /**
- * 定义一个响应式的 property，注意值可能为 `undefined`
+ * 定义一个响应式的 property，注意值可能为 `undefined`；不要覆盖定义
  *
  * For example
  * ```ts
@@ -37,7 +28,45 @@ export declare function numattribute(target: GemElementPrototype, prop: string):
  *  }
  * ```
  */
-export declare function property(target: GemElementPrototype, prop: string): void;
+export declare function property<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T>): (this: any, initValue: any) => any;
+/**
+ * 依赖 `GemElement.memo`
+ *
+ * For example
+ * ```ts
+ *  class App extends GemElement {
+ *    @memo(() => [])
+ *    get data() {
+ *      return 1;
+ *    }
+ *  }
+ * ```
+ */
+export declare function memo<T extends GemElement, V = any, K = any[] | undefined>(getDep?: K extends readonly any[] ? (instance: T) => K : undefined): (_: any, context: ClassGetterDecoratorContext<T, V> | ClassFieldDecoratorContext<T> | ClassMethodDecoratorContext<T>) => void;
+/**
+ * 依赖 `GemElement.effect`
+ * 方法执行在字段前面
+ *
+ * For example
+ * ```ts
+ *  class App extends GemElement {
+ *    @effect(() => [])
+ *    #fetchData() {
+ *      console.log('fetch')
+ *    }
+ *  }
+ * ```
+ */
+export declare function effect<T extends GemElement, V extends (depValues: K, oldDepValues?: K) => any, K = any[] | undefined>(getDep?: K extends readonly any[] ? (instance: T) => K : undefined): (_: any, { addInitializer, access }: ClassFieldDecoratorContext<T, V> | ClassMethodDecoratorContext<T, V>) => void;
+export declare function unmounted<T extends GemElement, V extends () => any>(): (_: any, { addInitializer, access }: ClassFieldDecoratorContext<T, V> | ClassMethodDecoratorContext<T, V>) => void;
+/**`@memo` 别名，不能再在回调中使用 `this.memo` */
+export declare function willMount(): (_: any, context: ClassGetterDecoratorContext<GemElement, any> | ClassFieldDecoratorContext<GemElement, unknown> | ClassMethodDecoratorContext<GemElement, (this: GemElement, ...args: any) => any>) => void;
+/**`@effect` 别名，不能再在回调中使用 `this.effect` */
+export declare function mounted(): (_: any, { addInitializer, access }: ClassFieldDecoratorContext<GemElement, (depValues: never[], oldDepValues?: never[] | undefined) => any> | ClassMethodDecoratorContext<GemElement, (depValues: never[], oldDepValues?: never[] | undefined) => any>) => void;
+export declare function template<T extends GemElement, V extends () => TemplateResult | null | undefined>(
+/** 当所有 `template` 返回 `false` 时不进行更新，包括 `memo` */
+condition?: (instance: T) => boolean): (_: any, { addInitializer, access }: ClassFieldDecoratorContext<T, V> | ClassMethodDecoratorContext<T, V>) => void;
+export declare function fallback<T extends GemElement, V extends (err: any) => TemplateResult | null | undefined>(): (_: any, { addInitializer, access }: ClassFieldDecoratorContext<T, V> | ClassMethodDecoratorContext<T, V>) => void;
 /**
  * 定义一个元素[内部](https://html.spec.whatwg.org/multipage/custom-elements.html#elementinternals) state，
  * 类似 `:checked`，用于自定义 css 伪类（:state(xxx)），默认值即为字段名。
@@ -51,7 +80,7 @@ export declare function property(target: GemElementPrototype, prop: string): voi
  *  }
  * ```
  */
-export declare function state(target: GemElementPrototype, prop: string): void;
+export declare function state<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, boolean>): void;
 /**
  * 定义一个内部 slot，默认值即为字段名，不能使用全局属性 `slot`
  *
@@ -63,7 +92,7 @@ export declare function state(target: GemElementPrototype, prop: string): void;
  *  }
  * ```
  */
-export declare function slot(target: any, prop: string): void;
+export declare function slot(_: undefined, context: ClassFieldDecoratorContext<any, string>): (this: any, value: string) => string;
 /**
  * 定义一个内部 part，默认值即为字段名，不能使用全局属性 `part`
  *
@@ -75,8 +104,8 @@ export declare function slot(target: any, prop: string): void;
  *  }
  * ```
  */
-export declare function part(target: any, prop: string): void;
-export type Emitter<T = any> = (detail: T, options?: Omit<CustomEventInit<unknown>, 'detail'>) => void;
+export declare function part(_: undefined, context: ClassFieldDecoratorContext<any, string>): (this: any, value: string) => string;
+export type Emitter<T = any> = (detail?: T, options?: Omit<CustomEventInit<unknown>, 'detail'>) => void;
 /**
  * 定义一个事件发射器，类似 `HTMLElement.click`，
  * 调用时将同步发送一个和字段名称的烤串式格式的自定义事件
@@ -88,10 +117,10 @@ export type Emitter<T = any> = (detail: T, options?: Omit<CustomEventInit<unknow
  *  }
  * ```
  */
-export declare function emitter(target: GemElementPrototype, prop: string): void;
-export declare function globalemitter(target: GemElementPrototype, prop: string): void;
+export declare function emitter<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, Emitter>): void;
+export declare function globalemitter<T extends GemElement>(_: undefined, context: ClassFieldDecoratorContext<T, Emitter>): void;
 /**
- * 分配一个构造的样式表，如果元素是 lightDOM，则将样式表挂载到 RootNode 上
+ * 分配一个构造的样式表，前面的优先级越高（因为装饰器是越近越早执行）
  *
  * For example
  * ```ts
@@ -99,7 +128,7 @@ export declare function globalemitter(target: GemElementPrototype, prop: string)
  *  class App extends GemElement {}
  * ```
  */
-export declare function adoptedStyle(style: Sheet<unknown>): (cls: unknown) => void;
+export declare function adoptedStyle(sheet: ReturnType<typeof createCSSSheet>): (_: unknown, context: ClassDecoratorContext) => void;
 /**
  * 链接一个 store，当 store 更新时更新元素
  *
@@ -109,17 +138,17 @@ export declare function adoptedStyle(style: Sheet<unknown>): (cls: unknown) => v
  *  class App extends GemElement {}
  * ```
  */
-export declare function connectStore(store: Store<unknown>): (cls: unknown) => void;
+export declare function connectStore(store: Store<unknown>): (_: unknown, context: ClassDecoratorContext) => void;
+export declare function shadow({ mode, serializable, delegatesFocus, slotAssignment, }?: Partial<ShadowRootInit>): (_: any, context: ClassDecoratorContext) => void;
 /**
- * 限制元素的 root 节点类型
- *
- * For example
- * ```ts
- *  @rootElement('my-element')
- *  class App extends GemElement {}
- * ```
+ * 将元素标记为可中断异步渲染
+ * 例如：https://examples.gemjs.org/async
+ */
+export declare function async(): (_: any, context: ClassDecoratorContext) => void;
+/**
+ * 定义元素的可访问性属性
  */
-export declare function rootElement(rootType: string): (cls: unknown) => void;
+export declare function aria(info: Metadata['aria']): (_: any, context: ClassDecoratorContext) => void;
 /**
  * 定义自定义元素
  *
@@ -129,6 +158,10 @@ export declare function rootElement(rootType: string): (cls: unknown) => void;
  *  class App extends GemElement {}
  * ```
  */
-export declare function customElement(name: string): (cls: unknown) => void;
-export {};
+export declare function customElement(name: string): (cls: new (...args: any) => any, { addInitializer }: ClassDecoratorContext) => void;
+declare global {
+    interface Window {
+        __GEM_DEVTOOLS__HOOK__?: (typeof elementExports & typeof decoratorsExports & typeof storeExports & typeof versionExports) | Record<string, never>;
+    }
+}
 //# sourceMappingURL=decorators.d.ts.map

package/lib/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/lib/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8D,UAAU,EAAuB,MAAM,WAAW,CAAC;AACxH,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,KAAK,EAA+B,MAAM,SAAS,CAAC;AAE7D,KAAK,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;AAiB3C,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,WAAW,IAAI;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAIlE;AAgBD,wBAAgB,SAAS,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAElE;AACD,wBAAgB,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAItE;AACD,wBAAgB,YAAY,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAIrE;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAGjE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAI9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,QAI7C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,QAI7C;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,KAAK,IAAI,CAAC;AAEvG;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAEhE;AACD,wBAAgB,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,QAEtE;AAOD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,SAC1B,OAAO,UAI9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,SAC1B,OAAO,UAI9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,SACpB,OAAO,UAI9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,SAClB,OAAO,UAG9B"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/lib/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAyD,MAAM,WAAW,CAAC;AAE9F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,cAAc,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,iBAAiB,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,YAAY,MAAM,SAAS,CAAC;AACxC,OAAO,KAAK,cAAc,MAAM,WAAW,CAAC;AAgI5C;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,MAAM,CAAC,UAfnF,GAAG,aAAa,GAAG,SAiB3C;AACD,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,UAlBxF,GAAG,aAAa,GAAG,SAoB3C;AACD,wBAAgB,YAAY,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,MAAM,CAAC,UArBtF,GAAG,aAAa,GAAG,SAuB3C;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAC,UAW1E,GAAG,aAAa,GAAG,SAG3C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,SAAS,EACvE,MAAM,CAAC,EAAE,CAAC,SAAS,SAAS,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,OAG7D,GAAG,WACG,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,CAAC,UAc9G;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,SAAS,EACnH,MAAM,CAAC,EAAE,CAAC,SAAS,SAAS,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,OAG7D,GAAG,8BACsB,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,UAMnG;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,GAAG,SAE5D,GAAG,8BACsB,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,UASnG;AAED,sCAAsC;AACtC,wBAAgB,SAAS,QA3DlB,GAAG,sMA6DT;AAED,0CAA0C;AAC1C,wBAAgB,OAAO,QA7BhB,GAAG,iIAJiF,GAAG,wGAAH,GAAG,WAmC7F;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,cAAc,GAAG,IAAI,GAAG,SAAS;AAC9F,iDAAiD;AACjD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,OAG/B,GAAG,8BACsB,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,UASnG;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,KAAK,cAAc,GAAG,IAAI,GAAG,SAAS,SAEjG,GAAG,8BACsB,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,2BAA2B,CAAC,CAAC,EAAE,CAAC,CAAC,UAQnG;AAsBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,QAWxG;AAsBD;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,MAAM,CAAC,UAC1D,GAAG,SAAS,MAAM,YAG1C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,MAAM,CAAC,UAC1D,GAAG,SAAS,MAAM,YAG1C;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,KAAK,IAAI,CAAC;AAExG;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,QAI1G;AACD,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,OAAO,CAAC,QAIhH;AAgBD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,OAC/C,OAAO,WAAW,qBAAqB,UAG5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,OAC5B,OAAO,WAAW,qBAAqB,UAG5D;AAED,wBAAgB,MAAM,CAAC,EACrB,IAAa,EACb,YAAmB,EACnB,cAAc,EACd,cAAc,GACf,GAAE,OAAO,CAAC,cAAc,CAAM,OACT,GAAG,WAAW,qBAAqB,UAIxD;AAED;;;GAGG;AACH,wBAAgB,KAAK,QACC,GAAG,WAAW,qBAAqB,UAIxD;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,OACrB,GAAG,WAAW,qBAAqB,UAIxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,SAClB,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,sBAAsB,qBAAqB,UAK3F;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,sBAAsB,CAAC,EACnB,CAAC,OAAO,cAAc,GAAG,OAAO,iBAAiB,GAAG,OAAO,YAAY,GAAG,OAAO,cAAc,CAAC,GAChG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;KAC3B;CACF"}