@forgerock/journey-client 0.0.0-beta-20251222204813

package/dist/src/lib/device/interfaces.js

@@ -0,0 +1,10 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * interfaces.ts
+ *
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+export {};

package/dist/src/lib/interfaces.d.ts

@@ -0,0 +1,15 @@
+import { JourneyClientConfig } from './config.types.js';
+import { JourneyStep } from './step.types.js';
+export interface StartParam extends JourneyClientConfig {
+    journey: string;
+    query?: Record<string, string>;
+}
+export interface ResumeOptions extends JourneyClientConfig {
+    journey?: string;
+    query?: Record<string, string>;
+}
+export interface NextOptions extends JourneyClientConfig {
+    query?: Record<string, string>;
+}
+export type { JourneyStep };
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/src/lib/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../src/lib/interfaces.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,WAAW,UAAW,SAAQ,mBAAmB;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,YAAY,EAAE,WAAW,EAAE,CAAC"}

package/dist/src/lib/interfaces.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+export {};

package/dist/src/lib/journey.api.d.ts

@@ -0,0 +1,15 @@
+import type { Step } from '@forgerock/sdk-types';
+import type { BaseQueryFn, FetchArgs, FetchBaseQueryError, FetchBaseQueryMeta } from '@reduxjs/toolkit/query';
+import { JourneyStep } from './step.types.js';
+import { NextOptions, StartParam } from './interfaces.js';
+export declare const journeyApi: import("@reduxjs/toolkit/query").Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, FetchBaseQueryMeta>, {
+    start: import("@reduxjs/toolkit/query").MutationDefinition<StartParam | undefined, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, FetchBaseQueryMeta>, never, Step, "journeyReducer", unknown>;
+    next: import("@reduxjs/toolkit/query").MutationDefinition<{
+        step: JourneyStep;
+        options?: NextOptions;
+    }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, FetchBaseQueryMeta>, never, Step, "journeyReducer", unknown>;
+    terminate: import("@reduxjs/toolkit/query").MutationDefinition<{
+        query?: Record<string, string>;
+    } | undefined, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, FetchBaseQueryMeta>, never, void, "journeyReducer", unknown>;
+}, "journeyReducer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
+//# sourceMappingURL=journey.api.d.ts.map

package/dist/src/lib/journey.api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journey.api.d.ts","sourceRoot":"","sources":["../../../src/lib/journey.api.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAgB,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAEV,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,kBAAkB,EAEnB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAgE1D,eAAO,MAAM,UAAU;;;cA+CkB,WAAW;kBAAY,WAAW;;;gBA8B3B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;mFA+BpE,CAAC"}

package/dist/src/lib/journey.api.js

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { initQuery } from '@forgerock/sdk-request-middleware';
+import { REQUESTED_WITH, getEndpointPath, stringify, resolve } from '@forgerock/sdk-utilities';
+import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query';
+// Move these functions to the top, before journeyApi definition
+function constructUrl(serverConfig, realmPath, tree, query) {
+    const treeParams = tree ? { authIndexType: 'service', authIndexValue: tree } : undefined;
+    const params = { ...query, ...treeParams };
+    const queryString = Object.keys(params).length > 0 ? `?${stringify(params)}` : '';
+    const path = getEndpointPath({
+        endpoint: 'authenticate',
+        realmPath,
+        customPaths: serverConfig.paths,
+    });
+    const url = resolve(serverConfig.baseUrl, `${path}${queryString}`);
+    return url;
+}
+function constructSessionsUrl(serverConfig, realmPath, query) {
+    const params = { ...query };
+    const queryString = Object.keys(params).length > 0 ? `?${stringify(params)}` : '';
+    const path = getEndpointPath({
+        endpoint: 'sessions',
+        realmPath,
+        customPaths: serverConfig.paths,
+    });
+    const url = resolve(serverConfig.baseUrl, `${path}${queryString}`);
+    return url;
+}
+function configureRequest(step) {
+    const init = {
+        body: step ? JSON.stringify(step.payload) : undefined,
+        credentials: 'include',
+        headers: new Headers({}),
+        method: 'POST',
+    };
+    return init;
+}
+function configureSessionRequest() {
+    const init = {
+        credentials: 'include',
+        headers: new Headers({}),
+        method: 'POST',
+    };
+    return init;
+}
+export const journeyApi = createApi({
+    reducerPath: 'journeyReducer',
+    baseQuery: fetchBaseQuery({
+        baseUrl: '/',
+        prepareHeaders: (headers) => {
+            headers.set('Accept', 'application/json');
+            headers.set('Accept-API-Version', 'protocol=1.0,resource=2.1');
+            headers.set('Content-Type', 'application/json');
+            headers.set('X-Requested-With', REQUESTED_WITH);
+            return headers;
+        },
+    }),
+    endpoints: (builder) => ({
+        start: builder.mutation({
+            queryFn: async (options, api, _, baseQuery) => {
+                const { config } = api.extra;
+                if (!config.serverConfig) {
+                    throw new Error('Server configuration is missing.');
+                }
+                const { realmPath, serverConfig } = config;
+                const query = options?.query || {};
+                const url = constructUrl(serverConfig, realmPath, options?.journey, query);
+                const request = configureRequest();
+                const { requestMiddleware } = api.extra;
+                const response = await initQuery({ ...request, url: url }, 'begin', {
+                    type: 'service',
+                    tree: options?.journey,
+                })
+                    .applyMiddleware(requestMiddleware)
+                    .applyQuery(async (req) => {
+                    const result = await baseQuery(req, api, api.extra);
+                    return result;
+                });
+                return response;
+            },
+        }),
+        next: builder.mutation({
+            queryFn: async ({ step, options }, api, _, baseQuery) => {
+                const { config } = api.extra;
+                if (!config.serverConfig) {
+                    throw new Error('Server configuration is missing.');
+                }
+                const { realmPath, serverConfig } = config;
+                const query = options?.query || {};
+                // TODO: Handle the `undefined` argument better
+                const url = constructUrl(serverConfig, realmPath, undefined, query);
+                const request = configureRequest(step);
+                const { requestMiddleware } = api.extra;
+                const response = await initQuery({ ...request, url }, 'continue')
+                    .applyMiddleware(requestMiddleware)
+                    .applyQuery(async (req) => {
+                    const result = await baseQuery(req, api, api.extra);
+                    return result;
+                });
+                return response;
+            },
+        }),
+        terminate: builder.mutation({
+            queryFn: async (options, api, _, baseQuery) => {
+                const { config } = api.extra;
+                if (!config.serverConfig) {
+                    throw new Error('Server configuration is missing.');
+                }
+                const { realmPath, serverConfig } = config;
+                const query = { ...options?.query, _action: 'logout' };
+                const url = constructSessionsUrl(serverConfig, realmPath, query);
+                const request = configureSessionRequest();
+                const { requestMiddleware } = api.extra;
+                const response = await initQuery({ ...request, url }, 'terminate')
+                    .applyMiddleware(requestMiddleware)
+                    .applyQuery(async (req) => {
+                    const result = await baseQuery(req, api, api.extra);
+                    return result;
+                });
+                return response;
+            },
+        }),
+    }),
+});

package/dist/src/lib/journey.slice.d.ts

@@ -0,0 +1,12 @@
+import { Slice } from '@reduxjs/toolkit';
+import type { Step } from '@forgerock/sdk-types';
+import type { JourneyClientConfig } from './config.types.js';
+export interface JourneyState {
+    authId?: string;
+    step?: Step;
+    error?: Error;
+    config?: JourneyClientConfig;
+}
+export declare const journeySlice: Slice<JourneyState>;
+export declare const setConfig: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<`${string}/${string}`> | import("@reduxjs/toolkit").ActionCreatorWithPayload<any, `${string}/${string}`> | import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<any[], any, `${string}/${string}`, never, never> | import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<any[], any, `${string}/${string}`, never, any> | import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<any[], any, `${string}/${string}`, any, never> | import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<any[], any, `${string}/${string}`, any, any>;
+//# sourceMappingURL=journey.slice.d.ts.map

package/dist/src/lib/journey.slice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journey.slice.d.ts","sourceRoot":"","sources":["../../../src/lib/journey.slice.ts"],"names":[],"mappings":"AAOA,OAAO,EAA8B,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAID,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,YAAY,CAQ3C,CAAC;AAEH,eAAO,MAAQ,SAAS,qlBAAyB,CAAC"}

package/dist/src/lib/journey.slice.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { createSlice } from '@reduxjs/toolkit';
+const initialState = {};
+export const journeySlice = createSlice({
+    name: 'journey',
+    initialState,
+    reducers: {
+        setConfig: (state, action) => {
+            state.config = action.payload;
+        },
+    },
+});
+export const { setConfig } = journeySlice.actions;

package/dist/src/lib/journey.utils.d.ts

@@ -0,0 +1,7 @@
+import type { Step } from '@forgerock/sdk-types';
+import type { JourneyStep } from './step.utils.js';
+import type { JourneyLoginFailure } from './login-failure.utils.js';
+import type { JourneyLoginSuccess } from './login-success.utils.js';
+declare function createJourneyObject(step: Step): JourneyStep | JourneyLoginSuccess | JourneyLoginFailure | undefined;
+export { createJourneyObject };
+//# sourceMappingURL=journey.utils.d.ts.map

package/dist/src/lib/journey.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journey.utils.d.ts","sourceRoot":"","sources":["../../../src/lib/journey.utils.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAMjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,iBAAS,mBAAmB,CAC1B,IAAI,EAAE,IAAI,GACT,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,SAAS,CAoBrE;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/src/lib/journey.utils.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { StepType } from '@forgerock/sdk-types';
+import { createJourneyLoginSuccess } from './login-success.utils.js';
+import { createJourneyLoginFailure } from './login-failure.utils.js';
+import { createJourneyStep } from './step.utils.js';
+function createJourneyObject(step) {
+    let type;
+    if (step.authId) {
+        type = StepType.Step;
+    }
+    else if (step.successUrl) {
+        type = StepType.LoginSuccess;
+    }
+    else {
+        type = StepType.LoginFailure;
+    }
+    switch (type) {
+        case StepType.LoginSuccess:
+            return createJourneyLoginSuccess(step);
+        case StepType.LoginFailure:
+            return createJourneyLoginFailure(step);
+        case StepType.Step:
+            return createJourneyStep(step);
+        default:
+            return undefined;
+    }
+}
+export { createJourneyObject };

package/dist/src/lib/login-failure.utils.d.ts

@@ -0,0 +1,16 @@
+import { StepType } from '@forgerock/sdk-types';
+import type { Step, AuthResponse, FailureDetail } from '@forgerock/sdk-types';
+import type { MessageCreator, ProcessedPropertyError } from './policy/interfaces.js';
+type JourneyLoginFailure = AuthResponse & {
+    type: StepType.LoginFailure;
+    payload: Step;
+    getCode: () => number;
+    getDetail: () => FailureDetail | undefined;
+    getMessage: () => string | undefined;
+    getProcessedMessage: (messageCreator?: MessageCreator) => ProcessedPropertyError[];
+    getReason: () => string | undefined;
+};
+declare function createJourneyLoginFailure(payload: Step): JourneyLoginFailure;
+export { createJourneyLoginFailure };
+export type { JourneyLoginFailure };
+//# sourceMappingURL=login-failure.utils.d.ts.map

package/dist/src/lib/login-failure.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"login-failure.utils.d.ts","sourceRoot":"","sources":["../../../src/lib/login-failure.utils.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAI9E,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAErF,KAAK,mBAAmB,GAAG,YAAY,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC5B,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,aAAa,GAAG,SAAS,CAAC;IAC3C,UAAU,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IACrC,mBAAmB,EAAE,CAAC,cAAc,CAAC,EAAE,cAAc,KAAK,sBAAsB,EAAE,CAAC;IACnF,SAAS,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAyBF,iBAAS,yBAAyB,CAAC,OAAO,EAAE,IAAI,GAAG,mBAAmB,CAWrE;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAC;AAErC,YAAY,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/src/lib/login-failure.utils.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { StepType } from '@forgerock/sdk-types';
+import { Policy } from './policy/policy.js';
+function getCode(payload) {
+    return Number(payload.code);
+}
+function getDetail(payload) {
+    return payload.detail;
+}
+function getMessage(payload) {
+    return payload.message;
+}
+function getProcessedMessage(payload, messageCreator) {
+    return Policy.parseErrors(payload, messageCreator);
+}
+function getReason(payload) {
+    return payload.reason;
+}
+function createJourneyLoginFailure(payload) {
+    return {
+        payload,
+        type: StepType.LoginFailure,
+        getCode: () => getCode(payload),
+        getDetail: () => getDetail(payload),
+        getMessage: () => getMessage(payload),
+        getProcessedMessage: (messageCreator) => getProcessedMessage(payload, messageCreator),
+        getReason: () => getReason(payload),
+    };
+}
+export { createJourneyLoginFailure };

package/dist/src/lib/login-success.utils.d.ts

@@ -0,0 +1,16 @@
+import { StepType } from '@forgerock/sdk-types';
+import type { Step, AuthResponse } from '@forgerock/sdk-types';
+type JourneyLoginSuccess = AuthResponse & {
+    type: StepType.LoginSuccess;
+    payload: Step;
+    getRealm: () => string | undefined;
+    getSessionToken: () => string | undefined;
+    getSuccessUrl: () => string | undefined;
+};
+declare function getRealm(payload: Step): string | undefined;
+declare function getSessionToken(payload: Step): string | undefined;
+declare function getSuccessUrl(payload: Step): string | undefined;
+declare function createJourneyLoginSuccess(payload: Step): JourneyLoginSuccess;
+export { createJourneyLoginSuccess, getRealm, getSessionToken, getSuccessUrl };
+export type { JourneyLoginSuccess };
+//# sourceMappingURL=login-success.utils.d.ts.map

package/dist/src/lib/login-success.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"login-success.utils.d.ts","sourceRoot":"","sources":["../../../src/lib/login-success.utils.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAE/D,KAAK,mBAAmB,GAAG,YAAY,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC5B,OAAO,EAAE,IAAI,CAAC;IACd,QAAQ,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;IAC1C,aAAa,EAAE,MAAM,MAAM,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,iBAAS,QAAQ,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAEnD;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAE1D;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAExD;AAED,iBAAS,yBAAyB,CAAC,OAAO,EAAE,IAAI,GAAG,mBAAmB,CAQrE;AAED,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;AAE/E,YAAY,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/src/lib/login-success.utils.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { StepType } from '@forgerock/sdk-types';
+function getRealm(payload) {
+    return payload.realm;
+}
+function getSessionToken(payload) {
+    return payload.tokenId;
+}
+function getSuccessUrl(payload) {
+    return payload.successUrl;
+}
+function createJourneyLoginSuccess(payload) {
+    return {
+        payload,
+        type: StepType.LoginSuccess,
+        getRealm: () => getRealm(payload),
+        getSessionToken: () => getSessionToken(payload),
+        getSuccessUrl: () => getSuccessUrl(payload),
+    };
+}
+export { createJourneyLoginSuccess, getRealm, getSessionToken, getSuccessUrl };

package/dist/src/lib/policy/interfaces.d.ts

@@ -0,0 +1,11 @@
+import type { FailedPolicyRequirement } from '@forgerock/sdk-types';
+export interface MessageCreator {
+    [key: string]: (propertyName: string, params?: {
+        [key: string]: unknown;
+    }) => string;
+}
+export interface ProcessedPropertyError {
+    detail: FailedPolicyRequirement;
+    messages: string[];
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/src/lib/policy/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../../src/lib/policy/interfaces.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,KAAK,MAAM,CAAC;CACtF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,uBAAuB,CAAC;IAChC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}

package/dist/src/lib/policy/interfaces.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+export {};

package/dist/src/lib/policy/message-creator.d.ts

@@ -0,0 +1,3 @@
+import type { MessageCreator } from './interfaces.js';
+export declare const defaultMessageCreator: MessageCreator;
+//# sourceMappingURL=message-creator.d.ts.map

package/dist/src/lib/policy/message-creator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-creator.d.ts","sourceRoot":"","sources":["../../../../src/lib/policy/message-creator.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,eAAO,MAAM,qBAAqB,EAAE,cAkDnC,CAAC"}

package/dist/src/lib/policy/message-creator.js

@@ -0,0 +1,58 @@
+/*
+ * @forgerock/ping-javascript-sdk
+ *
+ * message-creator.ts
+ *
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { PolicyKey } from '@forgerock/sdk-types';
+import { getProp, plural } from '@forgerock/sdk-utilities';
+export const defaultMessageCreator = {
+    [PolicyKey.CannotContainCharacters]: (property, params) => {
+        const forbiddenChars = getProp(params, 'forbiddenChars', '');
+        return `${property} must not contain following characters: "${forbiddenChars}"`;
+    },
+    [PolicyKey.CannotContainDuplicates]: (property, params) => {
+        const duplicateValue = getProp(params, 'duplicateValue', '');
+        return `${property} must not contain duplicates: "${duplicateValue}"`;
+    },
+    [PolicyKey.CannotContainOthers]: (property, params) => {
+        const disallowedFields = getProp(params, 'disallowedFields', '');
+        return `${property} must not contain: "${disallowedFields}"`;
+    },
+    [PolicyKey.LeastCapitalLetters]: (property, params) => {
+        const numCaps = getProp(params, 'numCaps', 0);
+        return `${property} must contain at least ${numCaps} capital ${plural(numCaps, 'letter')}`;
+    },
+    [PolicyKey.LeastNumbers]: (property, params) => {
+        const numNums = getProp(params, 'numNums', 0);
+        return `${property} must contain at least ${numNums} numeric ${plural(numNums, 'value')}`;
+    },
+    [PolicyKey.MatchRegexp]: (property) => `${property} has failed the "MATCH_REGEXP" policy`,
+    [PolicyKey.MaximumLength]: (property, params) => {
+        const maxLength = getProp(params, 'maxLength', 0);
+        return `${property} must be at most ${maxLength} ${plural(maxLength, 'character')}`;
+    },
+    [PolicyKey.MaximumNumber]: (property) => `${property} has failed the "MAXIMUM_NUMBER_VALUE" policy`,
+    [PolicyKey.MinimumLength]: (property, params) => {
+        const minLength = getProp(params, 'minLength', 0);
+        return `${property} must be at least ${minLength} ${plural(minLength, 'character')}`;
+    },
+    [PolicyKey.MinimumNumber]: (property) => `${property} has failed the "MINIMUM_NUMBER_VALUE" policy`,
+    [PolicyKey.Required]: (property) => `${property} is required`,
+    [PolicyKey.Unique]: (property) => `${property} must be unique`,
+    [PolicyKey.UnknownPolicy]: (property, params) => {
+        const policyRequirement = getProp(params, 'policyRequirement', 'Unknown');
+        return `${property}: Unknown policy requirement "${policyRequirement}"`;
+    },
+    [PolicyKey.ValidArrayItems]: (property) => `${property} has failed the "VALID_ARRAY_ITEMS" policy`,
+    [PolicyKey.ValidDate]: (property) => `${property} has an invalid date`,
+    [PolicyKey.ValidEmailAddress]: (property) => `${property} has an invalid email address`,
+    [PolicyKey.ValidNameFormat]: (property) => `${property} has an invalid name format`,
+    [PolicyKey.ValidNumber]: (property) => `${property} has an invalid number`,
+    [PolicyKey.ValidPhoneFormat]: (property) => `${property} has an invalid phone number`,
+    [PolicyKey.ValidQueryFilter]: (property) => `${property} has failed the "VALID_QUERY_FILTER" policy`,
+    [PolicyKey.ValidType]: (property) => `${property} has failed the "VALID_TYPE" policy`,
+};

package/dist/src/lib/policy/policy.d.ts

@@ -0,0 +1,57 @@
+import type { FailedPolicyRequirement, PolicyRequirement, Step } from '@forgerock/sdk-types';
+import type { MessageCreator, ProcessedPropertyError } from './interfaces.js';
+/**
+ * Utility for processing policy failures into human readable messages.
+ *
+ * Example:
+ *
+ * ```js
+ * // Create message overrides and extensions as needed
+ * const messageCreator = {
+ *   [PolicyKey.unique]: (property: string) => (
+ *     `this is a custom message for "UNIQUE" policy of ${property}`
+ *   ),
+ *   CUSTOM_POLICY: (property: string, params: any) => (
+ *     `this is a custom message for "${params.policyRequirement}" policy of ${property}`
+ *   ),
+ * };
+ *
+ * const thisStep = await journeyClient.next(previousStep);
+ *
+ * if (thisStep.type === StepType.LoginFailure) {
+ *   const messagesStepMethod = thisStep.getProcessedMessage(messageCreator);
+ *   const messagesClassMethod = Policy.parseErrors(thisStep, messageCreator)
+ * }
+ */
+export declare abstract class Policy {
+    /**
+     * Parses policy errors and generates human readable error messages.
+     *
+     * @param {Step} err The step containing the error.
+     * @param {MessageCreator} messageCreator
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {ProcessedPropertyError[]} Array of objects containing all processed policy errors.
+     */
+    static parseErrors(err: Partial<Step>, messageCreator?: MessageCreator): ProcessedPropertyError[];
+    /**
+     * Parses a failed policy and returns a string array of error messages.
+     *
+     * @param {FailedPolicyRequirement} failedPolicy The detail data of the failed policy.
+     * @param {MessageCreator} customMessage
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {string[]} Array of strings with all processed policy errors.
+     */
+    static parseFailedPolicyRequirement(failedPolicy: FailedPolicyRequirement, messageCreator?: MessageCreator): string[];
+    /**
+     * Parses a policy error into a human readable error message.
+     *
+     * @param {string} property The property with the policy failure.
+     * @param {PolicyRequirement} policy The policy failure data.
+     * @param {MessageCreator} customMessage
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {string} Human readable error message.
+     */
+    static parsePolicyRequirement(property: string, policy: PolicyRequirement, messageCreator?: MessageCreator): string;
+}
+export type { MessageCreator, ProcessedPropertyError };
+//# sourceMappingURL=policy.d.ts.map

package/dist/src/lib/policy/policy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../../../../src/lib/policy/policy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAI7F,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,MAAM;IAC1B;;;;;;;OAOG;WACW,WAAW,CACvB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAClB,cAAc,CAAC,EAAE,cAAc,GAC9B,sBAAsB,EAAE;IAe3B;;;;;;;OAOG;WACW,4BAA4B,CACxC,YAAY,EAAE,uBAAuB,EACrC,cAAc,CAAC,EAAE,cAAc,GAC9B,MAAM,EAAE;IAUX;;;;;;;;OAQG;WACW,sBAAsB,CAClC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,EACzB,cAAc,GAAE,cAAmB,GAClC,MAAM;CAiCV;AAED,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/src/lib/policy/policy.js

@@ -0,0 +1,108 @@
+/*
+ * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved.
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { PolicyKey } from '@forgerock/sdk-types';
+import { defaultMessageCreator } from './message-creator.js';
+/**
+ * Utility for processing policy failures into human readable messages.
+ *
+ * Example:
+ *
+ * ```js
+ * // Create message overrides and extensions as needed
+ * const messageCreator = {
+ *   [PolicyKey.unique]: (property: string) => (
+ *     `this is a custom message for "UNIQUE" policy of ${property}`
+ *   ),
+ *   CUSTOM_POLICY: (property: string, params: any) => (
+ *     `this is a custom message for "${params.policyRequirement}" policy of ${property}`
+ *   ),
+ * };
+ *
+ * const thisStep = await journeyClient.next(previousStep);
+ *
+ * if (thisStep.type === StepType.LoginFailure) {
+ *   const messagesStepMethod = thisStep.getProcessedMessage(messageCreator);
+ *   const messagesClassMethod = Policy.parseErrors(thisStep, messageCreator)
+ * }
+ */
+export class Policy {
+    /**
+     * Parses policy errors and generates human readable error messages.
+     *
+     * @param {Step} err The step containing the error.
+     * @param {MessageCreator} messageCreator
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {ProcessedPropertyError[]} Array of objects containing all processed policy errors.
+     */
+    static parseErrors(err, messageCreator) {
+        const errors = [];
+        if (err.detail && err.detail.failedPolicyRequirements) {
+            err.detail.failedPolicyRequirements.map((x) => {
+                errors.push.apply(errors, [
+                    {
+                        detail: x,
+                        messages: this.parseFailedPolicyRequirement(x, messageCreator),
+                    },
+                ]);
+            });
+        }
+        return errors;
+    }
+    /**
+     * Parses a failed policy and returns a string array of error messages.
+     *
+     * @param {FailedPolicyRequirement} failedPolicy The detail data of the failed policy.
+     * @param {MessageCreator} customMessage
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {string[]} Array of strings with all processed policy errors.
+     */
+    static parseFailedPolicyRequirement(failedPolicy, messageCreator) {
+        const errors = [];
+        failedPolicy.policyRequirements.map((policyRequirement) => {
+            errors.push(this.parsePolicyRequirement(failedPolicy.property, policyRequirement, messageCreator));
+        });
+        return errors;
+    }
+    /**
+     * Parses a policy error into a human readable error message.
+     *
+     * @param {string} property The property with the policy failure.
+     * @param {PolicyRequirement} policy The policy failure data.
+     * @param {MessageCreator} customMessage
+     * Extensible and overridable custom error messages for policy failures.
+     * @return {string} Human readable error message.
+     */
+    static parsePolicyRequirement(property, policy, messageCreator = {}) {
+        // AM is returning policy requirement failures as JSON strings
+        let policyObject;
+        if (typeof policy === 'string') {
+            try {
+                const parsed = JSON.parse(policy);
+                policyObject =
+                    typeof parsed === 'string'
+                        ? { policyRequirement: parsed }
+                        : parsed;
+            }
+            catch {
+                policyObject = { policyRequirement: policy };
+            }
+        }
+        else {
+            policyObject = { ...policy };
+        }
+        const policyRequirement = policyObject.policyRequirement;
+        // Determine which message creator function to use
+        const effectiveMessageCreator = messageCreator[policyRequirement] ||
+            defaultMessageCreator[policyRequirement] ||
+            defaultMessageCreator[PolicyKey.UnknownPolicy];
+        // Flatten the parameters and create the message
+        const params = policyObject.params
+            ? { ...policyObject.params, policyRequirement }
+            : { policyRequirement };
+        const message = effectiveMessageCreator(property, params);
+        return message;
+    }
+}