ストレージバケット API

[SecureContext]
interface mixin NavigatorStorageBuckets {
  [SameObject] readonly attribute StorageBucketManager storageBuckets;
};
Navigator includes NavigatorStorageBuckets;
WorkerNavigator includes NavigatorStorageBuckets;

[Exposed=(Window,Worker),
 SecureContext]
interface StorageBucketManager {
    Promise<StorageBucket> open(DOMString name, optional StorageBucketOptions options = {});
    Promise<sequence<DOMString>> keys();
    Promise<undefined> delete(DOMString name);
};

dictionary StorageBucketOptions {
  boolean persisted = false;
  unsigned long long quota;
  DOMHighResTimeStamp expires;
};

open(name, options) メソッドの手順は次のとおりです:

1. environment を this の関連する設定オブジェクトとします。

2. shelf を、environment を与えて ローカルストレージ棚を取得するを実行した結果とします。

3. shelf が failure である場合、TypeError で 拒否された promise を返します。

4. name を指定してバケット名を検証する結果が failure である場合、 TypeError で 拒否された promise を返します。

5. p を新しい promiseとします。

6. 次の手順をstorage bucket managerに キューに入れます:

   1. r を、shelf、name、 および options を指定してバケットを開くを実行した結果とします。

   2. r が failure である場合、TypeError で p を拒否するために、ストレージタスクをキューに入れます。

   3. それ以外の場合、r で p を 解決するために、ストレージタスクをキューに入れます。

7. p を返します。

shelf 上で、バケット name および任意の options を指定して バケットを開くには、 次の手順を実行します:

1. expires を undefined とします。

2. options["expires"] が存在する場合:

   1. expires を options["expires"] に設定します。

   2. Unix epoch の expires ミリ秒後が、 関連する設定オブジェクトの現在の壁時計時刻より前である場合、failure を返します。

3. quota を undefined とします。

4. options["quota"] が存在する場合:

   1. quota を options["quota"] に設定します。

   2. quota が 0 以下である場合、failure を返します。

5. persisted を false とします。

6. options["persisted"] が true である場合:

   1. permission を、 "persistent-storage" を使用する許可を要求する結果とします。

   2. permission が "granted" である場合、 persisted を true に設定します。

7. bucket を、shelf と name を指定して バケットを取得または期限切れにするを実行した結果とします。

8. bucket が null である場合:

   1. bucket を、名前 name を持つ新しいストレージバケットに設定します。

   2. bucket のクォータ値を quota に設定します。

   3. shelf のバケット マップ[name] を bucket に設定します。

9. persisted が true である場合、bucket のバケットモード を "persistent" に設定します。

10. bucket の有効期限を、Unix epoch の expires ミリ秒後に設定します。

11. storageBucket を新しい StorageBucket とします。

12. storageBucket のストレージ バケットを bucket に設定します。

13. storageBucket を返します。

文字列 name を指定してバケット名を 検証するには、次の手順を実行します:

1. name に、ASCII 小文字英字、ASCII 数字、 U+005F (_)、または U+002D(-) ではない符号位置が 含まれる場合、failure を返します。

2. name の符号位置長が 0 であるか 64 を超える場合、failure を返します。

3. name が U+005F (_) または U+002D(-) で始まる場合、failure を返します。

4. 返ります。

delete(name) メソッドの 手順は次のとおりです:

1. environment を this の関連する設定オブジェクトとします。

2. shelf を、environment を与えて ローカルストレージ棚を取得するを実行した結果とします。

3. shelf が failure である場合、TypeError で 拒否された promise を返します。

4. p を新しい promiseとします。

5. name を指定してバケット名を検証する結果が failure である場合、 InvalidCharacterError で p を拒否します。

6. それ以外の場合、次の手順をstorage bucket managerに キューに入れます:

   1. shelf と name を指定してバケットを 削除するを実行します。

   2. p を解決するために、ストレージタスクをキューに入れます。

7. p を返します。

shelf 上でバケット name を指定して バケットを削除するには、 次の手順を実行します:

1. bucket を、存在する場合は shelf のバケット マップ[name] とします。存在しない場合は返ります。

2. shelf のバケットマップ内の キー name を削除します。

3. bucket のremoved を true に設定します。

4. 返ります。

[IndexedDB-3] は、データがクォータにより退去されたとき削除がどのように発生するかを定義する必要があります。

[FS] は、データがクォータにより退去されたとき、 Bucket File System で削除がどのように発生するかを定義する必要があります。

[Service-Workers] は、データがクォータにより退去されたとき、CacheStorage および Service Workers で削除がどのように発生するかを定義する必要があります。

keys() メソッドの手順は次のとおりです:

1. shelf を、ローカルストレージ棚を取得するを実行した結果とします。

2. shelf が failure である場合、TypeError で 拒否された promise を返します。

3. p を新しい promiseとします。

4. keys を新しいリストとします。

5. 次の手順をstorage bucket managerに キューに入れます:

   1. shelf のバケット マップ内の各 key について、次の手順を実行します:

      1. bucket を、shelf と key を指定して バケットを取得または期限切れにするを実行した結果とします。

      2. bucket が非 null である場合、key を keys に 付加します。

   2. keys で p を 解決するために、ストレージタスクをキューに入れます。

6. p を返します。

[Exposed=(Window,Worker),
 SecureContext]
interface StorageBucket {
  readonly attribute DOMString name;

  [Exposed=Window] Promise<boolean> persist();
  Promise<boolean> persisted();

  Promise<StorageEstimate> estimate();

  Promise<undefined> setExpires(DOMHighResTimeStamp expires);
  Promise<DOMHighResTimeStamp?> expires();

  [SameObject] readonly attribute IDBFactory indexedDB;

  [SameObject] readonly attribute CacheStorage caches;

  Promise<FileSystemDirectoryHandle> getDirectory();
};

persist() メソッドの手順は次のとおりです:

1. bucket を this のストレージ バケットとします。

2. environment を this の関連する設定オブジェクトとします。

3. p を新しい promiseとします。

4. 次の手順を並列に実行します:

   1. bucket のremoved フラグが true である場合、 InvalidStateError で p を拒否するために、ストレージタスクをキューに入れます。

   2. bucket のバケット モードが "persistent" である場合、persisted を true とします。

   3. それ以外の場合、

      1. permission を、"persistent-storage" および environment で現在の許可状態を取得する結果とします。

      2. permission が "granted" である場合、 bucket のバケットモードを "persistent" に設定し、 persisted を true に設定します。

      3. それ以外の場合、persisted を false に設定します。

   4. persisted で p を 解決するために、ストレージタスクをキューに入れます。

5. p を返します。

persisted() メソッドの手順は次のとおりです:

1. p を新しい promiseとします。

2. bucket を this のストレージ バケットとします。

3. それ以外の場合、これらの手順を並列に実行します:

   1. bucket のremoved フラグが true である場合、 InvalidStateError で p を拒否するために、ストレージタスクをキューに入れます。

   2. bucket のバケット モードが "persistent" である場合は persistent を true とし、 それ以外の場合は false とします。

   3. persistent で p を 解決するために、ストレージタスクをキューに入れます。

4. p を返します。

estimate() メソッドの手順は次のとおりです:

1. environment を this の関連する設定オブジェクトとします。

2. shelf を、environment で ローカルストレージ棚を取得するを実行した結果とします。

3. shelf が failure である場合、TypeError で 拒否された promise を返します。

4. bucket を this のストレージ バケットとします。

5. bucket のremoved フラグが true である場合、 InvalidStateError で 拒否された promise を返します。

6. p を新しい promiseとします。

7. それ以外の場合、次の手順を並列に実行します:

   1. quota を shelf のストレージクォータとします。

   2. bucket のクォータ 値が非 null である場合、quota をそれに設定します。

   3. usage を bucket のストレージ使用量とします。

   4. usage メンバーが usage で、quota メンバーが quota である新しい StorageEstimate 辞書を dictionary とします。

   5. dictionary で p を 解決するために、ストレージタスクをキューに入れます。

8. p を返します。

setExpires(expires) メソッドの手順は 次のとおりです:

1. p を新しい promiseとします。

2. bucket を this のストレージ バケットとします。

3. それ以外の場合、これらの手順を並列に実行します:

   1. bucket のremoved フラグが true である場合、 InvalidStateError で p を拒否するために、ストレージタスクをキューに入れます。

   2. それ以外の場合、bucket の有効期限時刻を、 Unix epoch の expires ミリ秒後に設定します。

   3. p を解決するために、ストレージタスクをキューに入れます。

4. p を返します。

expires() メソッドの手順は次のとおりです:

1. p を新しい promiseとします。

2. bucket を this のストレージ バケットとします。

3. それ以外の場合、これらの手順を並列に実行します:

   1. bucket のremoved フラグが true である場合、 InvalidStateError で p を拒否するために、ストレージタスクをキューに入れます。

   2. それ以外の場合、expiration を bucket の有効期限時刻とします。

   3. expiration で p を 解決するために、ストレージタスクをキューに入れます。

4. p を返します。

StorageBucket は IDBFactory オブジェクトを持ち、初期値は null です。indexedDB 取得子の手順は次のとおりです:

1. this の indexedDB が null である場合、次の手順を実行します:

   1. bucket を this のストレージバケットとします。

   2. bottle map を、bucket と "indexedDB" で ローカルストレージボトルマップを取得する結果とします。

   3. indexedDB を IDBFactory オブジェクトとします。

   4. indexedDB のストレージボトルマップを bottle map に設定します。

   5. this の indexedDB を indexedDB に設定します。

2. this の indexedDB を返します。

StorageBucket は CacheStorage オブジェクトを持ち、初期値は null です。caches 取得子の 手順は次のとおりです:

1. this の caches が null である場合、次の手順を実行します:

   1. bucket を this のストレージバケットとします。

   2. bottle map を、bucket と "cacheStorage" で ローカルストレージボトル マップを取得する結果とします。

   3. cacheStorage を CacheStorage オブジェクトとします。

   4. cacheStorage の関連する名前からキャッシュへのマップを bottle map に設定します。

   5. this の caches を cacheStorage に設定します。

2. this の caches を返します。

getDirectory() の手順は次のとおりです:

1. map を、this のストレージ バケットと "fileSystem" で ローカルストレージボトルマップを取得する結果とします。

2. map で getDirectory を実行した結果を返します。

バケット付き Clear-Site-Data ヘッダーを解析するには、次の手順を実行します:

1. header 内の各 type について、次の手順を実行します:

   1. type が "storage:" で始まらない場合、これらの手順を中止します。

   2. bucket name を、type の 8 から終端までの 符号単位部分文字列とします。

   3. bucket name でバケット名を検証する結果が failure である場合、これらの手順を中止します。

   4. ("storage-bucket", bucket name) からなる タプルを types に付加します。

bucket name を指定してバケット付きでデータを消去するには、 次の手順を実行します:

1. environment を this の関連する設定オブジェクトとします。

2. shelf を、environment を与えて ローカルストレージ棚を取得するを実行した結果とします。

3. shelf が failure である場合、TypeError を投げ、これらの手順を中止します。

4. types 内の各 type について、次の手順を実行します:

   1. type がタプルではない、 または type[0] が "storage-bucket" ではない場合、これらの手順を中止します。

   2. bucket を、存在する場合は shelf のバケット マップ[bucket name] とします。存在しない場合はこれらの手順を中止します。

   3. bucket を削除します。