AstroCookies Class — astro Architecture

Source Code

packages/astro/src/core/cookies/cookies.ts lines 66–277

class AstroCookies implements AstroCookiesInterface {
	#request: Request;
	#requestValues: Record<string, string | undefined> | null;
	#outgoing: Map<string, [string, string, boolean]> | null;
	#consumed: boolean;
	constructor(request: Request) {
		this.#request = request;
		this.#requestValues = null;
		this.#outgoing = null;
		this.#consumed = false;
	}

	/**
	 * Astro.cookies.delete(key) is used to delete a cookie. Using this method will result
	 * in a Set-Cookie header added to the response.
	 * @param key The cookie to delete
	 * @param options Options related to this deletion, such as the path of the cookie.
	 */
	delete(key: string, options?: AstroCookieDeleteOptions): void {
		/**
		 * The `@ts-expect-error` is necessary because `maxAge` and `expires` properties
		 * must not appear in the AstroCookieDeleteOptions type.
		 */
		const {
			// @ts-expect-error
			maxAge: _ignoredMaxAge,
			// @ts-expect-error
			expires: _ignoredExpires,
			...sanitizedOptions
		} = options || {};
		const serializeOptions: SerializeOptions = {
			expires: DELETED_EXPIRATION,
			...sanitizedOptions,
		};

		// Set-Cookie: token=deleted; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT
		this.#ensureOutgoingMap().set(key, [
			DELETED_VALUE,
			serialize(key, DELETED_VALUE, serializeOptions),
			false,
		]);
	}

	/**
	 * Astro.cookies.get(key) is used to get a cookie value. The cookie value is read from the
	 * request. If you have set a cookie via Astro.cookies.set(key, value), the value will be taken
	 * from that set call, overriding any values already part of the request.
	 * @param key The cookie to get.
	 * @returns An object containing the cookie value as well as convenience methods for converting its value.
	 */
	get(
		key: string,
		options: AstroCookieGetOptions | undefined = undefined,
	): AstroCookie | undefined {
		// Check for outgoing Set-Cookie values first
		if (this.#outgoing?.has(key)) {
			let [serializedValue, , isSetValue] = this.#outgoing.get(key)!;
			if (isSetValue) {
				return new AstroCookie(serializedValue);
			} else {
				return undefined;
			}
		}
		// decodeURIComponent is the default decode function for cookies
		const decode = options?.decode ?? decodeURIComponent;

		const values = this.#ensureParsed();
		if (key in values) {
			const value = values[key];
			if (value) {
				let decodedValue: string;
				try {
					decodedValue = decode(value);
				} catch (_error) {
					// If decoding fails (e.g., invalid URI sequences), use the original value
					// This aligns with the behavior of the `cookie` package
					decodedValue = value;
				}
				return new AstroCookie(decodedValue);
			}
		}