diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000000..f643017526f --- /dev/null +++ b/.dockerignore @@ -0,0 +1,12 @@ +.git/ +.github/ +build/ +.editorconfig +.gitattributes +.gitignore +CHANGELOG.md +CODE_OF_CONDUCT.md +deploy.sh +font-selection.json +README.md +Vagrantfile \ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000000..1692977cec8 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# Top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true + +[*.rb] +charset = utf-8 + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000000..3069c432317 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +source/javascripts/lib/* linguist-vendored diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000000..43305a233da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,22 @@ +--- +name: Report a Bug +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Bug Description** +A clear and concise description of what the bug is and how to reproduce it. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Browser (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Last upstream Slate commit (run `git log --author="\(Robert Lord\)\|\(Matthew Peveler\)\|\(Mike Ralphson\)" | head -n 1`):** +Put the commit hash here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..16f4beed616 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions, Ideas, Discussions + url: https://github.com/slatedocs/slate/discussions + about: Ask and answer questions, and propose new features. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..151e45d78cd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ + \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000000..d17e8826d4f --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,9 @@ +version: 2 +updates: +- package-ecosystem: bundler + directory: "/" + schedule: + interval: daily + open-pull-requests-limit: 10 + target-branch: dev + versioning-strategy: increase-if-necessary diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 00000000000..34e1b77de6f --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,38 @@ +name: Build + +on: + push: + branches: [ '*' ] + pull_request: + branches: [ '*' ] + +jobs: + test: + runs-on: ubuntu-latest + + strategy: + matrix: + ruby-version: [2.6, 2.7, '3.0', 3.1, 3.2] + + steps: + - uses: actions/checkout@v3 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby-version }} + + - uses: actions/cache@v3 + with: + path: vendor/bundle + key: gems-${{ runner.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + gems-${{ runner.os }}-${{ matrix.ruby-version }}- + gems-${{ runner.os }}- + + - run: bundle config set deployment 'true' + - name: bundle install + run: | + bundle config path vendor/bundle + bundle install --jobs 4 --retry 3 + + - run: bundle exec middleman build diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000000..6a032b44969 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,44 @@ +name: Deploy + +on: + push: + branches: [ 'main' ] + +jobs: + deploy: + permissions: + contents: write + + runs-on: ubuntu-latest + env: + ruby-version: 2.6 + + steps: + - uses: actions/checkout@v3 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ env.ruby-version }} + + - uses: actions/cache@v3 + with: + path: vendor/bundle + key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + gems-${{ runner.os }}-${{ env.ruby-version }}- + gems-${{ runner.os }}- + + - run: bundle config set deployment 'true' + - name: bundle install + run: | + bundle config path vendor/bundle + bundle install --jobs 4 --retry 3 + + - run: bundle exec middleman build + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build + keep_files: true diff --git a/.github/workflows/dev_deploy.yml b/.github/workflows/dev_deploy.yml new file mode 100644 index 00000000000..d9edd290178 --- /dev/null +++ b/.github/workflows/dev_deploy.yml @@ -0,0 +1,85 @@ +name: Dev Deploy + +on: + push: + branches: [ 'dev' ] + +jobs: + push_to_registry: + runs-on: ubuntu-latest + + steps: + - name: Check out the repo + uses: actions/checkout@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + with: + platforms: all + + - name: Docker meta + id: meta + uses: docker/metadata-action@v3 + with: + images: | + slatedocs/slate + tags: | + type=ref,event=branch + + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v1 + + - name: Login to DockerHub + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_ACCESS_KEY }} + + - name: Push to Docker Hub + uses: docker/build-push-action@v2 + with: + builder: ${{ steps.buildx.outputs.name }} + context: . + file: ./Dockerfile + platforms: linux/amd64,linux/arm64,linux/ppc64le + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + + deploy_gh: + permissions: + contents: write + + runs-on: ubuntu-latest + env: + ruby-version: 2.6 + + steps: + - uses: actions/checkout@v3 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ env.ruby-version }} + + - uses: actions/cache@v3 + with: + path: vendor/bundle + key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + restore-keys: | + gems-${{ runner.os }}-${{ env.ruby-version }}- + gems-${{ runner.os }}- + - run: bundle config set deployment 'true' + - name: bundle install + run: | + bundle config path vendor/bundle + bundle install --jobs 4 --retry 3 + - run: bundle exec middleman build + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3.7.0-8 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + destination_dir: dev + publish_dir: ./build + keep_files: true diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 00000000000..149e72011c1 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,47 @@ +name: Publish Docker image + +on: + release: + types: [published] + +jobs: + push_to_registry: + name: Push Docker image to Docker Hub + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + with: + platforms: all + + - name: Docker meta + id: meta + uses: docker/metadata-action@v3 + with: + images: slatedocs/slate + tags: | + type=ref,event=tag + + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v1 + + - name: Login to DockerHub + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_ACCESS_KEY }} + + - name: Push to Docker Hub + uses: docker/build-push-action@v2 + with: + builder: ${{ steps.buildx.outputs.name }} + context: . + file: ./Dockerfile + platforms: linux/amd64,linux/arm64,linux/ppc64le + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/.gitignore b/.gitignore index f6fc8c00b25..1d5d08dd245 100644 --- a/.gitignore +++ b/.gitignore @@ -14,9 +14,14 @@ tmp *.DS_STORE build/ .cache +.vagrant +.sass-cache # YARD artifacts .yardoc _yardoc doc/ -.idea/ \ No newline at end of file +.idea/ + +# Vagrant artifacts +ubuntu-*-console.log diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 3280d947c9a..00000000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -sudo: false - -language: ruby - -rvm: - - 1.9.3 - - 2.0.0 - -cache: bundler diff --git a/CHANGELOG.md b/CHANGELOG.md index 59ee6a441e5..49b83dc3257 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,294 @@ # Changelog +## Version 2.13.1 + +*January 31, 2023* + +* Fix Vagrantfile gem install for ruby >= 2.6 (thanks @Cyb0rk) +* Disable file watcher in run_build() for sake of qemu on arm64 (thanks @anapsix) +* Expand deprecated git.io links to full url in docs (thanks @judge2020) +* Add margin to paragraph following code-block on phones (thanks @tlhunter) +* Bump nokogiri from 1.13.4 to 1.13.9 +* Bump rouge from 3.28.0 to 3.30.0 +* Bump redcarpet from 3.5.1 to 3.6.0 +* Bump middleman from 4.4.2 to 4.4.3 +* Bump middleman-syntax from 3.2.0 to 3.3.0 +* Bump webrick from 1.7.0 to 1.8.1 + +## Version 2.13.0 + +*April 22, 2022* + +* __Drop support for ruby 2.5__ +* Bump rouge from 3.26.1 to 3.28.0 +* Formally support ruby 3.1 +* Bump nokogiri from 1.12.5 to 1.13.4 +* Build docker images for multiple architectures (e.g. `aarch64`) +* Remove `VOLUME` declaration from Dockerfile (thanks @aemengo) + +The security vulnerabilities reported against recent versions of nokogiri should not affect slate users with a regular setup. + +## Version 2.12.0 + +*November 04, 2021* + +* Bump nokogiri from 1.12.3 to 1.12.5 +* Bump ffi from 1.15.0 to 1.15.4 +* Bump rouge from 3.26.0 to 3.26.1 +* Bump middleman from 4.4.0 to 4.4.2 +* Remove unnecessary files from docker images + +## Version 2.11.0 + +*August 12, 2021* + +* __[Security]__ Bump addressable transitive dependency from 2.7.0 to 2.8.0 +* Support specifying custom meta tags in YAML front-matter +* Bump nokogiri from 1.11.3 to 1.12.3 (minimum supported version is 1.11.4) +* Bump middleman-autoprefixer from 2.10.1 to 3.0.0 +* Bump jquery from 3.5.1 to 3.6.0 +* Bump middleman from [`d180ca3`](https://github.com/middleman/middleman/commit/d180ca337202873f2601310c74ba2b6b4cf063ec) to 4.4.0 + +## Version 2.10.0 + +*April 13, 2021* + +* Add support for Ruby 3.0 (thanks @shaun-scale) +* Add requirement for Git on installing dependencies +* Bump nokogiri from 1.11.2 to 1.11.3 +* Bump middleman from 4.3.11 to [`d180ca3`](https://github.com/middleman/middleman/commit/d180ca337202873f2601310c74ba2b6b4cf063ec) + +## Version 2.9.2 + +*March 30, 2021* + +* __[Security]__ Bump kramdown from 2.3.0 to 2.3.1 +* Bump nokogiri from 1.11.1 to 1.11.2 + +## Version 2.9.1 + +*February 27, 2021* + +* Fix Slate language tabs not working if localStorage is disabled + +## Version 2.9.0 + +*January 19, 2021* + +* __Drop support for Ruby 2.3 and 2.4__ +* __[Security]__ Bump nokogiri from 1.10.10 to 1.11.1 +* __[Security]__ Bump redcarpet from 3.5.0 to 3.5.1 +* Specify slate is not supported on Ruby 3.x +* Bump rouge from 3.24.0 to 3.26.0 + +## Version 2.8.0 + +*October 27, 2020* + +* Remove last trailing newline when using the copy code button +* Rework docker image and make available at slatedocs/slate +* Improve Dockerfile layout to improve caching (thanks @micvbang) +* Bump rouge from 3.20 to 3.24 +* Bump nokogiri from 1.10.9 to 1.10.10 +* Bump middleman from 4.3.8 to 4.3.11 +* Bump lunr.js from 2.3.8 to 2.3.9 + +## Version 2.7.1 + +*August 13, 2020* + +* __[security]__ Bumped middleman from 4.3.7 to 4.3.8 + +_Note_: Slate uses redcarpet, not kramdown, for rendering markdown to HTML, and so was unaffected by the security vulnerability in middleman. +If you have changed slate to use kramdown, and with GFM, you may need to install the `kramdown-parser-gfm` gem. + +## Version 2.7.0 + +*June 21, 2020* + +* __[security]__ Bumped rack in Gemfile.lock from 2.2.2 to 2.2.3 +* Bumped bundled jQuery from 3.2.1 to 3.5.1 +* Bumped bundled lunr from 0.5.7 to 2.3.8 +* Bumped imagesloaded from 3.1.8 to 4.1.4 +* Bumped rouge from 3.17.0 to 3.20.0 +* Bumped redcarpet from 3.4.0 to 3.5.0 +* Fix color of highlighted code being unreadable when printing page +* Add clipboard icon for "Copy to Clipboard" functionality to code boxes (see note below) +* Fix handling of ToC selectors that contain punctutation (thanks @gruis) +* Fix language bar truncating languages that overflow screen width +* Strip HTML tags from ToC title before displaying it in title bar in JS (backup to stripping done in Ruby code) (thanks @atic) + +To enable the new clipboard icon, you need to add `code_clipboard: true` to the frontmatter of source/index.html.md. +See [this line](https://github.com/slatedocs/slate/blame/main/source/index.html.md#L19) for an example of usage. + +## Version 2.6.1 + +*May 30, 2020* + +* __[security]__ update child dependency activesupport in Gemfile.lock to 5.4.2.3 +* Update Middleman in Gemfile.lock to 4.3.7 +* Replace Travis-CI with GitHub actions for continuous integration +* Replace Spectrum with GitHub discussions + +## Version 2.6.0 + +*May 18, 2020* + +__Note__: 2.5.0 was "pulled" due to a breaking bug discovered after release. It is recommended to skip it, and move straight to 2.6.0. + +* Fix large whitespace gap in middle column for sections with codeblocks +* Fix highlighted code elements having a different background than rest of code block +* Change JSON keys to have a different font color than their values +* Disable asset hashing for woff and woff2 elements due to middleman bug breaking woff2 asset hashing in general +* Move Dockerfile to Debian from Alpine +* Converted repo to a [GitHub template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository) +* Update sassc to 2.3.0 in Gemfile.lock + +## Version 2.5.0 + +*May 8, 2020* + +* __[security]__ update nokogiri to ~> 1.10.8 +* Update links in example docs to https://github.com/slatedocs/slate from https://github.com/lord/slate +* Update LICENSE to include full Apache 2.0 text +* Test slate against Ruby 2.5 and 2.6 on Travis-CI +* Update Vagrantfile to use Ubuntu 18.04 (thanks @bradthurber) +* Parse arguments and flags for deploy.sh on script start, instead of potentially after building source files +* Install nodejs inside Vagrantfile (thanks @fernandoaguilar) +* Add Dockerfile for running slate (thanks @redhatxl) +* update middleman-syntax and rouge to ~>3.2 +* update middleman to 4.3.6 + +## Version 2.4.0 + +*October 19, 2019* + +- Move repository from lord/slate to slatedocs/slate +- Fix documentation to point at new repo link, thanks to [Arun](https://github.com/slash-arun), [Gustavo Gawryszewski](https://github.com/gawry), and [Daniel Korbit](https://github.com/danielkorbit) +- Update `nokogiri` to 1.10.4 +- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack) +- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jakemack](https://github.com/jakemack) +- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jakemack](https://github.com/jakemack) +- Add sass gem, thanks to [jakemack](https://github.com/jakemack) +- Activate `asset_cache` in middleman to improve cacheability of static files, thanks to [Sam Gilman](https://github.com/thenengah) +- Update to using bundler 2 for `Gemfile.lock`, thanks to [jakemack](https://github.com/jakemack) + +## Version 2.3.1 + +*July 5, 2018* + +- Update `sprockets` in `Gemfile.lock` to fix security warnings + +## Version 2.3 + +*July 5, 2018* + +- Allows strikethrough in markdown by default. +- Upgrades jQuery to 3.2.1, thanks to [Tomi Takussaari](https://github.com/TomiTakussaari) +- Fixes invalid HTML in `layout.erb`, thanks to [Eric Scouten](https://github.com/scouten) for pointing out +- Hopefully fixes Vagrant memory issues, thanks to [Petter Blomberg](https://github.com/p-blomberg) for the suggestion +- Cleans HTML in headers before setting `document.title`, thanks to [Dan Levy](https://github.com/justsml) +- Allows trailing whitespace in markdown files, thanks to [Samuel Cousin](https://github.com/kuzyn) +- Fixes pushState/replaceState problems with scrolling not changing the document hash, thanks to [Andrey Fedorov](https://github.com/anfedorov) +- Removes some outdated examples, thanks [@al-tr](https://github.com/al-tr), [Jerome Dahdah](https://github.com/jdahdah), and [Ricardo Castro](https://github.com/mccricardo) +- Fixes `nav-padding` bug, thanks [Jerome Dahdah](https://github.com/jdahdah) +- Code style fixes thanks to [Sebastian Zaremba](https://github.com/vassyz) +- Nokogiri version bump thanks to [Grey Baker](https://github.com/greysteil) +- Fix to default `index.md` text thanks to [Nick Busey](https://github.com/NickBusey) + +Thanks to everyone who contributed to this release! + +## Version 2.2 + +*January 19, 2018* + +- Fixes bugs with some non-roman languages not generating unique headers +- Adds editorconfig, thanks to [Jay Thomas](https://github.com/jaythomas) +- Adds optional `NestingUniqueHeadCounter`, thanks to [Vladimir Morozov](https://github.com/greenhost87) +- Small fixes to typos and language, thx [Emir Ribić](https://github.com/ribice), [Gregor Martynus](https://github.com/gr2m), and [Martius](https://github.com/martiuslim)! +- Adds links to Spectrum chat for questions in README and ISSUE_TEMPLATE + +## Version 2.1 + +*October 30, 2017* + +- Right-to-left text stylesheet option, thanks to [Mohammad Hossein Rabiee](https://github.com/mhrabiee) +- Fix for HTML5 history state bug, thanks to [Zach Toolson](https://github.com/ztoolson) +- Small styling changes, typo fixes, small bug fixes from [Marian Friedmann](https://github.com/rnarian), [Ben Wilhelm](https://github.com/benwilhelm), [Fouad Matin](https://github.com/fouad), [Nicolas Bonduel](https://github.com/NicolasBonduel), [Christian Oliff](https://github.com/coliff) + +Thanks to everyone who submitted PRs for this version! + +## Version 2.0 + +*July 17, 2017* + +- All-new statically generated table of contents + - Should be much faster loading and scrolling for large pages + - Smaller Javascript file sizes + - Avoids the problem with the last link in the ToC not ever highlighting if the section was shorter than the page + - Fixes control-click not opening in a new page + - Automatically updates the HTML title as you scroll +- Updated design + - New default colors! + - New spacings and sizes! + - System-default typefaces, just like GitHub +- Added search input delay on large corpuses to reduce lag +- We even bumped the major version cause hey, why not? +- Various small bug fixes + +Thanks to everyone who helped debug or wrote code for this version! It was a serious community effort, and I couldn't have done it alone. + +## Version 1.5 + +*February 23, 2017* + +- Add [multiple tabs per programming language](https://github.com/lord/slate/wiki/Multiple-language-tabs-per-programming-language) feature +- Upgrade Middleman to add Ruby 1.4.0 compatibility +- Switch default code highlighting color scheme to better highlight JSON +- Various small typo and bug fixes + +## Version 1.4 + +*November 24, 2016* + +- Upgrade Middleman and Rouge gems, should hopefully solve a number of bugs +- Update some links in README +- Fix broken Vagrant startup script +- Fix some problems with deploy.sh help message +- Fix bug with language tabs not hiding properly if no error +- Add `!default` to SASS variables +- Fix bug with logo margin +- Bump tested Ruby versions in .travis.yml + +## Version 1.3.3 + +*June 11, 2016* + +Documentation and example changes. + +## Version 1.3.2 + +*February 3, 2016* + +A small bugfix for slightly incorrect background colors on code samples in some cases. + +## Version 1.3.1 + +*January 31, 2016* + +A small bugfix for incorrect whitespace in code blocks. + +## Version 1.3 + +*January 27, 2016* + +We've upgraded Middleman and a number of other dependencies, which should fix quite a few bugs. + +Instead of `rake build` and `rake deploy`, you should now run `bundle exec middleman build --clean` to build your server, and `./deploy.sh` to deploy it to Github Pages. + ## Version 1.2 -*June 20, 2014* +*June 20, 2015* **Fixes:** @@ -21,7 +307,7 @@ ## Version 1.1 -*July 27th, 2014* +*July 27, 2014* **Fixes:** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index b04fc955ca5..00000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,9 +0,0 @@ -# Contributing to Slate - -Thanks for contributing to Slate! A couple of quick guidelines for submitting PRs: - -- Please point your pull requests at the `dev` branch, and keep your commit messages clear and informative. -- Please make sure your contributions work in the most recent version of Chrome, Firefox, and IE. -- If you're implementing a new feature, even if it's relatively small, it's nice to open an issue before you start so that others know what you're working on and can help make sure you're on the right track. - -Thanks again! Happy coding. \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 8183c7a8b04..077ef3b18a8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,12 +1,26 @@ -FROM ubuntu:trusty - -RUN apt-get update -RUN apt-get install -yq ruby ruby-dev build-essential git -RUN gem install --no-ri --no-rdoc bundler -ADD Gemfile /app/Gemfile -ADD Gemfile.lock /app/Gemfile.lock -RUN cd /app; bundle install -ADD . /app +FROM ruby:2.6-slim + +WORKDIR /srv/slate + EXPOSE 4567 -WORKDIR /app -CMD ["bundle", "exec", "middleman", "server"] + +COPY Gemfile . +COPY Gemfile.lock . + +RUN apt-get update \ + && apt-get install -y --no-install-recommends \ + build-essential \ + git \ + nodejs \ + && gem install bundler \ + && bundle install \ + && apt-get remove -y build-essential git \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + +COPY . /srv/slate + +RUN chmod +x /srv/slate/slate.sh + +ENTRYPOINT ["/srv/slate/slate.sh"] +CMD ["build"] diff --git a/Gemfile b/Gemfile index 3a2a2e01a82..f2e84416dd6 100644 --- a/Gemfile +++ b/Gemfile @@ -1,12 +1,13 @@ +ruby '>= 2.6' source 'https://rubygems.org' # Middleman -gem 'middleman', '~>3.3.10' -gem 'middleman-gh-pages', '~> 0.0.3' -gem 'middleman-syntax', '~> 2.0.0' -gem 'middleman-autoprefixer', '~> 2.4.4' -gem 'rouge', '~> 1.9.0' -gem 'redcarpet', '~> 3.3.1' - -gem 'rake', '~> 10.4.2' -gem 'therubyracer', '~> 0.12.1', platforms: :ruby +gem 'middleman', '~> 4.4' +gem 'middleman-syntax', '~> 3.2' +gem 'middleman-autoprefixer', '~> 3.0' +gem 'middleman-sprockets', '~> 4.1' +gem 'rouge', '~> 3.21' +gem 'redcarpet', '~> 3.6.0' +gem 'nokogiri', '~> 1.13.3' +gem 'sass' +gem 'webrick' diff --git a/Gemfile.lock b/Gemfile.lock index f9978492816..79bfbcbf7e4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,140 +1,145 @@ GEM remote: https://rubygems.org/ specs: - activesupport (4.1.11) - i18n (~> 0.6, >= 0.6.9) - json (~> 1.7, >= 1.7.7) - minitest (~> 5.1) - thread_safe (~> 0.1) - tzinfo (~> 1.1) - autoprefixer-rails (5.2.0.1) - execjs - json - celluloid (0.16.0) - timers (~> 4.0.0) - chunky_png (1.3.4) + activesupport (6.1.6.1) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + zeitwerk (~> 2.3) + addressable (2.8.1) + public_suffix (>= 2.0.2, < 6.0) + autoprefixer-rails (10.2.5.0) + execjs (< 2.8.0) + backports (3.23.0) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.9.1.1) - compass (1.0.3) - chunky_png (~> 1.2) - compass-core (~> 1.0.2) - compass-import-once (~> 1.0.5) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - sass (>= 3.3.13, < 3.5) - compass-core (1.0.3) - multi_json (~> 1.0) - sass (>= 3.3.0, < 3.5) - compass-import-once (1.0.5) - sass (>= 3.2, < 3.5) + coffee-script-source (1.12.2) + concurrent-ruby (1.2.0) + contracts (0.16.1) + dotenv (2.8.1) erubis (2.7.0) - execjs (2.5.2) - ffi (1.9.8) - haml (4.0.6) + execjs (2.7.0) + fast_blank (1.0.1) + fastimage (2.2.6) + ffi (1.15.5) + haml (5.2.2) + temple (>= 0.8.0) tilt - hike (1.2.3) - hitimes (1.2.2) - hooks (0.4.0) - uber (~> 0.0.4) - i18n (0.7.0) - json (1.8.3) - kramdown (1.7.0) - libv8 (3.16.14.7) - listen (2.10.1) - celluloid (~> 0.16.0) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - middleman (3.3.12) + hamster (3.0.0) + concurrent-ruby (~> 1.0) + hashie (3.6.0) + i18n (1.6.0) + concurrent-ruby (~> 1.0) + kramdown (2.4.0) + rexml + listen (3.8.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + memoist (0.16.2) + middleman (4.4.3) coffee-script (~> 2.2) - compass (>= 1.0.0, < 2.0.0) - compass-import-once (= 1.0.5) - execjs (~> 2.0) - haml (>= 4.0.5) - kramdown (~> 1.2) - middleman-core (= 3.3.12) - middleman-sprockets (>= 3.1.2) - sass (>= 3.4.0, < 4.0) - uglifier (~> 2.5) - middleman-autoprefixer (2.4.4) - autoprefixer-rails (~> 5.2.0) - middleman-core (>= 3.3.3) - middleman-core (3.3.12) - activesupport (~> 4.1.0) - bundler (~> 1.1) + haml (>= 4.0.5, < 6.0) + kramdown (>= 2.3.0) + middleman-cli (= 4.4.3) + middleman-core (= 4.4.3) + middleman-autoprefixer (3.0.0) + autoprefixer-rails (~> 10.0) + middleman-core (>= 4.0.0) + middleman-cli (4.4.3) + thor (>= 0.17.0, < 2.0) + middleman-core (4.4.3) + activesupport (>= 6.1, < 7.1) + addressable (~> 2.4) + backports (~> 3.6) + bundler (~> 2.0) + contracts (~> 0.13) + dotenv erubis - hooks (~> 0.3) - i18n (~> 0.7.0) - listen (>= 2.7.9, < 3.0) - padrino-helpers (~> 0.12.3) - rack (>= 1.4.5, < 2.0) - rack-test (~> 0.6.2) - thor (>= 0.15.2, < 2.0) - tilt (~> 1.4.1, < 2.0) - middleman-gh-pages (0.0.3) - rake (> 0.9.3) - middleman-sprockets (3.4.2) - middleman-core (>= 3.3) - sprockets (~> 2.12.1) - sprockets-helpers (~> 1.1.0) - sprockets-sass (~> 1.3.0) - middleman-syntax (2.0.0) - middleman-core (~> 3.2) - rouge (~> 1.0) - minitest (5.7.0) - multi_json (1.11.1) - padrino-helpers (0.12.5) - i18n (~> 0.6, >= 0.6.7) - padrino-support (= 0.12.5) - tilt (~> 1.4.1) - padrino-support (0.12.5) - activesupport (>= 3.1) - rack (1.6.4) - rack-test (0.6.3) - rack (>= 1.0) - rake (10.4.2) - rb-fsevent (0.9.5) - rb-inotify (0.9.5) - ffi (>= 0.5.0) - redcarpet (3.3.1) - ref (1.0.5) - rouge (1.9.0) - sass (3.4.14) - sprockets (2.12.3) - hike (~> 1.2) - multi_json (~> 1.0) - rack (~> 1.0) - tilt (~> 1.1, != 1.3.0) - sprockets-helpers (1.1.0) - sprockets (~> 2.0) - sprockets-sass (1.3.1) - sprockets (~> 2.0) - tilt (~> 1.1) - therubyracer (0.12.2) - libv8 (~> 3.16.14.0) - ref - thor (0.19.1) - thread_safe (0.3.5) - tilt (1.4.1) - timers (4.0.1) - hitimes - tzinfo (1.2.2) - thread_safe (~> 0.1) - uber (0.0.13) - uglifier (2.7.1) - execjs (>= 0.3.0) - json (>= 1.8.0) + execjs (~> 2.0) + fast_blank + fastimage (~> 2.0) + hamster (~> 3.0) + hashie (~> 3.4) + i18n (~> 1.6.0) + listen (~> 3.0) + memoist (~> 0.14) + padrino-helpers (~> 0.15.0) + parallel + rack (>= 1.4.5, < 3) + sassc (~> 2.0) + servolux + tilt (~> 2.0.9) + toml + uglifier (~> 3.0) + webrick + middleman-sprockets (4.1.1) + middleman-core (~> 4.0) + sprockets (>= 3.0) + middleman-syntax (3.3.0) + middleman-core (>= 3.2) + rouge (~> 3.2) + mini_portile2 (2.8.0) + minitest (5.17.0) + nokogiri (1.13.9) + mini_portile2 (~> 2.8.0) + racc (~> 1.4) + padrino-helpers (0.15.2) + i18n (>= 0.6.7, < 2) + padrino-support (= 0.15.2) + tilt (>= 1.4.1, < 3) + padrino-support (0.15.2) + parallel (1.22.1) + parslet (2.0.0) + public_suffix (5.0.1) + racc (1.6.0) + rack (2.2.6.2) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + redcarpet (3.6.0) + rexml (3.2.5) + rouge (3.30.0) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sassc (2.4.0) + ffi (~> 1.9) + servolux (0.13.0) + sprockets (3.7.2) + concurrent-ruby (~> 1.0) + rack (> 1, < 3) + temple (0.10.0) + thor (1.2.1) + tilt (2.0.11) + toml (0.3.0) + parslet (>= 1.8.0, < 3.0.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + uglifier (3.2.0) + execjs (>= 0.3.0, < 3) + webrick (1.8.1) + zeitwerk (2.6.0) PLATFORMS ruby DEPENDENCIES - middleman (~> 3.3.10) - middleman-autoprefixer (~> 2.4.4) - middleman-gh-pages (~> 0.0.3) - middleman-syntax (~> 2.0.0) - rake (~> 10.4.2) - redcarpet (~> 3.3.1) - rouge (~> 1.9.0) - therubyracer (~> 0.12.1) + middleman (~> 4.4) + middleman-autoprefixer (~> 3.0) + middleman-sprockets (~> 4.1) + middleman-syntax (~> 3.2) + nokogiri (~> 1.13.3) + redcarpet (~> 3.6.0) + rouge (~> 3.21) + sass + webrick + +RUBY VERSION + ruby 2.7.2p137 + +BUNDLED WITH + 2.2.22 diff --git a/LICENSE b/LICENSE index 5ceddf59f68..261eeb9e9f8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,201 @@ -Copyright 2008-2013 Concur Technologies, Inc. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Licensed under the Apache License, Version 2.0 (the "License"); you may -not use this file except in compliance with the License. You may obtain -a copy of the License at + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations -under the License. \ No newline at end of file + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index efb7e1eb8cd..c93bcb8a6e8 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,16 @@ -Slate -======== +# Gigapay API Documentation -[![Build Status](https://travis-ci.org/tripit/slate.svg?branch=master)](https://travis-ci.org/tripit/slate) [![Dependency Status](https://gemnasium.com/tripit/slate.png)](https://gemnasium.com/tripit/slate) +Based on [slate docs](https://github.com/slatedocs/slate). -Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. +### Running the development server -Screenshot of Example Documentation created with Slate - -*The example above was created with Slate. Check it out at [tripit.github.io/slate](http://tripit.github.io/slate).* - -Features ------------- - -* **Clean, intuitive design** — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even print. - -* **Everything on a single page** — gone are the days where your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy. - -* **Slate is just Markdown** — when you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks! - -* **Write code samples in multiple languages** — if your API has bindings in multiple programming languages, you easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown! - -* **Out-of-the-box syntax highlighting** for [almost 60 languages](http://rouge.jayferd.us/demo), no configuration required. - -* **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents. - -* **Let your users update your documentation for you** — by default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it's simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to, you're welcome to not use Github and host your docs elsewhere! - -Getting starting with Slate is super easy! Simply fork this repository, and then follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://tripit.github.io/slate). - - - -Getting Started with Slate ------------------------------- - -### Prerequisites - -You're going to need: - - - **Linux or OS X** — Windows may work, but is unsupported. - - **Ruby, version 1.9.3 or newer** - - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. - -### Getting Set Up - - 1. Fork this repository on Github. - 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` - 3. `cd slate` - 4. Install all dependencies: `bundle install` - 5. Start the test server: `bundle exec middleman server` - -Or use the included Dockerfile! (must install Docker first) - -```shell -docker build -t slate . -docker run -d -p 4567:4567 slate +``` +$ docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve ``` -You can now see the docs at . Whoa! That was fast! - -*Note: if you're using the Docker setup on OSX, the docs will be -availalable at the output of `boot2docker ip` instead of `localhost:4567`.* - -Now that Slate is all set up your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/tripit/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/tripit/slate/wiki/Deploying-Slate). - -Examples of Slate in the Wild ---------------------------------- - -* [Travis-CI's API docs](http://docs.travis-ci.com/api/) -* [Mozilla's localForage docs](http://mozilla.github.io/localForage/) -* [Mozilla Recroom](http://mozilla.github.io/recroom/) -* [ChaiOne Gameplan API docs](http://chaione.github.io/gameplanb2b/#introduction) -* [Drcaban's Build a Quine tutorial](http://drcabana.github.io/build-a-quine/#introduction) -* [PricePlow API docs](https://www.priceplow.com/api/documentation) -* [Emerging Threats API docs](http://apidocs.emergingthreats.net/) -* [Appium docs](http://appium.io/slate/en/master) -* [Golazon Developer](http://developer.golazon.com) -* [Dwolla API docs](https://docs.dwolla.com/) -* [RozpisyZapasu API docs](http://www.rozpisyzapasu.cz/dev/api/) -* [Codestar Framework Docs](http://codestarframework.com/documentation/) -* [Buddycloud API](http://buddycloud.com/api) -* [Crafty Clicks API](https://craftyclicks.co.uk/api/) -* [Paracel API Reference](http://paracel.io/docs/api_reference.html) -* [Switch Payments Documentation](http://switchpayments.com/docs/) & [API](http://switchpayments.com/developers/) -* [Coinbase API Reference](https://developers.coinbase.com/api) -* [Whispir.io API](https://whispir.github.io/api) -* [NASA API](https://data.nasa.gov/developer/external/planetary/) -* [CardPay API](https://developers.cardpay.com/) -* [IBM Cloudant](https://docs-testb.cloudant.com/content-review/_design/couchapp/index.html) -* [Bitrix basis components](http://bbc.bitrix.expert/) -* [viagogo API Documentation](http://developer.viagogo.net/) -* [Fidor Bank API Documentation](http://docs.fidor.de/) -* [Market Prophit API Documentation](http://developer.marketprophit.com/) - -(Feel free to add your site to this list in a pull request!) - -Need Help? Found a bug? --------------------- - -Just [submit a issue](https://github.com/tripit/slate/issues) to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes. - - -Contributors --------------------- - -Slate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com). - -Thanks to the following people who have submitted major pull requests: - -- [@chrissrogers](https://github.com/chrissrogers) -- [@bootstraponline](https://github.com/bootstraponline) -- [@realityking](https://github.com/realityking) - -Also, thanks to [Sauce Labs](http://saucelabs.com) for helping sponsor the project. +### Deploying -Special Thanks --------------------- -- [Middleman](https://github.com/middleman/middleman) -- [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js) -- [middleman-syntax](https://github.com/middleman/middleman-syntax) -- [middleman-gh-pages](https://github.com/neo/middleman-gh-pages) -- [Font Awesome](http://fortawesome.github.io/Font-Awesome/) +``` +$ docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build +$ ./deploy.sh --push-only +``` diff --git a/Rakefile b/Rakefile deleted file mode 100644 index 6a952e1e914..00000000000 --- a/Rakefile +++ /dev/null @@ -1,6 +0,0 @@ -require 'middleman-gh-pages' -require 'rake/clean' - -CLOBBER.include('build') - -task :default => [:build] diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 00000000000..8a9981b8f77 --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,47 @@ +Vagrant.configure(2) do |config| + config.vm.box = "ubuntu/focal64" + config.vm.network :forwarded_port, guest: 4567, host: 4567 + config.vm.provider "virtualbox" do |vb| + vb.memory = "2048" + end + + config.vm.provision "bootstrap", + type: "shell", + inline: <<-SHELL + # add nodejs v12 repository + curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - + + sudo apt-get update + sudo apt-get install -yq ruby ruby-dev + sudo apt-get install -yq pkg-config build-essential nodejs git libxml2-dev libxslt-dev + sudo apt-get autoremove -yq + gem install --no-document bundler + SHELL + + # add the local user git config to the vm + config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig" + + config.vm.provision "install", + type: "shell", + privileged: false, + inline: <<-SHELL + echo "==============================================" + echo "Installing app dependencies" + cd /vagrant + sudo gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" + bundle config build.nokogiri --use-system-libraries + bundle install + SHELL + + config.vm.provision "run", + type: "shell", + privileged: false, + run: "always", + inline: <<-SHELL + echo "==============================================" + echo "Starting up middleman at http://localhost:4567" + echo "If it does not come up, check the ~/middleman.log file for any error messages" + cd /vagrant + bundle exec middleman server --watcher-force-polling --watcher-latency=1 &> ~/middleman.log & + SHELL +end diff --git a/config.rb b/config.rb index 43bceaa5a43..6f8b677f617 100644 --- a/config.rb +++ b/config.rb @@ -1,3 +1,6 @@ +# Unique header generation +require './lib/unique_head.rb' + # Markdown set :markdown_engine, :redcarpet set :markdown, @@ -5,9 +8,11 @@ smartypants: true, disable_indented_code_blocks: true, prettify: true, + strikethrough: true, tables: true, with_toc_data: true, - no_intra_emphasis: true + no_intra_emphasis: true, + renderer: UniqueHeadCounter # Assets set :css_dir, 'stylesheets' @@ -17,6 +22,12 @@ # Activate the syntax highlighter activate :syntax +ready do + require './lib/monokai_sublime_slate.rb' + require './lib/multilang.rb' +end + +activate :sprockets activate :autoprefixer do |config| config.browsers = ['last 2 version', 'Firefox ESR'] @@ -30,9 +41,23 @@ # Build Configuration configure :build do + # We do want to hash woff and woff2 as there's a bug where woff2 will use + # woff asset hash which breaks things. Trying to use a combination of ignore and + # rewrite_ignore does not work as it conflicts weirdly with relative_assets. Disabling + # the .woff2 extension only does not work as .woff will still activate it so have to + # have both. See https://github.com/slatedocs/slate/issues/1171 for more details. + activate :asset_hash, :exts => app.config[:asset_extensions] - %w[.woff .woff2] + # If you're having trouble with Middleman hanging, commenting + # out the following two lines has been known to help activate :minify_css activate :minify_javascript - # activate :relative_assets - # activate :asset_hash # activate :gzip end + +# Deploy Configuration +# If you want Middleman to listen on a different port, you can set that below +set :port, 4567 + +helpers do + require './lib/toc_data.rb' +end diff --git a/deploy.sh b/deploy.sh new file mode 100755 index 00000000000..9dbd7db9c72 --- /dev/null +++ b/deploy.sh @@ -0,0 +1,226 @@ +#!/usr/bin/env bash +set -o errexit #abort if any command fails +me=$(basename "$0") + +help_message="\ +Usage: $me [-c FILE] [] +Deploy generated files to a git branch. + +Options: + + -h, --help Show this help information. + -v, --verbose Increase verbosity. Useful for debugging. + -e, --allow-empty Allow deployment of an empty directory. + -m, --message MESSAGE Specify the message used when committing on the + deploy branch. + -n, --no-hash Don't append the source commit's hash to the deploy + commit's message. + --source-only Only build but not push + --push-only Only push but not build +" + + +run_build() { + bundle exec middleman build --clean +} + +parse_args() { + # Set args from a local environment file. + if [ -e ".env" ]; then + source .env + fi + + # Parse arg flags + # If something is exposed as an environment variable, set/overwrite it + # here. Otherwise, set/overwrite the internal variable instead. + while : ; do + if [[ $1 = "-h" || $1 = "--help" ]]; then + echo "$help_message" + exit 0 + elif [[ $1 = "-v" || $1 = "--verbose" ]]; then + verbose=true + shift + elif [[ $1 = "-e" || $1 = "--allow-empty" ]]; then + allow_empty=true + shift + elif [[ ( $1 = "-m" || $1 = "--message" ) && -n $2 ]]; then + commit_message=$2 + shift 2 + elif [[ $1 = "-n" || $1 = "--no-hash" ]]; then + GIT_DEPLOY_APPEND_HASH=false + shift + elif [[ $1 = "--source-only" ]]; then + source_only=true + shift + elif [[ $1 = "--push-only" ]]; then + push_only=true + shift + else + break + fi + done + + if [ ${source_only} ] && [ ${push_only} ]; then + >&2 echo "You can only specify one of --source-only or --push-only" + exit 1 + fi + + # Set internal option vars from the environment and arg flags. All internal + # vars should be declared here, with sane defaults if applicable. + + # Source directory & target branch. + deploy_directory=build + deploy_branch=gh-pages + + #if no user identity is already set in the current git environment, use this: + default_username=${GIT_DEPLOY_USERNAME:-deploy.sh} + default_email=${GIT_DEPLOY_EMAIL:-} + + #repository to deploy to. must be readable and writable. + repo=origin + + #append commit hash to the end of message by default + append_hash=${GIT_DEPLOY_APPEND_HASH:-true} +} + +main() { + enable_expanded_output + + if ! git diff --exit-code --quiet --cached; then + echo Aborting due to uncommitted changes in the index >&2 + return 1 + fi + + commit_title=`git log -n 1 --format="%s" HEAD` + commit_hash=` git log -n 1 --format="%H" HEAD` + + #default commit message uses last title if a custom one is not supplied + if [[ -z $commit_message ]]; then + commit_message="publish: $commit_title" + fi + + #append hash to commit message unless no hash flag was found + if [ $append_hash = true ]; then + commit_message="$commit_message"$'\n\n'"generated from commit $commit_hash" + fi + + previous_branch=`git rev-parse --abbrev-ref HEAD` + + if [ ! -d "$deploy_directory" ]; then + echo "Deploy directory '$deploy_directory' does not exist. Aborting." >&2 + return 1 + fi + + # must use short form of flag in ls for compatibility with macOS and BSD + if [[ -z `ls -A "$deploy_directory" 2> /dev/null` && -z $allow_empty ]]; then + echo "Deploy directory '$deploy_directory' is empty. Aborting. If you're sure you want to deploy an empty tree, use the --allow-empty / -e flag." >&2 + return 1 + fi + + if git ls-remote --exit-code $repo "refs/heads/$deploy_branch" ; then + # deploy_branch exists in $repo; make sure we have the latest version + + disable_expanded_output + git fetch --force $repo $deploy_branch:$deploy_branch + enable_expanded_output + fi + + # check if deploy_branch exists locally + if git show-ref --verify --quiet "refs/heads/$deploy_branch" + then incremental_deploy + else initial_deploy + fi + + restore_head +} + +initial_deploy() { + git --work-tree "$deploy_directory" checkout --orphan $deploy_branch + git --work-tree "$deploy_directory" add --all + commit+push +} + +incremental_deploy() { + #make deploy_branch the current branch + git symbolic-ref HEAD refs/heads/$deploy_branch + #put the previously committed contents of deploy_branch into the index + git --work-tree "$deploy_directory" reset --mixed --quiet + git --work-tree "$deploy_directory" add --all + + set +o errexit + diff=$(git --work-tree "$deploy_directory" diff --exit-code --quiet HEAD --)$? + set -o errexit + case $diff in + 0) echo No changes to files in $deploy_directory. Skipping commit.;; + 1) commit+push;; + *) + echo git diff exited with code $diff. Aborting. Staying on branch $deploy_branch so you can debug. To switch back to main, use: git symbolic-ref HEAD refs/heads/main && git reset --mixed >&2 + return $diff + ;; + esac +} + +commit+push() { + set_user_id + git --work-tree "$deploy_directory" commit -m "$commit_message" + + disable_expanded_output + #--quiet is important here to avoid outputting the repo URL, which may contain a secret token + git push --quiet $repo $deploy_branch + enable_expanded_output +} + +#echo expanded commands as they are executed (for debugging) +enable_expanded_output() { + if [ $verbose ]; then + set -o xtrace + set +o verbose + fi +} + +#this is used to avoid outputting the repo URL, which may contain a secret token +disable_expanded_output() { + if [ $verbose ]; then + set +o xtrace + set -o verbose + fi +} + +set_user_id() { + if [[ -z `git config user.name` ]]; then + git config user.name "$default_username" + fi + if [[ -z `git config user.email` ]]; then + git config user.email "$default_email" + fi +} + +restore_head() { + if [[ $previous_branch = "HEAD" ]]; then + #we weren't on any branch before, so just set HEAD back to the commit it was on + git update-ref --no-deref HEAD $commit_hash $deploy_branch + else + git symbolic-ref HEAD refs/heads/$previous_branch + fi + + git reset --mixed +} + +filter() { + sed -e "s|$repo|\$repo|g" +} + +sanitize() { + "$@" 2> >(filter 1>&2) | filter +} + +parse_args "$@" + +if [[ ${source_only} ]]; then + run_build +elif [[ ${push_only} ]]; then + main "$@" +else + run_build + main "$@" +fi diff --git a/lib/monokai_sublime_slate.rb b/lib/monokai_sublime_slate.rb new file mode 100644 index 00000000000..cd2de33172d --- /dev/null +++ b/lib/monokai_sublime_slate.rb @@ -0,0 +1,95 @@ +# -*- coding: utf-8 -*- # +# frozen_string_literal: true + +# this is based on https://github.com/rouge-ruby/rouge/blob/master/lib/rouge/themes/monokai_sublime.rb +# but without the added background, and changed styling for JSON keys to be soft_yellow instead of white + +module Rouge + module Themes + class MonokaiSublimeSlate < CSSTheme + name 'monokai.sublime.slate' + + palette :black => '#000000' + palette :bright_green => '#a6e22e' + palette :bright_pink => '#f92672' + palette :carmine => '#960050' + palette :dark => '#49483e' + palette :dark_grey => '#888888' + palette :dark_red => '#aa0000' + palette :dimgrey => '#75715e' + palette :emperor => '#555555' + palette :grey => '#999999' + palette :light_grey => '#aaaaaa' + palette :light_violet => '#ae81ff' + palette :soft_cyan => '#66d9ef' + palette :soft_yellow => '#e6db74' + palette :very_dark => '#1e0010' + palette :whitish => '#f8f8f2' + palette :orange => '#f6aa11' + palette :white => '#ffffff' + + style Generic::Heading, :fg => :grey + style Literal::String::Regex, :fg => :orange + style Generic::Output, :fg => :dark_grey + style Generic::Prompt, :fg => :emperor + style Generic::Strong, :bold => false + style Generic::Subheading, :fg => :light_grey + style Name::Builtin, :fg => :orange + style Comment::Multiline, + Comment::Preproc, + Comment::Single, + Comment::Special, + Comment, :fg => :dimgrey + style Error, + Generic::Error, + Generic::Traceback, :fg => :carmine + style Generic::Deleted, + Generic::Inserted, + Generic::Emph, :fg => :dark + style Keyword::Constant, + Keyword::Declaration, + Keyword::Reserved, + Name::Constant, + Keyword::Type, :fg => :soft_cyan + style Literal::Number::Float, + Literal::Number::Hex, + Literal::Number::Integer::Long, + Literal::Number::Integer, + Literal::Number::Oct, + Literal::Number, + Literal::String::Char, + Literal::String::Escape, + Literal::String::Symbol, :fg => :light_violet + style Literal::String::Doc, + Literal::String::Double, + Literal::String::Backtick, + Literal::String::Heredoc, + Literal::String::Interpol, + Literal::String::Other, + Literal::String::Single, + Literal::String, :fg => :soft_yellow + style Name::Attribute, + Name::Class, + Name::Decorator, + Name::Exception, + Name::Function, :fg => :bright_green + style Name::Variable::Class, + Name::Namespace, + Name::Entity, + Name::Builtin::Pseudo, + Name::Variable::Global, + Name::Variable::Instance, + Name::Variable, + Text::Whitespace, + Text, + Name, :fg => :white + style Name::Label, :fg => :bright_pink + style Operator::Word, + Name::Tag, + Keyword, + Keyword::Namespace, + Keyword::Pseudo, + Operator, :fg => :bright_pink + end + end + end diff --git a/lib/multilang.rb b/lib/multilang.rb new file mode 100644 index 00000000000..36fbe5b1f07 --- /dev/null +++ b/lib/multilang.rb @@ -0,0 +1,16 @@ +module Multilang + def block_code(code, full_lang_name) + if full_lang_name + parts = full_lang_name.split('--') + rouge_lang_name = (parts) ? parts[0] : "" # just parts[0] here causes null ref exception when no language specified + super(code, rouge_lang_name).sub("highlight #{rouge_lang_name}") do |match| + match + " tab-" + full_lang_name + end + else + super(code, full_lang_name) + end + end +end + +require 'middleman-core/renderers/redcarpet' +Middleman::Renderers::MiddlemanRedcarpetHTML.send :include, Multilang diff --git a/lib/nesting_unique_head.rb b/lib/nesting_unique_head.rb new file mode 100644 index 00000000000..01278371c17 --- /dev/null +++ b/lib/nesting_unique_head.rb @@ -0,0 +1,22 @@ +# Nested unique header generation +require 'middleman-core/renderers/redcarpet' + +class NestingUniqueHeadCounter < Middleman::Renderers::MiddlemanRedcarpetHTML + def initialize + super + @@headers_history = {} if !defined?(@@headers_history) + end + + def header(text, header_level) + friendly_text = text.gsub(/<[^>]*>/,"").parameterize + @@headers_history[header_level] = text.parameterize + + if header_level > 1 + for i in (header_level - 1).downto(1) + friendly_text.prepend("#{@@headers_history[i]}-") if @@headers_history.key?(i) + end + end + + return "#{text}" + end +end diff --git a/lib/toc_data.rb b/lib/toc_data.rb new file mode 100644 index 00000000000..4a04efee26f --- /dev/null +++ b/lib/toc_data.rb @@ -0,0 +1,31 @@ +require 'nokogiri' + +def toc_data(page_content) + html_doc = Nokogiri::HTML::DocumentFragment.parse(page_content) + + # get a flat list of headers + headers = [] + html_doc.css('h1, h2, h3').each do |header| + headers.push({ + id: header.attribute('id').to_s, + content: header.children, + title: header.children.to_s.gsub(/<[^>]*>/, ''), + level: header.name[1].to_i, + children: [] + }) + end + + [3,2].each do |header_level| + header_to_nest = nil + headers = headers.reject do |header| + if header[:level] == header_level + header_to_nest[:children].push header if header_to_nest + true + else + header_to_nest = header if header[:level] < header_level + false + end + end + end + headers +end diff --git a/lib/unique_head.rb b/lib/unique_head.rb new file mode 100644 index 00000000000..d42bab2aa9d --- /dev/null +++ b/lib/unique_head.rb @@ -0,0 +1,24 @@ +# Unique header generation +require 'middleman-core/renderers/redcarpet' +require 'digest' +class UniqueHeadCounter < Middleman::Renderers::MiddlemanRedcarpetHTML + def initialize + super + @head_count = {} + end + def header(text, header_level) + friendly_text = text.gsub(/<[^>]*>/,"").parameterize + if friendly_text.strip.length == 0 + # Looks like parameterize removed the whole thing! It removes many unicode + # characters like Chinese and Russian. To get a unique URL, let's just + # URI escape the whole header + friendly_text = Digest::SHA1.hexdigest(text)[0,10] + end + @head_count[friendly_text] ||= 0 + @head_count[friendly_text] += 1 + if @head_count[friendly_text] > 1 + friendly_text += "-#{@head_count[friendly_text]}" + end + return "#{text}" + end +end diff --git a/slate.sh b/slate.sh new file mode 100755 index 00000000000..d6f1bd9d5f1 --- /dev/null +++ b/slate.sh @@ -0,0 +1,248 @@ +#!/usr/bin/env bash +set -o errexit #abort if any command fails + +me=$(basename "$0") + +help_message="\ +Usage: $me [] [] +Run commands related to the slate process. + +Commands: + + serve Run the middleman server process, useful for + development. + build Run the build process. + deploy Will build and deploy files to branch. Use + --no-build to only deploy. + +Global Options: + + -h, --help Show this help information. + -v, --verbose Increase verbosity. Useful for debugging. + +Deploy options: + -e, --allow-empty Allow deployment of an empty directory. + -m, --message MESSAGE Specify the message used when committing on the + deploy branch. + -n, --no-hash Don't append the source commit's hash to the deploy + commit's message. + --no-build Do not build the source files. +" + + +run_serve() { + exec bundle exec middleman serve --watcher-force-polling +} + +run_build() { + bundle exec middleman build --clean --watcher-disable +} + +parse_args() { + # Set args from a local environment file. + if [ -e ".env" ]; then + source .env + fi + + command= + + # Parse arg flags + # If something is exposed as an environment variable, set/overwrite it + # here. Otherwise, set/overwrite the internal variable instead. + while : ; do + if [[ $1 = "-h" || $1 = "--help" ]]; then + echo "$help_message" + exit 0 + elif [[ $1 = "-v" || $1 = "--verbose" ]]; then + verbose=true + shift + elif [[ $1 = "-e" || $1 = "--allow-empty" ]]; then + allow_empty=true + shift + elif [[ ( $1 = "-m" || $1 = "--message" ) && -n $2 ]]; then + commit_message=$2 + shift 2 + elif [[ $1 = "-n" || $1 = "--no-hash" ]]; then + GIT_DEPLOY_APPEND_HASH=false + shift + elif [[ $1 = "--no-build" ]]; then + no_build=true + shift + elif [[ $1 = "serve" || $1 = "build" || $1 = "deploy" ]]; then + if [ ! -z "${command}" ]; then + >&2 echo "You can only specify one command." + exit 1 + fi + command=$1 + shift + elif [ -z $1 ]; then + break + fi + done + + if [ -z "${command}" ]; then + >&2 echo "Command not specified." + exit 1 + fi + + # Set internal option vars from the environment and arg flags. All internal + # vars should be declared here, with sane defaults if applicable. + + # Source directory & target branch. + deploy_directory=build + deploy_branch=gh-pages + + #if no user identity is already set in the current git environment, use this: + default_username=${GIT_DEPLOY_USERNAME:-deploy.sh} + default_email=${GIT_DEPLOY_EMAIL:-} + + #repository to deploy to. must be readable and writable. + repo=origin + + #append commit hash to the end of message by default + append_hash=${GIT_DEPLOY_APPEND_HASH:-true} +} + +main() { + enable_expanded_output + + if ! git diff --exit-code --quiet --cached; then + echo Aborting due to uncommitted changes in the index >&2 + return 1 + fi + + commit_title=`git log -n 1 --format="%s" HEAD` + commit_hash=` git log -n 1 --format="%H" HEAD` + + #default commit message uses last title if a custom one is not supplied + if [[ -z $commit_message ]]; then + commit_message="publish: $commit_title" + fi + + #append hash to commit message unless no hash flag was found + if [ $append_hash = true ]; then + commit_message="$commit_message"$'\n\n'"generated from commit $commit_hash" + fi + + previous_branch=`git rev-parse --abbrev-ref HEAD` + + if [ ! -d "$deploy_directory" ]; then + echo "Deploy directory '$deploy_directory' does not exist. Aborting." >&2 + return 1 + fi + + # must use short form of flag in ls for compatibility with macOS and BSD + if [[ -z `ls -A "$deploy_directory" 2> /dev/null` && -z $allow_empty ]]; then + echo "Deploy directory '$deploy_directory' is empty. Aborting. If you're sure you want to deploy an empty tree, use the --allow-empty / -e flag." >&2 + return 1 + fi + + if git ls-remote --exit-code $repo "refs/heads/$deploy_branch" ; then + # deploy_branch exists in $repo; make sure we have the latest version + + disable_expanded_output + git fetch --force $repo $deploy_branch:$deploy_branch + enable_expanded_output + fi + + # check if deploy_branch exists locally + if git show-ref --verify --quiet "refs/heads/$deploy_branch" + then incremental_deploy + else initial_deploy + fi + + restore_head +} + +initial_deploy() { + git --work-tree "$deploy_directory" checkout --orphan $deploy_branch + git --work-tree "$deploy_directory" add --all + commit+push +} + +incremental_deploy() { + #make deploy_branch the current branch + git symbolic-ref HEAD refs/heads/$deploy_branch + #put the previously committed contents of deploy_branch into the index + git --work-tree "$deploy_directory" reset --mixed --quiet + git --work-tree "$deploy_directory" add --all + + set +o errexit + diff=$(git --work-tree "$deploy_directory" diff --exit-code --quiet HEAD --)$? + set -o errexit + case $diff in + 0) echo No changes to files in $deploy_directory. Skipping commit.;; + 1) commit+push;; + *) + echo git diff exited with code $diff. Aborting. Staying on branch $deploy_branch so you can debug. To switch back to main, use: git symbolic-ref HEAD refs/heads/main && git reset --mixed >&2 + return $diff + ;; + esac +} + +commit+push() { + set_user_id + git --work-tree "$deploy_directory" commit -m "$commit_message" + + disable_expanded_output + #--quiet is important here to avoid outputting the repo URL, which may contain a secret token + git push --quiet $repo $deploy_branch + enable_expanded_output +} + +#echo expanded commands as they are executed (for debugging) +enable_expanded_output() { + if [ $verbose ]; then + set -o xtrace + set +o verbose + fi +} + +#this is used to avoid outputting the repo URL, which may contain a secret token +disable_expanded_output() { + if [ $verbose ]; then + set +o xtrace + set -o verbose + fi +} + +set_user_id() { + if [[ -z `git config user.name` ]]; then + git config user.name "$default_username" + fi + if [[ -z `git config user.email` ]]; then + git config user.email "$default_email" + fi +} + +restore_head() { + if [[ $previous_branch = "HEAD" ]]; then + #we weren't on any branch before, so just set HEAD back to the commit it was on + git update-ref --no-deref HEAD $commit_hash $deploy_branch + else + git symbolic-ref HEAD refs/heads/$previous_branch + fi + + git reset --mixed +} + +filter() { + sed -e "s|$repo|\$repo|g" +} + +sanitize() { + "$@" 2> >(filter 1>&2) | filter +} + +parse_args "$@" + +if [ "${command}" = "serve" ]; then + run_serve +elif [[ "${command}" = "build" ]]; then + run_build +elif [[ ${command} = "deploy" ]]; then + if [[ ${no_build} != true ]]; then + run_build + fi + main "$@" +fi diff --git a/source/fonts/slate.eot b/source/fonts/slate.eot old mode 100755 new mode 100644 diff --git a/source/fonts/slate.svg b/source/fonts/slate.svg old mode 100755 new mode 100644 diff --git a/source/fonts/slate.ttf b/source/fonts/slate.ttf old mode 100755 new mode 100644 diff --git a/source/fonts/slate.woff b/source/fonts/slate.woff old mode 100755 new mode 100644 diff --git a/source/fonts/slate.woff2 b/source/fonts/slate.woff2 old mode 100755 new mode 100644 diff --git a/source/images/events.svg b/source/images/events.svg new file mode 100644 index 00000000000..67b8f099a96 --- /dev/null +++ b/source/images/events.svg @@ -0,0 +1,21 @@ + + +EventsPayout.acceptedPayout.notifiedInvoice.paidPayout.createdInvoice.createdEmployee.verifiedEmployee.notifiedEmployee.createdPayInvoiceDisbursePayoutCreatePayoutAcceptPayoutNotifyEmployeeVerify workpermitsUpload workpermitsCreateEmployeeNotifyEmployeeGiggerGigapayClient \ No newline at end of file diff --git a/source/images/favicon.ico b/source/images/favicon.ico new file mode 100644 index 00000000000..58d28cd54d4 Binary files /dev/null and b/source/images/favicon.ico differ diff --git a/source/images/logo.png b/source/images/logo.png index fa1f13da819..68a478fae36 100644 Binary files a/source/images/logo.png and b/source/images/logo.png differ diff --git a/source/images/logo.svg b/source/images/logo.svg new file mode 100644 index 00000000000..6bed7c8784e --- /dev/null +++ b/source/images/logo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/source/includes/_employees.md b/source/includes/_employees.md new file mode 100644 index 00000000000..f15f89a6d67 --- /dev/null +++ b/source/includes/_employees.md @@ -0,0 +1,555 @@ +# Employees + +An Employee is an individual performing tasks within your organization, employed or sub-contracted by Gigapay. To add an Employee to your +organization you can create an Employee object. The Employee will be notified and Gigapay will verify their identity +and working permits. + +### The Employee object + +> An example Employee object: + +```json +{ + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": "2019-05-22T10:32:37.846274Z", + "claimed_at": "2019-05-23T11:56:41.123721Z", + "verified_at": "2019-05-23T11:57:03.742345Z", + "invitation_code": null +} +``` + +| Attribute | Description | +| ------------------ | --------------------------------------------------------------------------------- | +| `id` | Unique identifier for the object. | +| `name` | The full name of the Employee. | +| `email` | Email address of the Employee. | +| `country` | Employee's country of residence. ISO-3166 country code. | +| `cellphone_number` | The Employees cellphone number, including country code. | +| `metadata` | JSON-encoded metadata. | +| `created_at` | Time at which the Employee was created at. Displayed as ISO 8601 string. | +| `notified_at` | Time at which the Employee was notified. Displayed as ISO 8601 string. | +| `claimed_at` | Time at which the Employee consumed the magic link. Displayed as ISO 8601 string. | +| `verified_at` | Time when the Employee was verified. Displayed as ISO 8601 string. | +| `invitation_code` | 8-digit alphanumeric uppercase code available when an employee is invited but not yet claimed. Users can use this code to create a magic link to claim the employee. | + + + + +## List All Employees + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/employees/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/employees/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/employees/?page=2", + "results": [ + { + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": "2019-05-22T10:32:37.846274Z", + "claimed_at": "2019-05-23T11:56:41.123721Z", + "verified_at": "2019-05-23T11:57:03.742345Z", + "invitation_code": null + }, { + "id": "1848", + "name": "Joakim Olovsson", + "email": "joakim@gigapay.co", + "cellphone_number": "+46703000001", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-23T14:45:12.545271Z", + "notified_at": "2019-05-23T14:45:13.374627Z", + "claimed_at": null, + "verified_at": null, + "invitation_code": "A1B2C3D4" + } + ] +} +``` + +This endpoint retrieves all Employees. + +### HTTP Request + +`GET https://api.gigapay.se/v2/employees/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### Query Parameters + +| Parameter | Default | Description | +|---------------------------|---------|----------------------------------------------------| +| `page` | 1 | Which page to return. | +| `page_size` | 25 | The number of Employees per page. | +| `created_at` | | Timestamp filter. | +| `notified_at` | | Timestamp filter. | +| `claimed_at` | | Timestamp filter. | +| `verified_at` | | Timestamp filter. | +| `search` | | Filter by part of name, email or cellphone number. | + +## Register an Employee + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/employees/', + json={ + 'id': 1847, + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000001', + 'email': 'albin@mail.com', + 'country': 'SWE' + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 1847, "name": "Albin Lindskog", "cellphone_number": "+4670000001", "email": "albin@mail.com", "country": "SWE"}' https://api.gigapay.se/v2/employees/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/", { + method: "POST", + body: JSON.stringify({ + name: "Albin Lindskog", + cellphone_number: "+4670000000", + email: "albin@mail.com", + country: "SWE" + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "14585989-9a6c-4f05-b251-69e38e85d324", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": null, + "claimed_at": null, + "verified_at": null, + "invitation_code": "A1B2C3D4" +} +``` + +This endpoint registers an Employee. The Employee will be notified with the `invitation_code` that can be used to sign up in Gigapay and accept your invitation. + +### HTTP Request + +`POST https://api.gigapay.se/v2/employees/` + +### Headers + +| Parameter | Required | Description | +|-------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | +| `Idempotency-key` | False | Idempotency key. | + +### Body Parameters + +| Parameter | Type | Required | Default | Notes | +| ------------------ | ------ | -------- | ------- | --------------------------------------------------------------- | +| `id` | String | False | uuid4() | Unique per [Integration](#integrations). | +| `name` | String | True | | | +| `email` | String | True | | | +| `country` | String | True | | ISO-3166 country code where the employee is living and working. | +| `cellphone_number` | String | False | null | | +| `metadata` | Object | False | {} | | + +## Retrieve an Employee + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/employees/1847/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/employees/1847/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/1847/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": "2019-05-22T10:32:37.846274Z", + "claimed_at": "2019-05-23T11:56:41.123721Z", + "verified_at": "2019-05-23T11:57:03.742345Z", + "invitation_code": null +} +``` + +This endpoint retrieves an employee. + +### HTTP Request + +`GET https://api.gigapay.se/v2/employees/:id/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +|-----------|----------|-----------------------------------| +| `id` | True | Unique identifier for the object. | + +## Update an Employee + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/employees/1847/', + json={ + 'id': 8472, + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 8472}' https://api.gigapay.se/v2/employees/1847/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/1847/", { + method: "PATCH", + body: JSON.stringify({id: 8472}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "8472", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": "2019-05-22T10:32:37.846274Z", + "claimed_at": "2019-05-23T11:56:41.123721Z", + "verified_at": "2019-05-23T11:57:03.742345Z", + "invitation_code": null +} +``` + +This endpoint updates an Employee. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/employees/:id/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +|-----------|----------|-----------------------------------| +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +| Parameter | Type | Required | Default | Notes | +|--------------------|--------|----------|-----------------|-----------------------------------------------------------------| +| `id` | String | False | Previous value. | Unique per [Integration](#integrations). | +| `name` | String | False | Previous value. | | +| `email` | String | False | Previous value. | | +| `country` | String | False | Previous value. | ISO-3166 country code where the employee is living and working. | +| `cellphone_number` | False | False | Previous value. | | +| `metadata` | Object | False | Previous value. | | + +## Replace an Employee + +```python +import requests + +response = requests.put( + 'https://api.gigapay.se/v2/employees/8472/', + json={ + 'id': 1847, + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000001', + 'email': 'albin@mail.com', + 'country': 'SWE' + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 1847, "name": "Albin Lindskog", "cellphone_number": "+4670000001", "email": "albin@mail.com", "country": "SWE"}' https://api.gigapay.se/v2/employees/8472/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/8472/", { + method: "PUT", + body: JSON.stringify({ + id: 1847, + name: "Albin Lindskog", + cellphone_number: "+4670000000", + email: "albin@mail.com", + country: "SWE" + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@gigapay.co", + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": null, + "claimed_at": null, + "verified_at": null, + "invitation_code": null +} +``` + +This endpoint replaces an Employee. + +### HTTP Request + +`PUT https://api.gigapay.se/v2/employees/:id/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +|-----------|----------|-----------------------------------| +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +| Parameter | Type | Required | Default | Description | +| ------------------ | ------ | -------- | ------- | --------------------------------------------------------------- | +| `id` | String | False | uuid4() | Unique per [Integration](#integrations). | +| `name` | String | True | | | +| `email` | String | True | | | +| `country` | String | True | | ISO-3166 country code where the employee is living and working. | +| `cellphone_number` | String | False | null | | +| `metadata` | Object | False | {} | | + +## Delete a Employee + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/employees/1847/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/employees/1847/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/1847/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns an empty response. + + +This endpoint deletes an Employee. You can not delete an Employee after a Payout has been registered to it. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/employees/:id/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +|-----------|----------|-----------------------------------| +| `id` | True | Unique identifier for the object. | + +## Resend an Invitation + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/employees/1847/resend/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b', + 'Idempotency-key': 'ac4beffd-79b0-4561-b16c-846a9600b168' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -H 'Idempotency-key: ac4beffd-79b0-4561-b16c-846a9600b168' https://api.gigapay.se/v2/employees/1847/resend/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/1847/resend/", { + method: "PATCH", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + "Idempotency-key": "ac4beffd-79b0-4561-b16c-846a9600b168" + } +}) +``` + +> The above command returns an empty response. + + +This endpoint resends a notification with an invitation code. After resending, you need to wait at least 24 hours before resending again. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/employees/:id/resend/` + +### Headers + +| Parameter | Required | Description | +|-------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | +| `Idempotency-key` | False | Idempotency key. | + +### URL Parameters + +| Parameter | Required | Description | +|-----------|----------|-----------------------------------| +| `id` | True | Unique identifier for the object. | diff --git a/source/includes/_errors.md b/source/includes/_errors.md deleted file mode 100644 index 56cffb34d22..00000000000 --- a/source/includes/_errors.md +++ /dev/null @@ -1,20 +0,0 @@ -# Errors - - - -The Kittn API uses the following error codes: - - -Error Code | Meaning ----------- | ------- -400 | Bad Request -- Your request sucks -401 | Unauthorized -- Your API key is wrong -403 | Forbidden -- The kitten requested is hidden for administrators only -404 | Not Found -- The specified kitten could not be found -405 | Method Not Allowed -- You tried to access a kitten with an invalid method -406 | Not Acceptable -- You requested a format that isn't json -410 | Gone -- The kitten requested has been removed from our servers -418 | I'm a teapot -429 | Too Many Requests -- You're requesting too many kittens! Slow down! -500 | Internal Server Error -- We had a problem with our server. Try again later. -503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later. diff --git a/source/includes/_integrations.md b/source/includes/_integrations.md new file mode 100644 index 00000000000..960ba23cf91 --- /dev/null +++ b/source/includes/_integrations.md @@ -0,0 +1,436 @@ +# Integrations + +Integrations are the parent object of all other objects in the Gigapay API. All other objects are separated per +Integration, when operating on these objects you thus need to specify which integration you are acting as by providing +the `Integration-ID` header. + + + + +### The Integration object + +> An example Integration object: + +```json +{ + "id": "1", + "name": "Zerebra AB", + "type": 1, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/zerebra_logo.png", + "metadata": {}, + "email": "faktura@zerebra.com", + "recipient": "Zerebra AB", + "address_line_1": "Svartmangatan 18", + "address_line_2": null, + "zip_code": "11129" +} +``` + +| Attribute | Description | +| ----------------- | -------------------------------------------------- | +| `id` | Unique identifier for the object. | +| `name` | Name of integration, presented to Employees. | +| `type` | Type of integrations. | +| `logo` | Image of logo to use, presented to Employees. | +| `metadata` | JSON-encoded metadata. | +| `email` | Email address to send invoices to. | +| `recipient` | Name of recipient written on invoices. | +| `address_line_1` | Address line 1 written on invoices. | +| `address_line_2` | Address line 2 written on invoices. | +| `zip_code` | Zip code written on invoices | +| `city` | City written on invoices. | + + +## List All Integrations + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/integrations/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/integrations/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/integrations/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/integrations/?page=2", + "results": [ + { + "id": "1", + "name": "Zerebra AB", + "type": 1, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/zerebra_logo.png", + "metadata": {}, + "email": "faktura@zerebra.com", + "recipient": "Zerebra AB", + "address_line_1": "Svartmangatan 18", + "address_line_2": null, + "zip_code": "11129" + }, { + "id": "1", + "name": "Zerebra AB Gig", + "type": 3, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/zerebra_logo.png", + "metadata": {}, + "email": "faktura+gig@zerebra.com", + "recipient": "Zerebra AB", + "address_line_1": "Svartmangatan 18", + "address_line_2": null, + "zip_code": "11129" + }, + ] +} +``` + +This endpoint retrieves all integrations. + +### HTTP Request + +`GET https://api.gigapay.se/v2/integrations/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +`page` | 1 | Which page to return. +`page_size` | 25 | The number of Integrations per page. +`type` | | Filter based on type. + + + + + + + +## Retrieve an Integration + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/integrations/846291712/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/integrations/846291712/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/integrations/846291712/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "846291712", + "name": "Pinestreet Tech", + "type": 3, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/pinestreet_logo.png", + "metadata": {}, + "email": "albin@pinestreet.tech", + "recipient": "Pinestreet Technology AB", + "address_line_1": "Malmvägen 8", + "address_line_2": null, + "zip_code": "14171", + "city": "Segeltorp" +} +``` + +This endpoint retrieves an Integration. + +### HTTP Request + +`GET https://api.gigapay.se/v2/integrations/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + + + + +## Update an Integration + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/integrations/846291712/', + json={ + 'email': 'invoice@pinestreet.tech' + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -d '{"email": "invoice@pinestreet.tech"} https://api.gigapay.se/v2/integrations/846291712/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/integrations/846291712/", { + method: "PATCH", + body: JSON.stringify({'email': 'invoice@pinestreet.tech'}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "846291712", + "name": "Pinestreet Tech", + "type": 3, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/pinestreet_logo.png", + "metadata": {}, + "email": "albin@pinestreet.tech", + "recipient": "Pinestreet Technology AB", + "address_line_1": "Malmvägen 8", + "address_line_2": null, + "zip_code": "14171", + "city": "Segeltorp" +} +``` + +This endpoint updates an integration. You may not update Integrations of type 2. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/integrations/:id/` + +This endpoints supports both JSON and multipart/form-data encoded requests, to facilitate uploading a logo file. + +Only examples with JSON-encoded payload and base64-encoded images are provided, though. + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | Previous value | Globally unique. +`name` | String | False | Previous value | +`logo` | Image | False | Previous value | base64 or multipart/form-data encoded image file. +`metadata` | Object | False | Previous value | +`email` | String | False | Previous value | +`recipient` | String | False | Previous value | +`address_line_1` | Object | False | Previous value | +`address_line_2` | String | False | Previous value | +`zip_code` | String | False | Previous value | +`city` | String | False | Previous value | + + + + +## Replace an Integration + +```python +import requests + +response = requests.put( + 'https://api.gigapay.se/v2/integrations/846291712/', + json={ + "address_line_1": "Malmvägen 8", + "city": "Segeltorp", + "email": "albin@pinestreet.tech", + "id": "846291712", + "logo": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=", + "name": "Pinestreet Tech", + "recipient": "Pinestreet Technology AB", + "zip_code": "14171", + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -d '{"address_line_1": "Malmv\u00e4gen 8", "city": "Segeltorp", "email": "albin@pinestreet.tech", "id": "846291712", "logo": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=", "name": "Pinestreet Tech", "recipient": "Pinestreet Technology AB", "zip_code": "14171"}' https://api.gigapay.se/v2/integrations/846291712/``` +``` + +```javascript +fetch("https://api.gigapay.se/v2/integrations/846291712/", { + method: "PUT", + body: JSON.stringify({ + address_line_1: "Malmvägen 8", + city: "Segeltorp", + email: "albin@pinestreet.tech", + id: "846291712", + logo: "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=", + name: "Pinestreet Tech", + recipient: "Pinestreet Technology AB", + zip_code: "14171", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "846291712", + "name": "Pinestreet Tech", + "type": 3, + "logo": "https://gigapay.ams3.digitaloceanspaces.com/gigapay/pinestreet_logo.png", + "metadata": {}, + "email": "albin@pinestreet.tech", + "recipient": "Pinestreet Technology AB", + "address_line_1": "Malmvägen 8", + "address_line_2": null, + "zip_code": "14171", + "city": "Segeltorp" +} +``` + +This endpoint replaces an Integration. You may not replace Integrations of type 2. + +### HTTP Request + +`PUT https://api.gigapay.se/v2/integrations/:id/` + +This endpoints supports both JSON and multipart/form-data encoded requests, to facilitate uploading a logo file. + +Only examples with JSON-encoded payload and base64-encoded images are provided, though. + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Globally unique. +`name` | String | True | | +`logo` | Image | False | null | base64 or multipart/form-data encoded image file. +`metadata` | Object | False | {} | +`email` | String | True | | +`recipient` | String | True | | +`address_line_1` | Object | True | | +`address_line_2` | String | False | null | +`zip_code` | String | True | | +`city` | String | True | | + + + + + +## Delete an Integration + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/integrations/846291712/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/integrations/846291712/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/integrations/846291712/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + } +}) +``` + +> The above command returns an empty response. + + +This endpoint deletes an Integration. Note that you can not delete Integrations of type 1 or 2, nor Integrations +that have objects associated with them. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/integrations/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. diff --git a/source/includes/_messages.md b/source/includes/_messages.md new file mode 100644 index 00000000000..423c2854429 --- /dev/null +++ b/source/includes/_messages.md @@ -0,0 +1,446 @@ +# Messages + +A Message is a one way communication object between the Integration and its Employee objects. + +To issue a message to an employee or multiple employees, you can create a Message object and +include a list of employees that should receive it. + +Once the Message object is created, the relevant Employees will see it in the gigapay app in their home view. + +### The Message object + +> An example Message object: + +```json +{ + "id": "3d5356ee-6943-4d10-8060-967d3180b79d", + "employees": [ + "9c9c19a6-bb64-4c53-8dc1-516033390092", + "a5384a47-ee2b-4a5e-be29-969fac195be7" + ], + "content": "The February payment is delayed", + "created_at": "2024-03-22T10:32:36.118753Z" +} +``` + +| Attribute | Description | +| ------------ | ----------------------------------------------------------------------- | +| `id` | Unique identifier for the object. | +| `employees` | A list of employees that will see the Message content. | +| `content` | The Message content to be displayed to the employees. | +| `created_at` | Time at which the Message was created at. Displayed as ISO 8601 string. | + +## List All Messages + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/messages/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/messages/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/messages/", { + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/messages/?page=2", + "results": [ + { + "id": "2a241017-80af-467a-a3e1-50a6321a2adc", + "created_at": "2024-03-27T08:34:32.802625Z", + "employees": [ + "9119e535-ef85-4a0e-a7ba-d46dddd58c3b", + "fafef424-cf39-4ada-a8a1-8b085738d64a" + ], + "content": "January payment is underway" + }, + { + "id": "f9a57847-5d28-43dc-a748-365f6d487084", + "created_at": "2024-03-27T08:35:05.070901Z", + "employees": [ + "74fb03a0-d890-45fc-972b-8562b8d9acbe", + "ee6100b2-7d80-4c1d-b251-19e961f7fc9f", + "ba6162b0-e949-44c4-92ec-f65cc3f64a8c", + "56a34d0e-068f-4f56-9663-a36095751b9b" + ], + "content": "Your application is incomplete" + } + ] +} +``` + +This endpoint retrieves all Messages. + +### HTTP Request + +`GET https://api.gigapay.se/v2/messages/` + +### Headers + +| Parameter | Required | Description | +| ---------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### Query Parameters + +| Parameter | Default | Description | +| ----------- | ------- | -------------------------------- | +| `page` | 1 | Which page to return. | +| `page_size` | 25 | The number of Messages per page. | + +## Create a Message + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/messages/', + json={ + 'employees': ['74fb03a0-d890-45fc-972b-8562b8d9acbe'], + 'content': 'Payment in progress', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"employees": ["74fb03a0-d890-45fc-972b-8562b8d9acbe"], "content": "Payment in progress"}' https://api.gigapay.se/v2/messages/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/messages/", { + method: "POST", + body: JSON.stringify({ + employees: ["74fb03a0-d890-45fc-972b-8562b8d9acbe"], + content: "Payment in progress", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "e9e3c146-83d9-4080-b719-091719d90629", + "employees": ["74fb03a0-d890-45fc-972b-8562b8d9acbe"], + "content": "Payment in progress", + "created_at": "2024-03-22T10:32:36.118753Z" +} +``` + +This endpoint creates a Message. + +### HTTP Request + +`POST https://api.gigapay.se/v2/messages/` + +### Headers + +| Parameter | Required | Description | +| ----------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | +| `Idempotency-key` | False | Idempotency key. | + +### Body Parameters + +| Parameter | Type | Required | Notes | +| ----------- | ------ | -------- | ----------------------------------------------------- | +| `employees` | List | True | A list of employee ids | +| `content` | String | True | The Message content to be displayed to the employees. | + +## Retrieve a Message + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/ +``` + +```javascript +fetch( + "https://api.gigapay.se/v2/message/e9e3c146-83d9-4080-b719-091719d90629/", + { + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, + }, +); +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "e9e3c146-83d9-4080-b719-091719d90629", + "employees": ["74fb03a0-d890-45fc-972b-8562b8d9acbe"], + "content": "Payment in progress", + "created_at": "2024-03-22T10:32:36.118753Z" +} +``` + +This endpoint retrieves a Message. + +### HTTP Request + +`GET https://api.gigapay.se/v2/messages/:id/` + +### Headers + +| Parameter | Required | Description | +| ---------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +| --------- | -------- | --------------------------------- | +| `id` | True | Unique identifier for the object. | + +## Update a Message + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/', + json={ + 'content': 'Correction: payment is delayed by 1 day', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"content": "Correction: payment is delayed by 1 day"}' https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/ +``` + +```javascript +fetch( + "https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/", + { + method: "PATCH", + body: JSON.stringify({ + content: "Correction: payment is delayed by 1 day", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, + }, +); +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "e9e3c146-83d9-4080-b719-091719d90629", + "employees": ["74fb03a0-d890-45fc-972b-8562b8d9acbe"], + "content": "Correction: payment is delayed by 1 day", + "created_at": "2024-03-22T10:32:36.118753Z" +} +``` + +This endpoint updates a Message. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/messages/:id/` + +### Headers + +| Parameter | Required | Description | +| ---------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +| --------- | -------- | --------------------------------- | +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +| Parameter | Type | Required | Notes | +| ----------- | ------ | -------- | ----------------------------------------------------- | +| `employees` | List | False | A list of employee ids | +| `content` | String | False | The Message content to be displayed to the employees. | + +## Replace a Message + +```python +import requests + +response = requests.put( + 'https://api.gigapay.se/v2/messages/8472/', + json={ + 'employees': ['74fb03a0-d890-45fc-972b-8562b8d9acbe', '696f4143-1579-4352-9e9c-a0cf09df7b3f'], + 'content': 'Payment 664 and 566 in progress', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"employees": ["74fb03a0-d890-45fc-972b-8562b8d9acbe", "696f4143-1579-4352-9e9c-a0cf09df7b3f"],"content": "Payment 664 and 566 in progress"}' https://api.gigapay.se/v2/messages/8472/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/messages/8472/", { + method: "PUT", + body: JSON.stringify({ + employees: [ + "74fb03a0-d890-45fc-972b-8562b8d9acbe", + "696f4143-1579-4352-9e9c-a0cf09df7b3f", + ], + content: "Payment 664 and 566 in progress", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "e9e3c146-83d9-4080-b719-091719d90629", + "employees": [ + "74fb03a0-d890-45fc-972b-8562b8d9acbe", + "696f4143-1579-4352-9e9c-a0cf09df7b3f" + ], + "content": "Payment 664 and 566 in progress", + "created_at": "2024-03-23T10:32:36.118753Z" +} +``` + +This endpoint replaces a Message. + +### HTTP Request + +`PUT https://api.gigapay.se/v2/messages/:id/` + +### Headers + +| Parameter | Required | Description | +| ---------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +| --------- | -------- | --------------------------------- | +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +| Parameter | Type | Required | Description | +| ----------- | ------ | -------- | ----------------------------------------------------- | +| `employees` | List | True | A list of employee ids | +| `content` | String | True | The Message content to be displayed to the employees. | + +## Delete a Message + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/ +``` + +```javascript +fetch( + "https://api.gigapay.se/v2/messages/e9e3c146-83d9-4080-b719-091719d90629/", + { + method: "DELETE", + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, + }, +); +``` + +> The above command returns an empty response. + +This endpoint deletes a Message. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/messages/:id/` + +### Headers + +| Parameter | Required | Description | +| ---------------- | -------- | ------------------------- | +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### URL Parameters + +| Parameter | Required | Description | +| --------- | -------- | --------------------------------- | +| `id` | True | Unique identifier for the object. | diff --git a/source/includes/_payouts.md b/source/includes/_payouts.md new file mode 100644 index 00000000000..a61b3a1c556 --- /dev/null +++ b/source/includes/_payouts.md @@ -0,0 +1,695 @@ +# Payouts + +To make a payout to an Employee you need to create a Payout object. The Employee is notified of the Payout once the +corresponding Invoice is paid. The Employee will need to sign and accept the Payout before it is disbursed to their +account. + +Either `amount`, `invoiced_amount` or `cost` is used as a basis for the Payout. For their definition and how they are +related see [Pricing](#pricing). Ensure that you are using the same definition when communicating with the recipient to +align everyone's expectation. + +### The Payout object + +> An example Payout object: + +```json +{ + "id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa", + "amount": "100.00", + "cost": "137.99", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2", + "invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2019-05-22T10:32:38.118753Z", + "notified_at": "2019-05-22T10:38:19.874623Z", + "accepted_at": null, + "canceled_at": null +} +``` + +| Attribute | Description | +| --------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | Unique identifier for the object. | +| `amount` | Decimal formatted string of the gross salary amount. | +| `invoiced_amount` | Decimal formatted string of the invoiced amount. | +| `cost` | Decimal formatted string of the total salary cost. | +| `currency` | ISO-4217 currency code. | +| `description` | String describing the work done, displayed to the recipient. Max 255 characters. | +| `full_salary_specification` | Controls whether to present the payroll taxes and Gigapay's fee on the payslip. It is set to false when `amount` is used as a basis for the Payout, true otherwise. | +| `employee` | Unique identifier for the Employee object, that is the recipient of the Payout. This is an [expandable object.](#expanding-objects) | +| `invoice` | Unique identifier for the Invoice object the Payout object belongs to. This is an [expandable object.](#expanding-objects) | +| `metadata` | JSON-encoded metadata. | +| `start_at` | The time at which the gig will start. Displayed as ISO 8601 string. | +| `end_at` | The time at which the gig will end. Displayed as ISO 8601 string. | +| `created_at` | The time at which the Payout was created at. Displayed as ISO 8601 string. | +| `notified_at` | The time at which the Employee was notified of the Payout. Displayed as ISO 8601 string. | +| `accepted_at` | The time at which the Employee accepted the Payout. Displayed as ISO 8601 string. | +| `canceled_at` | The time at which the Payout was canceled. Displayed as ISO 8601 string. | + + + + +## List All Payouts + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payouts/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payouts/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/payouts/?page=1", + "results": [ + { + "id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa", + "amount": "100.00", + "cost": "137.99", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2", + "invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e", + "metadata": { + "job_id": 127 + }, + "start_at": null, + "end_at": null, + "created_at": "2019-05-22T10:32:38.118753Z", + "notified_at": "2019-05-22T10:38:19.874623Z", + "accepted_at": null, + "canceled_at": null + }, { + "id": "8a726186-a4e4-42e0-b56e-20fd17dc67ba", + "amount": "10.00", + "cost": "13.79", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "1f1d1263-0e79-4787-b573-6df81b44bfc2", + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "metadata": { + "job_id": 128 + }, + "start_at": "2019-05-22T08:00:00.000000Z", + "end_at": "2019-05-22T17:00:00.000000Z", + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": "2019-05-23T11:46:29.298742Z", + "accepted_at": "2019-05-23T12:02:16.472846Z", + "canceled_at": null + } + ] +} +``` + +This endpoint retrieves all Payouts. + +### HTTP Request + +`GET https://api.gigapay.se/v2/payouts/` + +### Headers + +| Parameter | Required | Description | +|------------------|----------|---------------------------| +| `Authorization` | True | Your Authorization Token. | +| `Integration-ID` | True | Integration id. | + +### Query Parameters + +| Parameter | Default | Description | +|---------------|---------|-----------------------------------------------------------------------------------------------------| +| `page` | 1 | Which page to return. | +| `page_size` | 25 | The number of Employees per page. | +| `invoice` | | Relational Filter. | +| `employee` | | Relational Filter. | +| `start_at` | | Timestamp filter. | +| `end_at` | | Timestamp filter. | +| `created_at` | | Timestamp filter. | +| `notified_at` | | Timestamp filter. | +| `accepted_at` | | Timestamp filter. | +| `canceled_at` | | Timestamp filter. | +| `search` | | Find payout by searching for part of payout description or employee: name, cellphone number, email. | + +## Register a Payout + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/payouts/', + json={ + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': 1847, + 'invoiced_amount': '1000.00', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "employee": 1847, "invoiced_amount": "1000.00"}' https://api.gigapay.se/v2/payouts/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/", { + method: "POST", + body: JSON.stringify({ + id: 9472, + currency: 'SEK', + description: 'Instagram samarbete 2021-11-13.', + employee: 1847, + invoiced_amount: '1000.00', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "9472", + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "1847", + "full_salary_specification": true, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "1000.00", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": null, + "accepted_at": null, + "canceled_at": null +} +``` + +This endpoint registers a payout. + +### HTTP Request + +`POST https://api.gigapay.se/v2/payouts/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per [Integration](#integrations). +`amount` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`cost` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`currency` | String | True | | +`description` | String | True | | +`employee` | String | True | | +`invoiced_amount` | String | True | | Either `amount`, `invoiced_amount` or `cost` is required. +`metadata` | Object | False | | +`start_at` | String | False | | +`end_at` | String | False | null | + + + + +## Register multiple Payouts + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/payouts/', + json=[ + { + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': 1847, + 'invoiced_amount': '1000.00', + 'metadata': {}, + }, { + 'id': 9473, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': 1736, + 'invoiced_amount': '2500.00', + 'metadata': {}, + }, + ], + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '[{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "employee": 1847, "invoiced_amount": "1000.00"}, {"id": 9473, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "employee": 1736, "invoiced_amount": "2500.00"}]' https://api.gigapay.se/v2/payouts/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/", { + method: "POST", + body: JSON.stringify([ + { + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': 1847, + 'invoiced_amount': '1000.00', + 'metadata': {}, + }, { + 'id': 9473, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': 1736, + 'invoiced_amount': '2500.00', + 'metadata': {}, + }, + ]), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +[ + { + "id": "9472", + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "description": "Instagram samarbete 2021-11-13.", + "employee": "1847", + "full_salary_specification": true, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "1000.00", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": null, + "accepted_at": null, + "canceled_at": null + }, { + "id": "9473", + "amount": "1902.31", + "cost": "2550.00", + "currency": "SEK", + "description": "Instagram samarbete 2021-11-13.", + "employee": "1736", + "full_salary_specification": true, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "2500.00", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2019-05-23T10:32:38.118812Z", + "notified_at": null, + "accepted_at": null, + "canceled_at": null + } +] +``` + +This endpoint registers multiple Payouts at once. All payouts will be added to the same Invoice object. + +### HTTP Request + +`POST https://api.gigapay.se/v2/payouts/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +| Type | Required | Default | Notes +| ---- | -------- | ------- |------------ +| Payout[] | True | | Elements of array structured as [Payout](#register-a-payout). + + + + + + +## Register a Payout with an inline Employee + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/payouts/?expand=employee', + json={ + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'employee': { + 'id': 1847, + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000001', + 'email': 'albin@mail.com', + 'country': 'SWE' + }, + 'invoiced_amount': '1000.00', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "employee": {"id": 1847, "name": "Albin Lindskog", "cellphone_number": "+4670000001", "email": "albin@mail.com", "country": "SWE"}, "invoiced_amount": "1000.00"}' 'https://api.gigapay.se/v2/payouts/?expand=employee' +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/?expand=employee", { + method: "POST", + body: JSON.stringify({ + id: 9472, + currency: 'SEK', + description: 'Instagram samarbete 2021-11-13.', + employee: { + id: 1847, + name: 'Albin Lindskog', + cellphone_number: '+4670000001', + email: 'albin@mail.com', + country: 'SWE' + }, + invoiced_amount: '1000.00', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "9472", + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "description": "Instagram samarbete 2021-11-13.", + "employee": { + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@mail.com", + "cellphone_number": "+46700000001", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": null, + "claimed_at": null, + "verified_at": null, + "invitation_code": "ABCD1234" + }, + "full_salary_specification": true, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "1000.00", + "metadata": { + "campaign_id": 12394 + }, + "start_at": null, + "end_at": null, + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": null, + "accepted_at": null, + "canceled_at": null +} +``` + +This endpoint registers a Payout and an Employee at the same time. If an Employee with matching information is already +registered that object will be reused. + +### HTTP Request + +`POST https://api.gigapay.se/v2/payouts/?expand=employee` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per [Integration](#integrations). +`amount` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`cost` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`currency` | String | True | | +`description` | String | True | | +`employee` | Object | True | | Structured as an [Employee](#register-an-employee). | +`invoiced_amount` | String | True | | Either `amount`, `invoiced_amount` or `cost` is required. +`metadata` | Object | False | | +`start_at` | String | False | | +`end_at` | String | False | null | + + + + + +## Retrieve a Payout + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payouts/9472/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payouts/9472/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/9472/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "9472", + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "1847", + "full_salary_specification": true, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "1000.00", + "metadata": { + "campaign_id": 12394 + }, + "start_at": "2019-05-22T08:00:00.000000Z", + "end_at": "2019-05-22T17:00:00.000000Z", + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": "2019-05-23T11:46:29.298742Z", + "accepted_at": "2019-05-23T12:02:16.472846Z", + "canceled_at": null +} +``` + +This endpoint retrieves a payout. + +### HTTP Request + +`GET https://api.gigapay.se/v2/payouts/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + + + +## Delete a Payout + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/payouts/9472/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payouts/9472/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/9472/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns an empty response. + + +Endpoint for deleting a specific Payout. Note that you can not delete a payout belonging to a paid Invoice or an Invoice +on credit. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/payouts/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + + +## Resend a Notification + +```python +import requests + +response = requests.put( + 'https://api.gigapay.se/v2/payouts/9472/resend/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b', + 'Idempotency-key': 'ac4beffd-79b0-4561-b16c-846a9600b168' + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -H 'Idempotency-key: ac4beffd-79b0-4561-b16c-846a9600b168' https://api.gigapay.se/v2/payouts/9472/resend/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/9472/resend/", { + method: "PUT", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + "Idempotency-key": "ac4beffd-79b0-4561-b16c-846a9600b168" + } +}) +``` + +> The above command returns an empty response. + + +This endpoint resends a notification. After resending, you need to wait at least 24 hours before resending again. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/payouts/:id/resend/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. diff --git a/source/includes/_payruns.md b/source/includes/_payruns.md new file mode 100644 index 00000000000..2254bd3af5f --- /dev/null +++ b/source/includes/_payruns.md @@ -0,0 +1,386 @@ +# Payruns + +A Payrun groups Payouts together. It is a managed object, you can not create them directly. When a Payout is created +it is added to the Payrun that is currently open. If there is no open Payrun, a new will be created. + +You can keep payruns open for a certain time period by enabling batching of payouts. Contact [support@gigapay.se](mailto:support@gigapay.se) if you are interested in this. + +### The Payrun object + +> An example Payrun object: + +```json +{ + "app": "https://app.gigapay.se/i/2859272/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy9jMTMzYzIwMi0xMDUwLTQ5NTktODMwNi05NWQ3Y2IzZjNiMjgvIg", + "created_at": "2019-05-22T10:32:36.118753Z", + "currency": "SEK", + "id": "2859272", + "metadata": {}, + "ocr_number": "986911160380", + "open": false, + "paid_at": "2019-05-25T9:02:16.8462735Z", + "pdf": "https://api.gigapay.se/invoice/cad7d4d7-cdc7-4f70-8246-c061e041e9e/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy8zYjcyNTYyOS05MTE4LTQ5YTctYTFiYS0yMTU4NTZhMzYwOTgvIg&language=en", + "price": "1340.48" +} +``` + +| Attribute | Description | +| ------------ | -------------------------------------------------------------------- | +| `app` | Link to pay invoice in app. | +| `created_at` | Time at which the Invoice was created. Displayed as ISO 8601 string. | +| `currency` | ISO-4217 currency code. | +| `id` | A unique identifier for the object. | +| `metadata` | JSON-encoded metadata. | +| `ocr_number` | Bank reference. | +| `open` | Whether the Payrun is the currently open one. | +| `paid_at` | Time at which the Payrun was paid. Displayed as ISO 8601 string. | +| `pdf` | Link to download a pdf version of the Payrun. | +| `price` | Decimal formatted string of the price. | + + + + + +## List All Payruns + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payruns/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payruns/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payruns/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/payruns/?page=1", + "results": [ + { + "app": "https://app.gigapay.se/i/2859272/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy9jMTMzYzIwMi0xMDUwLTQ5NTktODMwNi05NWQ3Y2IzZjNiMjgvIg", + "created_at": "2019-05-22T10:32:36.118753Z", + "currency": "SEK", + "id": "2859272", + "metadata": {}, + "ocr_number": "986911160380", + "open": false, + "paid_at": "2019-05-25T9:02:16.8462735Z", + "pdf": "https://api.gigapay.se/invoice/cad7d4d7-cdc7-4f70-8246-c061e041e9e/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy8zYjcyNTYyOS05MTE4LTQ5YTctYTFiYS0yMTU4NTZhMzYwOTgvIg&language=en", + "price": "1340.48" + }, { + "app": "https://app.gigapay.se/i/2859273/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy9jMTMzYzIwMi0xMDUwLTQ5NTktODMwNi05NWQ3Y2IzZjNiMjgvIg", + "created_at": "2019-06-22T10:28:21.847474Z", + "currency": "SEK", + "id": "2859273", + "metadata": {}, + "ocr_number": "986911160349", + "open": false, + "paid_at": "2019-06-25T9:12:57.742648Z", + "pdf": "https://api.gigapay.se/invoice/cad7d4d7-cdc7-4f70-8246-c061e041e9e/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy8zYjcyNTYyOS05MTE4LTQ5YTctYTFiYS0yMTU4NTZhMzYwOTgvIg&language=en", + "price": "1340.48" + } +} +``` + +This endpoint retrieves all Payruns. + +### HTTP Request + +`GET https://api.gigapay.se/v2/payruns/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +`page` | 1 | Which page to return. +`page_size` | 25 | The number of Payruns per page. +`created_at` | | Timestamp filter. +`paid_at` | | Timestamp filter. + + + + + +## Retrieve a Payrun + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payruns/2859272/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payruns/2859272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payruns/2859272/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "app": "https://app.gigapay.se/i/2859272/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy9jMTMzYzIwMi0xMDUwLTQ5NTktODMwNi05NWQ3Y2IzZjNiMjgvIg", + "created_at": "2019-05-22T10:32:36.118753Z", + "currency": "SEK", + "id": "2859272", + "metadata": {}, + "ocr_number": "986911160380", + "open": false, + "paid_at": "2019-05-25T9:02:16.8462735Z", + "pdf": "https://api.gigapay.se/invoice/cad7d4d7-cdc7-4f70-8246-c061e041e9e/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy8zYjcyNTYyOS05MTE4LTQ5YTctYTFiYS0yMTU4NTZhMzYwOTgvIg&language=en", + "price": "1340.48" +} +``` + +This endpoint retrieves a Payrun. + +### HTTP Request + +`GET https://api.gigapay.se/v2/payruns/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + + + + +## Update a Payrun + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/payruns/2859272/', + json={ + 'id': '846271', + 'metadata': {'original_id': '2859272'} + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": "846271", "metadata": {"original_id": "2859272"}}' https://api.gigapay.se/v2/payruns/2859272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payruns/2859272/", { + method: "PATCH", + body: JSON.stringify({'id': '846271', 'metadata': {'original_id': '2859272'}}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "app": "https://app.gigapay.se/i/2859272/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy9jMTMzYzIwMi0xMDUwLTQ5NTktODMwNi05NWQ3Y2IzZjNiMjgvIg", + "created_at": "2019-05-22T10:32:36.118753Z", + "currency": "SEK", + "id": "846271", + "metadata": { + "original_id": "2859272" + }, + "ocr_number": "986911160380", + "open": false, + "paid_at": "2019-05-25T9:02:16.8462735Z", + "pdf": "https://api.gigapay.se/invoice/cad7d4d7-cdc7-4f70-8246-c061e041e9e/?token=Ii9pbnZvaWNpbmcvb3Blbl9pbnZvaWNlcy8zYjcyNTYyOS05MTE4LTQ5YTctYTFiYS0yMTU4NTZhMzYwOTgvIg&language=en", + "price": "1340.48" +} +``` + +This endpoint updates a Payrun. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/payruns/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | Previous value | Unique per [Integration](#integrations). +`metadata` | Object | False | Previous value | + + +## Finalize a Payrun + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/payruns/846271/close/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payruns/846271/close/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payruns/846271/close/", { + method: "POST", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns an empty response. + + +Payruns are initially created in an open state (pro-forma) and are not immediately finalized. This allows users to review and edit their payruns before submission. + +Once the payrun is ready, it can be finalized using this endpoint. Finalization has two important effects: +1. The payouts become visible to the employees +2. The payrun is sent to the email address configured in the integration settings + +### HTTP Request + +`POST https://api.gigapay.se/v2/payruns/:id/close/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + +## Delete a Payrun + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/payruns/846271/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/payruns/846271/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payruns/846271/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns an empty response. + + +This endpoint deletes a Payrun. Note that you can not delete a paid Payrun or a Payrun on credit. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/payruns/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + diff --git a/source/includes/_pricing.md b/source/includes/_pricing.md new file mode 100644 index 00000000000..8b0def58a2c --- /dev/null +++ b/source/includes/_pricing.md @@ -0,0 +1,529 @@ +# Pricing + +The Pricing endpoint allows you to calculate the price of payout you would like to make, and to retrieve the price +information about previously made payouts. The endpoint is designed to mirror the Payouts endpoint as closely as +possible, e.g. the same request can be used to retrieve the price information of a Payout you'd like to make and to +actually make it. + +### The Pricing breakdown + +> An example Pricing breakdown for a Payout: + +```json +{ + "amount": "1000.00", + "cost": "1379.91", + "currency": "SEK", + "fee": "65.71", + "health_insurance": null, + "invoiced_amount": "1314.20", + "payroll": "314.20", + "pension": null, + "tax": "300.00", + "vat": "344.97" +} +``` + + +| Attribute | Description | +| ----------------- | --------------------------------------------------------------------------------- | +| amount | Decimal formatted string of the gross salary amount. | +| invoiced_amount | Decimal formatted string of the invoiced amount. | +| cost | Decimal formatted string of the total salary cost. | +| currency | ISO-4217 currency code. | +| fee | Decimal formatted string of Gigapay's fee for this Payout. | +| health_insurance | Decimal formatted string of the cost of mandated health insurance. Will be none if health insurance is not mandated. | +| payroll | Decimal formatted string of the payroll taxes. Will be none if payroll taxes are not mandated. | +| pension | Decimal formatted string of the cost of mandated pension. Will be none if pension is not mandated. | +| tax | Decimal formatted string of the preliminary income taxes the will be reported and paid on behalf of the recipient. | +| vat | Decimal formatted string of the VAT for the Payout. + + +Either `amount`, `invoiced_amount` or `cost` is used as a basis for calculating the Pricing breakdown. One is provided +and the other are calculated based on that. Their definitions are: + +- `amount`: net amount paid out plus obligations paid by the recipient. +- `invoiced_amount`: `amount` plus obligations paid by the employer. +- `cost`: `invoiced_amount` plus Gigapay's fee. This is the final amount you end up paying. + +Which of the attributes that are included and in what step varies between countries. Examples of what the pricing looks +like in each country are provided. + + +## List Pricing info + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/pricing/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/pricing/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/pricing/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/pricing/?page=1", + "results": [ + { + "amount": "1000.00", + "cost": "1379.91", + "currency": "SEK", + "fee": "65.71", + "health_insurance": null, + "invoiced_amount": "1314.20", + "payroll": "314.20", + "pension": null, + "tax": "300.00", + "vat": "344.97" + }, { + "amount": "3000.00", + "cost": "4139.73", + "currency": "SEK", + "fee": "197.13", + "health_insurance": null, + "invoiced_amount": "3942.60", + "payroll": "942.60", + "pension": null, + "tax": "900.00", + "vat": "1034.93" + } + ] +} +``` + +List Pricing info for past Payouts. + +### HTTP Request + +`GET https://api.gigapay.se/v2/pricing/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +`page` | 1 | Which page to return. +`page_size` | 25 | The number of Employees per page. +`invoice` | | Relational Filter. +`employee` | | Relational Filter. +`start_at` | | Timestamp filter. +`end_at` | | Timestamp filter. +`created_at` | | Timestamp filter. +`notified_at` | | Timestamp filter. +`accepted_at` | | Timestamp filter. + + + + + +## Calculate Pricing info + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/pricing/', + json={ + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': True, + 'employee': 1847, + 'invoiced_amount': '1000.00', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "full_salary_specification": true, "employee": 1847, "invoiced_amount": "1000.00"}' https://api.gigapay.se/v2/pricing/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/pricing/", { + method: "POST", + body: JSON.stringify({ + id: 9472, + currency: 'SEK', + description: 'Instagram samarbete 2021-11-13.', + full_salary_specification: true, + employee: 1847, + invoiced_amount: '1000.00', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "fee": "20.00", + "health_insurance": null, + "invoiced_amount": "1000.00", + "payroll": "239.18", + "pension": null, + "tax": "228.28", + "vat": "255.00" +} +``` + +This endpoint allows you to calculate the price of payout you would like to make. + +### HTTP Request + +`POST https://api.gigapay.se/v2/pricing/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +Parameter | Type | Required | Default | Description +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per [Integration](#integrations). +`amount` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`cost` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`currency` | String | True | | +`description` | String | True | | +`employee` | String | True | | +`full_salary_specification` | Bool | False | False | +`invoiced_amount` | String | True | | Either `amount`, `invoiced_amount` or `cost` is required. +`metadata` | Object | False | | +`start_at` | String | False | | +`end_at` | String | False | null | + + + + +## Calculate bulk pricing info + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/payouts/', + json=[ + { + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': True, + 'employee': 1847, + 'invoiced_amount': '1000.00', + }, { + 'id': 9473, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': True, + 'employee': 1736, + 'invoiced_amount': '2500.00', + }, + ], + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '[{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "full_salary_specification": true, "employee": 1847, "invoiced_amount": "1000.00"}, {"id": 9473, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "full_salary_specification": true, "employee": 1736, "invoiced_amount": "2500.00"}]' https://api.gigapay.se/v2/payouts/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/", { + method: "POST", + body: JSON.stringify([ + { + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': true, + 'employee': 1847, + 'invoiced_amount': '1000.00', + }, { + 'id': 9473, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': true, + 'employee': 1736, + 'invoiced_amount': '2500.00', + }, + ]), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +[ + { + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "fee": "20.00", + "health_insurance": null, + "invoiced_amount": "1000.00", + "payroll": "239.18", + "pension": null, + "tax": "228.28", + "vat": "255.00" + }, { + "amount": "1902.30", + "cost": "2550.00", + "currency": "SEK", + "fee": "50.00", + "health_insurance": null, + "invoiced_amount": "2500.00", + "payroll": "597.95", + "pension": null, + "tax": "570.70", + "vat": "637.50" + } +] +``` + +The same endpoint is used to calculate the pricing info for multiple Payouts at once. + +### HTTP Request + +`POST https://api.gigapay.se/v2/pricing/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +| Type | Required | Default | Notes +| ---- | -------- | ------- |------------ +| Payout[] | True | | Elements of array structured as [Payout](#calculate-pricing-info). + + + + + + +## Calculate Pricing info with an inline Employee + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/pricing/?expand=employee', + json={ + 'id': 9472, + 'currency': 'SEK', + 'description': 'Instagram samarbete 2021-11-13.', + 'full_salary_specification': True, + 'employee': { + 'id': 1847, + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000001', + 'email': 'albin@mail.com', + 'country': 'SWE' + }, + 'invoiced_amount': '1000.00', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 9472, "currency": "SEK", "description": "Instagram samarbete 2021-11-13.", "full_salary_specification": true, "employee": {"id": 1847, "name": "Albin Lindskog", "cellphone_number": "+4670000001", "email": "albin@mail.com", "country": "SWE"}, "invoiced_amount": "1000.00"}' 'https://api.gigapay.se/v2/pricing/?expand=employee' +``` + +```javascript +fetch("https://api.gigapay.se/v2/pricing/?expand=employee", { + method: "POST", + body: JSON.stringify({ + id: 9472, + currency: 'SEK', + description: 'Instagram samarbete 2021-11-13.', + full_salary_specification: true, + employee: { + id: 1847, + name: 'Albin Lindskog', + cellphone_number: '+4670000001', + email: 'albin@mail.com', + country: 'SWE' + }, + invoiced_amount: '1000.00', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "fee": "20.00", + "health_insurance": null, + "invoiced_amount": "1000.00", + "payroll": "239.18", + "pension": null, + "tax": "228.28", + "vat": "255.00" +} +``` + +This endpoint registers a Payout and an Employee at the same time. If an Employee with matching information is already +registered will the object be reused. + +### HTTP Request + +`POST https://api.gigapay.se/v2/payouts/?expand=employee` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +Parameter | Type | Required | Default | Description +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per [Integration](#integrations). +`amount` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`cost` | String | False | | Either `amount`, `invoiced_amount` or `cost` is required. +`currency` | String | True | | +`description` | String | True | | +`employee` | Object | True | | Structured as an [Employee](#register-an-employee). | +`full_salary_specification` | Bool | False | False | +`invoiced_amount` | String | True | | Either `amount`, `invoiced_amount` or `cost` is required. +`metadata` | Object | False | | +`start_at` | String | False | | +`end_at` | String | False | null | + + + + + +## Retrieve Pricing info of Payout + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/pricing/9472/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/pricing/9472/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/pricing/9472/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "fee": "20.00", + "health_insurance": null, + "invoiced_amount": "1000.00", + "payroll": "239.18", + "pension": null, + "tax": "228.28", + "vat": "255.00" +} +``` + +This endpoint retrieves a payout. + +### HTTP Request + +`GET https://api.gigapay.se/v2/pricing/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True | Integration id. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the Payout object. diff --git a/source/includes/_registrations.md b/source/includes/_registrations.md new file mode 100644 index 00000000000..1c2297d837f --- /dev/null +++ b/source/includes/_registrations.md @@ -0,0 +1,660 @@ +# Registrations + +A registration holds all the necessary legal and contact information for a company. The registration object represents the onboarding state of a company, from creation (onboarding started) to approved (onboarding complete). + +Once a registration is submitted (object created), it will be reviewed by the Gigapay team. Upon approval, an `Integration` is automatically created with the same id as the `integration_id` specified in the object. + +You can always create and view registrations associated with your account. You can also update and delete registrations as long as the registrations has not been approved yet. + + +### The Registration object + +> An example Registration object: + +```json +{ + "id": "1f2c22ed-88e5-457d-b9a8-2ab511d5a8d9", + "integration_id": "b6e1a18b-621b-465c-9371-9b9344c2b9c8", + "needs_review": false, + "tin_number": "18785153", + "vat_number": "DK18785153", + "registered_name": "Zerebra AB", + "friendly_name": "Zerebra AB", + "address_line_1": "Malmvägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14171", + "city": "Segeltorp", + "email": "faktura@zerebra.com", + "phone_number": "+46703000000", + "country": "DNK", +} +``` + + +| Attribute | Description | +| --- | --- | +| `id` | A unique identifier for the registration object. | +| `integration_id` | A unique identifier for the integration object that will be created from this registration. If not provided during creation, it will be auto-generated. This ID must be unique for each registration managed by a user. | +| `email` | The contact email address for the company. | +| `phone_number` | The contact phone number for the company. | +| `friendly_name` | The company's display name or brand name. | +| `registered_name` | The legally registered name of the company. | +| `tin_number` | The company's Tax Identification Number. | +| `vat_number` | The company's Value Added Tax number, if applicable. | +| `country` | The 3-letter ISO code for the country where the company is registered. Cannot be 'SWE'. | +| `state` | The state, province, or territory, where applicable (e.g., for US, CA, AU). | +| `address_line_1` | The primary line of the company's address. | +| `address_line_2` | The secondary line of the company's address. | +| `zip_code` | The postal or zip code for the company's address. | +| `city` | The city for the company's address. | +| `needs_review` | A read-only flag indicating if the registration is pending review by Gigapay. | + + +## List All Registrations + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/registrations/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/registrations/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 2, + "next": null, + "previous": "https://api.gigapay.se/v2/registrations/?page=1", + "results": [ + { + "id": "1f2c22ed-88e5-457d-b9a8-2ab511d5a8d9", + "integration_id": "b6e1a18b-621b-465c-9371-9b9344c2b9c8", + "needs_review": false, + "tin_number": "18785153", + "vat_number": "DK18785153", + "registered_name": "Zerebra AB", + "friendly_name": "Zerebra AB", + "address_line_1": "Malmvägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14171", + "city": "Segeltorp", + "email": "faktura@zerebra.com", + "phone_number": "+46703000000", + "country": "DNK", + }, + { + "id": "8347fdd5-688d-4267-ae42-864b34a4220b", + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "needs_review": true, + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Zebrebra AB", + "friendly_name": "Zebrebra AB", + "address_line_1": "Malmövägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14172", + "city": "Segeltorps", + "email": "faktura@zebrebra.com", + "phone_number": "+46703000001", + "country": "DNK", + }, + ] +} +``` + +This endpoint retrieves all Registrations. + +### HTTP Request + +`GET https://api.gigapay.se/v2/registrations/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +`page` | 1 | Which page to return. +`page_size` | 25 | The number of Registrations per page. + + +## Register a Registration + +```python +import requests +response = requests.post( + 'https://api.gigapay.se/v2/registrations/', + json={ + 'integration_id': "e50d4871-a3e0-4a41-b99a-6c7d4acd07c6", + 'email': 'contact@example.com', + 'phone_number': '+4570123456', + 'tin_number': '18785161', + 'vat_number': 'DK18785161', + 'registered_name': 'Example Company ApS', + 'friendly_name': 'Example Company', + 'address_line_1': 'Nørrebrogade 20', + 'zip_code': '2200', + 'city': 'Copenhagen', + 'country': 'DNK', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -d '{ + "integration_id": "e50d4871-a3e0-4a41-b99a-6c7d4acd07c6", + "email": "contact@example.com", + "phone_number": "+4570123456", + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Example Company ApS", + "friendly_name": "Example Company", + "address_line_1": "Nørrebrogade 20", + "zip_code": "2200", + "city": "Copenhagen", + "country": "DNK" +}' https://api.gigapay.se/v2/registrations/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/", { + method: "POST", + body: JSON.stringify({ + integration_id: "e50d4871-a3e0-4a41-b99a-6c7d4acd07c6", + email: 'contact@example.com', + phone_number: '+4570123456', + tin_number: '18785161', + vat_number: 'DK18785161', + registered_name: 'Example Company ApS', + friendly_name: 'Example Company', + address_line_1: 'Nørrebrogade 20', + zip_code: '2200', + city: 'Copenhagen', + country: 'DNK', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "e50d4871-a3e0-4a41-b99a-6c7d4acd07c6", + "integration_id": "e50d4871-a3e0-4a41-b99a-6c7d4acd07c6", + "needs_review": true, + "tin_number": "12345658", + "vat_number": "DK12345658", + "registered_name": "Example Company ApS", + "friendly_name": "Example Company", + "address_line_1": "Nørrebrogade 20", + "address_line_2": "", + "state": null, + "zip_code": "2200", + "city": "Copenhagen", + "email": "contact@example.com", + "phone_number": "+4570123456", + "country": "DNK" +} +``` + +This endpoint creates a Registration. + +### HTTP Request + +`POST https://api.gigapay.se/v2/registrations/` + +### Headers + +| Parameter | Required | Description | +| --- | --- | --- | +| `Authorization` | True | Your Authorization Token. | + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`integration_id` | String | False | uuid4() | Unique per registration. Also, user cannot have more than one integration with the same `integration_id`. +`email` | String | True | | +`phone_number` | String | True | | +`friendly_name` | String | True | | +`registered_name` | String | True | | +`tin_number` | String | True | | Must be a valid number for the country. +`vat_number` | String | False | | Must be a valid number for the country. Will return an error if required for the supplied country. +`country` | String | True | | Cannot be 'SWE'. +`state` | String | False | | Only required for countries that have states, provinces, or territories (e.g., for US, CA, AU). +`address_line_1` | String | True | | +`address_line_2` | String | False | | +`zip_code` | String | True | | +`city` | String | True | | + + + +## Retrieve a Registration + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "8347fdd5-688d-4267-ae42-864b34a4220b", + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "needs_review": true, + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Zebrebra AB", + "friendly_name": "Zebrebra AB", + "address_line_1": "Malmövägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14172", + "city": "Segeltorps", + "email": "faktura@zebrebra.com", + "phone_number": "+46703000001", + "country": "DNK" +} +``` + +This endpoint retrieves a Registration. + +### HTTP Request + +`GET https://api.gigapay.se/v2/registrations/:id/` + +### Headers + +| Parameter | Required | Description | +| --- | --- | --- | +| `Authorization` | True | Your Authorization Token. | + +### URL Parameters + +| Parameter | Required | Description | +| --- | --- | --- | +| `id` | True | Unique identifier for the object. | + +## Update a Registration + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/', + json={ + 'friendly_name': 'Zerebra Inc.', + 'email': 'billing@zerebra.com' + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -d '{"friendly_name": "Zerebra Inc.", "email": "billing@zerebra.com"}' https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/", { + method: "PATCH", + body: JSON.stringify({'friendly_name': 'Zerebra Inc.', 'email': 'billing@zerebra.com'}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json" + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "8347fdd5-688d-4267-ae42-864b34a4220b", + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "needs_review": true, + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Zebrebra AB", + "friendly_name": "Zerebra Inc.", + "address_line_1": "Malmövägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14172", + "city": "Segeltorps", + "email": "billing@zerebra.com", + "phone_number": "+46703000001", + "country": "DNK" +} +``` + +This endpoint updates a Registration. +A registration can only be updated if the `needs_review` field is set to `true`, meaning the registration has not been approved yet. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/registrations/:id/` + +### Headers + +| Parameter | Required | Description | +| --- | --- | --- | +| `Authorization` | True | Your Authorization Token. | + +### URL Parameters + +| Parameter | Required | Description | +| --- | --- | --- | +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`integration_id` | String | False | uuid4() | Unique per registration. Also, user cannot have more than one integration with the same `integration_id`. +`email` | String | True | | +`phone_number` | String | True | | +`friendly_name` | String | True | | +`registered_name` | String | True | | +`tin_number` | String | True | | Must be a valid number for the country. +`vat_number` | String | False | | Must be a valid number for the country. Will return an error if required for the supplied country. +`country` | String | True | | Cannot be 'SWE'. +`state` | String | False | | Only required for countries that have states, provinces, or territories (e.g., for US, CA, AU). +`address_line_1` | String | True | | +`address_line_2` | String | False | | +`zip_code` | String | True | | +`city` | String | True | | + + +## Replace a Registration + +```python +import requests +response = requests.put( + 'https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/', + json={ + 'integration_id': "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + 'email': 'billing@example.com', + 'phone_number': '+4570987654', + 'tin_number': '18785161', + 'vat_number': 'DK18785161', + 'registered_name': 'Example Company ApS', + 'friendly_name': 'Example Company', + 'address_line_1': 'Vesterbrogade 40', + 'zip_code': '1620', + 'city': 'Copenhagen', + 'country': 'DNK', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821' + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -d '{ + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "email": "billing@example.com", + "phone_number": "+4570987654", + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Example Company ApS", + "friendly_name": "Example Company", + "address_line_1": "Vesterbrogade 40", + "zip_code": "1620", + "city": "Copenhagen", + "country": "DNK" +}' https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/", { + method: "PUT", + body: JSON.stringify({ + integration_id: "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + email: 'billing@example.com', + phone_number: '+4570987654', + tin_number: '18785161', + vat_number: 'DK18785161', + registered_name: 'Example Company ApS', + friendly_name: 'Example Company', + address_line_1: 'Vesterbrogade 40', + zip_code: '1620', + city: 'Copenhagen', + country: 'DNK', + }), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "8347fdd5-688d-4267-ae42-864b34a4220b", + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "needs_review": true, + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Example Company ApS", + "friendly_name": "Example Company", + "address_line_1": "Vesterbrogade 40", + "address_line_2": "", + "state": null, + "zip_code": "1620", + "city": "Copenhagen", + "email": "billing@example.com", + "phone_number": "+4570987654", + "country": "DNK" +} +``` + +This endpoint replaces a Registration completely. +A registration can only be replaced if the `needs_review` field is set to `true`, meaning the registration has not been approved yet. + +### HTTP Request + +`PUT https://api.gigapay.se/v2/registrations/:id/` + +### Headers + +| Parameter | Required | Description | +| --- | --- | --- | +| `Authorization` | True | Your Authorization Token. | + +### URL Parameters + +| Parameter | Required | Description | +| --- | --- | --- | +| `id` | True | Unique identifier for the object. | + +### Body Parameters + +| Parameter | Type | Required | Default | Notes | +| --- | --- | --- | --- | --- | +| `integration_id` | String | False | uuid4() | Unique per registration. | +| `email` | String | True | | | +| `phone_number` | String | True | | | +| `friendly_name` | String | True | | | +| `registered_name` | String | True | | | +| `tin_number` | String | True | | Must be a valid number for the country. | +| `vat_number` | String | False | | Must be a valid number for the country. Will return an error if required for the supplied country. | +| `country` | String | True | | Cannot be 'SWE'. | +| `state` | String | False | | Only required for countries that have states, provinces, or territories (e.g., for US, CA, AU). | +| `address_line_1` | String | True | | | +| `address_line_2` | String | False | | | +| `zip_code` | String | True | | | +| `city` | String | True | | | + + +## Delete a Registration + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821" + } +}) +``` + +> The above command returns an empty response. + + +This endpoint deletes a Registration. +A registration can only be deleted if the `needs_review` field is set to `true`, meaning the registration has not been approved yet. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/registrations/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. + + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + +## Approve a Registration (Demo Only) + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/approve/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/approve/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/registrations/8347fdd5-688d-4267-ae42-864b34a4220b/approve/", { + method: "POST", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "8347fdd5-688d-4267-ae42-864b34a4220b", + "integration_id": "cc7e24d0-5e43-4bd5-806a-27b0df5f419a", + "needs_review": false, + "tin_number": "18785161", + "vat_number": "DK18785161", + "registered_name": "Zebrebra AB", + "friendly_name": "Zebrebra AB", + "address_line_1": "Malmövägen 8", + "address_line_2": "", + "state": null, + "zip_code": "14172", + "city": "Segeltorps", + "email": "faktura@zebrebra.com", + "phone_number": "+46703000001", + "country": "DNK" +} +``` + +This endpoint approves a Registration and is **only available in demo environments**. In production, registrations are reviewed and approved by the Gigapay team. + +When a registration is approved using this endpoint, the `needs_review` field is set to `false` and an `Integration` is automatically created with the same id as the `integration_id` specified in the registration. + +### HTTP Request + +`POST https://api.gigapay.se/v2/registrations/:id/approve/` + +### Headers + +| Parameter | Required | Description | +| --- | --- | --- | +| `Authorization` | True | Your Authorization Token. | + +### URL Parameters + +| Parameter | Required | Description | +| --- | --- | --- | +| `id` | True | Unique identifier for the registration to approve. | diff --git a/source/includes/_webhooks.md b/source/includes/_webhooks.md new file mode 100644 index 00000000000..dbcaaa8ffc3 --- /dev/null +++ b/source/includes/_webhooks.md @@ -0,0 +1,461 @@ +# Webhooks + +Webhooks allows you to receive real-time status updates any time an event happens on your account. For a complete +description of these notifications, see [Events](#events). + +In the case where the receiving server is unavailable, we will retry the webhook notification up to 10 times with an exponential backoff. + + + +### The Webhook object + +> An example Webhook object + +```json +{ + "id": "38a93e19-886a-4246-9cfe-471214ff6739", + "url": "https://jobmatchr.se/webhooks/payouts/", + "events": ["Payout.notified", "Payout.accepted"], + "secret_key": "c1329a085d65f7757838df5920fdcc9a", + "metadata": {} +} +``` + +| Attribute | Description | +| ------------ | -------------------------------------------------- | +| `id` | Unique identifier for the object. | +| `url` | URL to which the notifications are posted. | +| `events` | List of events to subscribe to. | +| `secret_key` | Secret key used to sign the Webhook notifications. | +| `metadata` | JSON-encoded metadata. | + + + + + +## List All Registered Webhooks + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/webhooks/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/webhooks/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "count": 4, + "next": null, + "previous": "https://api.gigapay.se/v2/webhooks/?page=2", + "results": [ + { + "id": "38a93e19-886a-4246-9cfe-471214ff6739", + "url": "https://jobmatchr.se/webhooks/payouts/", + "events": ["Payout.notified", "Payout.accepted"], + "secret_key": "c1329a085d65f7757838df5920fdcc9a", + "metadata": {} + }, { + "id": "0630bfcf-ad0a-458a-9794-816b54b542b6", + "url": "https://jobmatchr.se/webhooks/employees/", + "events": ["Employee.verified"], + "secret_key": "1fc0ee40ecf33f83cbd3f930443074ca", + "metadata": {} + } + ] +} +``` + +This endpoint retrieves all webhooks. + +### HTTP Request + +`GET https://api.gigapay.se/v2/webhooks/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped webhooks | Having integration id in the header will list integration-scoped webhook along with user-scoped webhooks. If it ommited then only user-scoped webhooks will be listed. + +### Query Parameters + +Parameter | Default | Description +--------- | ------- | ----------- +`page` | 1 | Which page to return. +`page_size` | 25 | The number of Webhooks per page. + + + + + +## Register a Webhook + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/webhooks/', + json={ + 'url': 'https://jobmatchr.se/webhooks/payouts/', + 'events': ['Payout.created'] + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"url": "http://0.0.0.0:8000/", "events": ["Payout.created"]}' https://jobmatchr.se/webhooks/payouts/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/", { + method: "POST", + body: JSON.stringify({url: "https://jobmatchr.se/webhooks/payouts/", events: ["Payout.created"]}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "38a93e19-886a-4246-9cfe-471214ff6739", + "url": "https://jobmatchr.se/webhooks/payouts/", + "events": ["Payout.created"], + "secret_key": "c1329a085d65f7757838df5920fdcc9a", + "metadata": {} +} +``` + +This endpoint creates a webhook. + +### HTTP Request + +`POST https://api.gigapay.se/v2/webhooks/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being registered is integration-scoped event. +`Idempotency-key` | False | Idempotency key. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per user account or integration. +`url` | URL | True | | +`events` | String[] | True | | +`secret_key` | String | False | 32 char random string | +`metadata` | Object | False | {} | + + + + + +## Retrieve a Webhook + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/webhooks/481272/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/webhooks/481272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/481272/", { + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "38a93e19-886a-4246-9cfe-471214ff6739", + "url": "https://jobmatchr.se/webhooks/payouts/", + "events": ["Payout.created"], + "secret_key": "c1329a085d65f7757838df5920fdcc9a", + "metadata": {} +} +``` + +This endpoint retrieves a webhook. + +### HTTP Request + +`GET https://api.gigapay.se/v2/webhooks/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped events | The integration id is requied if the webhook that's being retrieved contains one or more integration-scoped events. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + + + + + + +## Update a Webhook + +```python +import requests + +response = requests.patch( + 'https://api.gigapay.se/v2/webhooks/481272/', + json={ + 'events': ['Payout.created', 'Payout.notified'] + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PATCH -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"events": ["Payout.created", "Payout.notified"]}' https://api.gigapay.se/v2/webhooks/481272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/481272/", { + method: "PATCH", + body: JSON.stringify({events: ["Payout.created", "Payout.notified"]}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + }, +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "481272", + "url": "https://jobmatchr.se/webhooks/payouts/", + "events": ["Payout.created", "Payout.notified"], + "secret_key": "c1329a085d65f7757838df5920fdcc9a", + "metadata": {} +} +``` + +This endpoint updates a webhook. + +### HTTP Request + +`PATCH https://api.gigapay.se/v2/webhooks/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being updated is integration-scoped event. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + +### Body Parameters + +Parameter | Type | Required | Default | Notes +--------- | ---- | -------- | ------- |------------ +`id` | String | False | Previous value | Unique per user account or integration. +`url` | URL | False | Previous value | +`events` | String[] | False | Previous value | +`secret_key` | String | False |Previous value | +`metadata` | Object | False | Previous value | + + + + +## Replace a Webhook + +```python +import requests + +response = requests.put( + 'https://api.gigapay.se/v2/webhooks/481272/', + json={ + 'url': 'https://jobmatchr.se/webhooks/payruns/', + 'events': ['Payrun.created'] + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X PUT -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"url": "https://jobmatchr.se/webhooks/payruns/", "events": ["Payrun.created"]}' https://api.gigapay.se/v2/webhooks/481272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/481272/", { + method: "PUT", + body: JSON.stringify({url: "https://jobmatchr.se/webhooks/payruns/", events: ["Payrun.created"]}), + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns JSON structured like this: + +```json +{ + "id": "481272", + "url": "https://jobmatchr.se/webhooks/payruns/", + "events": ["Payrun.created"], + "secret_key": "vksnrsc6tamq73tc26rzrnzf33a4pgdv", + "metadata": {} +} +``` + +```json +{ + "id": "481272", + "url": "https://jobmatchr.se/webhooks/payruns/", + "events": ["Payrun.created"], + "secret_key": "vksnrsc6tamq73tc26rzrnzf33a4pgdv", + "metadata": {} +} +``` + +This endpoint replaces a webhook. + +### HTTP Request + +`PUT https://api.gigapay.se/v2/webhooks/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped events | The integration id is requied if any of the events that is being replaced is integration-scoped event. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. + +### Body Parameters + +Parameter | Type | Required | Default | Description +--------- | ---- | -------- | ------- |------------ +`id` | String | False | uuid4() | Unique per [Integration](#integrations). +`url` | URL | True | | +`events` | String[] | True | | +`secret_key` | String | False | 32 char random string | +`metadata` | Object | False | {} | + + + + + +## Delete a Webhook + +```python +import requests + +response = requests.delete( + 'https://api.gigapay.se/v2/webhooks/481272/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X DELETE -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/webhooks/481272/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/webhooks/481272/", { + method: "DELETE", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +}) +``` + +> The above command returns an empty response. + +This endpoint deletes a webhook. + +### HTTP Request + +`DELETE https://api.gigapay.se/v2/webhooks/:id/` + +### Headers + +Parameter | Required | Description +--------- | ------- | ----------- +`Authorization` | True | Your Authorization Token. +`Integration-ID` | True for integration-scoped events | The integration id is requied if the webhook that is being deleted contains one or more integration-scoped events. + +### URL Parameters + +Parameter | Required | Description +--------- | ------- | ----------- +`id` | True | Unique identifier for the object. diff --git a/source/index.html.md b/source/index.html.md new file mode 100644 index 00000000000..3e99f81321c --- /dev/null +++ b/source/index.html.md @@ -0,0 +1,935 @@ +--- +title: API Documentation | Gigapay + +language_tabs: # must be one of https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers + - shell + - python + - javascript + +toc_footers: + - Questions? Ask us! + - support@gigapay.se + +includes: + - registrations + - integrations + - employees + - messages + - payouts + - pricing + - payruns + - webhooks + +search: true + +code_clipboard: true + +meta: + - name: description + content: Find the all the information you need to implement the Gigapay API here. Simple and fast to integrate. + - name: og:image + content: "https://uploads-ssl.webflow.com/63e63a988110ab2d23f167eb/66193bd79ff1a32e6eaa25ce_api_docs_gigapay_2x.webp" +--- + +# API Reference + +The Gigapay API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded requests, +returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. + +### API server + +
+
+ + +
+ +
+ + +
+
+ +The demo version serves as a test environment for developers working to integrate with our API. No money flows +through the demo environment. + +### Browsable API + +Both the live and demo environment render a human-friendly HTML output for each resource, when the HTML format is +requested by a web browser. This allows for easy browsing and interaction with the available resources. We strongly +recommend you test our Browsable API before starting to integrate with our API, as it will give you a far more +intuitive understanding of the API compared to reading this documentation. + +# Authentication + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' https://api.gigapay.se/v2/ + +``` + +```javascript +fetch("https://api.gigapay.se/v2/", { + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +The Gigapay API uses API keys to identify and authenticate requests. You can request a key by contacting us at +[support@gigapay.se](mailto:support@gigapay.se). Note that you will receive separate keys for the live and demo environment. + +Your API keys carry many privileges, so make sure you keep them secure. Do not share your API keys in +publicly accessible areas such as GitHub, client-side code, etc. + +Authorization to the API is performed through a token-based HTTP Authentication scheme. To authorize requests, +include your key in the `Authorization` HTTP header. Note that the API key should be prefixed by the string literal +`Token`, with whitespace separating the two strings. + +To specify which [Integration](#integrations) you are acting as you need to provide the `Integration-ID` header. + +### Tokens + +
+ + + + +

Replacing the above tokens with your own will add them to the provided code examples, making them executable. +

+
+ +### Unauthenticated Requests + +API requests without valid authentication will fail with the HTTP response code `401`. If you are getting unexpected +`401` responses, ensure that your URL is correct. API calls made over plain HTTP will be redirected with the response +code `301`, and API calls with incorrect placed `/` will be redirected with the response code `307` to the correct URL, +and most HTTP clients will automatically follow the redirects while stripping out the authorization headers, resulting +in the `401` response. Disable automated redirects or be mindful of this. + +### IP-whitelisting + +The Gigapay API Supports IP-whitelisting. When requesting API-keys, let us know if you want to only allow access from certain IP addresses. +If IP-whitelisting is enabled, API requests made from a non-whitelisted IP will be rejected with HTTP +response code `403`. + +### Language + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b', + 'Accept-Language': 'sv', + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -H "Accept-Language: en" https://api.gigapay.se/v2/ + +``` + +```javascript +fetch("https://api.gigapay.se/v2/", { + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + "Accept-Language": "sv", + }, +}); +``` + +The default language of the API is English. This document is written assuming you have the language set to English. +To change language set the `Accept-Language` header to your preferred language. + +# Events + +> An example Employee object with event timestamps: + +```json +{ + "id": "25d2af38-59b9-4f73-9452-51787fed5c84", + "name": "Karl Karlsson", + "cellphone_number": null, + "email": "karl.karlsson@gmail.com", + "metadata": {}, + "created_at": "2019-05-20T15:33:08.974624Z", + "notified_at": "2019-05-20T15:33:12.581720Z", + "claimed_at": "2019-05-21T09:13:32.575721Z", + "verified_at": "2019-05-21T09:13:48.625263Z", + "invitation_code": null +} +``` + +The Gigapay API is driven by actions taken by the parties involved in each Payout; the Client making the Payout, +Gigapay facilitating it, and the Employee receiving it. The flowchart below illustrates each of these actions and +the corresponding events. + +[ ![](events.svg) ](images/events.svg) + +Note that the Employee and Payout flow typically occur in parallel as the Employee is usually created when, or close in +time to when, their first Payout is created. + +All objects are timestamped when an associated event occurs. The field is simply the name of the event suffixed +with `_at`. + +## Subscribing to Events + +> An example webhook for the `Employee.verified` event: + +```http +POST https://jobmatchr.se/webhooks/employees/ HTTP/1.1 +Content-Type: application/json +Gigapay-Signature: t=1583327301,v1=ad583e2b2093c8d6fb3b65e04b99fc5988e98c0c312909acad334072da7e99ec +... + +{ + "id": "25d2af38-59b9-4f73-9452-51787fed5c84", + "name": "Karl Karlsson", + "cellphone_number": null, + "email": "karl.karlsson@gmail.com", + "metadata": { + "user_id": 3 + }, + "created_at": "2019-05-20T15:33:08.974624Z", + "notified_at": "2019-05-20T15:33:12.581720Z", + "claimed_at": "2019-05-21T09:13:32.575721Z", + "verified_at": "2019-05-21T09:13:48.625263Z", + "invitation_code": null +} +``` + +The Gigapay API allows you to register [Webhooks](#webhooks) in order to receive real-time updates on events related +to your Gigapay account. They are optional, but the preferred way of monitoring the status of objects. We can send callbacks +on the following events: + +- `Employee.created` +- `Employee.notified` +- `Employee.claimed` +- `Employee.verified` +- `Payout.created` +- `Payout.notified` +- `Payout.accepted` +- `Payrun.created` +- `Payrun.paid` +- `Registration.verified` + +The notifications simply contain the object that triggered the event, as represented in the API. + +### Webhook Types + +**Integration-Scoped Webhooks** +
+These webhooks are tied to a specific integration and require an `Integration-ID` header for all operations. +This includes events that start with `Employee`, `Payout`, or `Payrun`. + +**User-Scoped Webhooks** +
+These webhooks are tied to your user account and do **not** require an `Integration-ID` header for any operations. +This includes events that start with `Registration`. + + +### Gigapay Signature + +> Example code to verify a Gigapay Signature: + +```shell +secret_key = '...asId' + +# If you're doing this in shell; parse the request manually: +timestamp='...' +signature='...' +body='...' + +payload=${timestamp}.${body} + +calculated_signature=$(echo -n $payload | openssl dgst -sha256 -hmac $secret_key) + +if [ $signature == $calculated_signature ]; then + ... +fi +``` + +```python +import hmac + +secret_key = '...asId' + +t, v1 = request.headers['Gigapay-Signature'].split(',') +timestamp = t.split('=')[1] +signature = v1.split('=')[1] + +payload = timestamp + '.' + request.body + +hmac.new(secret_key.encode('utf-8'), digestmod='sha256') +hmac.update(payload.encode('utf-8')) +calculated_signature = hmac.hexdigest() + +hmac.compare_digest(signature, calculated_signature) +``` + +```javascript +import hmacSHA512 from "crypto-js/hmac-sha512"; + +let secret_key = "...asId"; + +let [t, v1] = request.get("Gigapay-Signature").split(","); +let timestamp = t.split("=")[1]; +let signature = v1.split("=")[1]; + +let payload = timestamp + "." + request.body; + +let calculated_signature = hmacSHA512(payload, secret_key); + +calculated_signature === signature; +``` + +The notification is signed using the `secret_key` for the [Webhooks](#webhooks), the signature is included in the +notification as a `Gigapay-Signature` header. This allows you to verify that the events were sent by Gigapay, and not +by a third party. + +The signature consists of two parameters; + +`t`, the timestamp of when the notification was sent, and; + +`v` the signature of the current scheme. + +The only valid signature scheme is currently `v1`, which is the HMAC algorithm as described in +[RFC 2104](https://datatracker.ietf.org/doc/html/rfc2104.html) using SHA256 as digestmod. + +To verify signatures using the v1 scheme, extract the timestamp from the Gigapay-Signature header, and the JSON-encoded +notification from the request body. Join these strings with a period, `.`, as a separator. Compute an HMAC with the +SHA256 hash function using the Webhook's secret key as the key. Lastly ensure that the signature in the header and the +calculated signature matches. + +# Errors + +```http +HTTP/1.1 405 Method Not Allowed +Allow: GET, HEAD, OPTIONS +... + +{"detail":"Method \"DELETE\" not allowed."} +``` + +Gigapay uses HTTP response codes to indicate whether an API request was successful. Codes in the `2XX` range indicate +success; codes in the `4XX` range indicate that the request failed, given the information provided; codes in the +`5XX` range indicate an error with Gigapay's servers. Response codes in the `4XX` range generally indicate a client +error and will as such include information in the body of the response describing the cause of the error. + +```http +HTTP/1.1 400 Bad Request +... + +{"description": ["This field may not be blank."]} +``` + +Validation errors returned on otherwise valid requests are structured differently. They will respond with the +status code `400`and include the field names as the keys in the response. If the validation error was not specific +to a particular field then the `non_field_errors` key will be used. + +# Expanding objects + +> Request to retrieve a Payout object with the related Employee object expanded: + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payouts/9472/?expand=employee', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' 'https://api.gigapay.se/v2/payouts/9472/?expand=employee' +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/9472/?expand=employee", { + method: "GET", + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> Returns a response formatted as such: + +```json +{ + "id": "9472", + "amount": "760.92", + "cost": "1020.00", + "currency": "SEK", + "description": "Instagram samarbete 2021-11-13.", + "employee": { + "id": "1847", + "name": "Albin Lindskog", + "email": "albin@mail.com", + "cellphone_number": "+46700000001", + "country": "SWE", + "metadata": {}, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": null, + "claimed_at": null, + "verified_at": null, + "invitation_code": "ABCD1234" + }, + "invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7", + "invoiced_amount": "1000.00", + "metadata": { + "campaign_id": 12394 + }, + "start_at": null, + "end_at": null, + "created_at": "2019-05-23T10:32:38.118753Z", + "notified_at": null, + "accepted_at": null +} +``` + +Many objects contain the identifier of a related object in their response properties. For example, a +[Payout](#payouts) has an associated [Employee](#employees) identifier. Those objects can be +expanded inline with the `expand` request parameter. Objects that can be expanded are noted in this documentation. +You can use the `expand` param on any endpoint which includes expandable fields, including the create endpoints. +You can expand multiple objects at once by repeating the `expand` request parameter. + +# Pagination + +> Request to retrieve two Employee objects per page, and the second page: + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/employees/?page_size=2&page=2', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' 'https://api.gigapay.se/v2/employees/?page_size=2&page=2' +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/?page_size=2&page=2", { + method: "GET", + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> Returns a response formatted as such: + +```json +{ + "count": 17, + "next": "https://api.gigapay.se/v2/employees/?page=3", + "previous": "https://api.gigapay.se/v2/employees/?page=1", + "results": [ + { + "id": "1f1d1263-0e79-4787-b573-6df81b44bfc2", + "name": "Albin Lindskog", + "cellphone_number": "+46703000000", + "email": null, + "metadata": { + "user_id": 2 + }, + "created_at": "2019-05-20T15:33:08.974624Z", + "notified_at": "2019-05-20T15:33:12.581720Z", + "claimed_at": "2019-05-21T09:13:32.575721Z", + "verified_at": "2019-05-21T09:13:48.625263Z", + "invitation_code": null + }, + { + "id": "25d2af38-59b9-4f73-9452-51787fed5c84", + "name": "Karl Karlsson", + "cellphone_number": null, + "email": "karl.karlsson@gmail.com", + "metadata": { + "user_id": 3 + }, + "created_at": "2019-05-20T15:33:08.974624Z", + "notified_at": "2019-05-20T15:33:12.581720Z", + "claimed_at": null, + "verified_at": null, + "invitation_code": "ABCD1234" + } + ] +} +``` + +The Gigapay API uses pagination on all of its list-endpoints. These endpoints all share a common structure, optionally +accepting `page` and a `page_size` request parameter. `page` specifies which page to return and `page_size` the number +of objects per page. The objects returned are contained within the `result` field of the response. + +# Filtering + +> Request to retrieve all non-accepted Payouts belonging to a specific Employee: + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payouts/?employee=12&accepted_at_null=True', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' 'https://api.gigapay.se/v2/payouts/?employee=12&accepted_at_null=True' +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/?employee=12&accepted_at_null=True", { + method: "GET", + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> Returns a response formatted as such: + +```json +{ + "count": 1, + "next": null, + "previous": null, + "results": [ + { + "id": "0177270d-f94b-4ab9-88ba-ac1fa2f791aa", + "amount": "100.00", + "cost": "137.99", + "currency": "SEK", + "description": "Lön genom Gigapay", + "employee": "12", + "invoice": "bab4b830-47d6-4a24-a460-3289897f6e8e", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2019-05-22T10:32:38.118753Z", + "notified_at": "2019-05-22T10:38:19.874623Z", + "accepted_at": null + } + ] +} +``` + +> Request to retrieve all employees with string "skoog" in name, email or phone number: + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/employees/?search=skoog', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' 'https://api.gigapay.se/v2/employees/?search=skoog' +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/?search=skoog", { + method: "GET", + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> Returns a response formatted as such: + +```json +{ + "count": 2, + "next": null, + "previous": null, + "results": [ + { + "id": "59cc997d-b4bc-4b2d-ac2d-0101ea9ba241", + "name": "Joakim Karlsson", + "cellphone_number": "+46703100002", + "email": "skoog@gigapay.co", + "country": "SWE", + "metadata": {}, + "created_at": "2022-04-11T13:05:27.565954Z", + "notified_at": "2022-04-11T13:05:27.565954Z", + "claimed_at": "2022-04-11T13:05:27.565954Z", + "verified_at": "2022-04-11T14:05:27.565954Z", + "invitation_code": null + }, + { + "id": "481c3138-5710-4086-9237-a082e87d624f", + "name": "Joakim Skoog", + "cellphone_number": "+46703100001", + "email": "joakims@gigapay.co", + "country": "SWE", + "metadata": {}, + "created_at": "2022-04-11T13:05:27.543935Z", + "notified_at": "2022-04-11T13:05:27.543935Z", + "claimed_at": "2022-04-11T13:05:27.543935Z", + "verified_at": "2022-04-11T14:05:27.543935Z", + "invitation_code": null + } + ] +} +``` + +> Request to retrieve all payouts to employees with string "skoog" in name, email or phone number or with string "skoog" in the description of the payout: + +```python +import requests + +response = requests.get( + 'https://api.gigapay.se/v2/payouts/?search=skoog', + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X GET -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' 'https://api.gigapay.se/v2/payouts/?search=skoog' +``` + +```javascript +fetch("https://api.gigapay.se/v2/payouts/?search=skoog", { + method: "GET", + headers: { + "Authorization": "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b" + } +} +``` + +> Returns a response formatted as such: + +```json +{ + "count": 3, + "next": null, + "previous": null, + "results": [ + { + "id": "bfdac591-4bc5-45d3-9e93-27a885c8b130", + "cost": "1396.32", + "invoiced_amount": "1368.95", + "amount": "1000.00", + "currency": "SEK", + "description": "Test", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2022-04-14T08:31:11.773275Z", + "notified_at": null, + "accepted_at": null, + "employee": { + "id": "411246da-0b59-41c6-8b87-1e5abb73af30", + "name": "Kalle Karlsson", + "cellphone_number": "+46703100003", + "email": "skoog@gigapay.co", + "country": "SWE", + "metadata": {}, + "created_at": "2022-04-14T08:31:11.741713Z", + "notified_at": "2022-04-14T08:31:11.741713Z", + "claimed_at": "2022-04-14T08:31:11.741713Z", + "verified_at": "2022-04-14T09:31:11.741713Z", + "invitation_code": null + }, + "invoice": "f4377884-e4c0-4e65-bbd1-24f52973b933", + "full_salary_specification": false + }, + { + "id": "1bc53e19-3589-4f92-aece-360006cfe196", + "cost": "1396.32", + "invoiced_amount": "1368.95", + "amount": "1000.00", + "currency": "SEK", + "description": "Test", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2022-04-14T08:31:11.763167Z", + "notified_at": null, + "accepted_at": null, + "employee": { + "id": "411246da-0b59-41c6-8b87-1e5abb73af30", + "name": "Kalle Karlsson", + "cellphone_number": "+46703100003", + "email": "skoog@gigapay.co", + "country": "SWE", + "metadata": {}, + "created_at": "2022-04-14T08:31:11.741713Z", + "notified_at": "2022-04-14T08:31:11.741713Z", + "claimed_at": "2022-04-14T08:31:11.741713Z", + "verified_at": "2022-04-14T09:31:11.741713Z", + "invitation_code": null + }, + "invoice": "b749b0fd-a82a-4644-a7c8-e89ae891cc23", + "full_salary_specification": false + }, + { + "id": "bf216a95-0560-46c8-b9c7-0d15850aea23", + "cost": "1396.32", + "invoiced_amount": "1368.95", + "amount": "1000.00", + "currency": "SEK", + "description": "Test", + "metadata": {}, + "start_at": null, + "end_at": null, + "created_at": "2022-04-14T08:31:11.755175Z", + "notified_at": null, + "accepted_at": null, + "employee": { + "id": "1fa40cc7-a2c9-43ab-972f-eb322bded992", + "name": "Joakim Skoog", + "cellphone_number": "+46703100002", + "email": "joakim@gigapay.co", + "country": "SWE", + "metadata": {}, + "created_at": "2022-04-14T08:31:11.707438Z", + "notified_at": "2022-04-14T08:31:11.707438Z", + "claimed_at": "2022-04-14T08:31:11.707438Z", + "verified_at": "2022-04-14T09:31:11.707438Z", + "invitation_code": null + }, + "invoice": "e5647953-4df7-4166-9066-f9dea11b66f3", + "full_salary_specification": false + } + ] +} +``` + +The Gigapay API supports filtering on all of its list-endpoints. These filters are of two types, either relational +filters or timestamp filters. Which filters are available are described under each endpoint. + +Relational filters filter out all objects belonging to a specified object. +They are use the format `{field_name}={object_id}`. + +Timestamp filters are used to filter out objects having had a certain event associated with them. They can be used to +filter on whether an event has occurred with the `null` suffix, e.g. `{field_name}_null={Bool}`, or when, by using the +`_before` and `_after` suffix, e.g. `{field_name}_before={ISO 8601 string}`. + +# Idempotency + +> Registering an Employee with an idempotency key + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/employees/', + json={ + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000000', + 'country': 'SWE', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Idempotency-Key': 'afjkakkknbkasaskkaksdakjdnsakja', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Idempotency-Key': 'afjkakkknbkasaskkaksdakjdnsakja' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"name": "Albin Lindskog", "cellphone_number": "+4670000001", "country": "SWE"}' https://api.gigapay.se/v2/employees/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/", { + method: "POST", + body: JSON.stringify({ + name: "Albin Lindskog", + cellphone_number: "+4670000000", + country: "SWE", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Idempotency-Key": "afjkakkknbkasaskkaksdakjdnsakja", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +The Gigapay API supports idempotency to safely retry requests without accidentally performing the same operation twice. +Gigapay offers two mechanism of idempotency; idempotency keys and object ids. + +To perform an idempotent request using an idempotency-key, provide the additional `Idempotency-Key` header to the +request. Idempotency keys works by storing the responses of previous requests. Subsequent requests with the same key +return the same response, without performing the action specified in the request. Keys expire after 24 hours, so a new +response is generated if a key is reused outside that timeframe. + +> Registering an Employee with a specific id + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/employees/', + json={ + 'id': 19472, + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000000', + 'country': 'SWE', + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Idempotency-Key': 'afjkakkknbkasaskkaksdakjdnsakja' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"id": 19472, "name": "Albin Lindskog", "cellphone_number": "+4670000001", "country": "SWE"}' https://api.gigapay.se/v2/employees/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/", { + method: "POST", + body: JSON.stringify({ + id: 19472, + name: "Albin Lindskog", + cellphone_number: "+4670000000", + country: "SWE", + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +To perform an idempotent request using an object id simply specify the id when creating the object. Object ids ensure +idempotency when creating object as no objects can have the same id. Subsequent requests with the same id will return +an error. The uniqueness of an id is guaranteed for the lifetime of the object. + +# Metadata + +> Registering an Employee with metadata: + +```python +import requests + +response = requests.post( + 'https://api.gigapay.se/v2/employees/', + json={ + 'name': 'Albin Lindskog', + 'cellphone_number': '+4670000000', + 'country': 'SWE', + 'metadata': { + 'user_id': 1847, + }, + }, + headers={ + 'Authorization': 'Token cd7a4537a231356d404b553f465b6af2fa035821', + 'Integration-ID': '79606358-97af-4196-b64c-5f719433d56b' + } +) +``` + +```shell +curl -X POST -H 'Authorization: Token cd7a4537a231356d404b553f465b6af2fa035821' -H 'Content-Type: application/json' -H 'Integration-ID: 79606358-97af-4196-b64c-5f719433d56b' -d '{"name": "Albin Lindskog", "cellphone_number": "+4670000001", "country": "SWE", "metadata": {"user_id": 1847}}' https://api.gigapay.se/v2/employees/ +``` + +```javascript +fetch("https://api.gigapay.se/v2/employees/", { + method: "POST", + body: JSON.stringify({ + name: "Albin Lindskog", + cellphone_number: "+4670000000", + country: "SWE", + metadata: { + user_id: 1847, + }, + }), + headers: { + Authorization: "Token cd7a4537a231356d404b553f465b6af2fa035821", + "Content-Type": "application/json", + "Integration-Id": "79606358-97af-4196-b64c-5f719433d56b", + }, +}); +``` + +> Response: + +```json +{ + "id": "123e4567-e89b-12d3-a456-426614174000", + "name": "Albin Lindskog", + "email": null, + "cellphone_number": "+46703000000", + "country": "SWE", + "metadata": { + "user_id": 1847 + }, + "created_at": "2019-05-22T10:32:36.118753Z", + "notified_at": null, + "claimed_at": null, + "verified_at": null, + "invitation_code": "ABCD1234" +} +``` + +All objects in the Gigapay API have a `metadata` attribute. You can use this attribute to attach any +JSON-serializable data to these objects. It is useful for storing additional information about an object. For example, +you could store a unique identifier for an Employee in your system. This data is not used by Gigapay, and will not be +displayed to any users. + +The [Payout](#payouts) object also has a `description` field. It should contain a human-readable description of why +this Payout is being made. Unlike `metadata`, `description` is a single string, and the Employee will see it. diff --git a/source/index.md b/source/index.md deleted file mode 100644 index 4c1fa8c9f7d..00000000000 --- a/source/index.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: API Reference - -language_tabs: - - shell - - ruby - - python - -toc_footers: - - Sign Up for a Developer Key - - Documentation Powered by Slate - -includes: - - errors - -search: true ---- - -# Introduction - -Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database. - -We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right. - -This example API documentation page was created with [Slate](http://github.com/tripit/slate). Feel free to edit it and use it as a base for your own API's documentation. - -# Authentication - -> To authorize, use this code: - -```ruby -require 'kittn' - -api = Kittn::APIClient.authorize!('meowmeowmeow') -``` - -```python -import kittn - -api = kittn.authorize('meowmeowmeow') -``` - -```shell -# With shell, you can just pass the correct header with each request -curl "api_endpoint_here" - -H "Authorization: meowmeowmeow" -``` - -> Make sure to replace `meowmeowmeow` with your API key. - -Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our [developer portal](http://example.com/developers). - -Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following: - -`Authorization: meowmeowmeow` - - - -# Kittens - -## Get All Kittens - -```ruby -require 'kittn' - -api = Kittn::APIClient.authorize!('meowmeowmeow') -api.kittens.get -``` - -```python -import kittn - -api = kittn.authorize('meowmeowmeow') -api.kittens.get() -``` - -```shell -curl "http://example.com/api/kittens" - -H "Authorization: meowmeowmeow" -``` - -> The above command returns JSON structured like this: - -```json -[ - { - "id": 1, - "name": "Fluffums", - "breed": "calico", - "fluffiness": 6, - "cuteness": 7 - }, - { - "id": 2, - "name": "Isis", - "breed": "unknown", - "fluffiness": 5, - "cuteness": 10 - } -] -``` - -This endpoint retrieves all kittens. - -### HTTP Request - -`GET http://example.com/api/kittens` - -### Query Parameters - -Parameter | Default | Description ---------- | ------- | ----------- -include_cats | false | If set to true, the result will also include cats. -available | true | If set to false, the result will include kittens that have already been adopted. - - - -## Get a Specific Kitten - -```ruby -require 'kittn' - -api = Kittn::APIClient.authorize!('meowmeowmeow') -api.kittens.get(2) -``` - -```python -import kittn - -api = kittn.authorize('meowmeowmeow') -api.kittens.get(2) -``` - -```shell -curl "http://example.com/api/kittens/2" - -H "Authorization: meowmeowmeow" -``` - -> The above command returns JSON structured like this: - -```json -{ - "id": 2, - "name": "Isis", - "breed": "unknown", - "fluffiness": 5, - "cuteness": 10 -} -``` - -This endpoint retrieves a specific kitten. - - - -### HTTP Request - -`GET http://example.com/kittens/` - -### URL Parameters - -Parameter | Description ---------- | ----------- -ID | The ID of the kitten to retrieve - diff --git a/source/javascripts/all.js b/source/javascripts/all.js index ffaa9b01307..5f5d4067ba6 100644 --- a/source/javascripts/all.js +++ b/source/javascripts/all.js @@ -1,4 +1,2 @@ -//= require ./lib/_energize -//= require ./app/_lang +//= require ./all_nosearch //= require ./app/_search -//= require ./app/_toc diff --git a/source/javascripts/all_nosearch.js b/source/javascripts/all_nosearch.js index 818bc4e5095..4af7bfbbfde 100644 --- a/source/javascripts/all_nosearch.js +++ b/source/javascripts/all_nosearch.js @@ -1,3 +1,28 @@ //= require ./lib/_energize -//= require ./app/_lang +//= require ./app/_copy //= require ./app/_toc +//= require ./app/_lang +//= require ./app/_dynamic + +function adjustLanguageSelectorWidth() { + const elem = $('.dark-box > .lang-selector'); + elem.width(elem.parent().width()); +} + +$(function() { + loadToc($('#toc'), '.toc-link', '.toc-list-h2', 10); + setupLanguages($('body').data('languages')); + $('.content').imagesLoaded( function() { + window.recacheHeights(); + window.refreshToc(); + }); + + $(window).resize(function() { + adjustLanguageSelectorWidth(); + }); + adjustLanguageSelectorWidth(); +}); + +window.onpopstate = function() { + activateLanguage(getLanguageFromQueryString()); +}; diff --git a/source/javascripts/app/_copy.js b/source/javascripts/app/_copy.js new file mode 100644 index 00000000000..4dfbbb6c06d --- /dev/null +++ b/source/javascripts/app/_copy.js @@ -0,0 +1,15 @@ +function copyToClipboard(container) { + const el = document.createElement('textarea'); + el.value = container.textContent.replace(/\n$/, ''); + document.body.appendChild(el); + el.select(); + document.execCommand('copy'); + document.body.removeChild(el); +} + +function setupCodeCopy() { + $('pre.highlight').prepend('
Copy to Clipboard
'); + $('.copy-clipboard').on('click', function() { + copyToClipboard(this.parentNode.children[1]); + }); +} diff --git a/source/javascripts/app/_dynamic.js b/source/javascripts/app/_dynamic.js new file mode 100644 index 00000000000..363adbff47c --- /dev/null +++ b/source/javascripts/app/_dynamic.js @@ -0,0 +1,87 @@ +//= require ../lib/_jquery + +function wrapDynamicContent() { + dynamicServerNames(); + dynamicAuthenticationToken(); + dynamicIntegrationId(); +} + +/* +When the page has loaded we wrap all occurrences of the server name with a then we attach +an event_handler to the serverSelect in index.html.md. This allows us the user to change between +the prod and demo server in the documentation. + */ +function dynamicServerNames() { + var input = $('input[type=radio]'); + var placeholder = 'https://api.gigapay.se/v2/'; + var value = $('input[type=radio]:checked')[0].value.replace('///', '//'); // remove escaping necessary in .md file + + var span = document.createElement('span'); + span.className = 'hostServer'; + span.innerHTML = value || placeholder; + + $("code").each(function() { + if (this.innerText.includes(placeholder)) { + this.innerHTML = this.innerHTML.replaceAll(placeholder, span.outerHTML); + } + }); + + input.click(function() { + var choice = this.value.replace('///', '//'); + $(".hostServer").map(function() { + this.innerText = choice; + }) + }); +} + +/* +Then we do the same for the Authentication Token input. + */ +function dynamicAuthenticationToken() { + var inputs = $('#auth') + var placeholder = inputs[0].placeholder + var value = inputs[0].value + + var span = document.createElement('span'); + span.className = 'authenticationToken'; + span.innerHTML = value || placeholder; + + $("code").each(function() { + if (this.innerText.includes(placeholder)) { + this.innerHTML = this.innerHTML.replaceAll(placeholder, span.outerHTML); + } + }); + + inputs.on('input', function() { + var value = this.value; + $(".authenticationToken").map(function() { + this.innerText = value ? value : placeholder; + }) + }); +} + +/* +And the Integration ID input. + */ +function dynamicIntegrationId() { + var inputs = $('#integration'); + var placeholder = inputs[0].placeholder + var value = inputs[0].value + + var span = document.createElement('span'); + span.className = 'integrationToken'; + span.innerHTML = value || placeholder; + + $("code").each(function() { + if (this.innerText.includes(placeholder)) { + this.innerHTML = this.innerHTML.replaceAll(placeholder, span.outerHTML); + } + }); + + inputs.on('input', function() { + var value = this.value; + $(".integrationToken").map(function() { + this.innerText = value ? value : placeholder; + }) + }); +} diff --git a/source/javascripts/app/_lang.js b/source/javascripts/app/_lang.js index 1a124bb68ae..c1bd6b2a9b0 100644 --- a/source/javascripts/app/_lang.js +++ b/source/javascripts/app/_lang.js @@ -1,3 +1,5 @@ +//= require ../lib/_jquery + /* Copyright 2008-2013 Concur Technologies, Inc. @@ -13,13 +15,14 @@ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ -(function (global) { +;(function () { 'use strict'; var languages = []; - global.setupLanguages = setupLanguages; - global.activateLanguage = activateLanguage; + window.setupLanguages = setupLanguages; + window.activateLanguage = activateLanguage; + window.getLanguageFromQueryString = getLanguageFromQueryString; function activateLanguage(language) { if (!language) return; @@ -28,11 +31,13 @@ under the License. $(".lang-selector a").removeClass('active'); $(".lang-selector a[data-language-name='" + language + "']").addClass('active'); for (var i=0; i < languages.length; i++) { - $(".highlight." + languages[i]).hide(); + $(".highlight.tab-" + languages[i]).hide(); + $(".lang-specific." + languages[i]).hide(); } - $(".highlight." + language).show(); + $(".highlight.tab-" + language).show(); + $(".lang-specific." + language).show(); - global.toc.calculateHeights(); + window.recacheHeights(); // scroll to the new location of the position if ($(window.location.hash).get(0)) { @@ -93,7 +98,7 @@ under the License. // gets the language set in the query string function getLanguageFromQueryString() { if (location.search.length >= 1) { - var language = parseURL(location.search).language + var language = parseURL(location.search).language; if (language) { return language; } else if (jQuery.inArray(location.search.substr(1), languages) != -1) { @@ -124,20 +129,27 @@ under the License. history.pushState({}, '', '?' + generateNewQueryString(language) + '#' + hash); // save language as next default - localStorage.setItem("language", language); + if (localStorage) { + localStorage.setItem("language", language); + } } function setupLanguages(l) { - var defaultLanguage = localStorage.getItem("language"); + var defaultLanguage = null; + if (localStorage) { + defaultLanguage = localStorage.getItem("language"); + } languages = l; var presetLanguage = getLanguageFromQueryString(); - if (presetLanguage) { + if (presetLanguage && languages.includes(presetLanguage)) { // the language is in the URL, so use that language! activateLanguage(presetLanguage); - localStorage.setItem("language", presetLanguage); + if (localStorage) { + localStorage.setItem("language", presetLanguage); + } } else if ((defaultLanguage !== null) && (jQuery.inArray(defaultLanguage, languages) != -1)) { // the language was the last selected one saved in localstorage, so use that language! activateLanguage(defaultLanguage); @@ -155,8 +167,5 @@ under the License. activateLanguage(language); return false; }); - window.onpopstate = function() { - activateLanguage(getLanguageFromQueryString()); - }; }); -})(window); +})(); diff --git a/source/javascripts/app/_search.js b/source/javascripts/app/_search.js index 91f38a04edf..0b0ccd97fdd 100644 --- a/source/javascripts/app/_search.js +++ b/source/javascripts/app/_search.js @@ -1,49 +1,76 @@ //= require ../lib/_lunr +//= require ../lib/_jquery //= require ../lib/_jquery.highlight -(function () { +;(function () { 'use strict'; var content, searchResults; var highlightOpts = { element: 'span', className: 'search-highlight' }; + var searchDelay = 0; + var timeoutHandle = 0; + var index; - var index = new lunr.Index(); + function populate() { + index = lunr(function(){ + + this.ref('id'); + this.field('title', { boost: 10 }); + this.field('body'); + this.pipeline.add(lunr.trimmer, lunr.stopWordFilter); + var lunrConfig = this; + + $('h1, h2').each(function() { + var title = $(this); + var body = title.nextUntil('h1, h2'); + lunrConfig.add({ + id: title.prop('id'), + title: title.text(), + body: body.text() + }); + }); - index.ref('id'); - index.field('title', { boost: 10 }); - index.field('body'); - index.pipeline.add(lunr.trimmer, lunr.stopWordFilter); + }); + determineSearchDelay(); + } $(populate); $(bind); - function populate() { - $('h1, h2').each(function() { - var title = $(this); - var body = title.nextUntil('h1, h2'); - index.add({ - id: title.prop('id'), - title: title.text(), - body: body.text() - }); - }); + function determineSearchDelay() { + if (index.tokenSet.toArray().length>5000) { + searchDelay = 300; + } } function bind() { content = $('.content'); searchResults = $('.search-results'); - $('#input-search').on('keyup', search); + $('#input-search').on('keyup',function(e) { + var wait = function() { + return function(executingFunction, waitTime){ + clearTimeout(timeoutHandle); + timeoutHandle = setTimeout(executingFunction, waitTime); + }; + }(); + wait(function(){ + search(e); + }, searchDelay); + }); } function search(event) { + + var searchInput = $('#input-search')[0]; + unhighlight(); searchResults.addClass('visible'); // ESC clears the field - if (event.keyCode === 27) this.value = ''; + if (event.keyCode === 27) searchInput.value = ''; - if (this.value) { - var results = index.search(this.value).filter(function(r) { + if (searchInput.value) { + var results = index.search(searchInput.value).filter(function(r) { return r.score > 0.0001; }); @@ -53,10 +80,10 @@ var elem = document.getElementById(result.ref); searchResults.append("
  • " + $(elem).text() + "
    • "); }); - highlight.call(this); + highlight.call(searchInput); } else { searchResults.html('
  • '); - $('.search-results li').text('No Results Found for "' + this.value + '"'); + $('.search-results li').text('No Results Found for "' + searchInput.value + '"'); } } else { unhighlight(); @@ -72,3 +99,4 @@ content.unhighlight(highlightOpts); } })(); + diff --git a/source/javascripts/app/_toc.js b/source/javascripts/app/_toc.js index d84bf8e197a..f70bdc0ff44 100644 --- a/source/javascripts/app/_toc.js +++ b/source/javascripts/app/_toc.js @@ -1,50 +1,122 @@ -//= require ../lib/_jquery_ui -//= require ../lib/_jquery.tocify -(function (global) { +//= require ../lib/_jquery +//= require ../lib/_imagesloaded.min +;(function () { 'use strict'; + var htmlPattern = /<[^>]*>/g; + var loaded = false; + + var debounce = function(func, waitTime) { + var timeout = false; + return function() { + if (timeout === false) { + setTimeout(function() { + func(); + timeout = false; + }, waitTime); + timeout = true; + } + }; + }; + var closeToc = function() { - $(".tocify-wrapper").removeClass('open'); + $(".toc-wrapper").removeClass('open'); $("#nav-button").removeClass('open'); }; - var makeToc = function() { - global.toc = $("#toc").tocify({ - selectors: 'h1, h2', - extendPage: false, - theme: 'none', - smoothScroll: false, - showEffectSpeed: 0, - hideEffectSpeed: 180, - ignoreSelector: '.toc-ignore', - highlightOffset: 60, - scrollTo: -1, - scrollHistory: true, - hashGenerator: function (text, element) { - return element.prop('id'); + function loadToc($toc, tocLinkSelector, tocListSelector, scrollOffset) { + var headerHeights = {}; + var pageHeight = 0; + var windowHeight = 0; + var originalTitle = document.title; + + var recacheHeights = function() { + headerHeights = {}; + pageHeight = $(document).height(); + windowHeight = $(window).height(); + + $toc.find(tocLinkSelector).each(function() { + var targetId = $(this).attr('href'); + if (targetId[0] === "#") { + headerHeights[targetId] = $("#" + $.escapeSelector(targetId.substring(1))).offset().top; + } + }); + }; + + var refreshToc = function() { + var currentTop = $(document).scrollTop() + scrollOffset; + + if (currentTop + windowHeight >= pageHeight) { + // at bottom of page, so just select last header by making currentTop very large + // this fixes the problem where the last header won't ever show as active if its content + // is shorter than the window height + currentTop = pageHeight + 1000; + } + + var best = null; + for (var name in headerHeights) { + if ((headerHeights[name] < currentTop && headerHeights[name] > headerHeights[best]) || best === null) { + best = name; + } } - }).data('toc-tocify'); - $("#nav-button").click(function() { - $(".tocify-wrapper").toggleClass('open'); - $("#nav-button").toggleClass('open'); - return false; - }); + // Catch the initial load case + if (currentTop == scrollOffset && !loaded) { + best = window.location.hash; + loaded = true; + } - $(".page-wrapper").click(closeToc); - $(".tocify-item").click(closeToc); - }; + var $best = $toc.find("[href='" + best + "']").first(); + if (!$best.hasClass("active")) { + // .active is applied to the ToC link we're currently on, and its parent
      s selected by tocListSelector + // .active-expanded is applied to the ToC links that are parents of this one + $toc.find(".active").removeClass("active"); + $toc.find(".active-parent").removeClass("active-parent"); + $best.addClass("active"); + $best.parents(tocListSelector).addClass("active").siblings(tocLinkSelector).addClass('active-parent'); + $best.siblings(tocListSelector).addClass("active"); + $toc.find(tocListSelector).filter(":not(.active)").slideUp(150); + $toc.find(tocListSelector).filter(".active").slideDown(150); + if (window.history.replaceState) { + window.history.replaceState(null, "", best); + } + var thisTitle = $best.data("title"); + if (thisTitle !== undefined && thisTitle.length > 0) { + document.title = thisTitle.replace(htmlPattern, "") + " – " + originalTitle; + } else { + document.title = originalTitle; + } + } + }; - // Hack to make already open sections to start opened, - // instead of displaying an ugly animation - function animate () { - setTimeout(function() { - toc.setOption('showEffectSpeed', 180); - }, 50); - } + var makeToc = function() { + recacheHeights(); + refreshToc(); - $(makeToc); - $(animate); + $("#nav-button").click(function() { + $(".toc-wrapper").toggleClass('open'); + $("#nav-button").toggleClass('open'); + return false; + }); + $(".page-wrapper").click(closeToc); + $(".toc-link").click(closeToc); -})(window); + // reload immediately after scrolling on toc click + $toc.find(tocLinkSelector).click(function() { + setTimeout(function() { + refreshToc(); + }, 0); + }); + + $(window).scroll(debounce(refreshToc, 200)); + $(window).resize(debounce(recacheHeights, 200)); + }; + + makeToc(); + + window.recacheHeights = recacheHeights; + window.refreshToc = refreshToc; + } + window.loadToc = loadToc; +})(); diff --git a/source/javascripts/lib/_imagesloaded.min.js b/source/javascripts/lib/_imagesloaded.min.js new file mode 100644 index 00000000000..e443a77d627 --- /dev/null +++ b/source/javascripts/lib/_imagesloaded.min.js @@ -0,0 +1,7 @@ +/*! + * imagesLoaded PACKAGED v4.1.4 + * JavaScript is all like "You images are done yet or what?" + * MIT License + */ + +!function(e,t){"function"==typeof define&&define.amd?define("ev-emitter/ev-emitter",t):"object"==typeof module&&module.exports?module.exports=t():e.EvEmitter=t()}("undefined"!=typeof window?window:this,function(){function e(){}var t=e.prototype;return t.on=function(e,t){if(e&&t){var i=this._events=this._events||{},n=i[e]=i[e]||[];return n.indexOf(t)==-1&&n.push(t),this}},t.once=function(e,t){if(e&&t){this.on(e,t);var i=this._onceEvents=this._onceEvents||{},n=i[e]=i[e]||{};return n[t]=!0,this}},t.off=function(e,t){var i=this._events&&this._events[e];if(i&&i.length){var n=i.indexOf(t);return n!=-1&&i.splice(n,1),this}},t.emitEvent=function(e,t){var i=this._events&&this._events[e];if(i&&i.length){i=i.slice(0),t=t||[];for(var n=this._onceEvents&&this._onceEvents[e],o=0;o elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
      " ], + col: [ 2, "", "
      " ], + tr: [ 2, "", "
      " ], + td: [ 3, "", "
      " ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " <% if current_page.data.search %> <%= javascript_include_tag "all" %> <% else %> <%= javascript_include_tag "all_nosearch" %> <% end %> - <% if language_tabs %> - + <% if current_page.data.code_clipboard %> + <% end %> + + - + NAV <%= image_tag('navbar.png') %> -
      - <%= image_tag "logo.png" %> - <% if language_tabs %> +
      + <%= image_tag "logo.svg", class: 'logo' %> + <% if language_tabs.any? %>
      <% language_tabs.each do |lang| %> <% if lang.is_a? Hash %> @@ -66,8 +95,44 @@ under the License.
        <% end %> -
        -
        + + +
          + <% toc_data(page_content)[1..8].each do |h1| %> +
        • + <%= h1[:content] %> + <% if h1[:children].length > 0 %> + + <% end %> +
          • + <% end %> + +
        • + Objects +
          • + + <% toc_data(page_content)[9..-1].each do |h1| %> +
        • + <%= h1[:content] %> + <% if h1[:children].length > 0 %> + + <% end %> +
          • + <% end %> + +
        <% if current_page.data.toc_footers %>
          <% current_page.data.toc_footers.each do |footer| %> @@ -79,13 +144,10 @@ under the License.
          - <%= yield %> - <% current_page.data.includes && current_page.data.includes.each do |include| %> - <%= partial "includes/#{include}" %> - <% end %> + <%= page_content %>
          - <% if language_tabs %> + <% if language_tabs.any? %>
          <% language_tabs.each do |lang| %> <% if lang.is_a? Hash %> diff --git a/source/stylesheets/_normalize.css b/source/stylesheets/_normalize.scss similarity index 99% rename from source/stylesheets/_normalize.css rename to source/stylesheets/_normalize.scss index 46f646a5c00..a38db2a1001 100644 --- a/source/stylesheets/_normalize.css +++ b/source/stylesheets/_normalize.scss @@ -1,4 +1,4 @@ -/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ +/*! normalize.css v3.0.2 | MIT License | github.com/necolas/normalize.css */ /** * 1. Set default font family to sans-serif. diff --git a/source/stylesheets/_rtl.scss b/source/stylesheets/_rtl.scss new file mode 100644 index 00000000000..720719a0216 --- /dev/null +++ b/source/stylesheets/_rtl.scss @@ -0,0 +1,140 @@ +//////////////////////////////////////////////////////////////////////////////// +// RTL Styles Variables +//////////////////////////////////////////////////////////////////////////////// + +$default: auto; + +//////////////////////////////////////////////////////////////////////////////// +// TABLE OF CONTENTS +//////////////////////////////////////////////////////////////////////////////// + +#toc>ul>li>a>span { + float: left; +} + +.toc-wrapper { + transition: right 0.3s ease-in-out !important; + left: $default !important; + #{right}: 0; +} + +.toc-h2 { + padding-#{right}: $nav-padding + $nav-indent; +} + +#nav-button { + #{right}: 0; + transition: right 0.3s ease-in-out; + &.open { + right: $nav-width + } +} + +//////////////////////////////////////////////////////////////////////////////// +// PAGE LAYOUT AND CODE SAMPLE BACKGROUND +//////////////////////////////////////////////////////////////////////////////// +.page-wrapper { + margin-#{left}: $default !important; + margin-#{right}: $nav-width; + .dark-box { + #{right}: $default; + #{left}: 0; + } +} + +.lang-selector { + width: $default !important; + a { + float: right; + } +} + +//////////////////////////////////////////////////////////////////////////////// +// CODE SAMPLE STYLES +//////////////////////////////////////////////////////////////////////////////// +.content { + &>h1, + &>h2, + &>h3, + &>h4, + &>h5, + &>h6, + &>p, + &>table, + &>ul, + &>ol, + &>aside, + &>dl { + margin-#{left}: $examples-width; + margin-#{right}: $default !important; + } + &>ul, + &>ol { + padding-#{right}: $main-padding + 15px; + } + table { + th, + td { + text-align: right; + } + } + dd { + margin-#{right}: 15px; + } + aside { + aside:before { + padding-#{left}: 0.5em; + } + .search-highlight { + background: linear-gradient(to top right, #F7E633 0%, #F1D32F 100%); + } + } + pre, + blockquote { + float: left !important; + clear: left !important; + } +} + +//////////////////////////////////////////////////////////////////////////////// +// TYPOGRAPHY +//////////////////////////////////////////////////////////////////////////////// +h1, +h2, +h3, +h4, +h5, +h6, +p, +aside { + text-align: right; + direction: rtl; +} + +.toc-wrapper { + text-align: right; + direction: rtl; + font-weight: 100 !important; +} + + +//////////////////////////////////////////////////////////////////////////////// +// RESPONSIVE DESIGN +//////////////////////////////////////////////////////////////////////////////// +@media (max-width: $tablet-width) { + .toc-wrapper { + #{right}: -$nav-width; + &.open { + #{right}: 0; + } + } + .page-wrapper { + margin-#{right}: 0; + } +} + +@media (max-width: $phone-width) { + %left-col { + margin-#{left}: 0; + } +} diff --git a/source/stylesheets/_syntax.scss.erb b/source/stylesheets/_syntax.scss.erb deleted file mode 100644 index dfeb0c15240..00000000000 --- a/source/stylesheets/_syntax.scss.erb +++ /dev/null @@ -1,27 +0,0 @@ -/* -Copyright 2008-2013 Concur Technologies, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); you may -not use this file except in compliance with the License. You may obtain -a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations -under the License. -*/ - -@import 'variables'; - -<%= Rouge::Themes::Base16::Monokai.render(:scope => '.highlight') %> - -.highlight .c, .highlight .cm, .highlight .c1, .highlight .cs { - color: #909090; -} - -.highlight, .highlight .w { - background-color: $code-bg; -} \ No newline at end of file diff --git a/source/stylesheets/_variables.scss b/source/stylesheets/_variables.scss index 5fe64b1f302..4a50a1fa52d 100644 --- a/source/stylesheets/_variables.scss +++ b/source/stylesheets/_variables.scss @@ -23,53 +23,54 @@ under the License. // BACKGROUND COLORS //////////////////// -$nav-bg: #393939; -$examples-bg: #393939; -$code-bg: #292929; -$code-annotation-bg: #1c1c1c; -$nav-subitem-bg: #262626; -$nav-active-bg: #2467af; -$lang-select-border: #000; -$lang-select-bg: #222; -$lang-select-active-bg: $examples-bg; // feel free to change this to blue or something -$lang-select-pressed-bg: #111; // color of language tab bg when mouse is pressed -$main-bg: #eaf2f6; -$aside-notice-bg: #8fbcd4; -$aside-warning-bg: #c97a7e; -$aside-success-bg: #6ac174; -$search-notice-bg: #c97a7e; +$nav-bg: linear-gradient(45deg, #32425A, #394C6B) !default; +$examples-bg: linear-gradient(45deg, #32425A, #394C6B) !default; +$code-bg: linear-gradient(45deg, #32425A, #394C6B) !default; +$code-annotation-bg: rgba(38, 76, 112, 0.3) !default; +$nav-active-bg: #0F75D4 !default; +$nav-active-parent-bg: #021C47 !default; // parent links of the current section +$lang-select-border: #000 !default; +$lang-select-bg: #01173D !default; +$lang-select-active-bg: $examples-bg !default; // feel free to change this to blue or something +$lang-select-pressed-bg: #111 !default; // color of language tab bg when mouse is pressed +$main-bg: #F3F3F4 !default; +$aside-notice-bg: #8fbcd4 !default; +$aside-warning-bg: #c97a7e !default; +$aside-success-bg: #6ac174 !default; +$search-notice-bg: #c97a7e !default; // TEXT COLORS //////////////////// -$main-text: #333; // main content text color -$nav-text: #fff; -$nav-active-text: #fff; -$lang-select-text: #fff; // color of unselected language tab text -$lang-select-active-text: #fff; // color of selected language tab text -$lang-select-pressed-text: #fff; // color of language tab text when mouse is pressed +$main-text: #333 !default; // main content text color +$nav-text: #fff !default; +$nav-active-text: #fff !default; +$nav-active-parent-text: #fff !default; // parent links of the current section +$lang-select-text: #fff !default; // color of unselected language tab text +$lang-select-active-text: #FFFBF1 !default; // color of selected language tab text +$lang-select-pressed-text: #fff !default; // color of language tab text when mouse is pressed // SIZES //////////////////// -$nav-width: 230px; // width of the navbar -$examples-width: 50%; // portion of the screen taken up by code examples -$logo-margin: 20px; // margin between nav items and logo, ignored if search is active -$main-padding: 28px; // padding to left and right of content & examples -$nav-padding: 15px; // padding to left and right of navbar -$nav-v-padding: 10px; // padding used vertically around search boxes and results -$nav-indent: 10px; // extra padding for ToC subitems -$code-annotation-padding: 13px; // padding inside code annotations -$h1-margin-bottom: 21px; // padding under the largest header tags -$tablet-width: 930px; // min width before reverting to tablet size -$phone-width: $tablet-width - $nav-width; // min width before reverting to mobile size +$nav-width: 230px !default; // width of the navbar +$examples-width: 50% !default; // portion of the screen taken up by code examples +$logo-margin: 0px !default; // margin below logo +$main-padding: 28px !default; // padding to left and right of content & examples +$nav-padding: 15px !default; // padding to left and right of navbar +$nav-v-padding: 10px !default; // padding used vertically around search boxes and results +$nav-indent: 10px !default; // extra padding for ToC subitems +$code-annotation-padding: 13px !default; // padding inside code annotations +$h1-margin-bottom: 21px !default; // padding under the largest header tags +$tablet-width: 930px !default; // min width before reverting to tablet size +$phone-width: $tablet-width - $nav-width !default; // min width before reverting to mobile size // FONTS //////////////////// %default-font { - font-family: "Helvetica Neue", Helvetica, Arial, "Microsoft Yahei","微软雅黑", STXihei, "华文细黑", sans-serif; - font-size: 13px; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font-size: 14px; } %header-font { @@ -86,12 +87,8 @@ $phone-width: $tablet-width - $nav-width; // min width before reverting to mobil // OTHER //////////////////// -$nav-active-shadow: #000; -$nav-footer-border-color: #666; -$nav-embossed-border-top: #000; -$nav-embossed-border-bottom: #939393; -$main-embossed-text-shadow: 0px 1px 0px #fff; -$search-box-border-color: #666; +$nav-footer-border-color: #666 !default; +$search-box-border-color: #666 !default; //////////////////////////////////////////////////////////////////////////////// @@ -100,10 +97,6 @@ $search-box-border-color: #666; // These settings are probably best left alone. %break-words { - word-break: break-all; - - /* Non standard for webkit */ - word-break: break-word; - - hyphens: auto; -} + word-break: break-word; + hyphens: auto; +} \ No newline at end of file diff --git a/source/stylesheets/print.css.scss b/source/stylesheets/print.css.scss index 4bda057f019..aea88c3065d 100644 --- a/source/stylesheets/print.css.scss +++ b/source/stylesheets/print.css.scss @@ -1,6 +1,5 @@ @charset "utf-8"; @import 'normalize'; -@import 'compass'; @import 'variables'; @import 'icon-font'; @@ -48,6 +47,12 @@ body { font-size: 0.8em; } + pre { + code { + border: 0; + } + } + pre { padding: 1.3em; } @@ -139,4 +144,10 @@ body { aside.success:before { @extend %icon-ok-sign; } -} \ No newline at end of file +} + +.copy-clipboard { + @media print { + display: none + } +} diff --git a/source/stylesheets/screen.css.scss b/source/stylesheets/screen.css.scss index e4b3ef82b22..33a26239376 100644 --- a/source/stylesheets/screen.css.scss +++ b/source/stylesheets/screen.css.scss @@ -1,9 +1,8 @@ @charset "utf-8"; @import 'normalize'; -@import 'compass'; @import 'variables'; -@import 'syntax'; @import 'icon-font'; +// @import 'rtl'; // uncomment to switch to RTL format /* Copyright 2008-2013 Concur Technologies, Inc. @@ -25,7 +24,8 @@ under the License. // GENERAL STUFF //////////////////////////////////////////////////////////////////////////////// -html, body { +html, +body { color: $main-text; padding: 0; margin: 0; @@ -34,30 +34,22 @@ html, body { @extend %default-font; background-color: $main-bg; height: 100%; - -webkit-text-size-adjust: none; /* Never autoresize text */ + -webkit-text-size-adjust: none; + /* Never autoresize text */ } //////////////////////////////////////////////////////////////////////////////// // TABLE OF CONTENTS //////////////////////////////////////////////////////////////////////////////// -#toc > ul > li > a > span { +#toc>ul>li>a>span { float: right; background-color: #2484FF; border-radius: 40px; width: 20px; } -@mixin embossed-bg { - background: - linear-gradient(to bottom, rgba(#000, 0.2), rgba(#000, 0) 8px), - linear-gradient(to top, rgba(#000, 0.2), rgba(#000, 0) 8px), - linear-gradient(to bottom, rgba($nav-embossed-border-top, 1), rgba($nav-embossed-border-top, 0) 1.5px), - linear-gradient(to top, rgba($nav-embossed-border-bottom, 1), rgba($nav-embossed-border-bottom, 0) 1.5px), - $nav-subitem-bg; -} - -.tocify-wrapper { +.toc-wrapper { transition: left 0.3s ease-in-out; overflow-y: auto; @@ -68,13 +60,14 @@ html, body { left: 0; bottom: 0; width: $nav-width; - background-color: $nav-bg; + background: $nav-bg; font-size: 13px; font-weight: bold; // language selector for mobile devices .lang-selector { display: none; + a { padding-top: 0.5em; padding-bottom: 0.5em; @@ -82,8 +75,12 @@ html, body { } // This is the logo at the top of the ToC - &>img { + .logo { display: block; + max-width: 100%; + margin-top: 20px; + margin-left: 40px; + margin-bottom: 20px; } &>.search { @@ -96,10 +93,11 @@ html, body { padding: 6px 0 6px 20px; box-sizing: border-box; margin: $nav-v-padding $nav-padding; - width: $nav-width - 30; + width: $nav-width - ($nav-padding*2); outline: none; color: $nav-text; - border-radius: 0; /* ios has a default border radius */ + border-radius: 0; + /* ios has a default border radius */ } &:before { @@ -111,10 +109,6 @@ html, body { } } - img+.tocify { - margin-top: $logo-margin; - } - .search-results { margin-top: 0; box-sizing: border-box; @@ -124,13 +118,13 @@ html, body { transition-property: height, margin; transition-duration: 180ms; transition-timing-function: ease-in-out; + background: $nav-bg; + &.visible { height: 30%; margin-bottom: 1em; } - @include embossed-bg; - li { margin: 1em $nav-padding; line-height: 1; @@ -147,18 +141,11 @@ html, body { } - .tocify-item>a, .toc-footer li { - padding: 0 $nav-padding 0 $nav-padding; - display: block; - overflow-x: hidden; - white-space: nowrap; - text-overflow: ellipsis; - } - // The Table of Contents is composed of multiple nested // unordered lists. These styles remove the default // styling of an unordered list because it is ugly. - ul, li { + ul, + li { list-style: none; margin: 0; padding: 0; @@ -169,32 +156,39 @@ html, body { color: $nav-text; transition-property: background; transition-timing-function: linear; - transition-duration: 230ms; + transition-duration: 200ms; } // This is the currently selected ToC entry - .tocify-focus { - box-shadow: 0px 1px 0px $nav-active-shadow; + .toc-link.active { background-color: $nav-active-bg; color: $nav-active-text; } - // Subheaders are the submenus that slide open - // in the table of contents. - .tocify-subheader { - display: none; // tocify will override this when needed - background-color: $nav-subitem-bg; + // this is parent links of the currently selected ToC entry + .toc-link.active-parent { + background-color: $nav-active-parent-bg; + color: $nav-active-parent-text; + } + + .toc-list-h2 { + display: none; + background: $nav-bg; font-weight: 500; - .tocify-item>a { - padding-left: $nav-padding + $nav-indent; - font-size: 12px; - } + } - // for embossed look: - @include embossed-bg; - &>li:last-child { - box-shadow: none; // otherwise it'll overflow out of the subheader - } + .toc-list-span { + padding: 15px; + font-weight: 900; + } + + .toc-list-section { + padding-top: 25px; + } + + .toc-h2 { + padding-left: $nav-padding + $nav-indent; + font-size: 12px; } .toc-footer { @@ -202,7 +196,8 @@ html, body { margin-top: 1em; border-top: 1px dashed $nav-footer-border-color; - li,a { + li, + a { color: $nav-text; text-decoration: none; } @@ -217,7 +212,20 @@ html, body { text-decoration: none; } } +} +.toc-link, +.toc-footer li { + padding: 0 $nav-padding 0 $nav-padding; + display: block; + overflow-x: hidden; + white-space: nowrap; + text-overflow: ellipsis; + text-decoration: none; + color: $nav-text; + transition-property: background; + transition-timing-function: linear; + transition-duration: 130ms; } // button to show navigation on mobile devices @@ -231,6 +239,7 @@ html, body { transform: rotate(-90deg) translate(-100%, 0); border-radius: 0 0 0 5px; } + padding: 0 1.5em 5em 0; // increase touch size area display: none; position: fixed; @@ -242,6 +251,7 @@ html, body { font-weight: bold; opacity: 0.7; line-height: 16px; + img { height: 16px; vertical-align: bottom; @@ -249,8 +259,13 @@ html, body { transition: left 0.3s ease-in-out; - &:hover { opacity: 1; } - &.open {left: $nav-width} + &:hover { + opacity: 1; + } + + &.open { + left: $nav-width + } } @@ -274,7 +289,7 @@ html, body { // half of the content always this background color. .dark-box { width: $examples-width; - background-color: $examples-bg; + background: $examples-bg; position: absolute; right: 0; top: 0; @@ -289,19 +304,22 @@ html, body { } .lang-selector { - background-color: $lang-select-bg; + display: flex; + background: $nav-bg; width: 100%; font-weight: bold; + overflow-x: auto; + a { - display: block; - float:left; + display: inline; color: $lang-select-text; text-decoration: none; padding: 0 10px; line-height: 30px; outline: 0; - &:active, &:focus { + &:active, + &:focus { background-color: $lang-select-pressed-bg; color: $lang-select-pressed-text; } @@ -309,6 +327,7 @@ html, body { &.active { background-color: $lang-select-active-bg; color: $lang-select-active-text; + border-bottom: 2px solid $lang-select-active-text; } } @@ -325,6 +344,8 @@ html, body { // This is all the stuff with the light background in the left half of the page .content { + // fixes webkit rendering bug for some: see #538 + -webkit-transform: translateZ(0); // to place content above the dark box position: relative; z-index: 30; @@ -335,68 +356,88 @@ html, body { clear: both; } - &>h1, &>h2, &>h3, &>h4, &>h5, &>h6, &>p, &>table, &>ul, &>ol, &>aside, &>dl { + &>h1, + &>h2, + &>h3, + &>h4, + &>h5, + &>h6, + &>p, + &>table, + &>ul, + &>ol, + &>aside, + &>dl { margin-right: $examples-width; padding: 0 $main-padding; box-sizing: border-box; display: block; - @include text-shadow($main-embossed-text-shadow); @extend %left-col; } - &>ul, &>ol { + &>ul, + &>ol { padding-left: $main-padding + 15px; } // the div is the tocify hidden div for placeholding stuff - &>h1, &>h2, &>div { - clear:both; + &>h1, + &>h2, + &>div { + clear: both; } h1 { @extend %header-font; - font-size: 30px; + font-size: 25px; padding-top: 0.5em; padding-bottom: 0.5em; - border-bottom: 1px solid #ccc; margin-bottom: $h1-margin-bottom; margin-top: 2em; - border-top: 1px solid #ddd; - background-image: linear-gradient(to bottom, #fff, #f9f9f9); + border-top: 1px solid #ccc; + border-bottom: 1px solid #ccc; + background-color: #fdfdfd; } - h1:first-child, div:first-child + h1 { + h1:first-child, + div:first-child+h1 { border-top-width: 0; margin-top: 0; } h2 { @extend %header-font; - font-size: 20px; + font-size: 19px; margin-top: 4em; margin-bottom: 0; border-top: 1px solid #ccc; padding-top: 1.2em; padding-bottom: 1.2em; - background-image: linear-gradient(to bottom, rgba(#fff, 0.4), rgba(#fff, 0)); + background-image: linear-gradient(to bottom, rgba(#fff, 0.2), rgba(#fff, 0)); } // h2s right after h1s should bump right up // against the h1s. - h1 + h2, h1 + div + h2 { + h1+h2, + h1+div+h2 { margin-top: $h1-margin-bottom * -1; border-top: none; } - h3, h4, h5, h6 { + h3, + h4, + h5, + h6 { @extend %header-font; font-size: 15px; margin-top: 2.5em; margin-bottom: 0.8em; } - h4, h5, h6 { + h4, + h5, + h6 { font-size: 10px; } @@ -409,10 +450,16 @@ html, body { table { margin-bottom: 1em; overflow: auto; - th,td { + + th, + td { text-align: left; vertical-align: top; line-height: 1.6; + + code { + white-space: nowrap; + } } th { @@ -430,11 +477,11 @@ html, body { } tr:nth-child(odd)>td { - background-color: lighten($main-bg,4.2%); + background-color: lighten($main-bg, 4.2%); } tr:nth-child(even)>td { - background-color: lighten($main-bg,2.4%); + background-color: lighten($main-bg, 2.4%); } } @@ -446,7 +493,10 @@ html, body { margin-left: 15px; } - p, li, dt, dd { + p, + li, + dt, + dd { line-height: 1.6; margin-top: 0; } @@ -456,7 +506,7 @@ html, body { } code { - background-color: rgba(0,0,0,0.05); + background-color: rgba(0, 0, 0, 0.05); padding: 3px; border-radius: 3px; @extend %break-words; @@ -471,7 +521,6 @@ html, body { aside { padding-top: 1em; padding-bottom: 1em; - @include text-shadow(0 1px 0 lighten($aside-notice-bg, 15%)); margin-top: 1.5em; margin-bottom: 1.5em; background: $aside-notice-bg; @@ -479,12 +528,10 @@ html, body { &.warning { background-color: $aside-warning-bg; - @include text-shadow(0 1px 0 lighten($aside-warning-bg, 15%)); } &.success { background-color: $aside-success-bg; - @include text-shadow(0 1px 0 lighten($aside-success-bg, 15%)); } } @@ -508,10 +555,9 @@ html, body { .search-highlight { padding: 2px; - margin: -2px; + margin: -3px; border-radius: 4px; border: 1px solid #F7E633; - @include text-shadow(1px 1px 0 #666); background: linear-gradient(to top left, #F7E633 0%, #F1D32F 100%); } } @@ -522,23 +568,28 @@ html, body { // This is all the stuff that appears in the right half of the page .content { - pre, blockquote { - background-color: $code-bg; + &>div.highlight { + clear: none; + } + + pre, + blockquote { + background: $code-bg; color: #fff; - padding: 2em $main-padding; margin: 0; width: $examples-width; - float:right; - clear:right; + float: right; + clear: right; box-sizing: border-box; - @include text-shadow(0px 1px 2px rgba(0,0,0,0.4)); @extend %right-col; - &>p { margin: 0; } + &>p { + margin: 0; + } a { color: #fff; @@ -549,16 +600,16 @@ html, body { pre { @extend %code-font; + padding-top: 2em; + padding-bottom: 2em; + padding: 2em $main-padding; } blockquote { &>p { background-color: $code-annotation-bg; - border-radius: 5px; - padding: $code-annotation-padding; - color: #ccc; - border-top: 1px solid #000; - border-bottom: 1px solid #404040; + padding: $code-annotation-padding 2em; + color: #eee; } } } @@ -570,7 +621,7 @@ html, body { // There are also a couple styles disperesed @media (max-width: $tablet-width) { - .tocify-wrapper { + .toc-wrapper { left: -$nav-width; &.open { @@ -586,7 +637,7 @@ html, body { display: block; } - .tocify-wrapper .tocify-item > a { + .toc-link { padding-top: 0.3em; padding-bottom: 0.3em; } @@ -601,7 +652,7 @@ html, body { margin-right: 0; } - .tocify-wrapper .lang-selector { + .toc-wrapper .lang-selector { display: block; } @@ -614,7 +665,142 @@ html, body { float: none; } - %right-col + %left-col { + %right-col+%left-col { margin-top: $main-padding; } + + .highlight + p { + margin-top: 20px; + } +} + +.highlight .c, +.highlight .cm, +.highlight .c1, +.highlight .cs { + color: #909090; +} + +.highlight, +.highlight .w { + background: $code-bg; +} + +.copy-clipboard { + float: right; + fill: #9DAAB6; + cursor: pointer; + opacity: 0.4; + height: 18px; + width: 18px; +} + +.copy-clipboard:hover { + opacity: 0.8; +} + +.content { + .center-column+.highlight { + pre { + position: static; + float: none; + clear: none; + margin: 0 28px; + left: 0; + } + } } + + +//////////////////////////////////////////////////////////////////////////////// +// CUSTOM DESIGN +//////////////////////////////////////////////////////////////////////////////// +// Code sample in center text block +.content { + .center-column+.highlight { + + margin-right: 50%; + margin-bottom: 14px; + + pre { + position: static; + float: none; + clear: none; + margin: 0; + left: 0; + width: 100%; + } + } +} + +.content { + .serverSelect { + line-height: 2.4; + margin-right: $examples-width; + padding: 0 $main-padding; + margin-bottom: 14px; + @extend %left-col; + + .serverSelectExplanation { + font-weight: 200; + font-size: 13px; + } + } + + #api-server { + margin-top: 18px; + } + + #tokens { + margin-top: 18px; + } + + .tokenSelect { + margin-right: $examples-width; + padding: 0 $main-padding; + margin-bottom: 14px; + @extend %left-col; + + .TokenExplanation { + font-weight: 200; + font-size: 13px; + } + + .authInput { + position: relative; + height: 34px; + padding-top: 5px; + + span { + position: absolute; + z-index: 2; + line-height: 1.6; + padding-left: 4px; + padding-right: 4px; + top: 5.5px; + } + + input { + position: absolute; + left: 0; + top: 5px; + padding-left: 50px; + width: 350px; + } + } + + .integrationInput { + position: relative; + height: 34px; + padding-top: 5px; + + label { + padding-bottom: 7px; + } + + input { + width: 398px; + } + } + } +} \ No newline at end of file