cookieStore

[mmkal]

lib Update Request

The cookieStore API

Configuration Check

My compilation target is esnext and my lib is ["dom", "dom.iterable", "esnext"].

Missing / Incorrect Definition

cookieStore: https://developer.mozilla.org/en-US/docs/Web/API/CookieStore

Sample Code

From https://davidwalsh.name/cookiestore

await cookieStore.set({ 
  name: "dw-test", 
  value: 1, 
  domain: 'davidwalsh.name', 
  // Very far in the future!
  expires: Date.now() + Date.now() 
});

const testCookie = await cookieStore.get('dw-test');

Documentation Link

https://developer.mozilla.org/en-US/docs/Web/API/CookieStore

---

Note: I'm a little confused by DOM lib generator repo. Should I be creating that issue there? It also mentions that it needs to be implemented in two major engines, and maybe Chromium counts as one? I'd have thought it'd make sense to allow including it explicitly via lib somehow though.

FireFox implementation tracking issue
Safari implementation tracking issue

[RyanCavanaugh]

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

[typescript-bot]

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

[dwjohnston]

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

[dwjohnston]

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;

[jnoordsij]

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

[jrencz]

CookieStore made it to Safari in 18.4 https://webkit.org/b/231750 and it's now in nightly of Firefox on its way to be ready https://bugzilla.mozilla.org/show_bug.cgi?id=1953406

Maybe it's time to revisit this one?

[jnoordsij]

@jrencz (and others interested) I've recently created #61604 as re-opened version of this with new references.