Cookie Store API

document.cookie =
  '__Secure-COOKIENAME=cookie-value' +
  '; Path=/' +
  '; expires=Fri, 12 Aug 2016 23:05:17 GMT' +
  '; Secure' +
  '; Domain=example.org';
// これで書き込みが成功したと仮定できるが、失敗はサイレントなので判別しにくいため、
// 読み込みで書き込みが成功したか確認する必要がある
var successRegExp =
  /(^|; ?)__Secure-COOKIENAME=cookie-value(;|$)/;
if (String(document.cookie).match(successRegExp)) {
  console.log('成功しました！');
} else {
  console.error('成功しませんでした。理由は不明です');
}

const one_day_ms = 24 * 60 * 60 * 1000;
cookieStore.set(
  {
    name: '__Secure-COOKIENAME',
    value: 'cookie-value',
    expires: Date.now() + one_day_ms,
    domain: 'example.org'
  }).then(function() {
    console.log('成功しました！');
  }, function(reason) {
    console.error(
      '成功しませんでした。理由はこちら:',
      reason);
  });
// 書き込みを待つ間、他の処理もできる…

try {
  const cookie = await cookieStore.get('session_id');
  if (cookie) {
    console.log(`「${cookie.name}」クッキーが見つかりました: ${cookie.value}`);
  } else {
    console.log('クッキーが見つかりません');
  }
} catch (e) {
  console.error(`クッキーストアエラー: ${e}`);
}

try {
  const cookies = await cookieStore.getAll('session_id'});
  for (const cookie of cookies)
    console.log(`結果: ${cookie.name} = ${cookie.value}`);
} catch (e) {
  console.error(`クッキーストアエラー: ${e}`);
}

await cookieStore.getAll({url: '/admin'});

await cookie = cookieStore.get('session_id');
console.log(`クッキーのスコープ - Domain: ${cookie.domain} Path: ${cookie.path}`);
if (cookie.expires === null) {
  console.log('クッキーはセッション終了時に期限切れ');
} else {
  console.log(`クッキーの有効期限: ${cookie.expires}`);
}
if (cookie.secure)
  console.log('このクッキーはセキュアオリジンに限定されています');

try {
  await cookieStore.set('opted_out', '1');
} catch (e) {
  console.error(`クッキーの設定に失敗: ${e}`);
}

await cookieStore.set({
  name: 'opted_out',
  value: '1',
  expires: null,  // セッションクッキー

  // デフォルトではdomainはnull（現在のドメインに限定）
  domain: null,
  path: '/'
});

try {
  await cookieStore.delete('session_id');
} catch (e) {
  console.error(`クッキーの削除に失敗: ${e}`);
}

try {
  const one_day_ms = 24 * 60 * 60 * 1000;
  await cookieStore.set({
    name: 'session_id',
    value: 'value will be ignored',
    expires: Date.now() - one_day_ms });
} catch (e) {
  console.error(`クッキーの削除に失敗: ${e}`);
}

cookieStore.addEventListener('change', event => {
  console.log(`${event.changed.length} 件のクッキーが変更されました`);
  for (const cookie in event.changed)
    console.log(`クッキー ${cookie.name} が ${cookie.value} に変更されました`);

  console.log(`${event.deleted.length} 件のクッキーが削除されました`);
  for (const cookie in event.deleted)
    console.log(`クッキー ${cookie.name} が削除されました`);
});

self.addEventListener('activate', (event) => {
  event.waitUntil(async () => {
    // 現在の購読状態をスナップショット
    const subscriptions = await self.registration.cookies.getSubscriptions();

    // 既存の購読をすべて解除
    await self.registration.cookies.unsubscribe(subscriptions);

    await self.registration.cookies.subscribe([
      {
        name: 'session_id',  // session_idという名前のクッキー変更イベントを受信
      }
    ]);
  });
});

self.addEventListener('cookiechange', event => {
  // eventの|changed|や|deleted|プロパティはDocumentイベントと同じ意味
  console.log(`${event.changed.length} 件のクッキーが変更されました`);
  console.log(`${event.deleted.length} 件のクッキーが削除されました`);
});

const subscriptions = await self.registration.cookies.getSubscriptions();
for (const sub of subscriptions) {
  console.log(sub.name, sub.url);
}

クッキー名または値を正規化するには、string inputが与えられた場合、 inputの先頭または末尾にあるU+0009 TABおよびU+0020 SPACEをすべて削除する。

[Exposed=(ServiceWorker,Window),
 SecureContext]
interface CookieStore : EventTarget {
  Promise<CookieListItem?> get(USVString name);
  Promise<CookieListItem?> get(optional CookieStoreGetOptions options = {});

  Promise<CookieList> getAll(USVString name);
  Promise<CookieList> getAll(optional CookieStoreGetOptions options = {});

  Promise<undefined> set(USVString name, USVString value);
  Promise<undefined> set(CookieInit options);

  Promise<undefined> delete(USVString name);
  Promise<undefined> delete(CookieStoreDeleteOptions options);

  [Exposed=Window]
  attribute EventHandler onchange;
};

dictionary CookieStoreGetOptions {
  USVString name;
  USVString url;
};

enum CookieSameSite {
  "strict",
  "lax",
  "none"
};

dictionary CookieInit {
  required USVString name;
  required USVString value;
  DOMHighResTimeStamp? expires = null;
  USVString? domain = null;
  USVString path = "/";
  CookieSameSite sameSite = "strict";
  boolean partitioned = false;
};

dictionary CookieStoreDeleteOptions {
  required USVString name;
  USVString? domain = null;
  USVString path = "/";
  boolean partitioned = false;
};

dictionary CookieListItem {
  USVString name;
  USVString value;
};

typedef sequence<CookieListItem> CookieList;

get(name)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. pに、新しいPromiseを設定する。

6. 以下の手順を並行して実行：

   1. listにurlとnameでクッキー検索を実行した結果を設定する。

   2. listが失敗なら、TypeErrorでpを拒否し、この手順を中断する。

   3. listが空なら、pをnullで解決する。

   4. それ以外の場合、pをlistの最初の要素で解決する。

7. pを返す。

get(options) メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンなら、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. optionsが空なら、TypeErrorでPromiseを拒否して返す。

6. options["url"] が存在する場合、以下の手順を実行：

   1. parsedに、options["url"]をsettingsのAPI基本URLでパースした結果を設定する。

   2. thisの関連グローバルオブジェクトがWindow かつparsedがurlと等しくない場合（exclude fragmentsをtrue）、TypeErrorでPromiseを拒否して返す。

   3. parsedのoriginとurlのoriginが同一オリジンでない場合、TypeErrorでPromiseを拒否して返す。

   4. urlにparsedを設定する。

7. pに新しいPromiseを設定する。

8. 以下の手順を並行して実行：

   1. listを、urlおよびoptions["name"]でクッキーを照会するを実行した結果とする。ただし、デフォルト値付きでnullを指定する。

   2. listが失敗なら、TypeErrorでpを拒否する。

   3. listが空なら、pをnullで解決する。

   4. それ以外の場合、pをlistの最初の要素で解決する。

9. pを返す。

getAll(name)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. pに、新しいPromiseを設定する。

6. 以下の手順を並行して実行：

   1. listにurlとnameでクッキー検索を実行した結果を設定する。

   2. listが失敗なら、TypeErrorでpを拒否する。

   3. それ以外の場合、pをlistで解決する。

7. pを返す。

getAll(options)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. options["url"] が存在する場合、以下の手順を実行：

   1. parsedに、options["url"]をsettingsのAPI基本URLでパースした結果を設定する。

   2. thisの関連グローバルオブジェクトがWindow かつparsedがurlと等しくない場合（exclude fragmentsをtrue）、TypeErrorでPromiseを拒否して返す。

   3. parsedのoriginとurlのoriginが同一オリジンでない場合、TypeErrorでPromiseを拒否して返す。

   4. urlにparsedを設定する。

6. pに新しいPromiseを設定する。

7. 以下の手順を並行して実行：

   1. listを、urlおよびoptions["name"]でクッキーを照会するを実行した結果とする。ただし、デフォルト値付きでnullを指定する。

   2. listが失敗なら、TypeErrorでpを拒否する。

   3. それ以外の場合、pをlistで解決する。

8. pを返す。

set(name, value)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. domainにnullを設定する。

6. pathに"/"を設定する。

7. sameSiteにstrictを設定する。

8. partitionedにfalseを設定する。

9. pに新しいPromiseを設定する。

10. 以下の手順を並行して実行：

    1. rに、url, name, value, domain, path, sameSite, partitionedでクッキー設定を実行した結果を設定する。

    2. rが失敗なら、TypeErrorでpを拒否し、この手順を中断する。

    3. pをundefinedで解決する。

11. pを返す。

set(options)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンなら、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. pに新しいPromiseを設定する。

6. 以下の手順を並行して実行：

   1. rに、url, options["name"], options["value"], options["expires"], options["domain"], options["path"], options["sameSite"], options["partitioned"]でクッキー設定を実行した結果を設定する。

   2. rが失敗なら、TypeErrorでpを拒否し、この手順を中断する。

   3. pをundefinedで解決する。

7. pを返す。

delete(name)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. pに新しいPromiseを設定する。

6. 以下の手順を並行して実行：

   1. rに、url, name, null, "/", trueでクッキー削除を実行した結果を設定する。

   2. rが失敗なら、TypeErrorでpを拒否し、この手順を中断する。

   3. pをundefinedで解決する。

7. pを返す。

delete(options)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定する。

2. originに、settingsのオリジンを設定する。

3. originが不透明オリジンの場合、"SecurityError" DOMExceptionでPromiseを拒否して返す。

4. urlに、settingsの作成URLを設定する。

5. pに新しいPromiseを設定する。

6. 以下の手順を並行して実行：

   1. rに、url, options["name"], options["domain"], options["path"], options["partitioned"]でクッキー削除を実行した結果を設定する。

   2. rが失敗なら、TypeErrorでpを拒否し、この手順を中断する。

   3. pをundefinedで解決する。

7. pを返す。

[Exposed=(ServiceWorker,Window),
 SecureContext]
interface CookieStoreManager {
  Promise<undefined> subscribe(sequence<CookieStoreGetOptions> subscriptions);
  Promise<sequence<CookieStoreGetOptions>> getSubscriptions();
  Promise<undefined> unsubscribe(sequence<CookieStoreGetOptions> subscriptions);
};

subscribe(subscriptions)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定。

2. registrationに、thisのregistrationを設定。

3. pに新しいPromiseを設定。

4. 以下の手順を並行して実行：

   1. subscription listをregistrationに関連付けられたクッキー変更購読リストとする。

   2. 各entryをsubscriptions内で順に、次の手順を実行する：

      1. nameをentry["name"]とする。

      2. nameを正規化する。

      3. urlを、entry["url"]をsettingsのAPI基本URLで解析した結果とする。

      4. もしurlがregistrationのスコープURLで始まらない場合、pをTypeErrorで拒否し、これ以降の手順を中止する。

      5. subscriptionをクッキー変更購読(name, url)とする。

      6. もしsubscription listがすでにsubscriptionを含まない場合、subscriptionをsubscription listに追加する。

   3. pをundefinedで解決する。

5. pを返す。

getSubscriptions()メソッドの手順：

1. registrationに、thisのregistrationを設定。

2. pに新しいPromiseを設定。

3. 以下の手順を並行して実行：

   1. subscriptionsにregistrationの関連付けられたクッキー変更購読リストを設定する。

   2. resultに新しいリストを設定する。

   3. 各subscriptionについてsubscriptionsを順に処理：

      1. 追加 «[ "name" → subscriptionの name, "url" → subscriptionのurl]» をresultに。

   4. pをresultで解決する。

4. pを返す。

unsubscribe(subscriptions)メソッドの手順：

1. settingsに、thisの関連設定オブジェクトを設定。

2. registrationに、thisのregistrationを設定。

3. pに新しいPromiseを設定。

4. 以下の手順を並行して実行：

   1. subscription listにregistrationの関連付けられたクッキー変更購読リストを設定する。

   2. 各entryについてsubscriptionsを順に処理：

      1. nameをentry["name"]とする。

      2. nameを正規化する。

      3. urlを、entry["url"]をsettingsのAPI基本URLで解析した結果とする。

      4. もしurlがregistrationのスコープURLで始まらない場合、pをTypeErrorで拒否し、これ以降の手順を中止する。

      5. subscriptionをクッキー変更購読(name, url)とする。

      6. 削除する、アイテムで、subscription listからsubscriptionと等しいものを。

   3. pをundefinedで解決する。

5. pを返す。

[Exposed=(ServiceWorker,Window)]
partial interface ServiceWorkerRegistration {
  [SameObject] readonly attribute CookieStoreManager cookies;
};

self.registration.cookies.subscribe([{name:'session-id'}]);

navigator.serviceWorker.register('sw.js').then(registration => {
  registration.cookies.subscribe([{name:'session-id'}]);
});

[Exposed=Window,
 SecureContext]
interface CookieChangeEvent : Event {
  constructor(DOMString type, optional CookieChangeEventInit eventInitDict = {});
  [SameObject] readonly attribute FrozenArray<CookieListItem> changed;
  [SameObject] readonly attribute FrozenArray<CookieListItem> deleted;
};

dictionary CookieChangeEventInit : EventInit {
  CookieList changed;
  CookieList deleted;
};

[Exposed=ServiceWorker]
interface ExtendableCookieChangeEvent : ExtendableEvent {
  constructor(DOMString type, optional ExtendableCookieChangeEventInit eventInitDict = {});
  [SameObject] readonly attribute FrozenArray<CookieListItem> changed;
  [SameObject] readonly attribute FrozenArray<CookieListItem> deleted;
};

dictionary ExtendableCookieChangeEventInit : ExtendableEventInit {
  CookieList changed;
  CookieList deleted;
};

[SecureContext]
partial interface Window {
  [SameObject] readonly attribute CookieStore cookieStore;
};

partial interface ServiceWorkerGlobalScope {
  [SameObject] readonly attribute CookieStore cookieStore;

  attribute EventHandler oncookiechange;
};

dateTimeをタイムスタンプとして表すには、 dateTimeが1970年1月1日00:00:00 UTCから何ミリ秒経過したかを返す（1日＝86,400,000ミリ秒とする）。

注: これはECMAScriptの[ECMAScript]で使われている表現と同じです。

date serializeで DOMHighResTimeStamp millisを扱うには、 dateTimeを1970年1月1日00:00:00 UTCからmillisミリ秒後の日時とし（1日＝86,400,000ミリ秒とする）、 そのdateTimeの最も近いcookie-date表現に対応するバイト列を返す（Cookies § Dates参照）。

クッキーを照会するには、URL urlと、stringまたはnullのnameが与えられる：

1. Cookies § 取得モデルで定義された手順を実行し、urlをrequest-uriとして「cookie-string from a given cookie store」を算出する。cookie-string自体は無視し、中間のcookie-listを以降の手順で利用する。

   この手順では、cookie-stringは「非HTTP」APIのために生成される。

2. listを新しいリストとする。

3. 各cookieをcookie-listで順に、次の手順を実行する：

   1. Assert: cookieのhttp-only-flagはfalseである。

   2. もしnameがnullでない場合：

      1. nameを正規化する。

      2. cookieNameを、cookieのnameにBOMなしUTF-8デコードを実行した結果とする。

      3. もしcookieNameがnameと一致しない場合、continueする。

   3. itemをcreate a CookieListItemでcookieから生成した結果とする。

   4. itemをlistに追加する。

4. listを返す。

CookieListItemを生成するには、cookie cookieが与えられる：

1. nameを、cookieのnameにBOMなしUTF-8デコードを実行した結果とする。

2. valueを、cookieのvalueにBOMなしUTF-8デコードを実行した結果とする。

3. «[ "name" → name, "value" → value ]»を返す。

Note: 1つの実装は_name_と_value_以外の情報も公開することが知られている。

クッキーを設定するには、 url、 name、 value、 任意のexpires、 domain、 path、 sameSite、 partitioned を用いて、以下の手順を実行する：

1. nameを正規化する。

2. valueを正規化する。

3. もしnameまたはvalueがU+003B（;）、U+0009 TAB以外のC0制御文字、またはU+007F DELETEを含む場合、失敗を返す。

   この文字制限がexpires、domain、path、sameSiteにも適用されるかどうかは議論中。[httpwg/http-extensions Issue #1593]

4. もしnameがU+003D（=）を含む場合、失敗を返す。

5. もしnameの長さが0の場合：

   1. もしvalueがU+003D（=）を含む場合、失敗を返す。

   2. もしvalueの長さが0の場合、失敗を返す。

   3. もしvalueをバイト小文字化し、次で始まる場合：__host-、__host-http-、__http-、__secure-、失敗を返す。

6. もしnameをバイト小文字化し、次で始まる場合：__host-http-または__http-、失敗を返す。

7. encodedNameをnameにUTF-8エンコードした結果とする。

8. encodedValueをvalueにUTF-8エンコードした結果とする。

9. encodedNameのバイト系列の長さと、encodedValueのバイト系列の長さの合計が最大name/valueペアサイズを超える場合、失敗を返す。

10. hostをurlのホストとする。

11. attributesを新しいリストとする。

12. もしdomainがnullでない場合、次の手順を実行する：

    1. もしdomainがU+002E（.）で始まる場合、失敗を返す。

    2. もしnameをバイト小文字化し、次で始まる場合：__host-、失敗を返す。

    3. もしdomainがhostの登録可能なドメインサフィックスでなく、等しくもない場合、失敗を返す。

    4. parsedDomainをdomainにホストパースした結果とする。

    5. Assert: parsedDomainは失敗ではない。

    6. encodedDomainをparsedDomainにUTF-8エンコードした結果とする。

    7. encodedDomainのバイト系列の長さが最大属性値サイズを超える場合、失敗を返す。

    8. Domain/encodedDomainをattributesに追加する。

13. expires が与えられている場合、append `Expires`/expires（日付の直列化）を attributes に追加する。

14. path が空文字列の場合、path に 直列化された Cookie のデフォルトパス（url のもの）を設定する。

15. path が U+002F（/）で始まらない場合、失敗を返す。

16. path が U+002F（/）でない場合、かつ name を バイト小文字化し、`__host-` で始まる場合、失敗を返す。

17. encodedPath を UTF-8 エンコードした path とする。

18. バイト列 長さが encodedPath において、 最大属性値サイズ より大きい場合、失敗を返す。

19. `Path`/encodedPath を attributes に追加する。

20. `Secure`/`` を attributes に追加する。

21. sameSite に応じて切り替える：

    "none"

    `SameSite`/`None` を attributes に追加する。

    "strict"

    `SameSite`/`Strict` を attributes に追加する。

    "lax"

    `SameSite`/`Lax` を attributes に追加する。

22. partitioned が true の場合、`Partitioned`/`` を attributes に追加する。

23. Cookies § Storage Model に定義されている手順を、ユーザーエージェントが「Cookie を受け取った」ときについて、 url を request-uri として、 encodedName を cookie-name として、 encodedValue を cookie-value として、 attributes を cookie-attribute-list として実行する。

    これらの手順において、新しく作成された Cookie は「非 HTTP」API から受け取ったものとみなす。

24. 成功を返す。

    注: Cookie の保存は [RFC6265BIS-14] の要件により失敗する場合があるが、 これらの手順は成功したものとみなされる。

クッキーを削除するには、 url、 name、 domain、 path、 partitioned を用いて、以下の手順を実行する：

1. expiresを、タイムスタンプとして表される表現可能な最も早い日付とする。

   Note: このアルゴリズムの目的上、expiresの正確な値は重要ではなく、過去の日付であればよい。

2. nameを正規化する。

3. valueを空文字列とする。

4. もしnameの長さが0の場合、valueを空でない実装定義文字列に設定する。

5. set a cookieを url、 name、 value、 expires、 domain、 path、 "strict"、 partitioned で実行した結果を返す。

クッキー変更処理を行うには、次の手順を実行：

1. すべてのWindow windowについて、以下を実行：

   1. urlにwindowの関連設定オブジェクトの作成URLを設定する。

   2. changesにurlの観測可能変更を設定する。

   3. changesが空なら、次へ。

   4. グローバルタスクをキューに追加して、DOM操作タスクソースでwindowに対し、 changeイベント発火（名前"change"、changes、windowのCookieStore）を行う。

2. すべてのService Worker登録 registrationについて、以下を実行：

   1. changesに新しいセットを設定。

   2. 各changeについて、registrationの観測可能変更（registrationのscope url）を順に処理：

      1. cookieにchangeのクッキーを設定。

      2. 各subscriptionについてregistrationのクッキー変更購読リストを順に処理：

         1. changeがsubscriptionの観測可能変更（subscriptionのurl）に含まれなければ、次へ。

         2. cookieNameにcookieのnameをUTF-8 BOMなしでデコードした結果を設定。

         3. cookieNameがsubscriptionのnameと一致すれば、changeをchangesに追加して、breakする。

   3. changesが空なら、次へ。

   4. changedListとdeletedListにchangesからリスト準備を実行した結果を設定。

   5. 機能イベント発火（名前"cookiechange"、ExtendableCookieChangeEvent、registration）を、下記プロパティで行う：

      changed

      changedList

      deleted

      deletedList

urlの観測可能変更は、セットであり、クッキー変更で、クッキーがクッキーストア内にあり、Cookies § Retrieval Algorithmの「cookie-string from a given cookie store」算出手順の1番に合致し、urlをrequest-uri、非HTTP APIとする。

クッキー変更は、 クッキーとタイプ（changedまたはdeleted）の組み合わせ：

• 同じname、domain、pathの新規挿入によって削除されるクッキーは無視する。

• 新規作成され即時削除されないクッキーはchangedとする。

• 新規作成され即時削除されたクッキーはdeletedとする。

• その他削除/退去したクッキーはdeletedとする。

typeという名前で、changesをtargetでchangeイベント発火するには、次の手順を行う：

1. eventにCookieChangeEventでEvent生成を設定。

2. eventのtype属性にtypeを設定。

3. eventのbubblesとcancelable属性をfalseに設定。

4. changedListとdeletedListに、changesからリスト準備した結果を設定。

5. eventのchanged属性にchangedListを設定。

6. eventのdeleted属性にdeletedListを設定。

7. eventをtargetでdispatchする。

changesからリスト準備を行うには、次の手順：

1. changedListに新しいリストを設定。

2. deletedListに新しいリストを設定。

3. 各changeについてchangesを順に処理：

   1. itemにchangeのクッキーからCookieListItem生成を実行した結果を設定。

   2. changeのtypeがchangedなら、itemをchangedListに追加。

   3. それ以外の場合、以下を実行：

      1. item["value"]にundefinedを設定。

      2. itemをdeletedListに追加。

4. changedListとdeletedListを返す。