annil 1.0.0

package/src/api/RootComponent/Lifetimes/test/error.test.ts

@@ -0,0 +1,33 @@
+import { RootComponent } from "../..";
+/**
+ *  1 组件时(无ispage字段或为false),
+ */
+RootComponent()({
+  lifetimes: {
+    // beforeCreate() {},
+
+    created() {},
+
+    attached() {},
+
+    ready() {},
+
+    detached() {},
+
+    error(err) {
+      err.cause;
+    },
+    moved() {},
+    // @ts-expect-error  错误的声明周期字段报错
+    xxx() {},
+  },
+});
+
+/**
+ *  2. 页面时 不开启lifetimes字段
+ */
+RootComponent()({
+  isPage: true,
+  // @ts-expect-error 页面时未开启此字段
+  lifetimes: {},
+});

package/src/api/RootComponent/Lifetimes/test/normal.test.ts

@@ -0,0 +1,26 @@
+import { RootComponent } from "../../../..";
+
+/**
+ * 组件时(无ispage字段或为false)，lifetimes为官方约束 + beforeCreate声明周期
+ */
+RootComponent()({
+  lifetimes: {
+    // 新增声明周期用于查看实例初始化之前的配置文件
+    // beforeCreate(opitons) {
+    //   opitons;
+    // },
+    created() {
+    },
+    attached() {
+    },
+    ready() {
+    },
+    detached() {
+    },
+    error(err) {
+      err.cause;
+    },
+    moved() {
+    },
+  },
+});

package/src/api/RootComponent/Methods/MethodsConstraint.ts

@@ -0,0 +1,3 @@
+import type { Func } from "hry-types/src/Misc/Func";
+
+export type MethodsConstraint = Record<string, Func>;

package/src/api/RootComponent/Methods/MethodsOption.ts

@@ -0,0 +1,12 @@
+import type { V } from "hry-types";
+
+import type { MethodsConstraint } from "./MethodsConstraint";
+
+export type MethodsOption<
+  TMethods extends MethodsConstraint,
+  DuplicateField extends PropertyKey,
+> = {
+  methods?:
+    & TMethods
+    & V.DuplicateFieldValidator<TMethods, DuplicateField>;
+};

package/src/api/RootComponent/Methods/test/error.test.ts

@@ -0,0 +1,41 @@
+import { RootComponent } from "../..";
+
+/**
+ * 重复字段错误
+ */
+RootComponent()({
+  events: {
+    eventField() {
+      1;
+    },
+  },
+  customEvents: {
+    customField: String,
+  },
+  methods: {
+    // @ts-expect-error "⚠️与events字段重复⚠️"
+    eventField() {
+      1;
+    },
+    // @ts-expect-error "⚠️与customEvents字段重复⚠️"
+    customField() {
+      2;
+    },
+  },
+});
+
+/**
+ * 2. 没有的字段报错
+ */
+RootComponent()({
+  methods: {
+    M1() {
+      1;
+    },
+
+    M2() {
+      // @ts-expect-error 没有的字段
+      this.M3();
+    },
+  },
+});

package/src/api/RootComponent/Methods/test/mormal.test.ts

@@ -0,0 +1,25 @@
+import { Checking, type Test } from "hry-types";
+import { RootComponent } from "../..";
+
+/**
+ * 1 有methods时 返回Doc中methods类型与定义相同
+ */
+const RootDoc = RootComponent()({
+  methods: {
+    num() {
+      return 1;
+    },
+    str(str: string): string {
+      return str;
+    },
+  },
+});
+
+type RootDocExpected = {
+  methods: {
+    num: () => 1;
+    str: (str: string) => string;
+  };
+};
+
+Checking<typeof RootDoc, RootDocExpected, Test.Pass>;

package/src/api/RootComponent/PageLifetimes/PageLifetimesOption.ts

@@ -0,0 +1,31 @@
+import type { IfExtends } from "hry-types/src/Any/IfExtends";
+import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
+import type { WMCompPageLifetimes, WMPageLifetimes } from "../../../types/OfficialTypeAlias";
+import type { RemoveNullOfRequired } from "../../../types/RemoveNullOfRequired";
+
+export type PageLifetimesOption<TIsPage extends boolean, PropertiesDoc extends object> = IfExtends<
+  TIsPage,
+  false,
+  {
+    pageLifetimes?:
+      // 官方组件页面生命周期
+      & Partial<WMCompPageLifetimes>
+      & {
+        /**
+         * 事件发生在页面load事件后,要求组件为同步组件
+         */
+        load?: () => void;
+      };
+  },
+  {
+    pageLifetimes?:
+      & Partial<Omit<WMPageLifetimes, "onLoad">>
+      // 替换掉官方的 Parameters<WechatMiniprogram.Page.ILifetime['onLoad']>
+      & {
+        onLoad?: (
+          // 必传字段去掉null
+          props: ComputeIntersection<Required<RemoveNullOfRequired<PropertiesDoc>>>,
+        ) => void;
+      };
+  }
+>;

package/src/api/RootComponent/PageLifetimes/test/error.test.ts

@@ -0,0 +1,28 @@
+import { RootComponent } from "../..";
+/**
+ *  1 组件时(无ispage字段或为false),
+ */
+RootComponent()({
+  pageLifetimes: {
+    show() {},
+    hide() {},
+    resize() {},
+    load() {},
+    // @ts-expect-error 错误的声明周期
+    xxx() {},
+  },
+});
+
+/**
+ *  2. 页面时
+ */
+RootComponent()({
+  isPage: true,
+  pageLifetimes: {
+    onLoad(props) {
+      props;
+    },
+    // @ts-expect-error 错误的声明周期
+    xxx() {},
+  },
+});

package/src/api/RootComponent/PageLifetimes/test/normal.test.ts

@@ -0,0 +1,61 @@
+import { Checking, type Test } from "hry-types";
+import { RootComponent, type SpecificType } from "../../../..";
+
+import type { RemoveNullOfRequired } from "../../../../types/RemoveNullOfRequired";
+import type { Mock_User } from "../../Properties/expected/normalRequired";
+
+/**
+ * 组件时
+ */
+RootComponent()({
+  // 1  官方类型 加入load类型(同步组件时触发)
+  pageLifetimes: {
+    hide() {},
+    resize(size) {
+      Checking<typeof size, WechatMiniprogram.Page.IResizeOption, Test.Pass>;
+    },
+    show() {},
+    // 新增周期函数
+    load() {},
+  },
+});
+
+/**
+ * 页面时
+ */
+RootComponent()({
+  isPage: true,
+  properties: {
+    str: String,
+    obj: Object,
+    union: {
+      type: Object as SpecificType<Mock_User>,
+      value: { id: "001", name: "zhao" },
+    },
+    optionalObject: {
+      type: Object as SpecificType<Mock_User | null>,
+      value: null,
+    },
+  },
+  // 2 官方是把事件写在methods字段中,更改为写在pageLifetimes字段下
+  pageLifetimes: {
+    // 3 重写onLoad周期参数props的类型. (propertiesDoc中必传字段去除null后去除可选字段)
+    onLoad(props) {
+      Checking<
+        typeof props,
+        Required<
+          RemoveNullOfRequired<{
+            union?: Mock_User;
+            optionalObject?: Mock_User | null;
+            str: string;
+            obj: object;
+          }>
+        >,
+        Test.Pass
+      >;
+    },
+    onHide() {
+      console.log("onHide");
+    },
+  },
+});

package/src/api/RootComponent/Properties/GetOptionalDoc.ts

@@ -0,0 +1,38 @@
+import type { IfExtends } from "hry-types/src/Any/IfExtends";
+import type { Select } from "hry-types/src/Object/Select";
+import type { AddNullForObject } from "../../../types/AddNullForObject";
+import type { InferSpecificType } from "../../../types/InferSpecificType";
+import type { OptionalType, PropertiesConstraint } from "./PropertiesConstraint";
+
+/**
+ * 获取properties可传字段文档类型
+ */
+export type GetOptionalDoc<
+  TProperties extends PropertiesConstraint,
+  TIsPage extends boolean,
+  // @ts-ignore
+  Optional extends Record<string, OptionalType> = Select<TProperties, OptionalType>,
+> = {
+  [k in keyof Optional]?: IfExtends<
+    unknown,
+    Optional[k]["optionalTypes"],
+    IfExtends<
+      false,
+      TIsPage,
+      // 组件时 对象加null
+      AddNullForObject<InferSpecificType<Optional[k]["type"]>>,
+      // 页面时 对象不加
+      InferSpecificType<Optional[k]["type"]>
+    >,
+    IfExtends<
+      false,
+      TIsPage,
+      // 组件时 对象加null
+      AddNullForObject<
+        InferSpecificType<Optional[k]["type"]> | InferSpecificType<(Optional[k]["optionalTypes"] & {})[number]>
+      >,
+      // 页面时 对象不加
+      InferSpecificType<Optional[k]["type"]> | InferSpecificType<(Optional[k]["optionalTypes"] & {})[number]>
+    >
+  >;
+};

package/src/api/RootComponent/Properties/GetPropertiesDoc.ts

@@ -0,0 +1,33 @@
+import type { IfExtends } from "hry-types/src/Any/IfExtends";
+import type { Select } from "hry-types/src/Object/Select";
+
+import type { ComputeIntersection } from "hry-types/src/Object/_api";
+import type { GetOptionalDoc } from "./GetOptionalDoc";
+import type { GetRequiredDoc } from "./GetRequiredDoc";
+import type { OptionalType, PropertiesConstraint } from "./PropertiesConstraint";
+
+type _GetPropertiesDoc<
+  TProperties extends PropertiesConstraint,
+  TIsPage extends boolean,
+  Type extends "Required" | "Optional" | "all" = "all",
+  OptionalDoc = GetOptionalDoc<Select<TProperties, OptionalType>, TIsPage>,
+  RequiredDoc = GetRequiredDoc<Omit<TProperties, keyof OptionalDoc>, TIsPage>,
+> = IfExtends<
+  Type,
+  "all",
+  // @ts-ignore
+  ComputeIntersection<OptionalDoc & RequiredDoc>,
+  IfExtends<Type, "Optional", OptionalDoc, RequiredDoc>
+>;
+
+/**
+ * properties字段的文档类型
+ * @param TProperties - `PropertiesConstraint`
+ * @param Type - "Required" | "Optional" | "all"
+ * @returns  `GetRequiredDoc` | `GetOptionalDoc` | (`GetOptionalDoc` & `GetRequiredDoc`)
+ */
+export type GetPropertiesDoc<
+  TProperties extends PropertiesConstraint,
+  TisPage extends boolean,
+  Type extends "Required" | "Optional" | "all" = "all",
+> = _GetPropertiesDoc<TProperties, TisPage, Type>;

package/src/api/RootComponent/Properties/GetRequiredDoc.ts

@@ -0,0 +1,32 @@
+import type { IfExtends } from "hry-types/src/Any/IfExtends";
+import type { Select } from "hry-types/src/Object/Select";
+import type { AddNullForObject } from "../../../types/AddNullForObject";
+import type { InferSpecificType } from "../../../types/InferSpecificType";
+import type { PropertiesConstraint, RequiredSingle, RequiredType } from "./PropertiesConstraint";
+
+/**
+ * 获取properties必传字段的文档类型
+ * @remarks 小程序中必传字段如果是object,默认类型为null,所以文档类型要联合上null类型
+ */
+export type GetRequiredDoc<
+  TProperties extends PropertiesConstraint,
+  TIsPage extends boolean,
+  // @ts-ignore
+  Required extends Record<string, RequiredType> = Select<TProperties, RequiredType>,
+> = {
+  [k in keyof Required]: IfExtends<
+    Required[k],
+    RequiredSingle,
+    IfExtends<false, TIsPage, AddNullForObject<InferSpecificType<Required[k]>>, InferSpecificType<Required[k]>>,
+    IfExtends<
+      false,
+      TIsPage,
+      // @ts-ignore Required[k] 必为 RequiredUnion
+      | AddNullForObject<InferSpecificType<Required[k]["type"]>>
+      // @ts-ignore Required[k] 必为 RequiredUnion
+      | AddNullForObject<InferSpecificType<Required[k]["optionalTypes"][number]>>,
+      // @ts-ignore Required[k] 必为 RequiredUnion
+      InferSpecificType<Required[k]["type"]> | InferSpecificType<Required[k]["optionalTypes"][number]>
+    >
+  >;
+};

package/src/api/RootComponent/Properties/PropertiesConstraint.ts

@@ -0,0 +1,38 @@
+import type { SpecificType } from "../../../types/SpecificType";
+
+/**
+ * properties 必传(单一)类型
+ */
+export type RequiredSingle = SpecificType;
+
+/**
+ * properties 必传(联合)类型
+ */
+export type RequiredUnion<Literal = unknown> = {
+  type: SpecificType<Literal>;
+  optionalTypes: SpecificType[];
+};
+
+/**
+ * properties 必传类型
+ */
+export type RequiredType<Literal = unknown> = RequiredUnion<Literal> | RequiredSingle;
+
+/**
+ * properties 选传类型
+ */
+export type OptionalType<Literal = unknown> = {
+  type: SpecificType<Literal>;
+  value: Literal;
+  optionalTypes?: SpecificType[];
+};
+
+/**
+ * Properties 字段类型
+ */
+export type PropertiesTypes<Literal = unknown> = OptionalType<Literal> | RequiredType<Literal>;
+
+/**
+ * RootComponent API properties 字段约束
+ */
+export type PropertiesConstraint<Literal = unknown> = Record<string, PropertiesTypes<Literal>>;

package/src/api/RootComponent/Properties/PropertiesOption.ts

@@ -0,0 +1,39 @@
+import type { V } from "hry-types";
+import type { Validators } from "../../../types/Validators";
+import type { PropertiesConstraint } from "./PropertiesConstraint";
+import type { PropertiesValueValidator } from "./PropertiesValueValidator";
+
+/**
+ * properties 配置字段
+ * @remarks 二参 三参为了让AnyPropertiesOption也可以复用这个泛型
+ */
+export type PropertiesOption<
+  TProperties extends PropertiesConstraint,
+> // Prefix extends string = "",
+ = // DuplicateFieldCheck extends PropertyKey = "",
+  {
+    /**
+     * 可通过 as SpecificType<anyType> 书写任意类型
+     * @remarks 禁用observable字段,简写或对象写法无value字段时为必传属性(必传对象类型加入null类型),对象写法有value字段为可选属性.
+     */
+    properties?:
+      & TProperties
+      & Validators<[
+        // PrefixValidator<TProperties, Prefix>,
+        PropertiesValueValidator<TProperties>,
+        // V.DuplicateFieldValidator<TProperties, DuplicateFieldCheck>,
+        // 放在最后一个，正常返回不是unknown 而是Record<string,unknown>
+        V.IllegalFieldValidator<TProperties, "value" | "type" | "optionalTypes", 1>,
+      ]>;
+  };
+
+// export type PrefixValidator<
+//   G extends object,
+//   TPrefix extends string,
+//   Message extends string = "前缀错误",
+//   Result = TPrefix extends "" ? unknown : {
+//     [
+//       k in keyof G as k extends `${TPrefix}_${string}` ? never : k
+//     ]: G[k] extends object ? `⚠️${Message}` : () => `⚠️${Message}`;
+//   },
+// > = EmptyObject extends Result ? unknown : Result;

package/src/api/RootComponent/Properties/PropertiesValueValidator.ts

@@ -0,0 +1,20 @@
+import type { EmptyObject } from "hry-types/src/Misc/EmptyObject";
+import type { InferSpecificType } from "../../../types/InferSpecificType";
+
+/**
+ * 验证properties的value类型是否正确
+ * @returns unknown | `{ value: () => "⚠️类型错误⚠️" }`
+ */
+export type PropertiesValueValidator<
+  TProperties,
+  Result = {
+    [
+      k in keyof TProperties as TProperties[k] extends {
+        type: infer R;
+        value: infer V;
+      } ? V extends InferSpecificType<R> ? never
+        : k
+        : never
+    ]: { value: () => "⚠️类型错误⚠️" };
+  },
+> = EmptyObject extends Result ? unknown : Result;

package/src/api/RootComponent/Properties/expected/error.ts

@@ -0,0 +1,49 @@
+import { RootComponent, type SpecificType } from "../../../../index";
+import type { Mock_Cart } from "./normalRequired";
+
+// 1 非法字段
+RootComponent()({
+  properties: {
+    num: {
+      type: Number,
+      // @ts-expect-error   非法字段 values多了`s`
+      values: 123,
+    },
+    bool: {
+      type: Boolean,
+      value: true,
+      // @ts-expect-error   非法字段 optionalType少了`s`
+      optionalType: [String],
+    },
+    union: {
+      type: Number,
+      value: 123,
+      optionalTypes: [String],
+      // @ts-expect-error   非法字段 observable
+      observable: "",
+    },
+  },
+});
+
+// 2 value 类型错误
+RootComponent()({
+  properties: {
+    str: {
+      type: String,
+      // @ts-expect-error 类型错误
+      value: 123,
+    },
+    optionalObj: {
+      // @ts-expect-error 可选对象value若写null,需要先定义
+      type: Object as SpecificType<Mock_Cart>,
+      // @ts-expect-error 可选对象value若写null,需要先定义
+      value: null,
+    },
+    str_num: {
+      type: String,
+      // @ts-expect-error 类型错误 应该写type字段类型(string)而非optionalTypes中的类型
+      value: 123,
+      optionalTypes: [Number],
+    },
+  },
+});

package/src/api/RootComponent/Properties/expected/normalEmpty.ts

@@ -0,0 +1,33 @@
+import { Checking, type Test } from "hry-types";
+import { RootComponent } from "../..";
+
+/**
+ * Properties配置为`{}`时
+ */
+const emptyObj = RootComponent()({
+  properties: {},
+  methods: {
+    foo() {
+      // 1 this.data 为空对象类型
+      Checking<typeof this.data, {}, Test.Pass>;
+    },
+  },
+});
+
+// 2 返回文档类型无properties字段
+Checking<typeof emptyObj, { methods: { foo: () => void } }, Test.Pass>;
+
+/**
+ * 无Properties配置时
+ */
+const noProperties = RootComponent()({
+  methods: {
+    foo() {
+      // 3 this.data 为空对象类型
+      Checking<typeof this.data, {}, Test.Pass>;
+    },
+  },
+});
+
+// 4 返回文档类型无properties字段
+Checking<typeof noProperties, { methods: { foo(): void } }, Test.Pass>;