// The Shared Storage API.
// https://github.com/pythagoraskitty/shared-storage/blob/main/README.md

[
  RuntimeEnabled=SharedStorageAPI,
  Exposed=(Window, SharedStorageWorklet)
] interface SharedStorage {
  [Exposed=SharedStorageWorklet] async_iterable<DOMString, DOMString>;

  [
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_Set_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> set(DOMString key, DOMString value, optional SharedStorageSetMethodOptions options);

  [
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_Append_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> append(DOMString key, DOMString value, optional SharedStorageModifierMethodOptions options);

  [
    CallWith=ScriptState,
    ImplementedAs=Delete,
    RaisesException,
    MeasureAs=SharedStorageAPI_Delete_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> delete(DOMString key, optional SharedStorageModifierMethodOptions options);

  [
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_Clear_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> clear(optional SharedStorageModifierMethodOptions options);

  [
    RuntimeEnabled=SharedStorageWebLocks,
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_BatchUpdate_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> batchUpdate(sequence<SharedStorageModifierMethod> methods, optional SharedStorageModifierMethodOptions options);

  [
    Exposed=SharedStorageWorklet,
    CallWith=ScriptState,
    RaisesException,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<DOMString> get(DOMString key);

  [
    Exposed=SharedStorageWorklet,
    CallWith=ScriptState,
    RaisesException
  ] Promise<unsigned long> length();

  [
    Exposed=SharedStorageWorklet,
    CallWith=ScriptState,
    RaisesException
  ] Promise<double> remainingBudget();

  [
    Exposed=SharedStorageWorklet,
    CallWith=ScriptState,
    RaisesException
  ] readonly attribute any context;

  [
    Exposed=Window,
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_SelectURL_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<SharedStorageResponse> selectURL(DOMString name,
                                 sequence<SharedStorageUrlWithMetadata> urls,
                                 optional SharedStorageRunOperationMethodOptions options);

  [
    Exposed=Window,
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_Run_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<any> run(DOMString name, optional SharedStorageRunOperationMethodOptions options);

  [
    Exposed=Window,
    CallWith=ScriptState,
    RaisesException,
    MeasureAs=SharedStorageAPI_CreateWorklet_Method,
    DeprecateAs=SharedStorageAPIAll
  ] Promise<SharedStorageWorklet> createWorklet(USVString moduleURL,
                                                optional SharedStorageWorkletOptions options = {});

  [
    Exposed=Window,
    CallWith=ScriptState,
    RaisesException
  ] readonly attribute SharedStorageWorklet worklet;
};