RequestContext

empty

Creates an "empty" RequestContext object. This is only intended to be used when a service method must be called outside the normal request-response cycle, e.g. when programmatically populating data. Usually a better alternative is to use the RequestContextService create() method, which allows more control over the resulting RequestContext object.

The apiType of admin is a placeholder, not a statement about a caller. A session created from such a context records the Shop API, see SessionService.createNewAuthenticatedSession().

deserialize

Creates a new RequestContext object from a serialized object created by the serialize() method.

userHasPermissions

Returns true if there is an active Session & User associated with this request, and that User has at least one of the specified permissions on the given Channel. The Channel defaults to the active Channel of this request.

This method uses OR logic - it checks if the user has ANY of the given permissions, not ALL of them. For AND logic, use userHasAllPermissions.

Example

// Returns true if user has ReadProduct OR ReadCatalog on the active Channelctx.userHasPermissions([Permission.ReadProduct, Permission.ReadCatalog]);// Returns true if user has UpdateChannel on the Channel with the given idctx.userHasPermissions([Permission.UpdateChannel], channelId);

userHasAllPermissions

Returns true if there is an active Session & User associated with this request, and that User has all of the specified permissions on the given Channel. The Channel defaults to the active Channel of this request.

This method uses AND logic - it checks if the user has EVERY one of the given permissions. For OR logic (any permission), use userHasPermissions.

Example

// Returns true only if user has BOTH ReadProduct AND UpdateProduct on the active Channelctx.userHasAllPermissions([Permission.ReadProduct, Permission.UpdateProduct]);// Returns true only if user has BOTH permissions on the Channel with the given idctx.userHasAllPermissions([Permission.ReadProduct, Permission.UpdateProduct], channelId);

serialize

Serializes the RequestContext object into a JSON-compatible simple object. This is useful when you need to send a RequestContext object to another process, e.g. to pass it to the Job Queue via the JobQueueService.

The raw Express request (and with it every HTTP header) and the session token are not included, because serialized contexts are persisted and are readable over the Admin API. A context rebuilt with deserialize() therefore has req and session.token set to undefined.

toJSON

Used by JSON.stringify() and by Job, which prefers toJSON() when it makes job data serializable. A RequestContext instance passed straight into job data therefore takes the same path as serialize().

copy

Creates a shallow copy of the RequestContext instance. This means that mutations to the copy itself will not affect the original, but deep mutations (e.g. copy.channel.code = 'new') will also affect the original.

Passing a channel re-scopes the copy to it, switching language and currency to the channel's defaults so downstream logic runs in the target channel.

req

The raw Express request object.

This is undefined on a context which was rebuilt from a serialized object, e.g. in a job queue worker, because the request is deliberately not serialized. It is also undefined on a context built outside the request-response cycle, which is how SessionService.createNewAuthenticatedSession() tells a stated apiType from a placeholder one. Do not populate it on a synthetic context.

apiType

Signals which API this request was received by, e.g. admin or shop.

channel

The active Channel of this request.

channelId

languageCode

acceptedLanguageCodes

The languages the client asked to read this response in, most preferred first, taken from the Accept-Language header. Empty when the client sent no header.

RequestContext.languageCode selects which translation of the data to return. These codes say which language the server should write its own text in, such as the descriptions and labels attached to a ConfigurableOperationDef. The two differ for an administrator reading the Admin UI in Japanese while editing the German translation of a product.

A code here is not guaranteed to be a member of the LanguageCode enum, for the same reason languageCode is not: custom codes are permitted. A code with no translation behind it matches nothing and is skipped.

currencyCode

session

The cached session of this request.

On a context which was rebuilt from a serialized object, e.g. in a job queue worker, this is a DeserializedCachedSession: session.token is undefined, because the token is deliberately not serialized. The class cannot tell the two apart statically, so the type of session.token is string | undefined everywhere. Narrow it before using it as a credential.

activeUserId

isAuthorized

True if the current session is authorized to access the current resolver method.

authorizedAsOwnerOnly

True if the current anonymous session is only authorized to operate on entities that are owned by the current session.

translate

Translate the given i18n key

setReplicationMode

Sets the replication mode for the current RequestContext. This mode determines whether the operations within this context should interact with the master database or a replica. Use this method to explicitly define the replication mode for the context.

replicationMode

Gets the current replication mode of the RequestContext. If no replication mode has been set, it returns undefined. This property indicates whether the context is configured to interact with the master database or a replica.