Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/plenty-flies-tease.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@forgerock/journey-client': major
---

Add x-requested-platform to the journey-client as a header

BREAKING!: This adds a required header to the journey-client requests that will be required in cors-configurations.
9 changes: 8 additions & 1 deletion packages/journey-client/src/lib/journey.api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@
*/

import { initQuery } from '@forgerock/sdk-request-middleware';
import { getEndpointPath, REQUESTED_WITH, resolve, stringify } from '@forgerock/sdk-utilities';
import {
getEndpointPath,
REQUESTED_WITH,
resolve,
stringify,
X_REQUESTED_PLATFORM,
} from '@forgerock/sdk-utilities';
import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query';

import type { logger as loggerFn } from '@forgerock/sdk-logger';
Expand Down Expand Up @@ -98,6 +104,7 @@ export const journeyApi = createApi({
headers.set('Accept-API-Version', 'protocol=1.0,resource=2.1');
headers.set('Content-Type', 'application/json');
headers.set('X-Requested-With', REQUESTED_WITH);
headers.set('X-Requested-Platform', X_REQUESTED_PLATFORM);

return headers;
},
Expand Down
1 change: 1 addition & 0 deletions tools/api-report/src/integration.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ describe('integration: forgotten export detection and fix', () => {
});

it('should handle multiple entry points', () => {
// This test runs api-extractor twice, which can be slow in CI environments
// Add a second entry point: ./utils with its own forgotten export
mkdirSync(resolve(CLIENT_DIR, 'dist/src/utils'), { recursive: true });

Expand Down
3 changes: 3 additions & 0 deletions tools/api-report/vitest.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ export default defineConfig(() => ({
environment: 'node',
include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
reporters: ['default'],
// api-extractor invocations can be slow, especially in CI environments
testTimeout: 30000,
hookTimeout: 30000,
coverage: {
reportsDirectory: './test-output/vitest/coverage',
provider: 'v8' as const,
Expand Down
Loading