annil 1.16.0 → 1.18.0

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

@@ -1,29 +0,0 @@
-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";
-
-export type PageLifetimesOption<TIsPage extends boolean, PropertiesDoc extends object> = IfExtends<
-  TIsPage,
-  false,
-  {
-    pageLifetimes?: Partial<WMCompPageLifetimes>;
-  },
-  {
-    /**
-     * 官方要求写入methods中的页面生命周期
-     */
-    pageLifetimes?: ComputeIntersection<
-      & Partial<Omit<WMPageLifetimes, "onLoad">>
-      // 替换掉官方的 Parameters<WechatMiniprogram.Page.ILifetime['onLoad']>
-      & {
-        /** 生命周期回调—监听页面加载
-         *
-         * 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取Properties定义的数据。
-         */
-        onLoad?: (
-          props: Required<PropertiesDoc>,
-        ) => void | Promise<void>;
-      }
-    >;
-  }
->;

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

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

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

@@ -1,71 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import { type DetailedType, RootComponent } from "../../../..";
-
-import type { Mock_User } from "../../Properties/test/normalRequired.test";
-
-/**
- * 组件时
- */
-RootComponent()({
-  pageLifetimes: {
-    hide() {
-      void 0;
-    },
-    resize(size) {
-      void size;
-      void Checking<typeof size, WechatMiniprogram.Page.IResizeOption, Test.Pass>;
-    },
-    show() {
-      void 0;
-    },
-  },
-});
-
-/**
- * 页面时
- */
-RootComponent()({
-  isPage: true,
-  properties: {
-    str: String,
-    obj: Object,
-    union: {
-      type: Object as DetailedType<Mock_User>,
-      value: { id: "001", name: "zhao" },
-    },
-    optionalObject: {
-      type: Object as DetailedType<Mock_User | null>,
-      value: null,
-    },
-  },
-  // 2 官方是把事件写在methods字段中,更改为写在pageLifetimes字段下
-  pageLifetimes: {
-    // 3 重写onLoad周期参数props的类型(同页面properties定义类型).
-    onLoad(props) {
-      void props;
-      void Checking<
-        typeof props,
-        {
-          union: Mock_User;
-          optionalObject: Mock_User | null;
-          str: string;
-          obj: object;
-        },
-        Test.Pass
-      >;
-    },
-    onHide() {
-      console.log("onHide");
-    },
-    // onReady
-    // onResize
-    // onUnload
-    // onPageScroll
-    // onPullDownRefresh
-    // onReachBottom
-    // onShareAppMessage
-    // onShareTimeline
-    // onTabItemTap
-    // ...
-  },
-});

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

@@ -1,18 +0,0 @@
-import type { IfExtends } from "hry-types/src/Any/IfExtends";
-import type { InferDetailedType } from "../../../types/InferDetailedType";
-import type { OptionalType } from "./PropertiesConstraint";
-
-/**
- * 获取properties可传字段文档类型
- */
-export type GetOptionalDef<
-  TOptionalProperties extends Record<string, OptionalType>,
-> = {
-  -readonly [k in keyof TOptionalProperties]?: IfExtends<
-    unknown,
-    TOptionalProperties[k]["optionalTypes"],
-    InferDetailedType<TOptionalProperties[k]["type"]>,
-    | InferDetailedType<TOptionalProperties[k]["type"]>
-    | InferDetailedType<(TOptionalProperties[k]["optionalTypes"] & {})[number]>
-  >;
-};

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

@@ -1,22 +0,0 @@
-import type { Select } from "hry-types/src/Object/Select";
-
-import type { ComputeIntersection } from "hry-types/src/Object/_api";
-import type { GetOptionalDef } from "./GetOptionalDef";
-
-import type { As } from "hry-types/src/Any/As";
-import type { GetRequiredDef } from "./GetRequiredDef";
-import type { OptionalType, PropertiesConstraint, RequiredType } from "./PropertiesConstraint";
-
-type _GetPropertiesDef<
-  TProperties extends PropertiesConstraint,
-  OptionalDef extends object = GetOptionalDef<As<Select<TProperties, OptionalType>, Record<string, OptionalType>>>,
-  RequiredDef extends object = GetRequiredDef<As<Omit<TProperties, keyof OptionalDef>, Record<string, RequiredType>>>,
-> = ComputeIntersection<OptionalDef & RequiredDef>;
-
-/**
- * properties字段的文档类型
- * @remarks 必传的字段如果是object,要联合上null类型,选传的object根据是否是页面来决定是否加null
- */
-export type GetPropertiesDef<
-  TProperties extends PropertiesConstraint,
-> = _GetPropertiesDef<TProperties>;

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

@@ -1,16 +0,0 @@
-import type { InferDetailedType } from "../../../types/InferDetailedType";
-import type { RequiredSingle, RequiredType, RequiredUnion } from "./PropertiesConstraint";
-
-/**
- * 获取properties必传字段的文档类型
- * @remarks 小程序中必传字段如果是object,默认类型为null,所以组件文档对象类型要联合上null类型
- */
-export type GetRequiredDef<
-  TProperties extends Record<string, RequiredType>,
-> = {
-  -readonly [k in keyof TProperties]: TProperties[k] extends RequiredSingle ? InferDetailedType<TProperties[k]>
-    : TProperties[k] extends RequiredUnion ?
-        | InferDetailedType<TProperties[k]["type"]>
-        | InferDetailedType<TProperties[k]["optionalTypes"][number]>
-    : never;
-};

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

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

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

@@ -1,25 +0,0 @@
-import type { Validators } from "../../../types/Validators";
-import type { PropertiesConstraint } from "./PropertiesConstraint";
-import type { PropertiesValueValidator } from "./PropertiesValueValidator";
-
-export type PropertiesOption<
-  TProperties extends PropertiesConstraint,
-> = {
-  /**
-   * 可通过 as DetailedType<anyType> 书写任意类型
-   * @remarks
-   *
-   * 禁用observable字段(watch代替)
-   *
-   * 简写 → 必传，单一类型。对象写法 + optionalTypes → 必传，联合类型。对象写法 + value → 可选传（有默认值），可同时配合 optionalTypes。
-   *
-   * 有value类型检测和非法字段检测(例如value写出values)
-   */
-  properties?:
-    & TProperties
-    & Validators<[
-      PropertiesValueValidator<TProperties>,
-      // // 放在最后一个，正常返回不是unknown 而是Record<string,unknown>
-      // G.IllegalFieldValidator<TProperties, "value" | "type" | "optionalTypes", 1>,
-    ]>;
-};

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

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

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

@@ -1,49 +0,0 @@
-import { type DetailedType, RootComponent } from "../../../../index";
-import type { Mock_Cart } from "./normalRequired.test";
-
-// 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 对象默认值要写null则必须先定义
-      type: Object as DetailedType<Mock_Cart>,
-      // @ts-expect-error 对象默认值要写null则必须先定义
-      value: null,
-    },
-    str_num: {
-      type: String,
-      // @ts-expect-error 类型错误 应该写type字段类型(string)而非optionalTypes中的类型
-      value: 123,
-      optionalTypes: [Number],
-    },
-  },
-});

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

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

package/src/api/RootComponent/Properties/test/normalOptional.test.ts

@@ -1,118 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import type { ComputeIntersection } from "hry-types/src/Object/_api";
-import type { DetailedType } from "../../../../types/DetailedType";
-import type { IInjectAllData } from "../../../InstanceInject/instanceConfig";
-import { RootComponent } from "../..";
-import { type Mock_User } from "./normalRequired.test";
-
-/**
- * properties字段选传类型配置  类型为[OptionalType](../PropertiesConstraint.ts)
- */
-const OptionalDoc = RootComponent()({
-  properties: {
-    optional_num: { // 普通类型
-      type: Number,
-      value: 123,
-    },
-    optional_gender: {
-      type: String as DetailedType<"male" | "female">, // 同类字面量联合类型
-      value: "male",
-    },
-    optional_tuple: {
-      type: Array as unknown as DetailedType<[number, string, boolean]>, // 元组类型
-      value: [1, "a", true],
-    },
-    optional_obj: {
-      type: Object as DetailedType<Mock_User>, // 对象类型
-      value: {
-        id: "id",
-        age: 20,
-      },
-    },
-    optional_objOrNull: {
-      type: Object as DetailedType<Mock_User | null>, // 对象类型与null的联合
-      value: null,
-    },
-    optional_union: { // 非同类联合类型 string | number
-      type: String,
-      value: "string",
-      optionalTypes: [Number],
-    },
-    optional_arr: {
-      type: Array as DetailedType<string[]>,
-      value: [],
-    },
-  },
-  methods: {
-    foo() {
-      // 1. 内部this.data中的类型(去除可选)
-      void Checking<
-        typeof this.data,
-        ComputeIntersection<
-          {
-            optional_num: number;
-            optional_gender: "male" | "female";
-            optional_tuple: [number, string, boolean];
-            optional_obj: Mock_User;
-            optional_objOrNull: Mock_User | null;
-            optional_union: string | number;
-            optional_arr: string[];
-          } & IInjectAllData
-        >,
-        Test.Pass
-      >;
-    },
-  },
-});
-void OptionalDoc;
-type OptionalDocExpected = {
-  // 2. 预期返回类型 key为可选(带`?`)
-  properties: {
-    optional_num?: number;
-    optional_gender?: "male" | "female";
-    optional_tuple?: [number, string, boolean];
-    optional_obj?: Mock_User;
-    optional_objOrNull?: Mock_User | null;
-    optional_union?: string | number;
-    optional_arr?: string[];
-  };
-  methods: {
-    foo(): void;
-  };
-};
-
-void Checking<typeof OptionalDoc, OptionalDocExpected, Test.Pass>;
-
-// properties 使用DetailedType时,接受interface类型
-interface Foo {
-  name: string;
-}
-
-RootComponent()({
-  properties: {
-    xxx: Object as DetailedType<{ dd: Foo }>,
-    user: {
-      type: Object as DetailedType<Foo>,
-      value: { name: "zhao" },
-    },
-  },
-  computed: {
-    ddd() {
-      void this.data.user?.name;
-    },
-  },
-});
-
-/**
- * 对象类型字面量类型可验证通过。
- */
-type obj = { gender: "male" | "femal" };
-
-RootComponent()({
-  properties: {
-    obj: {
-      type: Object as DetailedType<obj>,
-      value: { gender: "male" },
-    },
-  },
-});

package/src/api/RootComponent/Properties/test/normalRequired.test.ts

@@ -1,107 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
-import type { DetailedType } from "../../../../types/DetailedType";
-import type { IInjectAllData } from "../../../InstanceInject/instanceConfig";
-import { RootComponent } from "../..";
-import type { RequiredSingle, RequiredType, RequiredUnion } from "../PropertiesConstraint";
-
-/**
- * 共用测试对象类型
- */
-export interface Mock_User {
-  readonly id: string;
-  age?: number;
-}
-
-/**
- * 共用测试对象类型
- */
-export type Mock_Cart = {
-  id: string;
-  selectedCount: number;
-};
-
-/**
- *  properties 必传单一类型配置
- */
-export const mock_requiredSingle = {
-  str: String,
-  num: Number,
-  bool: Boolean,
-  arr: Array,
-  obj: Object,
-  tuple: Array as unknown as DetailedType<[string, number, boolean]>,
-  union_str: String as DetailedType<"male" | "female">,
-  union_num: Number as DetailedType<0 | 1 | 2>,
-  union_bool: Boolean as DetailedType<false | true>,
-  union_arr: Array as DetailedType<number[] | string[]>,
-  union_obj: Object as DetailedType<Mock_User | Mock_Cart>,
-} satisfies Record<string, RequiredSingle>;
-
-/**
- * properties 必传联合类型配置
- */
-export const mock_requiredUnion = {
-  union_str_num_bool: {
-    type: String,
-    optionalTypes: [Number, Boolean],
-  },
-  union_literalStr_Literalnum: {
-    type: String as DetailedType<"male" | "female">,
-    optionalTypes: [Number as DetailedType<0 | 1 | 2>],
-  },
-  union_mockUser_num: {
-    type: Object as DetailedType<Mock_User>,
-    optionalTypes: [Number],
-  },
-  union_num_mockUser: {
-    type: Number,
-    optionalTypes: [Object as DetailedType<Mock_User>],
-  },
-} satisfies Record<string, RequiredUnion>;
-
-/**
- * properties 必传字段全配置(单一类型 + 联合类型)
- */
-export const mock_requiredTypes = {
-  ...mock_requiredSingle,
-  ...mock_requiredUnion,
-} satisfies Record<string, RequiredType>;
-
-type RequiredTypeExpected = {
-  str: string;
-  num: number;
-  bool: boolean;
-  arr: unknown[];
-  obj: object;
-  tuple: [string, number, boolean];
-  union_str: "male" | "female";
-  union_num: 0 | 1 | 2;
-  union_bool: boolean;
-  union_arr: number[] | string[];
-  union_obj: Mock_User | Mock_Cart;
-  union_str_num_bool: string | number | boolean;
-  union_literalStr_Literalnum: 0 | 1 | 2 | "male" | "female";
-  union_mockUser_num: number | Mock_User;
-  union_num_mockUser: number | Mock_User;
-};
-
-const RequiredDoc = RootComponent()({
-  properties: mock_requiredTypes,
-  methods: {
-    foo() {
-      // 1 this.data中的类型(对象类型加null)
-      void Checking<typeof this.data, ComputeIntersection<RequiredTypeExpected & IInjectAllData>, Test.Pass>;
-    },
-  },
-});
-void RequiredDoc;
-/**
- * 2 properties配置为必传类型时预期文档类型(与this.data一致)
- */
-export type RequiredDocExpected = {
-  properties: RequiredTypeExpected;
-  methods: { foo: () => void };
-};
-
-void Checking<typeof RequiredDoc, RequiredDocExpected, Test.Pass>;

package/src/api/RootComponent/Store/GetStoreDef.ts

@@ -1,34 +0,0 @@
-import { typeEqual } from "../../../utils/typeEqual";
-import type { Getter } from "./StoreConstraint";
-// 单独Getter类型返回值会把undefined转换为null
-// 但是WithDefault类型返回值为getter的返回值去除undefined和default的类型联合。
-export type GetStoreDef<TStore extends object> = {
-  [k in keyof TStore]: TStore[k] extends Getter ? ReturnType<TStore[k]>
-    : TStore[k] extends {
-      getter: (...args: unknown[]) => infer R;
-      default: infer D;
-    } ? Exclude<R, undefined> | (D extends null ? null : never)
-    : never;
-};
-
-// test
-type User = { name: string; age: number };
-type test = GetStoreDef<{
-  userName: (data: { aaa: "string" }) => string;
-  userAge: (data: { aaa: "string" }) => number;
-  userInfo: {
-    getter: (data: { aaa: "string" }) => User | undefined;
-    default: null;
-  };
-  list: {
-    getter: (data: { aaa: "string" }) => User[] | undefined;
-    default: [];
-  };
-}>;
-type expected = {
-  userName: string;
-  userAge: number;
-  userInfo: User | null;
-  list: User[];
-};
-typeEqual<test, expected>();

package/src/api/RootComponent/Store/StoreConstraint.ts

@@ -1,2 +0,0 @@
-export type Getter<T extends object = object, R = unknown> = (data: T) => R;
-export type StoreConstraint<T extends object = object> = Record<string, Getter<T>>;