import util from 'util'; import Constants from '../shared/Constants'; import { State } from '../shared/State'; import { getCurrentRealmPath } from '../utils/ForgeRockUtils'; import { type IdObjectSkeletonInterface, type PagedResult } from './ApiTypes'; import { generateAmApi } from './BaseApi'; const scriptURLTemplate = '%s/json%s/scripts/%s'; const scriptListURLTemplate = '%s/json%s/scripts?_queryFilter=true'; const scriptQueryURLTemplate = '%s/json%s/scripts?_queryFilter=name+eq+%%22%s%%22'; const libraryConfigQueryURLTemplate = '%s/json%s/libraries?_queryFilter=name+eq+%%22%s%%22'; const apiVersion = 'protocol=2.0,resource=1.0'; const getApiConfig = () => { return { apiVersion, }; }; export type ScriptLanguage = 'GROOVY' | 'JAVASCRIPT'; export type ScriptContext = | 'OAUTH2_ACCESS_TOKEN_MODIFICATION' | 'AUTHENTICATION_CLIENT_SIDE' | 'AUTHENTICATION_TREE_DECISION_NODE' | 'AUTHENTICATION_SERVER_SIDE' | 'SOCIAL_IDP_PROFILE_TRANSFORMATION' | 'OAUTH2_VALIDATE_SCOPE' | 'CONFIG_PROVIDER_NODE' | 'OAUTH2_AUTHORIZE_ENDPOINT_DATA_PROVIDER' | 'OAUTH2_EVALUATE_SCOPE' | 'POLICY_CONDITION' | 'OIDC_CLAIMS' | 'SAML2_IDP_ADAPTER' | 'SAML2_IDP_ATTRIBUTE_MAPPER' | 'OAUTH2_MAY_ACT' | 'LIBRARY'; export type ScriptSkeleton = IdObjectSkeletonInterface & { name: string; description: string; default: boolean; script: string | string[]; language: ScriptLanguage; context: ScriptContext; evaluatorVersion?: string; createdBy: string; creationDate: number; lastModifiedBy: string; lastModifiedDate: number; exports?: { arity?: number; id: string; type: string; }[]; }; export type LibraryScriptConfigSkeleton = IdObjectSkeletonInterface & { name: string; exports: { arity?: number; id: string; type: string; }[]; }; /** * Get all scripts * @returns {Promise} a promise that resolves to an object containing an array of script objects */ export async function getScripts({ state, }: { state: State; }): Promise> { const urlString = util.format( scriptListURLTemplate, state.getHost(), getCurrentRealmPath(state) ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).get>(urlString, { withCredentials: true, }); return data; } /** * Get script by name * @param {String} scriptName script name * @returns {Promise>} a promise that resolves to an object containing a script object */ export async function getScriptByName({ scriptName, state, }: { scriptName: string; state: State; }): Promise> { const urlString = util.format( scriptQueryURLTemplate, state.getHost(), getCurrentRealmPath(state), encodeURIComponent(scriptName) ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).get>(urlString, { withCredentials: true, }); return data; } /** * Get script by id * @param {String} scriptId script uuid/name * @returns {Promise} a promise that resolves to a script object */ export async function getScript({ scriptId, state, }: { scriptId: string; state: State; }): Promise { const urlString = util.format( scriptURLTemplate, state.getHost(), getCurrentRealmPath(state), scriptId ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).get(urlString, { withCredentials: true, }); return data; } /** * Get library script config by name * @param {String} scriptName script name * @returns {Promise>} a promise that resolves to an object containing the library script config */ export async function getLibraryScriptConfigByName({ scriptName, state, }: { scriptName: string; state: State; }): Promise> { const urlString = util.format( libraryConfigQueryURLTemplate, state.getHost(), getCurrentRealmPath(state), encodeURIComponent(scriptName) ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).get>(urlString, { withCredentials: true, }); return data; } /** * Put script * @param {string} scriptId script uuid * @param {Object} scriptData script object * @returns {Promise} a promise that resolves to an object containing a script object */ export async function putScript({ scriptId, scriptData, state, }: { scriptId: string; scriptData: ScriptSkeleton; state: State; }): Promise { const urlString = util.format( scriptURLTemplate, state.getHost(), getCurrentRealmPath(state), scriptId ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).put(urlString, scriptData, { withCredentials: true, }); return data; } /** * Delete script by id * @param {String} scriptId script uuid * @returns {Promise} a promise that resolves to a script object */ export async function deleteScript({ scriptId, state, }: { scriptId: string; state: State; }): Promise { const urlString = util.format( scriptURLTemplate, state.getHost(), getCurrentRealmPath(state), scriptId ); const { data } = await generateAmApi({ resource: getApiConfig(), requiredScopes: [Constants.AVAILABLE_SCOPES.AmFullScope], state, }).delete(urlString, { withCredentials: true, }); return data; } /** * Delete script by name * @param {String} scriptId script name * @returns {Promise} a promise that resolves to a script object */ export async function deleteScriptByName({ scriptName, state, }: { scriptName: string; state: State; }): Promise { const { result } = await getScriptByName({ scriptName, state }); if (!result[0]) { throw new Error(`Script with name ${scriptName} does not exist.`); } const scriptId = result[0]._id; return deleteScript({ scriptId, state, }); }