@autional/shared 0.1.0-rc.55 → 0.1.0-rc.57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,52 +1,53 @@
1
1
  {
2
- "name": "@autional/shared",
3
- "version": "0.1.0-rc.55",
4
- "description": "Autional shared layer — API client, auth, types, hooks, utils",
5
- "license": "AGPL-3.0",
6
- "main": "./src/index.ts",
7
- "module": "./src/index.ts",
8
- "types": "./src/index.ts",
9
- "exports": {
10
- ".": "./src/index.ts",
11
- "./branding": "./src/branding/index.ts",
12
- "./slug-from-url": "./src/auth/slug-from-url.ts",
13
- "./generated/api": "./src/generated/api.ts",
14
- "./generated/types": "./src/generated/types.ts",
15
- "./generated/queries": "./src/generated/queries.ts",
16
- "./package.json": "./package.json"
17
- },
18
- "files": [
19
- "src"
20
- ],
21
- "sideEffects": false,
22
- "scripts": {
23
- "typecheck": "tsc --noEmit",
24
- "test": "vitest run"
25
- },
26
- "dependencies": {
27
- "@opentelemetry/api": "1.9.1",
28
- "@tanstack/react-query": "5.100.9",
29
- "@types/lodash-es": "4.17.12",
30
- "@types/node": "26.1.2",
31
- "@types/react": "19.2.14",
32
- "@types/react-dom": "19.2.3",
33
- "axios": "1.16.0",
34
- "lodash-es": "4.18.1",
35
- "zustand": "5.0.13"
36
- },
37
- "devDependencies": {
38
- "@autional/tsconfig": "workspace:*",
39
- "@testing-library/jest-dom": "6.9.1",
40
- "@testing-library/react": "16.3.2",
41
- "jsdom": "29.1.1",
42
- "react": "19.2.5",
43
- "react-dom": "19.2.5",
44
- "typescript": "5.8.3",
45
- "vite": "6.4.2",
46
- "vitest": "3.2.0"
47
- },
48
- "peerDependencies": {
49
- "react": ">=18.0.0",
50
- "react-dom": ">=18.0.0"
51
- }
52
- }
2
+ "name": "@autional/shared",
3
+ "version": "0.1.0-rc.57",
4
+ "description": "Autional shared layer — API client, auth, types, hooks, utils",
5
+ "license": "AGPL-3.0",
6
+ "main": "./src/index.ts",
7
+ "module": "./src/index.ts",
8
+ "types": "./src/index.ts",
9
+ "exports": {
10
+ ".": "./src/index.ts",
11
+ "./branding": "./src/branding/index.ts",
12
+ "./slug-from-url": "./src/auth/slug-from-url.ts",
13
+ "./portal": "./src/portal/registry.ts",
14
+ "./generated/api": "./src/generated/api.ts",
15
+ "./generated/types": "./src/generated/types.ts",
16
+ "./generated/queries": "./src/generated/queries.ts",
17
+ "./package.json": "./package.json"
18
+ },
19
+ "files": [
20
+ "src"
21
+ ],
22
+ "sideEffects": false,
23
+ "dependencies": {
24
+ "@opentelemetry/api": "1.9.1",
25
+ "@tanstack/react-query": "5.100.9",
26
+ "@types/lodash-es": "4.17.12",
27
+ "@types/node": "26.1.2",
28
+ "@types/react": "19.2.14",
29
+ "@types/react-dom": "19.2.3",
30
+ "axios": "1.16.0",
31
+ "lodash-es": "4.18.1",
32
+ "zustand": "5.0.13"
33
+ },
34
+ "devDependencies": {
35
+ "@testing-library/jest-dom": "6.9.1",
36
+ "@testing-library/react": "16.3.2",
37
+ "jsdom": "29.1.1",
38
+ "react": "19.2.5",
39
+ "react-dom": "19.2.5",
40
+ "typescript": "5.8.3",
41
+ "vite": "6.4.2",
42
+ "vitest": "3.2.0",
43
+ "@autional/tsconfig": "0.1.0-rc"
44
+ },
45
+ "peerDependencies": {
46
+ "react": ">=18.0.0",
47
+ "react-dom": ">=18.0.0"
48
+ },
49
+ "scripts": {
50
+ "typecheck": "tsc --noEmit",
51
+ "test": "vitest run"
52
+ }
53
+ }
@@ -0,0 +1,141 @@
1
+ // @vitest-environment jsdom
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
3
+ import { configureAuthStore, getAccessToken, getAuthStorageMode, resetAuthStore, useAuthStore } from '../auth/store';
4
+ import { createFetchClient } from '../api/fetch-client';
5
+
6
+ /**
7
+ * 「控制台套件」契约测试 —— 证明 Wave 2 三项增量**能组合成两站的接入形态**,
8
+ * 而不是三个各自跑通的零件。
9
+ *
10
+ * 场景照配置中心的真实口径搭:
11
+ * - token 只落 sessionStorage(关标签即失效)
12
+ * - 请求带 X-App-ID / X-Tenant-ID
13
+ * - 401 → 静默续期 → 重试一次(页面无感)
14
+ * - 响应默认透传(不 unwrap、不转键),因为两站后端是 snake_case 直通
15
+ */
16
+
17
+ const KEY = 'autional-auth-v1';
18
+ const USER = { id: 'usr_1', username: 'demo', email: 'demo@example.com', status: 'active' } as never;
19
+
20
+ function jsonResponse(body: unknown, status = 200): Response {
21
+ return {
22
+ ok: status >= 200 && status < 300,
23
+ status,
24
+ text: async () => JSON.stringify(body),
25
+ headers: new Headers(),
26
+ } as unknown as Response;
27
+ }
28
+
29
+ describe('console kit 契约:auth(store) + fetch client 组合', () => {
30
+ beforeEach(() => {
31
+ window.localStorage.clear();
32
+ window.sessionStorage.clear();
33
+ resetAuthStore();
34
+ });
35
+
36
+ afterEach(() => {
37
+ vi.unstubAllGlobals();
38
+ });
39
+
40
+ it('配置中心形态:session 存储 + 作用域头 + 401 静默续期 + 透传响应', async () => {
41
+ // 1) 应用入口:先选存储(在任何读取之前)
42
+ configureAuthStore({ storage: 'session' });
43
+ expect(getAuthStorageMode()).toBe('session');
44
+
45
+ // 2) 登录落地:token 只进 sessionStorage
46
+ useAuthStore.getState().setAuth('token-old', 'refresh-1', USER);
47
+ useAuthStore.getState().setCurrentTenant('tenant-1');
48
+ expect(window.sessionStorage.getItem(KEY)).toContain('token-old');
49
+ expect(window.localStorage.getItem(KEY)).toBeNull();
50
+
51
+ // 3) 请求层:token 从 shared 取,续期写回 shared store
52
+ const seen: Array<Record<string, string>> = [];
53
+ let round = 0;
54
+ vi.stubGlobal(
55
+ 'fetch',
56
+ vi.fn(async (_url: string, init: RequestInit) => {
57
+ seen.push(init.headers as Record<string, string>);
58
+ round += 1;
59
+ if (round === 1) return jsonResponse({ message: 'token expired' }, 401);
60
+ return jsonResponse({ items: [{ key: 'a', value_type: 'string' }], total: 1 });
61
+ }),
62
+ );
63
+
64
+ const client = createFetchClient({
65
+ baseUrl: '/bff/config/api/v1/admin/config',
66
+ getToken: () => getAccessToken(),
67
+ getTenantId: () => useAuthStore.getState().currentTenantId,
68
+ getHeaders: () => ({ 'X-App-ID': 'app-config' }),
69
+ refresh: async () => {
70
+ useAuthStore.getState().setTokens('token-new', 'refresh-1');
71
+ return 'token-new';
72
+ },
73
+ });
74
+
75
+ const result = await client.get<{ items: unknown[]; total: number }>('/items', {
76
+ query: { page: 1, page_size: 20 },
77
+ });
78
+
79
+ // 4) 续期对页面无感:请求最终成功,且重试用的是新 token
80
+ expect(round).toBe(2);
81
+ expect(seen[0].Authorization).toBe('Bearer token-old');
82
+ expect(seen[1].Authorization).toBe('Bearer token-new');
83
+ expect(seen[0]['X-Tenant-ID']).toBe('tenant-1');
84
+ expect(seen[0]['X-App-ID']).toBe('app-config');
85
+ expect(useAuthStore.getState().accessToken).toBe('token-new');
86
+
87
+ // 5) 响应原样透传(不做 camelCase / 不解信封)—— 页面读到的键仍是 snake
88
+ expect(result).toEqual({ items: [{ key: 'a', value_type: 'string' }], total: 1 });
89
+ });
90
+
91
+ // 上一版这里只断言 `accessToken==='token-new'`,而写回是测试自己的回调干的(等于自己证自己)。
92
+ // 这条用例把"续期不写回 store"也走一遍:fetch client 必须用 refresh() 的**返回值**重试。
93
+ it('续期回调不写回 store 时,重试仍用 refresh 返回的 token(不依赖 store 已更新)', async () => {
94
+ configureAuthStore({ storage: 'session' });
95
+ useAuthStore.getState().setAuth('token-old', 'refresh', USER);
96
+
97
+ const seen: Array<Record<string, string>> = [];
98
+ let round = 0;
99
+ vi.stubGlobal(
100
+ 'fetch',
101
+ vi.fn(async (_url: string, init: RequestInit) => {
102
+ seen.push(init.headers as Record<string, string>);
103
+ round += 1;
104
+ return round === 1 ? jsonResponse({ message: 'expired' }, 401) : jsonResponse({ ok: true });
105
+ }),
106
+ );
107
+
108
+ const client = createFetchClient({
109
+ baseUrl: '/api',
110
+ getToken: () => getAccessToken(),
111
+ refresh: async () => 'token-refreshed', // 故意不写回 store
112
+ });
113
+
114
+ await expect(client.get('/x')).resolves.toEqual({ ok: true });
115
+ expect(seen[1].Authorization).toBe('Bearer token-refreshed');
116
+ expect(useAuthStore.getState().accessToken).toBe('token-old'); // store 未被偷偷改动
117
+ });
118
+
119
+ it('密钥中心形态:local 存储 + 持久化跨实例保持', () => {
120
+ configureAuthStore({ storage: 'local' });
121
+ useAuthStore.getState().setAuth('token-local', 'refresh', USER);
122
+
123
+ expect(getAuthStorageMode()).toBe('local');
124
+ expect(window.localStorage.getItem(KEY)).toContain('token-local');
125
+ expect(window.sessionStorage.getItem(KEY)).toBeNull();
126
+ });
127
+
128
+ it('两种形态互不串味:同一进程先后建实例时 storage 各自独立', () => {
129
+ configureAuthStore({ storage: 'session' });
130
+ useAuthStore.getState().setAuth('only-session', 'r', USER);
131
+
132
+ // 已建实例后再次 configure 不会换存储(避免"一半页面登出"),只告警
133
+ const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
134
+ configureAuthStore({ storage: 'local' });
135
+ expect(getAuthStorageMode()).toBe('session');
136
+ expect(warn).toHaveBeenCalledTimes(1);
137
+ warn.mockRestore();
138
+
139
+ expect(window.localStorage.getItem(KEY)).toBeNull();
140
+ });
141
+ });
@@ -0,0 +1,266 @@
1
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
2
+ import { FetchApiError, createFetchClient } from '../fetch-client';
3
+
4
+ type FetchArgs = { url: string; init: RequestInit };
5
+
6
+ function jsonResponse(body: unknown, status = 200): Response {
7
+ return {
8
+ ok: status >= 200 && status < 300,
9
+ status,
10
+ text: async () => JSON.stringify(body),
11
+ headers: new Headers(),
12
+ } as unknown as Response;
13
+ }
14
+
15
+ function textResponse(text: string, status = 200): Response {
16
+ return {
17
+ ok: status >= 200 && status < 300,
18
+ status,
19
+ text: async () => text,
20
+ headers: new Headers(),
21
+ } as unknown as Response;
22
+ }
23
+
24
+ describe('createFetchClient', () => {
25
+ let calls: FetchArgs[];
26
+
27
+ function stubFetch(handler: (args: FetchArgs) => Response | Promise<Response>) {
28
+ calls = [];
29
+ vi.stubGlobal(
30
+ 'fetch',
31
+ vi.fn(async (url: string, init: RequestInit) => {
32
+ const args = { url, init };
33
+ calls.push(args);
34
+ return handler(args);
35
+ }),
36
+ );
37
+ }
38
+
39
+ beforeEach(() => {
40
+ calls = [];
41
+ });
42
+
43
+ afterEach(() => {
44
+ vi.unstubAllGlobals();
45
+ });
46
+
47
+ it('注入 Authorization / X-Tenant-ID / 自定义作用域头', async () => {
48
+ stubFetch(() => jsonResponse({ ok: true }));
49
+ const client = createFetchClient({
50
+ baseUrl: '/bff/config/api/v1/admin/config',
51
+ getToken: () => 'token-abc',
52
+ getTenantId: () => 'tenant-1',
53
+ getHeaders: () => ({ 'X-App-ID': 'app-9' }),
54
+ });
55
+
56
+ await client.get('/items');
57
+
58
+ expect(calls).toHaveLength(1);
59
+ const headers = calls[0].init.headers as Record<string, string>;
60
+ expect(headers.Authorization).toBe('Bearer token-abc');
61
+ expect(headers['X-Tenant-ID']).toBe('tenant-1');
62
+ expect(headers['X-App-ID']).toBe('app-9');
63
+ expect(calls[0].init.credentials).toBe('omit');
64
+ });
65
+
66
+ it('无 token 时不注入 Authorization,也**不**注入 X-Tenant-ID(与 api/client.ts 同口径)', async () => {
67
+ stubFetch(() => jsonResponse({}));
68
+ const client = createFetchClient({
69
+ baseUrl: '/api',
70
+ getToken: () => null,
71
+ // 无 token 时租户头的唯一权威是地址栏/调用方;这里给一个值,验证不会注入
72
+ getTenantId: () => 'tenant-from-env',
73
+ });
74
+
75
+ await client.get('/x');
76
+
77
+ const headers = calls[0].init.headers as Record<string, string>;
78
+ expect(headers.Authorization).toBeUndefined();
79
+ expect(headers['X-Tenant-ID']).toBeUndefined();
80
+ });
81
+
82
+ it('查询参数:跳过 null/undefined,数组展开', async () => {
83
+ stubFetch(() => jsonResponse({}));
84
+ const client = createFetchClient({ baseUrl: '/api' });
85
+
86
+ await client.get('/items', {
87
+ query: { page: 1, q: 'a b', empty: null, skip: undefined, tag: ['x', 'y'] },
88
+ });
89
+
90
+ const url = new URL(calls[0].url);
91
+ expect(url.searchParams.get('page')).toBe('1');
92
+ expect(url.searchParams.get('q')).toBe('a b');
93
+ expect(url.searchParams.has('empty')).toBe(false);
94
+ expect(url.searchParams.has('skip')).toBe(false);
95
+ expect(url.searchParams.getAll('tag')).toEqual(['x', 'y']);
96
+ });
97
+
98
+ it('对象 body 序列化为 JSON 并带 Content-Type', async () => {
99
+ stubFetch(() => jsonResponse({}, 201));
100
+ const client = createFetchClient({ baseUrl: '/api' });
101
+
102
+ await client.post('/items', { key: 'a_b' });
103
+
104
+ expect(calls[0].init.body).toBe('{"key":"a_b"}');
105
+ expect((calls[0].init.headers as Record<string, string>)['Content-Type']).toBe('application/json');
106
+ });
107
+
108
+ it('默认透传信封(不 unwrap、不转键)', async () => {
109
+ stubFetch(() => jsonResponse({ code: 0, data: { snake_key: 1 } }));
110
+ const client = createFetchClient({ baseUrl: '/api' });
111
+
112
+ const result = await client.get<{ code: number; data: { snake_key: number } }>('/x');
113
+
114
+ expect(result).toEqual({ code: 0, data: { snake_key: 1 } });
115
+ });
116
+
117
+ it('unwrap=true 解 data;code!=0 抛错', async () => {
118
+ stubFetch(() => jsonResponse({ code: 0, data: { total: 3 } }));
119
+ const client = createFetchClient({ baseUrl: '/api', unwrap: true });
120
+ await expect(client.get('/x')).resolves.toEqual({ total: 3 });
121
+
122
+ stubFetch(() => jsonResponse({ code: 40000102, message: 'tenant not found' }));
123
+ const failing = createFetchClient({ baseUrl: '/api', unwrap: true });
124
+ await expect(failing.get('/x')).rejects.toMatchObject({
125
+ status: 200,
126
+ code: '40000102',
127
+ message: 'tenant not found',
128
+ });
129
+ });
130
+
131
+ it('unwrap:字符串 code("0" 成功 / "40000102" 失败)也按业务码处理', async () => {
132
+ stubFetch(() => jsonResponse({ code: '0', data: { ok: 1 } }));
133
+ const ok = createFetchClient({ baseUrl: '/api', unwrap: true });
134
+ await expect(ok.get('/x')).resolves.toEqual({ ok: 1 });
135
+
136
+ stubFetch(() => jsonResponse({ code: '40000102', message: 'tenant not found' }));
137
+ const bad = createFetchClient({ baseUrl: '/api', unwrap: true });
138
+ await expect(bad.get('/x')).rejects.toMatchObject({ status: 200, code: '40000102' });
139
+ });
140
+
141
+ it('caseConversion=camel 只转响应键', async () => {
142
+ stubFetch(() => jsonResponse({ item_key: [{ inner_key: 1 }] }));
143
+ const client = createFetchClient({ baseUrl: '/api', caseConversion: 'camel' });
144
+
145
+ await expect(client.get('/x')).resolves.toEqual({ itemKey: [{ innerKey: 1 }] });
146
+ });
147
+
148
+ it('非 2xx:RFC7807 归一为 FetchApiError', async () => {
149
+ stubFetch(() =>
150
+ jsonResponse({ title: '无权限', status: 403, code: '403001', detail: 'role missing' }, 403),
151
+ );
152
+ const client = createFetchClient({ baseUrl: '/api' });
153
+
154
+ const error = await client.get('/x').catch((e: unknown) => e);
155
+ expect(error).toBeInstanceOf(FetchApiError);
156
+ expect(error).toMatchObject({ status: 403, code: '403001', message: '无权限', detail: 'role missing' });
157
+ });
158
+
159
+ it('401:回调 onUnauthorized,无 refresh 时直接抛', async () => {
160
+ stubFetch(() => jsonResponse({ message: 'unauthorized' }, 401));
161
+ const onUnauthorized = vi.fn();
162
+ const client = createFetchClient({ baseUrl: '/api', onUnauthorized });
163
+
164
+ await expect(client.get('/x')).rejects.toMatchObject({ status: 401 });
165
+ expect(onUnauthorized).toHaveBeenCalledTimes(1);
166
+ expect(calls).toHaveLength(1);
167
+ });
168
+
169
+ it('401 + refresh 成功:只重试一次,且**不**触发 onUnauthorized(静默续期要真的静默)', async () => {
170
+ let attempt = 0;
171
+ stubFetch((args) => {
172
+ attempt += 1;
173
+ const headers = args.init.headers as Record<string, string>;
174
+ if (attempt === 1) {
175
+ expect(headers.Authorization).toBe('Bearer old');
176
+ return jsonResponse({ message: 'expired' }, 401);
177
+ }
178
+ return jsonResponse({ ok: true });
179
+ });
180
+
181
+ const onUnauthorized = vi.fn();
182
+ const client = createFetchClient({
183
+ baseUrl: '/api',
184
+ getToken: () => 'old',
185
+ // 注意:refresh 只返回新 token,**不**回写 getToken —— 证明重试用的是续期返回值
186
+ refresh: async () => 'new',
187
+ onUnauthorized,
188
+ });
189
+
190
+ await expect(client.get('/x')).resolves.toEqual({ ok: true });
191
+ expect(attempt).toBe(2);
192
+ expect((calls[1].init.headers as Record<string, string>).Authorization).toBe('Bearer new');
193
+ expect(onUnauthorized).not.toHaveBeenCalled();
194
+ });
195
+
196
+ it('401 + refresh 返回 null:不重试,抛 401 并通知一次', async () => {
197
+ stubFetch(() => jsonResponse({ message: 'expired' }, 401));
198
+ const onUnauthorized = vi.fn();
199
+ const client = createFetchClient({ baseUrl: '/api', refresh: async () => null, onUnauthorized });
200
+
201
+ await expect(client.get('/x')).rejects.toMatchObject({ status: 401 });
202
+ expect(calls).toHaveLength(1);
203
+ expect(onUnauthorized).toHaveBeenCalledTimes(1);
204
+ });
205
+
206
+ it('401 + 续期后仍 401:最多重试一次,onUnauthorized 只通知一次', async () => {
207
+ stubFetch(() => jsonResponse({ message: 'expired' }, 401));
208
+ const onUnauthorized = vi.fn();
209
+ const client = createFetchClient({
210
+ baseUrl: '/api',
211
+ getToken: () => 'old',
212
+ refresh: async () => 'new',
213
+ onUnauthorized,
214
+ });
215
+
216
+ await expect(client.get('/x')).rejects.toMatchObject({ status: 401 });
217
+ expect(calls).toHaveLength(2);
218
+ expect(onUnauthorized).toHaveBeenCalledTimes(1);
219
+ });
220
+
221
+ it('调用方 signal 已 abort:立即失败(code=aborted,不冒充 timeout)', async () => {
222
+ stubFetch(() => jsonResponse({ ok: true }));
223
+ const client = createFetchClient({ baseUrl: '/api' });
224
+ const controller = new AbortController();
225
+ controller.abort();
226
+
227
+ await expect(client.get('/x', { signal: controller.signal })).rejects.toMatchObject({
228
+ status: 0,
229
+ code: 'aborted',
230
+ });
231
+ expect(calls).toHaveLength(0);
232
+ });
233
+
234
+ it('超时:abort 归一为 status 0 / code timeout', async () => {
235
+ vi.stubGlobal(
236
+ 'fetch',
237
+ vi.fn(
238
+ (_url: string, init: RequestInit) =>
239
+ new Promise<Response>((_resolve, reject) => {
240
+ init.signal?.addEventListener('abort', () => {
241
+ const error = new Error('aborted');
242
+ error.name = 'AbortError';
243
+ reject(error);
244
+ });
245
+ }),
246
+ ),
247
+ );
248
+ const client = createFetchClient({ baseUrl: '/api', timeoutMs: 5 });
249
+
250
+ await expect(client.get('/slow')).rejects.toMatchObject({ status: 0, code: 'timeout' });
251
+ });
252
+
253
+ it('2xx 但响应不是合法 JSON ⇒ invalid_json', async () => {
254
+ stubFetch(() => textResponse('<html>oops</html>'));
255
+ const client = createFetchClient({ baseUrl: '/api' });
256
+
257
+ await expect(client.get('/x')).rejects.toMatchObject({ status: 200, code: 'invalid_json' });
258
+ });
259
+
260
+ it('空响应体 ⇒ null(删除成功类)', async () => {
261
+ stubFetch(() => textResponse('', 204));
262
+ const client = createFetchClient({ baseUrl: '/api' });
263
+
264
+ await expect(client.delete('/x')).resolves.toBeNull();
265
+ });
266
+ });