@fgrzl/fetch 1.0.0-ci.11 → 1.1.0-alpha.2

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.
@@ -1,5 +1,27 @@
1
1
  import { FetchClient } from './client';
2
+ /**
3
+ * Configuration options for unauthorized redirect middleware.
4
+ */
2
5
  export interface UnauthorizedConfig {
6
+ /** Path to redirect to when a 401 Unauthorized response is received */
3
7
  loginPath: string;
4
8
  }
9
+ /**
10
+ * Configures automatic redirection for unauthorized responses.
11
+ *
12
+ * When a 401 Unauthorized response is received, this middleware will
13
+ * automatically redirect the browser to the specified login page,
14
+ * including the current URL as a returnTo parameter for post-login redirection.
15
+ *
16
+ * @param client - The FetchClient instance to configure
17
+ * @param config - Configuration options including the login path
18
+ *
19
+ * @example
20
+ * ```typescript
21
+ * const client = new FetchClient();
22
+ * useUnauthorized(client, {
23
+ * loginPath: '/login'
24
+ * });
25
+ * ```
26
+ */
5
27
  export declare function useUnauthorized(client: FetchClient, config: UnauthorizedConfig): void;
@@ -1,6 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.useUnauthorized = useUnauthorized;
4
+ /**
5
+ * Creates a response middleware that handles 401 Unauthorized responses
6
+ * by redirecting to a login page with a return URL.
7
+ *
8
+ * @param config - Configuration options
9
+ * @returns Response middleware function
10
+ */
4
11
  function unauthorizedRedirectMiddleware(config) {
5
12
  return async (res) => {
6
13
  if (res.status === 401) {
@@ -10,6 +17,24 @@ function unauthorizedRedirectMiddleware(config) {
10
17
  return res;
11
18
  };
12
19
  }
20
+ /**
21
+ * Configures automatic redirection for unauthorized responses.
22
+ *
23
+ * When a 401 Unauthorized response is received, this middleware will
24
+ * automatically redirect the browser to the specified login page,
25
+ * including the current URL as a returnTo parameter for post-login redirection.
26
+ *
27
+ * @param client - The FetchClient instance to configure
28
+ * @param config - Configuration options including the login path
29
+ *
30
+ * @example
31
+ * ```typescript
32
+ * const client = new FetchClient();
33
+ * useUnauthorized(client, {
34
+ * loginPath: '/login'
35
+ * });
36
+ * ```
37
+ */
13
38
  function useUnauthorized(client, config) {
14
39
  client.useResponseMiddleware(unauthorizedRedirectMiddleware(config));
15
40
  }
@@ -1 +1 @@
1
- {"version":3,"file":"unauthorized.js","sourceRoot":"","sources":["../src/unauthorized.ts"],"names":[],"mappings":";;AAoBA,0CAKC;AAnBD,SAAS,8BAA8B,CACrC,MAA0B;IAE1B,OAAO,KAAK,EAAE,GAAG,EAAE,EAAE;QACnB,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,kBAAkB,CACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAClD,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,SAAS,aAAa,QAAQ,EAAE,CAAC;QACpE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,eAAe,CAC7B,MAAmB,EACnB,MAA0B;IAE1B,MAAM,CAAC,qBAAqB,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC"}
1
+ {"version":3,"file":"unauthorized.js","sourceRoot":"","sources":["../src/unauthorized.ts"],"names":[],"mappings":";;AAiDA,0CAKC;AA5CD;;;;;;GAMG;AACH,SAAS,8BAA8B,CACrC,MAA0B;IAE1B,OAAO,KAAK,EAAE,GAAG,EAAE,EAAE;QACnB,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,kBAAkB,CACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAClD,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,SAAS,aAAa,QAAQ,EAAE,CAAC;QACpE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,eAAe,CAC7B,MAAmB,EACnB,MAA0B;IAE1B,MAAM,CAAC,qBAAqB,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fgrzl/fetch",
3
- "version": "1.0.0-ci.11",
3
+ "version": "1.1.0-alpha.2",
4
4
  "description": "A simple fetch client",
5
5
  "keywords": [
6
6
  "fetch",
@@ -27,14 +27,18 @@
27
27
  "build": "tsc",
28
28
  "prepublishOnly": "npm run build",
29
29
  "format": "prettier --write .",
30
+ "format:check": "prettier --check .",
30
31
  "test": "vitest",
31
- "test:watch": "vitest --watch"
32
+ "test:watch": "vitest --watch",
33
+ "test:coverage": "vitest run --coverage",
34
+ "lint": "npm run format:check"
32
35
  },
33
36
  "devDependencies": {
34
- "@types/node": "^22.15.17",
35
- "@vitest/coverage-v8": "^3.1.3",
36
- "prettier": "^3.5.3",
37
- "typescript": "^5.8.3",
38
- "vitest": "^3.1.3"
37
+ "@types/node": "^24.2.1",
38
+ "@vitest/coverage-v8": "^3.2.4",
39
+ "jsdom": "^26.1.0",
40
+ "prettier": "^3.6.2",
41
+ "typescript": "^5.9.2",
42
+ "vitest": "^3.2.4"
39
43
  }
40
44
  }
@@ -1 +0,0 @@
1
- export {};
@@ -1,51 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const vitest_1 = require("vitest");
4
- const client_1 = require("./client");
5
- (0, vitest_1.describe)('FetchClient', () => {
6
- const mockFetch = vitest_1.vi.fn();
7
- const originalFetch = globalThis.fetch;
8
- (0, vitest_1.beforeEach)(() => {
9
- vitest_1.vi.resetAllMocks();
10
- globalThis.fetch = mockFetch;
11
- });
12
- (0, vitest_1.afterAll)(() => {
13
- globalThis.fetch = originalFetch;
14
- });
15
- (0, vitest_1.it)('calls fetch with correct method and URL', async () => {
16
- mockFetch.mockResolvedValueOnce(new Response(JSON.stringify({ message: 'ok' }), { status: 200 }));
17
- const client = new client_1.FetchClient();
18
- const result = await client.get('/test');
19
- (0, vitest_1.expect)(mockFetch).toHaveBeenCalledWith('/test', vitest_1.expect.objectContaining({ method: 'GET' }));
20
- (0, vitest_1.expect)(result.message).toBe('ok');
21
- });
22
- (0, vitest_1.it)('applies request middleware', async () => {
23
- const mw = async (req, url) => {
24
- const headers = { ...req.headers, 'X-Test': '123' };
25
- return [{ ...req, headers }, `${url}?extra=1`];
26
- };
27
- mockFetch.mockResolvedValueOnce(new Response(JSON.stringify({ done: true }), { status: 200 }));
28
- const client = new client_1.FetchClient();
29
- client.useRequestMiddleware(mw);
30
- await client.get('/original');
31
- (0, vitest_1.expect)(mockFetch).toHaveBeenCalledWith('/original?extra=1', vitest_1.expect.objectContaining({
32
- headers: vitest_1.expect.objectContaining({ 'X-Test': '123' }),
33
- }));
34
- });
35
- (0, vitest_1.it)('applies response middleware', async () => {
36
- const mw = async (res) => {
37
- return res;
38
- };
39
- mockFetch.mockResolvedValueOnce(new Response(JSON.stringify({ done: true }), { status: 200 }));
40
- const client = new client_1.FetchClient();
41
- client.useResponseMiddleware(mw);
42
- const res = await client.get('/ok');
43
- (0, vitest_1.expect)(res.done).toBe(true);
44
- });
45
- (0, vitest_1.it)('throws when response is not ok', async () => {
46
- mockFetch.mockResolvedValueOnce(new Response(JSON.stringify({ error: 'fail' }), { status: 400 }));
47
- const client = new client_1.FetchClient();
48
- await (0, vitest_1.expect)(client.get('/bad')).rejects.toEqual({ error: 'fail' });
49
- });
50
- });
51
- //# sourceMappingURL=index.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,mCAAwE;AACxE,qCAA8E;AAE9E,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,MAAM,SAAS,GAAG,WAAE,CAAC,EAAE,EAAE,CAAC;IAC1B,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC;IAEvC,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,WAAE,CAAC,aAAa,EAAE,CAAC;QACnB,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,GAAG,EAAE;QACZ,UAAU,CAAC,KAAK,GAAG,aAAa,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,SAAS,CAAC,qBAAqB,CAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACjE,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,oBAAW,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAsB,OAAO,CAAC,CAAC;QAE9D,IAAA,eAAM,EAAC,SAAS,CAAC,CAAC,oBAAoB,CACpC,OAAO,EACP,eAAM,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC3C,CAAC;QACF,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,EAAE,GAAsB,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;YAC/C,MAAM,OAAO,GAAG,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YACpD,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,GAAG,UAAU,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,SAAS,CAAC,qBAAqB,CAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC9D,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,oBAAW,EAAE,CAAC;QACjC,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAChC,MAAM,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE9B,IAAA,eAAM,EAAC,SAAS,CAAC,CAAC,oBAAoB,CACpC,mBAAmB,EACnB,eAAM,CAAC,gBAAgB,CAAC;YACtB,OAAO,EAAE,eAAM,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;SACtD,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,EAAE,GAAuB,KAAK,EAAE,GAAG,EAAE,EAAE;YAC3C,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,SAAS,CAAC,qBAAqB,CAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC9D,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,oBAAW,EAAE,CAAC;QACjC,MAAM,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,CAAoB,KAAK,CAAC,CAAC;QACvD,IAAA,eAAM,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,SAAS,CAAC,qBAAqB,CAC7B,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CACjE,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,oBAAW,EAAE,CAAC;QACjC,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}