1
// Licensed to the Software Freedom Conservancy (SFC) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The SFC licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17

18
/**
19
 * Represents a set of parameters for creating a context.
20
 * Described in https://w3c.github.io/webdriver-bidi/#command-browsingContext-create.
21
 */
22
class CreateContextParameters {
23
  #map = new Map()
24

25
  /**
26
   * Sets the reference context.
27
   * @param {string} id - The ID of the reference context.
28
   * @returns {CreateContextParameters} - The updated instance of CreateContextParameters for chaining.
29
   * @throws {Error} - If the provided ID is not a string.
30
   */
31
  referenceContext(id) {
32
    if (typeof id !== 'string') {
33
      throw new Error(`ReferenceContext must be string. Received:'${id}'`)
34
    }
35
    this.#map.set('referenceContext', id)
36
    return this
37
  }
38

39
  /**
40
   * Sets the background parameter.
41
   *
42
   * @param {boolean} background - The background value to set.
43
   * @returns {CreateContextParameters} - The updated instance of CreateContextParameters for chaining.
44
   * @throws {Error} - If the background parameter is not a boolean.
45
   */
46
  background(background) {
47
    if (typeof background !== 'boolean') {
48
      throw new Error(`Background must be boolean. Received:'${background}'`)
49
    }
50
    this.#map.set('background', background)
51
    return this
52
  }
53

54
  /**
55
   * Sets the user context.
56
   * @param {string} userContext - The user context to set.
57
   * @returns {CreateContextParameters} - The updated instance of CreateContextParameters for chaining.
58
   * @throws {Error} - If the userContext parameter is not a string.
59
   */
60
  userContext(userContext) {
61
    if (typeof userContext !== 'string') {
62
      throw new Error(`UserContext must be string. Received:'${userContext}'`)
63
    }
64
    this.#map.set('userContext', userContext)
65
    return this
66
  }
67

68
  asMap() {
69
    return this.#map
70
  }
71
}
72

73
module.exports = { CreateContextParameters }
74

75