存储桶 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 纪元之后 expires 毫秒的时刻早于 相关设置对象的当前墙上时间，则返回 failure。

3. 令 quota 为 undefined。

4. 如果 options["quota"] 存在，则：

   1. 将 quota 设为 options["quota"]。

   2. 如果 quota 小于或等于零，则返回 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 纪元之后 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. 令 dictionary 为一个新的 StorageEstimate 字典，其 usage 成员是 usage，且 quota 成员是 quota。

   5. 排入一个存储任务，以用 dictionary 解决 p。

8. 返回 p。

setExpires(expires) 方法步骤 为：

1. 令 p 为一个新的 promise。

2. 令 bucket 为 this 的存储 桶。

3. 否则，并行运行这些步骤：

   1. 如果 bucket 的removed 标志为 true，则排入一个存储任务，以用 InvalidStateError 拒绝 p。

   2. 否则，将 bucket 的过期时间设为 Unix 纪元之后 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. 向 types 附加一个由 ("storage-bucket", bucket name) 组成的元组

要给定 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。