We don't include APIs that aren't in all major browsers yet

This issue has been marked 'Working as Intended' and has seen no recent activity. It has been automatically closed for house-keeping purposes.

Has anyone got a type definition that will work in the meantime?

In an appeal to Cunningham's Law - here is my implementation:

interface Cookie {
	domain: string;
	expires: number;
	name: string;
	partitioned: boolean;
	path: string;
	sameSite: "Strict" | "Lax" | "None";
	secure: boolean;
	value: string;
}

interface CookieChangedEvent extends Event {
	changed: Readonly<Array<Cookie>>;
	deleted: Readonly<Array<Cookie>>;
}

interface CookieStore {
	get(name: string): Promise<Cookie | null>;
	get(options: { name: string; url?: string }): Promise<Cookie | null>;

	getAll(): Promise<Cookie[]>;
	getAll(name: string): Promise<Cookie[]>;
	getAll(options: { name?: string; url?: string }): Promise<Cookie[]>;

	set(name: string, value: string): Promise<void>;
	set(
		options: Partial<Cookie> & { name: string; value: string },
	): Promise<void>;

	delete(name: string): Promise<void>;
	delete(options: { name: string; url?: string }): Promise<void>;

	addEventListener(
		eventName: "change",
		handler: (event: CookieChangedEvent) => void,
	): void;
	removeEventListener(
		eventName: "change",
		handler: (event: CookieChangedEvent) => void,
	): void;
	onchange: null | ((event: CookieChangedEvent) => void);
}

declare var cookieStore: CookieStore;

In an appeal to Cunningham's Law - here is my implementation:

interface Cookie {
	domain: string;
	expires: number;
	name: string;
	partitioned: boolean;
	path: string;
	sameSite: "Strict" | "Lax" | "None";
	secure: boolean;
	value: string;
}

interface CookieChangedEvent extends Event {
	changed: Readonly<Array<Cookie>>;
	deleted: Readonly<Array<Cookie>>;
}

interface CookieStore {
	get(name: string): Promise<Cookie | null>;
	get(options: { name: string; url?: string }): Promise<Cookie | null>;

	getAll(): Promise<Cookie[]>;
	getAll(name: string): Promise<Cookie[]>;
	getAll(options: { name?: string; url?: string }): Promise<Cookie[]>;

	set(name: string, value: string): Promise<void>;
	set(
		options: Partial<Cookie> & { name: string; value: string },
	): Promise<void>;

	delete(name: string): Promise<void>;
	delete(options: { name: string; url?: string }): Promise<void>;

	addEventListener(
		eventName: "change",
		handler: (event: CookieChangedEvent) => void,
	): void;
	removeEventListener(
		eventName: "change",
		handler: (event: CookieChangedEvent) => void,
	): void;
	onchange: null | ((event: CookieChangedEvent) => void);
}

declare var cookieStore: CookieStore;

Thanks for sharing! This seems to be mostly fine to me, I've found two things that probably should be altered:

• sameSite value should be a lowercase string (see https://developer.mozilla.org/en-US/docs/Web/API/CookieStore/set#samesite and https://wicg.github.io/cookie-store/#CookieStore)
• Firefox and Safari have opted to only expose name and value on cookies shared by the get and getAll methods (to not expose more than is currently available with the document.cookie string) and are proposing to change the spec to reflect this: see Considering reducing the scope of the CookieStore API to match Firefox and Safari implementations WICG/cookie-store#241