web-core-tcm 0.0.29 → 0.0.30

package/dist/src/api/oauth/alova/globals.d.ts

@@ -0,0 +1,443 @@
+import { Alova, AlovaMethodCreateConfig, AlovaGenerics, Method } from 'alova';
+import { $$userConfigMap, alovaInstance } from './index';
+import { default as apiDefinitions } from './apiDefinitions';
+type CollapsedAlova = typeof alovaInstance;
+type UserMethodConfigMap = typeof $$userConfigMap;
+
+type Alova2MethodConfig<Responded> =
+  CollapsedAlova extends Alova<
+    AlovaGenerics<
+      any,
+      any,
+      infer RequestConfig,
+      infer Response,
+      infer ResponseHeader,
+      infer L1Cache,
+      infer L2Cache,
+      infer SE
+    >
+  >
+    ? Omit<
+        AlovaMethodCreateConfig<
+          AlovaGenerics<
+            Responded,
+            any,
+            RequestConfig,
+            Response,
+            ResponseHeader,
+            L1Cache,
+            L2Cache,
+            SE
+          >,
+          any,
+          Responded
+        >,
+        'params'
+      >
+    : never;
+
+// Extract the return type of transform function that define in $$userConfigMap, if it not exists, use the default type.
+type ExtractUserDefinedTransformed<
+  DefinitionKey extends keyof typeof apiDefinitions,
+  Default,
+> = DefinitionKey extends keyof UserMethodConfigMap
+  ? UserMethodConfigMap[DefinitionKey]['transform'] extends (...args: any[]) => any
+    ? Awaited<ReturnType<UserMethodConfigMap[DefinitionKey]['transform']>>
+    : Default
+  : Default;
+type Alova2Method<
+  Responded,
+  DefinitionKey extends keyof typeof apiDefinitions,
+  CurrentConfig extends Alova2MethodConfig<any>,
+> =
+  CollapsedAlova extends Alova<
+    AlovaGenerics<
+      any,
+      any,
+      infer RequestConfig,
+      infer Response,
+      infer ResponseHeader,
+      infer L1Cache,
+      infer L2Cache,
+      infer SE
+    >
+  >
+    ? Method<
+        AlovaGenerics<
+          CurrentConfig extends undefined
+            ? ExtractUserDefinedTransformed<DefinitionKey, Responded>
+            : CurrentConfig['transform'] extends (...args: any[]) => any
+              ? Awaited<ReturnType<CurrentConfig['transform']>>
+              : ExtractUserDefinedTransformed<DefinitionKey, Responded>,
+          any,
+          RequestConfig,
+          Response,
+          ResponseHeader,
+          L1Cache,
+          L2Cache,
+          SE
+        >
+      >
+    : never;
+
+export interface UserState {
+  id?: string;
+  name?: string;
+  phoneNumber?: string;
+  identityNumber?: string;
+  gender?: string;
+  createdTimestamp?: string;
+  updatedTimestamp?: string;
+}
+export interface PhoneVerifyRequest {
+  phoneNumber?: string;
+  code?: string;
+  id?: string;
+}
+export interface UserGetResponse {
+  status?: number;
+  user?: UserState;
+}
+export interface UserPutResponse {
+  status?: number;
+  user?: UserState;
+}
+export interface PhoneVerifyResponse {
+  status?: number;
+  token?: string;
+  users?: UserState[];
+  message?: string;
+}
+export interface Model {
+  bizId?: string;
+  outId?: string;
+  requestId?: string;
+  verifyCode?: string;
+}
+export interface SendSmsVerifyCodeResponseBody {
+  accessDeniedDetail?: string;
+  code?: string;
+  message?: string;
+  model?: Model;
+  success?: boolean;
+}
+export interface SendSmsVerifyCodeResponse {
+  headers?: Record<string, string>;
+  statusCode?: number;
+  body?: SendSmsVerifyCodeResponseBody;
+}
+export interface TokenInfo {
+  accessToken?: string;
+  jwtToken?: string;
+}
+export interface GetAuthTokenResponseBody {
+  code?: string;
+  message?: string;
+  requestId?: string;
+  tokenInfo?: TokenInfo;
+}
+export interface GetAuthTokenResponse {
+  headers?: Record<string, string>;
+  statusCode?: number;
+  body?: GetAuthTokenResponseBody;
+}
+export interface GetClientResponse {
+  status?: number;
+  clientDescription?: string;
+}
+declare global {
+  interface oauthApi {
+    userStateRestful: {
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /互联/服务/用户
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   status?: number
+       *   user?: {
+       *     id?: string
+       *     name?: string
+       *     phoneNumber?: string
+       *     identityNumber?: string
+       *     gender?: string
+       *     createdTimestamp?: string
+       *     updatedTimestamp?: string
+       *   }
+       * }
+       * ```
+       */
+      getUserState<Config extends Alova2MethodConfig<UserGetResponse>>(
+        config?: Config,
+      ): Alova2Method<UserGetResponse, 'userStateRestful.getUserState', Config>;
+      /**
+       * ---
+       *
+       * [PUT]
+       *
+       * **path:** /互联/服务/用户
+       *
+       * ---
+       *
+       * **RequestBody**
+       * ```ts
+       * type RequestBody = {
+       *   id?: string
+       *   name?: string
+       *   phoneNumber?: string
+       *   identityNumber?: string
+       *   gender?: string
+       *   createdTimestamp?: string
+       *   updatedTimestamp?: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   status?: number
+       *   user?: {
+       *     id?: string
+       *     name?: string
+       *     phoneNumber?: string
+       *     identityNumber?: string
+       *     gender?: string
+       *     createdTimestamp?: string
+       *     updatedTimestamp?: string
+       *   }
+       * }
+       * ```
+       */
+      putUserState<
+        Config extends Alova2MethodConfig<UserPutResponse> & {
+          data: UserState;
+        },
+      >(
+        config: Config,
+      ): Alova2Method<UserPutResponse, 'userStateRestful.putUserState', Config>;
+    };
+    phoneVerifyRestful: {
+      /**
+       * ---
+       *
+       * [POST]
+       *
+       * **path:** /互联/服务/电话/验证短信
+       *
+       * ---
+       *
+       * **RequestBody**
+       * ```ts
+       * type RequestBody = {
+       *   phoneNumber?: string
+       *   code?: string
+       *   id?: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   status?: number
+       *   token?: string
+       *   // [items] start
+       *   // [items] end
+       *   users?: Array<{
+       *     id?: string
+       *     name?: string
+       *     phoneNumber?: string
+       *     identityNumber?: string
+       *     gender?: string
+       *     createdTimestamp?: string
+       *     updatedTimestamp?: string
+       *   }>
+       *   message?: string
+       * }
+       * ```
+       */
+      verifySMSCode<
+        Config extends Alova2MethodConfig<PhoneVerifyResponse> & {
+          data: PhoneVerifyRequest;
+        },
+      >(
+        config: Config,
+      ): Alova2Method<PhoneVerifyResponse, 'phoneVerifyRestful.verifySMSCode', Config>;
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /互联/服务/电话/发送短信
+       *
+       * ---
+       *
+       * **Query Parameters**
+       * ```ts
+       * type QueryParameters = {
+       *   phoneNumber: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   headers?: Record<string, string>
+       *   statusCode?: number
+       *   body?: {
+       *     accessDeniedDetail?: string
+       *     code?: string
+       *     message?: string
+       *     model?: {
+       *       bizId?: string
+       *       outId?: string
+       *       requestId?: string
+       *       verifyCode?: string
+       *     }
+       *     success?: boolean
+       *   }
+       * }
+       * ```
+       */
+      sendSMSCode<
+        Config extends Alova2MethodConfig<SendSmsVerifyCodeResponse> & {
+          params: {
+            phoneNumber: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<SendSmsVerifyCodeResponse, 'phoneVerifyRestful.sendSMSCode', Config>;
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /互联/服务/电话/令牌认证
+       *
+       * ---
+       *
+       * **Query Parameters**
+       * ```ts
+       * type QueryParameters = {
+       *   bizType: number
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   headers?: Record<string, string>
+       *   statusCode?: number
+       *   body?: {
+       *     code?: string
+       *     message?: string
+       *     requestId?: string
+       *     tokenInfo?: {
+       *       accessToken?: string
+       *       jwtToken?: string
+       *     }
+       *   }
+       * }
+       * ```
+       */
+      authToken<
+        Config extends Alova2MethodConfig<GetAuthTokenResponse> & {
+          params: {
+            bizType: number;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<GetAuthTokenResponse, 'phoneVerifyRestful.authToken', Config>;
+    };
+    authorizationRestful: {
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /互联/服务/授权/许可
+       *
+       * ---
+       *
+       * **Query Parameters**
+       * ```ts
+       * type QueryParameters = {
+       *   client_id: string
+       *   scope: string
+       *   state: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = string
+       * ```
+       */
+      consent<
+        Config extends Alova2MethodConfig<string> & {
+          params: {
+            client_id: string;
+            scope: string;
+            state: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<string, 'authorizationRestful.consent', Config>;
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /互联/服务/授权/客户端介绍
+       *
+       * ---
+       *
+       * **Query Parameters**
+       * ```ts
+       * type QueryParameters = {
+       *   client_id: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   status?: number
+       *   clientDescription?: string
+       * }
+       * ```
+       */
+      getClientDescription<
+        Config extends Alova2MethodConfig<GetClientResponse> & {
+          params: {
+            client_id: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<GetClientResponse, 'authorizationRestful.getClientDescription', Config>;
+    };
+  }
+
+  var oauthApi: oauthApi;
+}