49 |
50 |
51 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ### Getting started sample Google Chrome / Mozilla Firefox extension
2 |
3 | Based on Chrome Extension sample from Google's Getting Started guide.
4 |
5 | Documentation [here](https://developer.chrome.com/extensions/getstarted).
6 |
7 | This version of the code is as rewriting of the original Google example using Kotlin.
8 | The API has been extended using Kotlin Coroutines.
9 | The extension code has been modified to use coroutines APIs.
10 | The API was converted to use Browser Extensions W3C proposed standard.
11 | Original comments have been kept at the closest place of the original code.
12 |
13 | ###### Previous versions of the extension
14 |
15 | * Original version in JavaScript [here](https://github.com/rivasdiaz/helloworld-chrome-extension-kotlin/tree/52fdf0db02fb636007d3cac652b593ebfc0d78c1).
16 | * Initial rewrite in Kotlin [here](https://github.com/rivasdiaz/helloworld-chrome-extension-kotlin/tree/047baa8c4f5011fe9f28bac22e847c2113bd3dce).
17 | * Extension with Kotlin Coroutines only for Chrome [here](https://github.com/rivasdiaz/helloworld-chrome-extension-kotlin/tree/e42bff49b13f19f5e2e6a0d3d8c5995771f88df1).
18 |
19 | ###### Medium articles
20 |
21 | Please check this series in Medium that describe this project:
22 |
23 | 1. [Writing a Chrome extension in Kotlin](https://medium.com/@rivasdiaz/writing-a-chrome-extension-in-kotlin-part-1-e013d431b63f)
24 | 2. [Writing a Chrome extension in Kotlin — Using Coroutines](https://medium.com/@rivasdiaz/writing-a-chrome-extension-in-kotlin-using-coroutines-part-2-29175f4d1739)
25 | 3. [Writing a Chrome extension in Kotlin — Supporting Firefox and Chrome](https://medium.com/@rivasdiaz/writing-a-chrome-extension-in-kotlin-supporting-firefox-and-chrome-part-3-a5ab0ae58bb4)
26 |
27 | ##### Building
28 |
29 | This project uses gradle. To build it, execute the following:
30 |
31 | ```
32 | gradlew clean assemble
33 | ```
34 |
35 | Unbundled extension will be generated inside `build/extension`.
36 | This folder can be used to install in Chrome.
37 |
38 | Zipped extension will be generated inside `build/distributions`.
39 | The zip generated inside that folder can be used to install in Firefox.
40 |
41 | ##### Installing the extension
42 |
43 | ###### Google Chrome
44 |
45 | 1. Go to Extensions
46 | 2. Enable "Developer Mode"
47 | 3. Click on "Load unpacked extension..."
48 | 4. Select the folder `${project}/build/extension` and open it.
49 |
50 | If changes are made and the extension is recompiled, make sure to update the extension:
51 |
52 | 1. Go to Extensions
53 | 2. Make sure "Developer Mode" is enabled
54 | 3. Click on "Update extensions now"
55 |
56 | Make sure to check Google documentation for more details.
57 |
58 | ###### Mozilla Firefox
59 |
60 | The extension needs to be uploaded to Mozilla Add-ons website for the extension to work in Firefox.
61 |
62 | Please follow instructions [here](https://developer.mozilla.org/en-US/Add-ons/Distribution/Submitting_an_add-on).
63 |
64 | ##### Testing the extension
65 |
66 | Upon installation a a new extension is added to Chrome/Firefox with the icon 
67 |
68 | Clicking the icon will open a small popup that will allow changing active page background color.
69 |
70 | Check Google's [Getting started guide](https://developer.chrome.com/extensions/getstarted) for more details.
71 |
--------------------------------------------------------------------------------
/src/main/kotlin/browser/storage/Imports.kt:
--------------------------------------------------------------------------------
1 | @file:JsQualifier("browser.storage")
2 |
3 | package browser.storage
4 |
5 | import kotlin.js.Promise
6 |
7 | /**
8 | * Items in the sync storage area are synced using Chrome Sync.
9 | */
10 | external val sync: StorageArea
11 |
12 | /**
13 | * Items in the local storage area are local to each machine.
14 | */
15 | external val local: StorageArea
16 |
17 | /**
18 | * Items in the managed storage area are set by the domain administrator,
19 | * and are read-only for the extension; trying to modify this namespace results in an error.
20 | *
21 | * Since Chrome 33.
22 | */
23 | external val managed: StorageArea
24 |
25 | external interface StorageArea {
26 |
27 | /**
28 | * Retrieves one or more items from the storage area.
29 | *
30 | * @param keys A key (string) or keys (an array of strings or an object specifying default
31 | * values) to identify the item(s) to be retrieved from storage. If you pass an empty
32 | * string, object or array here, an empty object will be retrieved. If you pass null,
33 | * or an undefined value, the entire storage contents will be retrieved.
34 | *
35 | * @return a Promise that will be fulfilled with a results object containing every object
36 | * in keys that was found in the storage area. If the operation failed, the promise
37 | * will be rejected with an error message.
38 | */
39 | fun get(keys: dynamic = definedExternally): Promise
40 |
41 | /**
42 | * Stores one or more items in the storage area, or update existing items.
43 | *
44 | * When you store or update a value using this API, the storage.onChanged event will fire.
45 | *
46 | * @param keys An object containing one or more key/value pairs to be stored in storage.
47 | * If an item already exists, its value will be updated.
48 | *
49 | * - Values of primitive types (number, string, boolean, null, undefined) will serialize
50 | * (omitting any custom properties)
51 | * Note: in Chrome passing undefined will leave the existing value untouched,
52 | * whereas Firefox will set it to null)
53 | * - Dates, and Arrays, will serialize (omitting any custom properties)
54 | * - In Firefox, RegExps, ArrayBuffers, Typed Arrays/Array Views (they make a copy
55 | * of their buffer), Maps, and Set s will also serialize (omitting any custom properties)
56 | * - Objects containing only the above types will serialize recursively,
57 | * but will lose class information (and so prototypes) for all but the above types
58 | * - Objects containing properties with unsupported types will be rejected with a
59 | * DataCloneError (Firefox) or have each unsupported property replaced by the
60 | * empty object (other implementations)
61 | * - Unsupported types (Functions, SharedArrayBuffers, Promises, WeakSets,
62 | * Errors, Proxys, etc) will be rejected with a DataCloneError (Firefox) or are
63 | * accepted and silently replaced by the empty object (other implementations)
64 | *
65 | * @return A Promise that will be fulfilled with no arguments if the operation succeeded.
66 | * If the operation failed, the promise will be rejected with an error message.
67 | */
68 | fun set(keys: dynamic): Promise
69 |
70 | /**
71 | * Removes one or more items from the storage area.
72 | *
73 | * @param keys A string, or array of strings, representing the key(s) of the item(s) to be
74 | * removed.
75 | *
76 | * @return A Promise that will be fulfilled with no arguments if the operation succeeded.
77 | * If the operation failed, the promise will be rejected with an error message.
78 | */
79 | fun remove(keys: dynamic): Promise
80 |
81 | /**
82 | * Removes all items from the storage area.
83 | *
84 | * @return A Promise that will be fulfilled with no arguments if the operation succeeded.
85 | * If the operation failed, the promise will be rejected with an error message.
86 | */
87 | fun clear(): Promise
88 | }
89 |
--------------------------------------------------------------------------------
/src/main/kotlin/helloworld/main.kt:
--------------------------------------------------------------------------------
1 | package helloworld
2 |
3 | import browser.tabs.ExecuteScriptDetails
4 | import browser.tabs.QueryInfo
5 | import kotlinx.coroutines.experimental.async
6 | import kotlinx.coroutines.experimental.await
7 | import org.w3c.dom.HTMLSelectElement
8 | import kotlin.browser.document
9 |
10 | /**
11 | * Get the current URL.
12 | *
13 | * @param callback called when the URL of the current tab
14 | * is found.
15 | */
16 | fun getCurrentTabUrlAsync() =
17 | async {
18 | // Query filter to be passed to browser.tabs.query - see
19 | // https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/query
20 | val queryInfo = QueryInfo {
21 | active = true
22 | currentWindow = true
23 | }
24 | val tabs = browser.tabs.query(queryInfo).await()
25 | // browser.tabs.query invokes the callback with a list of tabs that match the
26 | // query. When the popup is opened, there is certainly a window and at least
27 | // one tab, so we can safely assume that |tabs| is a non-empty array.
28 | // A window can only have one active tab at a time, so the array consists of
29 | // exactly one tab.
30 | val tab = tabs[0]
31 |
32 | // A tab is a plain object that provides information about the tab.
33 | // See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/Tab
34 | val url = tab.url
35 | // tab.url is only available if the "activeTab" permission is declared.
36 | // If you want to see the URL of other tabs (e.g. after removing active:true
37 | // from |queryInfo|), then the "tabs" permission is required to see their
38 | // "url" properties.
39 | url ?: throw RuntimeException("tab.url should be a string")
40 | }
41 |
42 | /**
43 | * Change the background color of the current page.
44 | *
45 | * @param color The new background color.
46 | */
47 | fun changeBackgroundColor(color: String) {
48 | val script = """document.body.style.backgroundColor="$color";"""
49 | // See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/executeScript.
50 | // browser.tabs.executeScript allows us to programmatically inject JavaScript
51 | // into a page. Since we omit the optional first argument "tabId", the script
52 | // is inserted into the active tab of the current window, which serves as the
53 | // default.
54 | browser.tabs.executeScript(
55 | details = ExecuteScriptDetails {
56 | code = script
57 | }
58 | )
59 | }
60 |
61 | /**
62 | * Gets the saved background color for url.
63 | *
64 | * @param url URL whose background color is to be retrieved.
65 | * @param promise fulfilled with the saved background color for
66 | * the given url on success, or rejected if no color is retrieved.
67 | */
68 | fun getSavedBackgroundColorAsync(url: String) =
69 | async {
70 | // See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea.
71 | val items = browser.storage.sync.get(url).await()
72 | items[url] as? String
73 | }
74 |
75 | /**
76 | * Sets the given background color for url.
77 | *
78 | * @param url URL for which background color is to be saved.
79 | * @param color The background color to be saved.
80 | */
81 | fun saveBackgroundColor(url: String, color: String) {
82 | val items = js("{}")
83 | items[url] = color
84 | // See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea.
85 | // We do not use the returned Promise since we don't need to perform any action once the
86 | // background color is saved.
87 | browser.storage.sync.set(items)
88 | }
89 |
90 | // This extension loads the saved background color for the current tab if one
91 | // exists. The user can select a new background color from the dropdown for the
92 | // current page, and it will be saved as part of the extension's isolated
93 | // storage. The browser.storage API is used for this purpose. This is different
94 | // from the window.localStorage API, which is synchronous and stores data bound
95 | // to a document's origin. Also, using browser.storage.sync instead of
96 | // browser.storage.local allows the extension data to be synced across multiple
97 | // user devices.
98 | fun main(args: Array) {
99 | document.onContentLoadedEventAsync {
100 | val url = getCurrentTabUrlAsync().await()
101 | val dropdown = document.getElementById("dropdown") as HTMLSelectElement
102 | // Load the saved background color for this page and modify the dropdown
103 | // value, if needed.
104 | val savedColor = getSavedBackgroundColorAsync(url).await()
105 | if (savedColor != null) {
106 | changeBackgroundColor(savedColor)
107 | dropdown.value = savedColor
108 | }
109 | // Ensure the background color is changed and saved when the dropdown
110 | // selection changes.
111 | dropdown.onChangeEvent {
112 | changeBackgroundColor(dropdown.value)
113 | saveBackgroundColor(url, dropdown.value)
114 | }
115 | }
116 | }
117 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/src/main/kotlin/browser/tabs/Imports.kt:
--------------------------------------------------------------------------------
1 | @file:JsQualifier("browser.tabs")
2 |
3 | package browser.tabs
4 |
5 | import kotlin.js.Promise
6 |
7 | external fun query(queryInfo: QueryInfo): Promise>
8 | external fun executeScript(
9 | tabId: Int? = definedExternally,
10 | details: ExecuteScriptDetails
11 | ): Promise>
12 |
13 | external val TAB_ID_NONE: Int = definedExternally
14 |
15 | external interface QueryInfo {
16 |
17 | /**
18 | * Whether the tabs are active in their windows.
19 | * */
20 | var active: Boolean?
21 |
22 | /**
23 | * Whether the tabs are pinned.
24 | * */
25 | var pinned: Boolean?
26 |
27 | /**
28 | * Whether the tabs are audible.
29 | *
30 | * Since Chrome 45.
31 | * */
32 | var audible: Boolean?
33 |
34 | /**
35 | * Whether the tabs are muted.
36 | *
37 | * Since Chrome 45.
38 | * */
39 | var muted: Boolean?
40 |
41 | /**
42 | * Whether the tabs are highlighted.
43 | * */
44 | var highlighted: Boolean?
45 |
46 | /**
47 | * Whether the tabs are discarded.
48 | * A discarded tab is one whose content has been unloaded from memory,
49 | * but is still visible in the tab strip.
50 | * Its content gets reloaded the next time it's activated.
51 | *
52 | * Since Chrome 54.
53 | */
54 | var discarded: Boolean?
55 |
56 | /**
57 | * Whether the tabs can be discarded automatically by the browser when resources are low.
58 | *
59 | * Since Chrome 54.
60 | */
61 | var autoDiscardable: Boolean?
62 |
63 | /**
64 | * Whether the tabs are in the current window.
65 | * */
66 | var currentWindow: Boolean?
67 |
68 | /**
69 | * Whether the tabs are in the last focused window.
70 | * */
71 | var lastFocusedWindow: Boolean?
72 |
73 | /**
74 | * Whether the tabs have completed loading.
75 | * */
76 | var status: String?
77 |
78 | /**
79 | * Match page titles against a pattern.
80 | * Note that this property is ignored if the extension doesn't have the "tabs" permission.
81 | */
82 | var title: String?
83 |
84 | /**
85 | * Match tabs against one or more URL patterns.
86 | * Note that fragment identifiers are not matched.
87 | * Note that this property is ignored if the extension doesn't have the "tabs" permission.
88 | */
89 | var url: String? //TODO string or array of string (optional)
90 |
91 | /** The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window. */
92 | var windowId: Int?
93 |
94 | /** The type of window the tabs are in. */
95 | var windowType: String?
96 |
97 | /** The position of the tabs within their windows. */
98 | var index: Int?
99 |
100 | }
101 |
102 | external interface Tab {
103 |
104 | /**
105 | * The ID of the tab. Tab IDs are unique within a browser session.
106 | * Under some circumstances a Tab may not be assigned an ID, for example when querying foreign tabs using the sessions API, in which case a session ID may be present.
107 | * Tab ID can also be set to chrome.tabs.TAB_ID_NONE for apps and devtools windows.
108 | */
109 | val id: Int?
110 |
111 | /**
112 | * The zero-based index of the tab within its window.
113 | */
114 | val index: Int
115 |
116 | /**
117 | * The ID of the window the tab is contained within.
118 | */
119 | val windowId: Int
120 |
121 | /**
122 | * The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists.
123 | */
124 | val openerTabId: Int?
125 |
126 | /**
127 | * Whether the tab is highlighted.
128 | */
129 | val highlighted: Boolean
130 |
131 | /**
132 | * Whether the tab is active in its window. (Does not necessarily mean the window is focused.)
133 | */
134 | val active: Boolean
135 |
136 | /**
137 | * Whether the tab is pinned.
138 | */
139 | val pinned: Boolean
140 |
141 | /**
142 | *Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted).
143 | * Equivalent to whether the speaker audio indicator is showing.
144 | *
145 | * Since Chrome 45.
146 | */
147 | val audible: Boolean?
148 |
149 | /**
150 | * Whether the tab is discarded.
151 | * A discarded tab is one whose content has been unloaded from memory, but is still visible in the tab strip.
152 | * Its content gets reloaded the next time it's activated.
153 | *
154 | * Since Chrome 54.
155 | */
156 | val discarded: Boolean
157 |
158 | /**
159 | * Whether the tab can be discarded automatically by the browser when resources are low.
160 | *
161 | * Since Chrome 54.
162 | */
163 | val autoDiscardable: Boolean
164 |
165 | /**
166 | * Current tab muted state and the reason for the last state change.
167 | *
168 | * Since Chrome 46.
169 | */
170 | val mutedInfo: MutedInfo?
171 |
172 | /**
173 | * The URL the tab is displaying.
174 | * This property is only present if the extension's manifest includes the "tabs" permission.
175 | */
176 | val url: String?
177 |
178 | /**
179 | * The title of the tab.
180 | * This property is only present if the extension's manifest includes the "tabs" permission.
181 | */
182 | val title: String?
183 |
184 | /**
185 | * The URL of the tab's favicon.
186 | * This property is only present if the extension's manifest includes the "tabs" permission.
187 | * It may also be an empty string if the tab is loading.
188 | */
189 | val favIconUrl: String?
190 |
191 | /**
192 | * Either loading or complete.
193 | */
194 | val status: String?
195 |
196 | /**
197 | * Whether the tab is in an incognito window.
198 | */
199 | val incognito: Boolean
200 |
201 | /**
202 | * The width of the tab in pixels.
203 | *
204 | * Since Chrome 31.
205 | */
206 | val width: Int?
207 |
208 | /**
209 | * The height of the tab in pixels.
210 | *
211 | * Since Chrome 31.
212 | */
213 | val height: Int?
214 |
215 | /**
216 | * The session ID used to uniquely identify a Tab obtained from the sessions API.
217 | *
218 | * Since Chrome 31.
219 | */
220 | val sessionId: String?
221 | }
222 |
223 | external interface MutedInfo {
224 |
225 | /**
226 | * Whether the tab is prevented from playing sound (but hasn't necessarily recently produced sound).
227 | * Equivalent to whether the muted audio indicator is showing.
228 | */
229 | val muted: Boolean
230 |
231 | /**
232 | * The reason the tab was muted or unmuted.
233 | * Not set if the tab's mute state has never been changed.
234 | */
235 | val reason: String?
236 |
237 | /**
238 | * The ID of the extension that changed the muted state.
239 | * Not set if an extension was not the reason the muted state last changed.
240 | */
241 | val extensionId: String?
242 | }
243 |
244 | external interface ExecuteScriptDetails {
245 |
246 | /**
247 | * JavaScript or CSS code to inject.
248 | *
249 | * Warning:
250 | * Be careful using the code parameter.
251 | * Incorrect use of it may open your extension to cross site scripting attacks.
252 | */
253 | var code: String?
254 |
255 | /** JavaScript or CSS file to inject. */
256 | var file: String?
257 |
258 | /**
259 | * If allFrames is true, implies that the JavaScript or CSS should be injected into all frames of current page.
260 | * By default, it's false and is only injected into the top frame.
261 | * If true and frameId is set, then the code is inserted in the selected frame and all of its child frames.
262 | */
263 | var allFrames: Boolean?
264 |
265 | /**
266 | * The frame where the script or CSS should be injected. Defaults to 0 (the top-level frame).
267 | * Since Chrome 39.
268 | */
269 | var frameId: Int?
270 |
271 | /**
272 | * If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has access to its parent document.
273 | * Code cannot be inserted in top-level about:-frames. By default it is false.
274 | * Since Chrome 39.
275 | */
276 | var matchAboutBlank: Boolean?
277 |
278 | /**
279 | * The soonest that the JavaScript or CSS will be injected into the tab. Defaults to "document_idle".
280 | */
281 | var runAt: String?
282 | }
283 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------