web-core-tcm 0.0.29 → 0.0.30

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

@@ -0,0 +1,377 @@
+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 GetTokenRequest {
+  type?: string;
+  uid?: string;
+  token?: string;
+}
+export interface DoctorState {
+  id?: string;
+  name?: string;
+  createdTimestamp?: number;
+  updatedTimestamp?: number;
+  gender?: string;
+  identityNumber?: string;
+  phoneNumber?: string;
+  birthdate?: string;
+}
+export interface PatientState {
+  id?: string;
+  doctorId?: string;
+  name?: string;
+  createdTimestamp?: number;
+  updatedTimestamp?: number;
+  identity?: string;
+  gender?: string;
+  phoneNumber?: string;
+  birthdate?: string;
+  tags?: string;
+  mainSymptom?: string;
+}
+export interface ScientistState {
+  id?: string;
+  name?: string;
+  createdTimestamp?: number;
+  updatedTimestamp?: number;
+  identityNumber?: string;
+  gender?: string;
+  phoneNumber?: string;
+  birthdate?: string;
+}
+export interface GetTokenResponse {
+  status?: number;
+  token?: string;
+  doctors?: DoctorState[];
+  patients?: PatientState[];
+  scientist?: ScientistState[];
+}
+export interface AuthorizationState {
+  requestDefinition?: string;
+  policyDefinition?: string;
+  policyEffect?: string;
+  matchers?: string;
+  policies?: string;
+}
+export interface ResourceAuthorizationState {
+  resourceId?: string;
+  authorizationStates?: AuthorizationState[];
+  ownerId?: string;
+}
+export interface RoleAuthorizationState {
+  role?: string;
+  authorizationStates?: AuthorizationState[];
+}
+export interface UserAuthorizationState {
+  userId?: string;
+  authorizationStates?: AuthorizationState[];
+}
+declare global {
+  interface authorizeApi {
+    oAuthRestful: {
+      /**
+       * ---
+       *
+       * [POST]
+       *
+       * **path:** /授权/服务/令牌
+       *
+       * ---
+       *
+       * **RequestBody**
+       * ```ts
+       * type RequestBody = {
+       *   type?: string
+       *   uid?: string
+       *   token?: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   status?: number
+       *   token?: string
+       *   // [items] start
+       *   // [items] end
+       *   doctors?: Array<{
+       *     id?: string
+       *     name?: string
+       *     createdTimestamp?: number
+       *     updatedTimestamp?: number
+       *     gender?: string
+       *     identityNumber?: string
+       *     phoneNumber?: string
+       *     birthdate?: string
+       *   }>
+       *   // [items] start
+       *   // [items] end
+       *   patients?: Array<{
+       *     id?: string
+       *     doctorId?: string
+       *     name?: string
+       *     createdTimestamp?: number
+       *     updatedTimestamp?: number
+       *     identity?: string
+       *     gender?: string
+       *     phoneNumber?: string
+       *     birthdate?: string
+       *     tags?: string
+       *     mainSymptom?: string
+       *   }>
+       *   // [items] start
+       *   // [items] end
+       *   scientist?: Array<{
+       *     id?: string
+       *     name?: string
+       *     createdTimestamp?: number
+       *     updatedTimestamp?: number
+       *     identityNumber?: string
+       *     gender?: string
+       *     phoneNumber?: string
+       *     birthdate?: string
+       *   }>
+       * }
+       * ```
+       */
+      getToken<
+        Config extends Alova2MethodConfig<GetTokenResponse> & {
+          data: GetTokenRequest;
+        },
+      >(
+        config: Config,
+      ): Alova2Method<GetTokenResponse, 'oAuthRestful.getToken', Config>;
+    };
+    resourceAuthorizationRestful: {
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /授权/服务/资源/{id}
+       *
+       * ---
+       *
+       * **Path Parameters**
+       * ```ts
+       * type PathParameters = {
+       *   id: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   resourceId?: string
+       *   // [items] start
+       *   // [items] end
+       *   authorizationStates?: Array<{
+       *     requestDefinition?: string
+       *     policyDefinition?: string
+       *     policyEffect?: string
+       *     matchers?: string
+       *     policies?: string
+       *   }>
+       *   ownerId?: string
+       * }
+       * ```
+       */
+      getResourceAuthorizationState<
+        Config extends Alova2MethodConfig<ResourceAuthorizationState> & {
+          pathParams: {
+            id: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<
+        ResourceAuthorizationState,
+        'resourceAuthorizationRestful.getResourceAuthorizationState',
+        Config
+      >;
+    };
+    roleAuthorizationRestful: {
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /授权/服务/角色/{role}
+       *
+       * ---
+       *
+       * **Path Parameters**
+       * ```ts
+       * type PathParameters = {
+       *   role: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   role?: string
+       *   // [items] start
+       *   // [items] end
+       *   authorizationStates?: Array<{
+       *     requestDefinition?: string
+       *     policyDefinition?: string
+       *     policyEffect?: string
+       *     matchers?: string
+       *     policies?: string
+       *   }>
+       * }
+       * ```
+       */
+      getRoleAuthorizationState<
+        Config extends Alova2MethodConfig<RoleAuthorizationState> & {
+          pathParams: {
+            role: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<
+        RoleAuthorizationState,
+        'roleAuthorizationRestful.getRoleAuthorizationState',
+        Config
+      >;
+    };
+    userAuthorizationRestful: {
+      /**
+       * ---
+       *
+       * [GET]
+       *
+       * **path:** /授权/服务/用户/{userId}
+       *
+       * ---
+       *
+       * **Path Parameters**
+       * ```ts
+       * type PathParameters = {
+       *   userId: string
+       * }
+       * ```
+       *
+       * ---
+       *
+       * **Response**
+       * ```ts
+       * type Response = {
+       *   userId?: string
+       *   // [items] start
+       *   // [items] end
+       *   authorizationStates?: Array<{
+       *     requestDefinition?: string
+       *     policyDefinition?: string
+       *     policyEffect?: string
+       *     matchers?: string
+       *     policies?: string
+       *   }>
+       * }
+       * ```
+       */
+      getUserAuthorizationState<
+        Config extends Alova2MethodConfig<UserAuthorizationState> & {
+          pathParams: {
+            userId: string;
+          };
+        },
+      >(
+        config: Config,
+      ): Alova2Method<
+        UserAuthorizationState,
+        'userAuthorizationRestful.getUserAuthorizationState',
+        Config
+      >;
+    };
+  }
+
+  var authorizeApi: authorizeApi;
+}