com.fulcrologic.fulcro.server.api-middleware — com.fulcrologic/fulcro 3.0.0-alpha-21

augment-map clj

(augment-map response)

Fulcro queries and mutations can wrap their responses with augment-response to indicate they need access to the raw Ring response. This function processes those into the response.

augment-response clj

(augment-response core-response ring-response-fn)

Augments the Ring response that's returned from the handler.

Use this function when you need to add information into the handler response, for example when you need to add cookies or session data. Example:

(defmutation my-mutate
  ...
  (augment-response
    {:uid 42} ; your regular response
    #(assoc-in % [:session :user-id] 42))) ; a function resp -> resp

If the parser has multiple responses with augment-response they will be applied in order, the first one will receive an empty map as input. Only top level values of your response will be checked for augmented response (i.e. primarily mutation responses).

default-malformed-response clj

The default response to return when a Transit request is malformed.

generate-response clj

(generate-response
  {:keys [status body headers] :or {status 200} :as input-response})

Generate a Fulcro-compatible response containing at least a status code, headers, and body. You should pre-populate at least the body of the input-response. The content type of the returned response will always be pegged to 'application/transit+json'.

handle-api-request clj

(handle-api-request query query-processor)

Given a parser and a query: Runs the parser on the query, and generates a standard Fulcro-compatible response.

not-found-handler clj

reader clj

(reader in)

(reader in opts)

Create a transit reader. This reader can handler the tempid type. Can pass transit reader customization opts map.

wrap-api clj

(wrap-api handler {:keys [uri parser]})

Wrap Fulcro API request processing. Required options are:

• :uri - The URI on the server that handles the API requests.
• :parser - A function (fn [eql-query] eql-response) that can process the query.

IMPORTANT: You must install wrap-transit-response and wrap-transit-params to your middleware below this.

wrap-transit-params clj

(wrap-transit-params handler)

(wrap-transit-params handler options)

Middleware that parses the body of Transit requests into a map of parameters, which are added to the request map on the :transit-params and :params keys. Accepts the following options: :malformed-response - a response map to return when the JSON is malformed :opts - a map of options to be passed to the transit reader Use the standard Ring middleware, ring.middleware.keyword-params, to convert the parameters into keywords.

wrap-transit-response clj

(wrap-transit-response handler)

(wrap-transit-response handler options)

Middleware that converts responses with a map or a vector for a body into a Transit response. Accepts the following options: :encoding - one of #{:json :json-verbose :msgpack} :opts - a map of options to be passed to the transit writer

writer clj

(writer out)

(writer out opts)

Create a transit writer. This writer can handler the tempid type. Can pass transit writer customization opts map.