annil 1.17.0 → 1.18.0

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

@@ -1,53 +0,0 @@
-import type { G } from "hry-types";
-import type { As } from "hry-types/src/Any/As";
-import type { IfContains } from "hry-types/src/Any/IfContains";
-import type { Func } from "hry-types/src/Misc/Func";
-import type { Validators } from "../../../types/Validators";
-import type { StoreConstraint } from "./StoreConstraint";
-
-export type StoreOption<
-  TStore extends StoreConstraint,
-  TDuplicateKeys extends PropertyKey,
-> = {
-  /**
-   * 全局响应式数据字段,全局store对应数据变化实例对应数据自动setData。与properties和data字段有重复检测
-   * @example
-   * ```ts
-   *  {
-   *   properties:{
-   *    useId: String,
-   *  }
-   *   //...
-   *   store: {
-   *     responsiveData: () => sroreX.str,
-   *     user:(data)=> M_AllUser[data.useId],
-   *    _user: {
-   *     getter: (data) => M_AllUser[data.useId],
-   *     default: null,
-   *    },
-   *   },
-   * }
-   * ```
-   */
-  store?:
-    & TStore
-    & Validators<[
-      G.DuplicateFieldValidator<TStore, TDuplicateKeys, "字段重复">,
-      // TypeValidator<TStore>,
-    ]>;
-};
-/**
- * 验证properties的value类型是否正确
- * @returns unknown | `{ default: () => "⚠️类型错误⚠️" }`
- */
-export type TypeValidator<
-  TStore,
-  Result = {
-    [k in keyof TStore]: IfContains<
-      ReturnType<As<TStore[k], Func>>,
-      undefined,
-      () => "⚠️返回类型中不可以包含undefined⚠️",
-      unknown
-    >;
-  },
-> = Record<keyof TStore, unknown> extends Result ? unknown : Result;

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

@@ -1,30 +0,0 @@
-import { observable } from "mobx";
-import { RootComponent } from "../..";
-const user = observable({
-  name: "zhao",
-  age: 20,
-});
-
-// 1 约束错误
-RootComponent()({
-  store: {
-    // @ts-expect-error 1.1 不能将类型“string”分配给类型“Getter<{}, unknown>”
-    userName: user.name,
-  },
-});
-
-// 2 重复字段错误
-RootComponent()({
-  properties: {
-    userName: String,
-  },
-  data: {
-    userAge: 20,
-  },
-  store: {
-    // @ts-expect-error 2.1 与properties字段重复
-    userName: () => user.name,
-    // @ts-expect-error 2.2 与userAge字段重复
-    userAge: () => user.age,
-  },
-});

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

@@ -1,55 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import { observable } from "mobx";
-import { typeEqual } from "../../../../utils/_utils";
-import { RootComponent } from "../..";
-const user = observable({
-  name: "zhao",
-  age: 20,
-});
-
-const storeDoc = RootComponent()({
-  properties: {
-    condition: Number,
-    optional: {
-      type: Number,
-      value: 10,
-    },
-  },
-  data: {
-    injectStr: 123,
-  },
-  store: {
-    // 1. 简单的箭头函数写法
-    userName: () => user.name,
-    // 2. 使用参数 datas
-    userAge: (datas) => {
-      // 参数类型为Required<PropertiesDef> & DataDef & Omit<InjectData, keyof (PropertiesDef & DataDef).
-      Checking<
-        typeof datas,
-        { condition: number; optional: number; injectStr: number; injectNum: number },
-        Test.Pass
-      >();
-
-      if (datas.condition > 10) {
-        return user.age;
-      }
-      // 返回undefined时字段不会被响应式追踪,不会报错(有警告).
-      return undefined;
-    },
-  },
-});
-
-type StoreDocExpected = {
-  properties: {
-    optional?: number;
-    condition: number;
-  };
-  data: {
-    injectStr: number;
-  };
-  store: {
-    userName: string;
-    userAge: number | undefined;
-  };
-};
-typeEqual<StoreDocExpected>()(storeDoc);

package/src/api/RootComponent/Watch/WatchOption.ts

@@ -1,67 +0,0 @@
-import type { IfExtends } from "hry-types/src/Any/IfExtends";
-import type { IsPureObject } from "hry-types/src/Any/IsPureObject";
-import type { NoInfer } from "hry-types/src/Generic/NoInfer";
-import type { EmptyObject } from "hry-types/src/Misc/EmptyObject";
-
-type getFirstKeys<T extends string> = T extends `${infer F}.${string}` ? F : never;
-
-type getLastKeys<T extends string> = T extends `${string}.${infer L}` ? L : never;
-
-// 加入对象字段一级key 例如 `obj.xxx`(newValue,oldValue){...}和`obj.**`
-type AddFieldsOfObject<
-  TWatchData extends object,
-  _WatchKeys extends keyof TWatchData,
-  secondKeys extends string = {
-    [k in _WatchKeys]: IsPureObject<TWatchData[k]> extends true
-      ? `${k & string}.${(keyof TWatchData[k]) & string}` | `${k & string}.**`
-      : never;
-  }[_WatchKeys],
-> = {
-  [k in secondKeys]?: (
-    // @ts-ignore
-    newValue: IfExtends<
-      getLastKeys<k>,
-      "**",
-      // @ts-ignore
-      Exclude<TWatchData[getFirstKeys<k>], null>,
-      // @ts-ignore
-      NonNullable<(Exclude<TWatchData[getFirstKeys<k>], null>)[getLastKeys<k>]>
-    >,
-    oldValue: IfExtends<
-      getLastKeys<k>,
-      "**",
-      // @ts-ignore
-      TWatchData[getFirstKeys<k>],
-      // @ts-ignore
-      (Exclude<TWatchData[getFirstKeys<k>], null>)[getLastKeys<k>]
-    >,
-  ) => void | Promise<void>;
-};
-
-export type WatchOption<TWatchData extends object, _WatchKeys extends keyof TWatchData = keyof TWatchData> = {
-  /**
-   * 监控所有data字段,值变化时(JSON.stringify判断)运行watch函数,一参为最新值,二参为变化前值。
-   * 对象数据可通过`obj.xxx:`监控具体字段(只加入了一级字段类型提示)
-   */
-  watch?: IfExtends<
-    {},
-    TWatchData,
-    EmptyObject,
-    // 不加NoInfer会导致只监控计算字段时错误
-    NoInfer<
-      & {
-        [k in _WatchKeys]?: (
-          newValue: TWatchData[k],
-          oldValue: TWatchData[k],
-        ) => void | Promise<void>;
-      }
-      // 解决单独书写计算书写字段的报错(猜测是:ts字面量约束检测提前计算属性key引起的错误提示)
-      // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
-      & {
-        [k in _WatchKeys as never]: unknown;
-      }
-      // 加入对象的一级字段类型提示
-      & AddFieldsOfObject<TWatchData, _WatchKeys>
-    >
-  >;
-};

package/src/api/RootComponent/Watch/test/WatchComputed.test.ts

@@ -1,40 +0,0 @@
-import { Checking, type Test } from "hry-types";
-
-import type { DetailedType } from "../../../../types/DetailedType";
-import { RootComponent } from "../..";
-import type { Mock_User } from "../../Properties/test/normalRequired.test";
-
-/**
- *  1 computed字段时需要手写类型,可悬停鼠标到key查看类型,深度只读
- */
-RootComponent()({
-  properties: {
-    Pnum: Number,
-    obj: Object as DetailedType<Mock_User>,
-  },
-  data: {
-    DNum: 123,
-  },
-  computed: {
-    CNum() {
-      return this.data.Pnum + this.data.DNum;
-    },
-    Cobj() {
-      return this.data.obj;
-    },
-  },
-  watch: {
-    CNum(newValue: number, oldValue: number) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-
-      void Checking<number, typeof oldValue, Test.Pass>;
-    },
-    Cobj(newValue: Mock_User, oldValue: Mock_User | null) {
-      void oldValue;
-      void Checking<Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User | null, typeof oldValue, Test.Pass>;
-    },
-  },
-});

package/src/api/RootComponent/Watch/test/WatchData.test.ts

@@ -1,55 +0,0 @@
-import { Checking, type Test } from "hry-types";
-
-import { observable } from "mobx";
-import { RootComponent } from "../..";
-import type { Mock_User } from "../../Properties/test/normalRequired.test";
-
-const obj = observable({
-  gender: "male" as "male" | "female",
-});
-
-/**
- * watch data字段 深度只读
- */
-RootComponent()({
-  data: {
-    num: 123,
-    obj: {} as Mock_User,
-  },
-  store: {
-    reactiveLiteral: () => obj.gender,
-    reactiveNumber: () => ({} as number),
-    reactiveUser: () => ({} as Mock_User),
-  },
-  watch: {
-    num(newValue, oldValue) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-
-      void Checking<number, typeof oldValue, Test.Pass>;
-    },
-    obj(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User, typeof oldValue, Test.Pass>;
-    },
-    reactiveNumber(newValue: number, oldValue) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-      void Checking<number, typeof oldValue, Test.Pass>;
-    },
-    reactiveLiteral(newValue, oldValue) {
-      void oldValue;
-      void Checking<"male" | "female", typeof newValue, Test.Pass>;
-
-      void Checking<"male" | "female", typeof oldValue, Test.Pass>;
-    },
-    reactiveUser(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User, typeof oldValue, Test.Pass>;
-    },
-  },
-});

package/src/api/RootComponent/Watch/test/WatchProperties.test.ts

@@ -1,170 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import type { DetailedType } from "../../../..";
-import { RootComponent } from "../..";
-import type { OptionalType } from "../../Properties/PropertiesConstraint";
-import {
-  type Mock_Cart,
-  mock_requiredTypes,
-  mock_requiredUnion,
-  type Mock_User,
-} from "../../Properties/test/normalRequired.test";
-const mock_optional = {
-  optional_num: {
-    type: Number,
-    value: 123,
-  },
-  optional_gender: {
-    type: String as DetailedType<"male" | "female">,
-    value: "male" as const,
-  },
-  optional_obj: {
-    type: Object as DetailedType<Mock_User>,
-    value: {
-      id: "id",
-      name: "name",
-      age: 20,
-    },
-  },
-  optional_objOrNull: {
-    type: Object as DetailedType<Mock_User | null>,
-    value: null,
-  },
-} satisfies Record<string, OptionalType>;
-
-/**
- * watch properties字段 深度只读, 必传对象字段newValue去除null
- */
-RootComponent()({
-  properties: {
-    ...mock_requiredTypes,
-    ...mock_requiredUnion,
-    ...mock_optional,
-  },
-  watch: {
-    // 必传单一字段
-    str(newValue, oldValue) {
-      void oldValue;
-      void Checking<string, typeof newValue, Test.Pass>;
-
-      void Checking<string, typeof oldValue, Test.Pass>;
-    },
-    num(newValue, oldValue) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-
-      void Checking<number, typeof oldValue, Test.Pass>;
-    },
-    bool(newValue, oldValue) {
-      void oldValue;
-      void Checking<boolean, typeof newValue, Test.Pass>;
-
-      void Checking<boolean, typeof oldValue, Test.Pass>;
-    },
-
-    obj(newValue, oldValue) {
-      void oldValue;
-      void Checking<object, typeof newValue, Test.Pass>;
-
-      void Checking<object, typeof oldValue, Test.Pass>;
-    },
-    tuple(newValue, oldValue) {
-      void oldValue;
-      void Checking<[string, number, boolean], typeof newValue, Test.Pass>;
-
-      void Checking<[string, number, boolean], typeof oldValue, Test.Pass>;
-    },
-    union_str(newValue, oldValue) {
-      void oldValue;
-      void Checking<"male" | "female", typeof newValue, Test.Pass>;
-
-      void Checking<"male" | "female", typeof oldValue, Test.Pass>;
-    },
-    union_num(newValue, oldValue) {
-      void oldValue;
-      void Checking<0 | 1 | 2, typeof newValue, Test.Pass>;
-
-      void Checking<0 | 1 | 2, typeof oldValue, Test.Pass>;
-    },
-    union_bool(newValue, oldValue) {
-      void oldValue;
-      void Checking<false | true, typeof newValue, Test.Pass>;
-
-      void Checking<false | true, typeof oldValue, Test.Pass>;
-    },
-    union_arr(newValue, oldValue) {
-      void oldValue;
-      void Checking<number[] | string[], typeof newValue, Test.Pass>;
-
-      void Checking<number[] | string[], typeof oldValue, Test.Pass>;
-    },
-    union_obj(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User | Mock_Cart, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User | Mock_Cart, typeof oldValue, Test.Pass>;
-    },
-    // 必传多类型联合
-    union_str_num_bool(newValue, oldValue) {
-      void oldValue;
-      void Checking<string | number | boolean, typeof newValue, Test.Pass>;
-
-      void Checking<string | number | boolean, typeof oldValue, Test.Pass>;
-    },
-    union_literalStr_Literalnum(newValue, oldValue) {
-      void oldValue;
-      void Checking<0 | 1 | 2 | "male" | "female", typeof newValue, Test.Pass>;
-
-      void Checking<0 | 1 | 2 | "male" | "female", typeof oldValue, Test.Pass>;
-    },
-    union_mockUser_num(newValue, oldValue) {
-      void oldValue;
-      void Checking<number | Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<number | Mock_User, typeof oldValue, Test.Pass>;
-    },
-    // 可选字段
-    optional_gender(newValue, oldValue) {
-      void oldValue;
-      void Checking<"male" | "female", typeof newValue, Test.Pass>;
-
-      void Checking<"male" | "female", typeof oldValue, Test.Pass>;
-    },
-    optional_num(newValue, oldValue) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-
-      void Checking<number, typeof oldValue, Test.Pass>;
-    },
-    optional_obj(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User, typeof oldValue, Test.Pass>;
-    },
-    // 对象的二段key
-    "optional_obj.age"(newValue, oldValue) {
-      void oldValue;
-      void Checking<number, typeof newValue, Test.Pass>;
-
-      void Checking<number | undefined, typeof oldValue, Test.Pass>;
-    },
-    "optional_obj.**"(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User, typeof oldValue, Test.Pass>;
-    },
-    "optional_obj.id"(newValue, oldValue) {
-      void oldValue;
-      void Checking<string, typeof newValue, Test.Pass>;
-
-      void Checking<string, typeof oldValue, Test.Pass>;
-    },
-    optional_objOrNull(newValue, oldValue) {
-      void oldValue;
-      void Checking<Mock_User | null, typeof newValue, Test.Pass>;
-
-      void Checking<Mock_User | null, typeof oldValue, Test.Pass>;
-    },
-  },
-});

package/src/api/RootComponent/Watch/test/WtachInject.test.ts

@@ -1,16 +0,0 @@
-import { Checking, type Test } from "hry-types";
-import { RootComponent } from "../..";
-/**
- * watch 只能监控 注入的store字段
- * 注入文件 https://github.com/missannil/annil/blob/main/src/api/InstanceInject/inject.ts
- */
-RootComponent()({
-  watch: {
-    injectTheme(newValue, oldValue) {
-      void oldValue;
-      void Checking<"dark" | "light" | undefined, typeof newValue, Test.Pass>;
-
-      void Checking<"dark" | "light" | undefined, typeof oldValue, Test.Pass>;
-    },
-  },
-});

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

@@ -1,54 +0,0 @@
-import type { DetailedType } from "../../../../types/DetailedType";
-import { RootComponent } from "../..";
-// 1 没有data可以watch 约束为EmptyObject
-RootComponent()({
-  watch: {
-    // @ts-expect-error 无可监控字段时，约束为EmptyObject,即不可写任何字段
-    xxx() {
-      void 0;
-    },
-  },
-});
-
-/**
- * 2  超出约束字段报错
- */
-RootComponent()({
-  properties: {
-    num: Number,
-  },
-  data: {
-    str: "123",
-  },
-  computed: {
-    Cnum() {
-      return this.data.num;
-    },
-  },
-  watch: {
-    // @ts-expect-error otherFields不在约束字段(num,str,Cnum)中
-    otherFields() {
-      void 0;
-    },
-  },
-});
-/**
- * 3  对象联合null的类型 不能watch子字段
- */
-RootComponent()({
-  properties: {
-    user: Object as DetailedType<{ name: string; age: number } | null>,
-  },
-
-  watch: {
-    user(newValue, oldValue) {
-      void oldValue;
-      void newValue;
-    },
-    // @ts-expect-error 不能watch子字段 因为user可能为null
-    "user.name"(newValue, oldValue) {
-      void oldValue;
-      void newValue;
-    },
-  },
-});