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..fd19cb00e4c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# 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 + +[*.py] +indent_size = 4 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..8eb6fd7ce03 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,42 @@ +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] + + steps: + - uses: actions/checkout@v2 + - 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 }}- + + # necessary to get ruby 2.3 to work nicely with bundler vendor/bundle cache + # can remove once ruby 2.3 is no longer supported + - run: gem update --system + + - 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..8ee93d86a03 --- /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@v2 + - 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..f61e56aec86 --- /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@v2 + + - 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@v2 + - 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..6c511807b22 --- /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@v2 + + - 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..fd25672fad3 100644 --- a/.gitignore +++ b/.gitignore @@ -14,9 +14,18 @@ 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 + +# Python +__pycache__/ +/scripts/settings.py 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/.vscode/reqtable.code-snippets b/.vscode/reqtable.code-snippets new file mode 100644 index 00000000000..88a0b0d10d9 --- /dev/null +++ b/.vscode/reqtable.code-snippets @@ -0,0 +1,28 @@ +{ + // Place your API-Documentation-slate workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and + // description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope + // is left empty or omitted, the snippet gets applied to all languages. The prefix is what is + // used to trigger the snippet and the body will be expanded and inserted. Possible variables are: + // $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. + // Placeholders with the same ids are connected. + // Example: + // "Print to console": { + // "scope": "javascript,typescript", + // "prefix": "log", + // "body": [ + // "console.log('$1');", + // "$2" + // ], + // "description": "Log output to console" + // } + "Request Table": { + "scope": "markdown", + "prefix": "reqtable", + "body": [ + "| Parameter | Type | Required | Description |", + "| --------- | ---- | -------- | ----------- |", + "| $1 | $2 | $3 | $4 |" + ], + "description": "Request Table" + } +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000000..4222a10913d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,19 @@ +{ + "markdownlint.config": { + "no-inline-html": { + "allowed_elements": [ + "aside", + "b", + "br", + "span", + "code", + "ul", + "ol", + "li", + ], + }, + "link-fragments": false, + "no-duplicate-heading": false, + "single-h1": false, + } +} diff --git a/CHANGELOG.md b/CHANGELOG.md index 59ee6a441e5..6e7e39dfff4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,279 @@ # Changelog +## 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 +292,7 @@ ## Version 1.1 -*July 27th, 2014* +*July 27, 2014* **Fixes:** diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..cc17fd98d59 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lord.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ 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..7604fd427f2 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.5.0' +gem 'nokogiri', '~> 1.13.3' +gem 'sass' +gem 'webrick' diff --git a/Gemfile.lock b/Gemfile.lock index f9978492816..bd60f7f66e1 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.4.1) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + zeitwerk (~> 2.3) + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + autoprefixer-rails (10.2.5.0) + execjs (< 2.8.0) + backports (3.21.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.1.9) + contracts (0.13.0) + dotenv (2.7.6) 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.5) + ffi (1.15.4) + 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.3.1) + rexml + listen (3.0.8) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + memoist (0.16.2) + middleman (4.4.2) 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) + kramdown (>= 2.3.0) + middleman-cli (= 4.4.2) + middleman-core (= 4.4.2) + middleman-autoprefixer (3.0.0) + autoprefixer-rails (~> 10.0) + middleman-core (>= 4.0.0) + middleman-cli (4.4.2) + thor (>= 0.17.0, < 2.0) + middleman-core (4.4.2) + activesupport (>= 6.1, < 7.0) + addressable (~> 2.4) + backports (~> 3.6) + bundler (~> 2.0) + contracts (~> 0.13.0) + 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.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.2.0) + middleman-core (>= 3.2) + rouge (~> 3.2) + mini_portile2 (2.8.0) + minitest (5.14.4) + nokogiri (1.13.4) + mini_portile2 (~> 2.8.0) + racc (~> 1.4) + padrino-helpers (0.15.1) + i18n (>= 0.6.7, < 2) + padrino-support (= 0.15.1) + tilt (>= 1.4.1, < 3) + padrino-support (0.15.1) + parallel (1.21.0) + parslet (2.0.0) + public_suffix (4.0.6) + racc (1.6.0) + rack (2.2.3) + rb-fsevent (0.11.0) + rb-inotify (0.10.1) + ffi (~> 1.0) + redcarpet (3.5.1) + rexml (3.2.5) + rouge (3.28.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.8.2) + thor (1.1.0) + tilt (2.0.10) + toml (0.3.0) + parslet (>= 1.8.0, < 3.0.0) + tzinfo (2.0.4) + concurrent-ruby (~> 1.0) + uglifier (3.2.0) + execjs (>= 0.3.0, < 3) + webrick (1.7.0) + zeitwerk (2.5.1) 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.5.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..36ac3c97d27 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,7 @@ -Slate -======== +# SimplyPrint 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) +**Link to the API documentation;** -Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. +This repository contains the entire SimplyPrint API documentation, all content is located in `/source/index.html.md` - edits or contributions are welcome. -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 -``` - -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. - -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/) +Powered by **[Slate](https://github.com/slatedocs/slate)**. 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..769b8a5bafe --- /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-ri --no-rdoc 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/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000000..5ce3644d27b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,8 @@ +services: + slate-dev: + image: slatedocs/slate:latest + ports: + - 127.0.0.1:4567:4567 + volumes: + - ./source:/srv/slate/source:ro + command: serve 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/scripts/check_outdated.py b/scripts/check_outdated.py new file mode 100644 index 00000000000..eaf71baf971 --- /dev/null +++ b/scripts/check_outdated.py @@ -0,0 +1,51 @@ +import os +import re + +ENDPOINTS_DIR = "" +DOCUMENTATION_DIR = os.path.join(os.path.dirname(__file__), "../source/includes") + +def get_all_endpoints(with_disabled=False): + endpoints = [] + for root, dirs, files in os.walk(ENDPOINTS_DIR): + for file in files: + if not with_disabled: + with open(os.path.join(root, file), 'r') as f: + if re.search(r"public *bool *\$api_disabled *= true;", f.read()): + continue + + endpoints.append(root.split(ENDPOINTS_DIR)[1] + "/" + file[:-4]) + + endpoints.sort() + return endpoints + +def get_all_documented_endpoints(): + endpoints = [] + + for file in os.listdir(DOCUMENTATION_DIR): + file_cat = file[1:-3] + with open(os.path.join(DOCUMENTATION_DIR, file), 'r') as f: + for line in f.readlines(): + match = re.match(r"(?:curl)?.*https:\/\/api\.simplyprint\.io\/\{id\}(.*?)(\?| \\).*$", line) + + if not match: + continue + + endpoints.append(match.group(1).replace("\"", "")) + + endpoints.sort() + return endpoints + +if __name__ == "__main__": + endpoints = get_all_endpoints() + documented_endpoints = get_all_documented_endpoints() + + # Show endpoints that are not documented and endpoints that have been removed + print("Undocumented endpoints:") + for endpoint in endpoints: + if endpoint not in documented_endpoints and not endpoint.startswith("/status/"): + print(f" - {endpoint}") + + print("Removed endpoints:") + for endpoint in documented_endpoints: + if endpoint not in endpoints: + print(f" - {endpoint}") diff --git a/scripts/generate_markdown.py b/scripts/generate_markdown.py new file mode 100644 index 00000000000..75c22d99c17 --- /dev/null +++ b/scripts/generate_markdown.py @@ -0,0 +1,77 @@ +# File that generates template markdown from endpoints folder + +import os +import re +from settings import ENDPOINTS_DIR + +OUTPUT_DIR = "./output" + +# Template +TEMPLATE = """ +## {endpoint} + +```shell +curl https://api.simplyprint.io/{{id}}{full_endpoint} \\ + -X ? \\ + -H 'accept: application/json' \\ + -H 'X-API-KEY: {{API_KEY}}' +``` + +> Success response + +```json +{{ + "TODO": "TODO" +}} +``` + +### Request + +`? /{{id}}{full_endpoint}` + +TODO +""" + + +# Get all level folders in endpoints +folders = [f for f in os.listdir(ENDPOINTS_DIR) if os.path.isdir( + os.path.join(ENDPOINTS_DIR, f))] + +includes = [] + +# Walk through each folder +for folder in folders: + out = f"# {folder.title()}\n" + + # Use os.walk to get all php source + for root, dirs, files in os.walk(os.path.join(ENDPOINTS_DIR, folder)): + for file in files: + # Readfd + with open(os.path.join(root, file), "r") as f: + if re.search(r"public bool \$api_disabled = true;", f.read()): + #print("Skipping disabled endpoint: " + file[:-4]) + continue + + # Write template + endpoint_path = root.split(ENDPOINTS_DIR)[1] + endpoint_dir = root.split("/")[-1] + endpoint = file[:-4] + + if endpoint_dir != folder: + endpoint = endpoint_dir + "/" + file[:-4] + + out += TEMPLATE.format(endpoint=endpoint, + full_endpoint=endpoint_path + "/" + file[:-4]) + + if len(out.splitlines()) == 1: + print("Skipping empty folder: " + folder) + continue + + # Write to file + with open(os.path.join(OUTPUT_DIR, f"_{folder}.md"), "w") as fd: + fd.write(out) + includes.append(folder) + +# Generate yaml includes: +print("Yaml includes:") +print("\n".join([f" - {f}" for f in includes])) diff --git a/slate.sh b/slate.sh new file mode 100755 index 00000000000..a3cc498e99a --- /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 +} + +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/favicon.ico b/source/images/favicon.ico new file mode 100644 index 00000000000..3b47ddbed09 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..f18049a47d5 100644 Binary files a/source/images/logo.png and b/source/images/logo.png differ diff --git a/source/includes/_account.md b/source/includes/_account.md new file mode 100644 index 00000000000..f2437415e04 --- /dev/null +++ b/source/includes/_account.md @@ -0,0 +1,398 @@ +# Account + +## Create company groups + +```shell +curl https://api.simplyprint.io/{id}/account/settings/groups/Create \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "ranks": [ + { + "title": "name of group", + "description": "group description", + "sort_order": 3, + "permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}" + } + ] +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "title": "name of group", + "description": "group description", + "company_id": 2, + "company_type": 2, + "sort_order": 3, + "permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}", + "id": 319 + } + ] +} +``` + + + + + +| Required permissions | +|-----------------------| +| `org_rank_management` | + +This endpoint creates a new group in the company. + +### Request + +`POST /{id}/account/settings/groups/Create` + +| Parameter | Type | Required | Description | +|-----------------------|---------|----------|-----------------------------------------------------------------------------------------------------| +| `ranks` | array | yes | Array of groups to create. | +| `ranks[].title` | string | yes | The name of the group. | +| `ranks[].description` | string | no | The description of the group. | +| `ranks[].sort_order` | integer | yes | The sort index of the group. | +| `ranks[].permissions` | string | yes | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | Array of the created groups. | + +## Update company groups + +```shell +curl https://api.simplyprint.io/{id}/account/settings/groups/Update \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "ranks": [ + { + "id": 319, + "title": "TITLE", + "description": "DESCRIPTION", + "permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}", + "sort_order": 3 + } + ] +} +``` + +> Success repsonse + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 319, + "title": "NAME", + "description": "DESCRIPTION", + "company_id": 2, + "company_type": 2, + "permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}", + "sort_order": 3, + "created": "2023-01-03 14:35:28" + } + ] +} +``` + + + +| Required permissions | +|-----------------------| +| `org_rank_management` | + +This endpoint updates the groups in the company. + +### Request + +`POST /{id}/account/settings/groups/Update` + +| Parameter | Type | Required | Description | +|-----------------------|---------|----------|-----------------------------------------------------------------------------------------------------| +| `ranks` | array | yes | Array of groups to update. | +| `ranks[].id` | integer | yes | The id of the group to update. | +| `ranks[].title` | string | no | The name of the group. | +| `ranks[].description` | string | no | The description of the group. | +| `ranks[].permissions` | string | no | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). | +| `ranks[].sort_order` | integer | no | The sort index of the group. | + +### Response + +| Parameter | Type | Description | +|-----------------------|---------|-----------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | Array of the updated groups. | +| `data[].id` | integer | The id of the group. | +| `data[].title` | string | The name of the group. | +| `data[].description` | string | The description of the group. | +| `data[].company_id` | integer | The id of the company. | +| `data[].company_type` | integer | The type of the company. | +| `data[].permissions` | string | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). | +| `data[].sort_order` | integer | The sort order of the group. | +| `data[].created` | string | The date and time the group was created. | + +## Get company groups + +```shell +curl https://api.simplyprint.io/{id}/account/GetGroups \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "groups": [ + { + "id": 112, + "name": "Administrator" + }, + { + "id": 151, + "name": "Manager" + }, + { + "id": 153, + "name": "User" + } + ] +} +``` + + + +| Required permissions | +|-----------------------| +| `org_rank_management` | + +This endpoint returns a list of groups that exist in the company. + +### Request + +`GET /{id}/account/GetGroups` + +### Response + +| Parameter | Type | Description | +|-----------------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `groups` | array | Array of group objects. | +| `groups[].id` | integer | Group ID. | +| `groups[].name` | string | Group name. | + +## Delete company group + +```shell +curl https://api.simplyprint.io/{id}/account/settings/groups/Delete \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "id": 112, + "replacementRankId": 151 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|-----------------------| +| `org_rank_management` | + +### Request + +`POST /{id}/account/settings/groups/Delete` + +| Parameter | Type | Required | Description | +|---------------------|---------|----------|---------------------------------------------------------------------------------------------------------| +| `id` | integer | yes | The id of the group to delete. | +| `replacementRankId` | integer | maybe | The id of the group to replace the deleted group with.
This is only required if the group has users. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Get statistics + +```shell +curl https://api.simplyprint.io/{id}/account/GetStatistics \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "users": [ + 1234, + 1235, + 1945 + ], + "printers": [ + 1234, + 1235, + 1945 + ], + "start_date": "1677629786", + "end_date": "1677629786" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": { + "total_print_seconds": 1234, + "total_filament_usage_gram": 1241.1231231, + "print_job_count": 123, + "regretted_print_jobs": 123, + "failed_print_jobs": 123, + "printer_error_print_jobs": 123, + "done_print_jobs": 123, + "date_range": { + "from": "2023-02-22", + "to": "2023-03-02", + "general": false + }, + "printers": { + "3104": { + "name": "Printer 1", + "done": 0, + "failed": 0, + "printer_error": 0, + "regretted": 0, + "filament_usage_gram": 0 + }, + ... + }, + "print_jobs": [ + { + "date": "2023-02-27", + "started": "2023-02-27 11:39:34", + "ended": "2023-02-27 11:56:18", + "cancelled": 1, + "failed": 0, + "cancel_reason_type": 5, + "print_seconds": 1004, + "filament_usage_gram": 0.03758012402132279 + }, + ... + ] + } +} +``` + + + +This endpoint returns statistics for the user / company. + +### Request + +`POST /{id}/account/GetStatistics` + +| Parameter | Type | Required | Description | +|--------------|--------|----------|--------------------------------------------------------------------------------------------------------------| +| `users` | array | no | Array of user ids to get statistics for. Don't include this parameter to get statistics for all users. | +| `printers` | array | no | Array of printer ids to get statistics for. Don't include this parameter to get statistics for all printers. | +| `start_date` | string | no | The start date of the statistics. Provide a unix timestamp in seconds. | +| `end_date` | string | no | The end date of the statistics. Provide a unix timestamp in seconds. | + +### Response + +| Parameter | Type | Description | +|------------------------------------------|---------|------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | object | Statistics object. | +| `data.total_print_seconds` | integer | Total print seconds. | +| `data.total_filament_usage_gram` | float | Total filament usage in grams. | +| `data.print_job_count` | integer | Total print job count. | +| `data.regretted_print_jobs` | integer | Total regretted print job count. | +| `data.failed_print_jobs` | integer | Total failed print job count. | +| `data.printer_error_print_jobs` | integer | Total printer error print job count. | +| `data.done_print_jobs` | integer | Total successful print job count. | +| `data.date_range` | object | Date range object. | +| `data.date_range.from` | string | Start date of the statistics. | +| `data.date_range.to` | string | End date of the statistics. | +| `data.date_range.general` | boolean | True if the date range is general. | +| `data.printers` | object | Object of printer statistics. | +| `data.printers.{id}` | object | Printer statistics object. | +| `data.printers.{id}.name` | string | Printer name. | +| `data.printers.{id}.done` | integer | Successful print job count. | +| `data.printers.{id}.failed` | integer | Failed print job count. | +| `data.printers.{id}.printer_error` | integer | Printer error print job count. | +| `data.printers.{id}.regretted` | integer | Regretted print job count. | +| `data.printers.{id}.filament_usage_gram` | float | Filament usage in grams. | +| `data.print_jobs` | array | Array of print job statistics. | +| `data.print_jobs[].date` | string | Date of the print job. | +| `data.print_jobs[].started` | string | Start time of the print job. | +| `data.print_jobs[].ended` | string | End time of the print job. | +| `data.print_jobs[].cancelled` | integer | True if the print job was cancelled. | +| `data.print_jobs[].failed` | integer | True if the print job failed. | +| `data.print_jobs[].cancel_reason_type` | integer | The reason for cancelling the print job. | +| `data.print_jobs[].print_seconds` | integer | Print seconds. | +| `data.print_jobs[].filament_usage_gram` | float | Filament usage in grams. | diff --git a/source/includes/_api_files.md b/source/includes/_api_files.md new file mode 100644 index 00000000000..69890cfa0ae --- /dev/null +++ b/source/includes/_api_files.md @@ -0,0 +1,101 @@ +# API Files + +The base URL for the SimplyPrint Files API is `https://files.simplyprint.io/{id}/`. Use the exact same authentication as +the normal api endpoint. It is very important you ensure you send files with the correct file extension. The API will +not be able to determine the file type based on the content. + +## Upload a file using the API + + + +`POST /{id}/files/Upload` + +> Example request to upload a file less than 100MB + +```shell +curl -X POST "https://files.simplyprint.io/%7Bid%7D/files/Upload" \ + -H 'accept: application/json' \ + -H "X-API-KEY: {API_KEY}" \ + -F "file=@/path/to/file.gcode" +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "file": { + "id": "f568ead4bbc2d881efc8a9a05f3bd585334cd8c662347ba2dfad7250176b0abd", + "name": "file.gcode", + "size": 13439 + } +} +``` + +> Multiple parts for a single file larger than 100MB. The first filename is the filename of the entire file. + +```shell +curl -X POST "https://files.simplyprint.io/%7Bid%7D/files/Upload" \ + -H 'accept: application/json' \ + -H "X-API-KEY: {API_KEY}" \ + -F "file=@/path/to/part1.3mf" + -F "totalSize=3352316" +``` + +> Success response with continueToken + +```json +{ + "status": true, + "message": null, + "continueToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzM4NCJ9.eyJ0eXBlIjoiYWN0ao9uX3Rva2VuIiwiYWN0aW9uIjoiZmlsZV9jb250aW51ZV91cGxvYWQiLCJ1c2VyIjo2OTc2LCJjb21wYW55IjoyLCJkYXRhIja7ImJ1Y2tldEhhc2giOiI0MGQ2MzgwNmQwYWUxODhkNjc5YzY0NjA0M2RiYjUxMTc0NTViNTc1NjNlODEzZDc2MGRjMTJkMzVaYjdmY2Y0IiwidG90YWxTaXplIjoxNjc2MTU4NH0sImlhdCI6MTcyNTU2MjEzMywiZXhwIjoxNzI1NjQ4NTMzfQ.9qyNyx9A4Ox_6GrFSxXpxlpLcAKaSr8ln84X3yuWdhT_2O3L8-lGWaXAbQk9VvR-3pu1-a9p40amnt6Fghy49InjzCfNMRp-6-Ft_uMRf6PbmcCCrksvRxNP38ImoXy6" +} +``` + +> Continue uploading the file (send next part with only the continueToken) + +```shell +curl -X POST "https://files.simplyprint.io/%7Bid%7D/files/Upload" \ + -H 'accept: application/json' \ + -H "X-API-KEY: {API_KEY}" \ + -F "continueToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzM4NCJ9.eyJ0eXBlIjoiYWN0ao9uX3Rva2VuIiwiYWN0aW9uIjoiZmlsZV9jb250aW51ZV91cGxvYWQiLCJ1c2VyIjo2OTc2LCJjb21wYW55IjoyLCJkYXRhIja7ImJ1Y2tldEhhc2giOiI0MGQ2MzgwNmQwYWUxODhkNjc5YzY0NjA0M2RiYjUxMTc0NTViNTc1NjNlODEzZDc2MGRjMTJkMzVaYjdmY2Y0IiwidG90YWxTaXplIjoxNjc2MTU4NH0sImlhdCI6MTcyNTU2MjEzMywiZXhwIjoxNzI1NjQ4NTMzfQ.9qyNyx9A4Ox_6GrFSxXpxlpLcAKaSr8ln84X3yuWdhT_2O3L8-lGWaXAbQk9VvR-3pu1-a9p40amnt6Fghy49InjzCfNMRp-6-Ft_uMRf6PbmcCCrksvRxNP38ImoXy6" \ + -F "file=@/path/to/part2.3mf" +``` + +> Sucessful final response as we ensured to only send exactly the total size of the file. + +```json +{ + "status": true, + "message": null, + "file": { + "id": "f568ead4bbc2d881efc8a9a05f3bd585334cd8c662347ba2dfad7250176b0abd", + "name": "part1.3mf", + "size": 3352316 + } +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------------|---------|----------|----------------------------------------------------------------------------------------------------------| +| `file` | file | yes | Uploaded file (Max 100mb) | +| `continueToken` | string | no | Optional token you'll get if you need to continue the upload for files greater than 100MB. | +| `totalSize` | integer | no | Send this if you want a continueToken, by providing the total size of the entire file you want to upload | + +### Response + +| Parameter | Type | Description | +|-----------------|---------|----------------------------------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `continueToken` | string | For every subsequent request that still has some pending size based on the total size this will be returned instead of the file. | +| `file.*` | object | Final file object after entire file has been uploaded | +| `file.id` | string | The API File ID you'll need to use other SimplyPrint APIs | +| `file.name` | string | Name used to reference the file | +| `file.size` | int | Total size of uploaded file | + diff --git a/source/includes/_courses.md b/source/includes/_courses.md new file mode 100644 index 00000000000..25a4417f26d --- /dev/null +++ b/source/includes/_courses.md @@ -0,0 +1,274 @@ +# Courses + + + +## Get course + +```shell +curl https://api.simplyprint.io/{id}/courses/GetCourse?id=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "course": { + // Course details + }, + "slides": [ + // Course slides + ], + "embeds": [ + { + "name": "Embed", + "logo": "example.png", + "privacy_policy": "https://example.com/privacy", + "allowed_url": "https://example.com/embed", + "how_to_embed_guide": "https://example.com/embed_guide" + } + ] +} +``` + +| Required permission | Description | +|---------------------|----------------------------| +| `courses_view` | Required to view courses. | +| `courses_manage` | Required for teacher view. | + +`GET /{id}/courses/GetCourse` + +### Request Parameters + +| Parameter | Type | Description | +|----------------|---------|------------------------------------------------------| +| `id` | integer | The ID of the course to retrieve. | +| `teacher_view` | boolean | Whether to retrieve the course in teacher view mode. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `course` | object | The course details. | +| `slides` | array | The slides of the course. | +| `embeds` | array | The embed types for the course. | + +## Delete course + +```shell +curl -X POST https://api.simplyprint.io/{id}/courses/DeleteCourse \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "id": 123 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | +|----------------------| +| `courses_manage` | + +`POST /{id}/courses/DeleteCourse` + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|---------------------------------| +| `id` | integer | The ID of the course to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Move course + +```shell +curl -X POST https://api.simplyprint.io/{id}/courses/MoveCourse \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "course": 123, + "category": 456 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | +|----------------------| +| `courses_manage` | + +`POST /{id}courses/MoveCourse` + +### Request Body + +| Parameter | Type | Description | +|------------|---------|-------------------------------| +| `course` | integer | The ID of the course to move. | +| `category` | integer | The ID of the new category. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Publish/unpublish course + +```shell +curl -X POST https://api.simplyprint.io/{id}/courses/PublishCourse \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "id": 123 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | +|----------------------| +| `courses_manage` | + +`POST /{id}/courses/PublishCourse` + +### Request Parameters + +| Parameter | Description | +|-------------|--------------------------------------------------------------| +| `unpublish` | Set if the course should be unpublished (no value required). | + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|----------------------------------| +| `id` | integer | The ID of the course to publish. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Create/update category + +```shell +curl -X POST https://api.simplyprint.io/{id}/courses/CreateCategory \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "name": "New Category", + "public": true + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "category": { + "id": 123, + "name": "New Category", + "public": true + } +} +``` + +| Required permissions | +|----------------------| +| `courses_manage` | + +`POST /{id}/courses/CreateCategory` + +### Request Body + +| Parameter | Type | Description | +|------------|---------|--------------------------------------------------------------------------| +| `language` | string | The language code (2 characters) (optional). | +| `id` | integer | The ID of the category to update (optional to update existing category). | +| `name` | string | The name of the category. | +| `public` | boolean | Whether the category is public. | + +### Response + +| Parameter | Type | Description | +|------------|---------|------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `category` | object | The created or updated category details. | + +## Delete category + +```shell +curl -X POST https://api.simplyprint.io/{id}/courses/DeleteCategory \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "id": 123 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | +|----------------------| +| `courses_manage` | + +`POST /{id}/courses/DeleteCategory` + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|-----------------------------------| +| `id` | integer | The ID of the category to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | diff --git a/source/includes/_custom_fields.md b/source/includes/_custom_fields.md new file mode 100644 index 00000000000..0aa9524dadf --- /dev/null +++ b/source/includes/_custom_fields.md @@ -0,0 +1,338 @@ +# Custom Fields + + + +Custom Fields allow you to add your own data-fields inside SimplyPrint. + +[Read more about Custom Fields on our Helpdesk](https://help.simplyprint.io/en/article/all-about-the-custom-fields-feature-4dd5if/) + +## List custom fields + + + +| Required permissions | +|------------------------| +| `custom_fields_manage` | + +`POST /{id}/custom_fields/Get` + +> Example request + +```shell +curl -X POST https://api.simplyprint.io/{id}/custom_fields/Get \ + -H 'accept: application/json' \ + -H "X-API-KEY: {API_KEY}" \ + -F "page=1" -F "page_size=10" +``` + +> Example response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 7, + "fieldId": "student_id", + "fieldLabel": "Student ID", + "fieldDescription": "", + "fieldPlaceholder": null, + "fieldType": "text", + "fieldOptions": null, + "category": "print", + "subCategory": [ + "user_file", + "print_queue", + "print_job" + ], + "required": false, + "enabled": true, + "defaultValue": null, + "visibleRequiredPermissions": null, + "editRequiredPermissions": null, + "visibleToGroups": [], + "editableByGroups": [], + "validation": null, + "createdByUser": -1, + "user": "John Doe", + "forPrinters": [], + "forModels": [], + "forGroups": [], + "showOnRegistration": null, + "showBeforeStartPrint": null, + "position": 0, + "created": "2024-09-07T13:46:59+00:00", + "updated": "2024-09-07T13:46:59+00:00" + } + ], + "page_amount": 1, + "total": 1 +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-------------|---------|----------|-----------------------------------------------------------------------------------------------------------------| +| `page` | integer | yes | Which page to show | +| `page_size` | integer | yes | Amount of items per page (1-100) | +| `search` | string | no | The search filter to apply | +| `sort_id` | string | no | What key to sort on (id, fieldId, fieldLabel, fieldDescription, fieldType, category, enabled, created, updated) | +| `sort_dir` | string | no | Sort direction (`asc`, `desc`) | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | List of custom fields. | + +## Create or update a custom field + + + +| Required permissions | +|------------------------| +| `custom_fields_manage` | + +`POST /{id}/custom_fields/Save` + +> Example request + +```shell +curl -X POST https://api.simplyprint.io/{id}/custom_fields/Save \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{"category":"print","subCategory":["user_file","print_queue","print_job"],"fieldType":"text","fieldId":"student_id","fieldLabel":"Student ID","required":false,"enabled":true}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|------------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | integer | no | If you want to update an existing custom field, specify this | +| `category` | string | yes | One of `print`, `user`, `printer`, `filament` | +| `subCategory` | array | no | Array of subcategories. Valid subcategories: `print_queue`, `print_job`, `user_file` | +| `fieldId` | string | yes | ID of the field | +| `fieldType` | string | yes | One of `boolean`, `text`, `longtext`, `number`, `date`, `datetime`, `phone`, `email`, `url`, `select`, `multiselect`, `radio`, `checkbox` | +| `fieldLabel` | string | yes | Label of the field | +| `fieldOptions` | object | no | Field options. An object with one entry, `options`, whose value is an array of `{label: string, value: string}` | +| `FieldDescription` | string | no | Description of the field | +| `fieldPlaceholder` | string | no | Placeholder text for the field | +| `required` | boolean | yes | Whether the field is required | +| `defaultValue` | object | no | Default value of the field. Object key should be either `string`, `number`, `boolean`, `date`, `options`, with the appropriate value type | +| `validation` | object | no | Validation rules for the field. Object keys can be any of `stringRegex`, `stringMinLength`, `stringMaxLength`, `numberAllowDecimals`, `numberMinValue`, `numberMaxValue`, `validationMessage` | +| `forPrinters` | array | no | Array of printer IDs the field should be visible for | +| `forModels` | array | no | Array of model IDs the field should be visible for | +| `forGroups` | array | no | Array of group IDs the field should be visible for | +| `showOnRegistration` | boolean | no | Whether the field should be shown on registration | +| `showBeforeStartPrint` | boolean | no | Whether the field should be shown before starting a print | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Enable or disable a custom field + + + +| Required permissions | +|------------------------| +| `custom_fields_manage` | + +`POST /{id}/custom_fields/SetEnabled` + +> Example request + +```shell +curl -X POST https://api.simplyprint.io/{id}/custom_fields/SetEnabled \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{"id": 123, "enabled": true}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------|---------|----------|---------------------------------------------------------------------------| +| `id` | integer | yes | ID of the custom field to enable or disable | +| `enabled` | boolean | yes | Whether the custom field should be enabled (`true`) or disabled (`false`) | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Delete custom fields + + + +| Required permissions | +|------------------------| +| `custom_fields_manage` | + +`GET /{id}/custom_fields/Delete` + +> Example request + +```shell +curl https://api.simplyprint.io/{id}/custom_fields/Delete?id=123 \ +-H 'accept: application/json' \ +-H 'X-API-KEY: {API_KEY}' +``` + +> Example request with multiple IDs + +```shell +curl https://api.simplyprint.io/{id}custom_fields/Delete?ids=123,124,125 \ +-H 'accept: application/json' \ +-H 'X-API-KEY: {API_KEY}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------|---------|--------------------------------|----------------------------------------------------------------------------------------------------| +| `id` | integer | yes (if `ids` is not provided) | The ID of the custom field to delete. | +| `ids` | string | yes (if `id` is not provided) | A comma-separated list of custom field IDs to delete. Valid if multiple fields need to be removed. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Custom field submission + + + +`POST /{id}/custom_fields/SubmitValues` + +> Example request + +```shell +curl -X POST https://api.simplyprint.io/{id}/custom_fields/SubmitValues \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{"category": "printer", "subCategory": "print_job", entityIds: [1234], "values": [{customFieldId: "student_id", value: {"string": "1234567890"}}]}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|---------------|--------|----------|------------------------------------------------------------------------------------------------------------------| +| `category` | string | yes | One of `print`, `user`, `printer`, `filament` | +| `subCategory` | string | yes | One of `print_queue`, `print_job`, `user_file` | +| `entityIds` | array | yes | Array of entity IDs to submit values for | +| `values` | array | yes | Array of custom field values to submit. Each value looks like `{customFieldId: string, value: CustomFieldValue}` | + +## Custom field submission value + + + +The value of a custom field when submitted via the API is an object with a key corresponding to the field type. +See the examples to the right for the different field types. + +> A text field would have a value like this: + +```json +{ + "string": "1234567890" +} +``` + +> A number field would have a value like this: + +```json +{ + "number": 1234567890 +} +``` + +> A date field would have a value like this: + +```json +{ + "date": "2024-09-07" +} +``` + +> A select field would have a value like this: + +```json +{ + "string": "Selected option" +} +``` + +> A multi-select field would have a value like this: + +```json +{ + "options": [ + "Option 1", + "Option 2" + ] +} +``` diff --git a/source/includes/_errors.md b/source/includes/_errors.md index 56cffb34d22..0a7205ca52e 100644 --- a/source/includes/_errors.md +++ b/source/includes/_errors.md @@ -1,20 +1,34 @@ # Errors - +The SimplyPrint API uses the following HTTP error codes: -The Kittn API uses the following error codes: +| Error Code | Meaning | +|------------|-------------------------------------------------------------------------------------------| +| 400 | Bad Request -- Your request is invalid. | +| 401 | Unauthorized -- Your API key is wrong. | +| 403 | Forbidden -- Request not allowed. | +| 404 | Not Found -- Endpoint not found. | +| 405 | Method Not Allowed -- You tried to access an endpoint with an invalid method. | +| 406 | Not Acceptable -- You requested a format that isn't json. | +| 410 | Gone -- The endpoint requested has been removed from our servers. | +| 429 | Too Many Requests -- You're requesting too much - slow down | +| 500 | Internal Server Error -- We had a problem with our server. Try again later. | +| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. | +## Error Response -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. +> Error response example: + +```json +{ + "status": false, + "message": "No API key provided, or not logged in" +} +``` + +When an error occurs, the API will return a JSON object with the following fields: + +| Field | Description | Type | +|---------|--------------------------------|-------------| +| status | The status of the request | Boolean | +| message | A message describing the error | String/null | diff --git a/source/includes/_filament.md b/source/includes/_filament.md new file mode 100644 index 00000000000..c4efa87535a --- /dev/null +++ b/source/includes/_filament.md @@ -0,0 +1,439 @@ +# Filament + +## List Filaments + +```shell +curl https://api.simplyprint.io/{id}/filament/GetFilament \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "showid": true, + "is_kg": false, + "brands": { + "test brand": 1, + ... + }, + "types": { + "PLA": 1, + ... + }, + "filament": { + "3017": { + "id": 3017, + "uid": "PL23", + "type": { + "id": 5637, + "name": "PLA" + }, + "brand": "test brand", + "colorName": "test color", + "colorHex": "#000000", + "dia": 1.75, + "density": 1.24, + "temps": { + "nozzle": 210, + "bed": 65, + "flNozzle": 210, + "flBed": 65 + }, + "slicing": { + "printSpeed": 70, + "finishRate": 0.5, + "minSpeed": 15 + }, + "total": 335284, + "left": 234699, + "extruder": 0, + "bought": 1630447200, + "created": 1630508337, + "printer": 0, + "nfc": 0, + "qr": 0, + "prodId": "" + }, + ... + } +} +``` + +This endpoint returns a list of all filaments as well as filament types and brands. + +### Request + +`GET /{id}/filament/GetFilament` + +### Response + +| Parameter | Type | Description | +|------------------------------------|---------|-------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `showid` | boolean | Whether to show filament id. (Frontend data) | +| `is_kg` | boolean | Whether to show filament in kg. (Frontend data) | +| `brands` | object | Filament brands. | +| `brands.{brand}` | integer | Number of filaments with `{brand}`. | +| `types` | object | Filament types such as PLA, ABS, PETG, etc. | +| `types.{type}` | integer | Number of filaments with `{type}`. | +| `filament` | object | Filament data where each key is a filament id. | +| `filament.{id}` | object | Filament data. | +| `filament.{id}.id` | integer | Filament id. (same as `{id}`) | +| `filament.{id}.uid` | string | Four character code that is used to identify the filament. Refered to as filament id in the frontend. | +| `filament.{id}.type` | object | Filament type. | +| `filament.{id}.type.id` | integer | Filament type id. | +| `filament.{id}.type.name` | string | Filament type name. | +| `filament.{id}.brand` | string | Filament brand. | +| `filament.{id}.colorName` | string | Filament color name. | +| `filament.{id}.colorHex` | string | Filament color hex code. | +| `filament.{id}.dia` | float | Filament diameter. | +| `filament.{id}.density` | float | Filament density. | +| `filament.{id}.temps` | object | Filament temperatures. | +| `filament.{id}.temps.nozzle` | integer | Filament nozzle temperature. | +| `filament.{id}.temps.bed` | integer | Filament bed temperature. | +| `filament.{id}.temps.flNozzle` | integer | Filament first layer nozzle temperature. | +| `filament.{id}.temps.flBed` | integer | Filament first layer bed temperature. | +| `filament.{id}.slicing` | object | Filament slicing settings. | +| `filament.{id}.slicing.printSpeed` | integer | Filament print speed. | +| `filament.{id}.slicing.finishRate` | float | Filament finish rate. | +| `filament.{id}.slicing.minSpeed` | integer | Filament minimum speed. | +| `filament.{id}.total` | integer | Total filament length in mm. | +| `filament.{id}.left` | integer | Left filament length in mm. | +| `filament.{id}.extruder` | integer | Which extruder the filament is assigned to. | +| `filament.{id}.bought` | integer | Timestamp of when the filament was bought. | +| `filament.{id}.created` | integer | Timestamp of when the filament was created. | +| `filament.{id}.printer` | integer | Which printer the filament is assigned to. | +| `filament.{id}.nfc` | integer | Whether the filament has NFC. | +| `filament.{id}.qr` | integer | Whether the filament has QR. | +| `filament.{id}.prodId` | string | Filament product id. | + +## Create or Update Existing Filament + +```shell +curl https://api.simplyprint.io/{id}/filament/Create \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request Body + +```json +{ + "color_name": "Porcelain White", + "color_hex": "#E5E5E5", + "color_standard": "NCS S 1000-N", + "width": 1.75, + "density": 1.24, + "bought_at": "2022-12-24", + "filament_type": "rPLA", + "cost": 23, + "custom_note": "This is a note", + "prod_id": "", + "brand": "lostboyslab", + "brand_id": 1, + "filgroup_id": 13, + "spool_id": 44, + "slicing_settings": { + "nozzle_temp": 200, + "nozzle_fl_temp": 200, + "bed_temp": 60, + "bed_fl_temp": 60, + "print_speed": 70, + "finish_rate": 0.5, + "min_speed": 15 + }, + "amount": 1, + "total_length_type": "kg", + "left_length_type": "percent", + "total_length": 1, + "length_used": 57 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "filament_ids": [ + "NGGY" + ], + "qr_gen": 1 +} +``` + +This endpoint can be used to create or update existing filament. + +To update existing filament, you need to provide a `fid` query parameter, which is the filament id of the filament you +want to update. + +| Required permissions | +|----------------------| +| `create_filament` | + +### Request + +`POST /{id}/filament/Create` + +#### Query Parameters + +| Parameter | Type | Required | Description | +|-----------|--------|----------|-------------------------------------------------| +| `fid` | string | no | Filament id of the filament you want to update. | + +#### Request Body + +| Parameter | Type | Required | Description | +|-----------------------------------|--------------|----------|----------------------------------------------------------------------------------| +| `color_name` | string | yes | Filament color name.
**Max 64 characters** | +| `color_hex` | string | yes | Filament color hex code. | +| `color_standard` | string | no | Filament color standard. | +| `width` | float (enum) | yes | Filament width.
**Value has to be one of `[1.75, 2.85, 3.00]`** | +| `density` | float | yes | Filament density. | +| `bought_at` | string | no | Date of purchase.
**Format: `YYYY-MM-DD`** | +| `filament_type` | string | yes | Filament type. | +| `cost` | float | no | Cost of filament in your account-defined currency (changed in account settings). | +| `custom_note` | string | no | Custom note.
**Max 1000 characters** | +| `prod_id` | string | no | Filament product id. | +| `brand` | string | yes | Filament brand. | +| `brand_id` | integer | no | Filament brand id. | +| `filgroup_id` | integer | no | Target SimplyPrint filament group id to insert filament into. | +| `spool_id` | integer | no | Filament spool id. | +| `slicing_settings` | object | yes | Slicing settings. | +| `slicing_settings.nozzle_temp` | integer | yes | Nozzle temperature. | +| `slicing_settings.nozzle_fl_temp` | integer | yes | Nozzle first layer temperature. | +| `slicing_settings.bed_temp` | integer | yes | Bed temperature. | +| `slicing_settings.bed_fl_temp` | integer | yes | Bed first layer temperature. | +| `slicing_settings.print_speed` | integer | yes | Print speed. | +| `slicing_settings.finish_rate` | float | yes | Finish rate. | +| `slicing_settings.min_speed` | integer | yes | Minimum speed. | +| `amount` | integer | yes | Amount of filament. | +| `total_length_type` | string | yes | Total length type. | +| `left_length_type` | string | yes | Left length type. | +| `total_length` | float | yes | Total length. | +| `length_used` | float | yes | Length used. | + +### Response + +| Parameter | Type | Description | +|----------------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `filament_ids` | array | Array of filament ids. | +| `qr_gen` | integer | Used for frontend, not important. | + +## Delete Filament + +```shell +curl https://api.simplyprint.io/{id}/filament/Delete?fid=4519 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint deletes a filament specified by the `fid` parameter. + +| Required permissions | +|----------------------| +| `create_filament` | + +### Request + +`GET /{id}/filament/Delete` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-------------| +| fid | integer | yes | Filament id | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Assign Filament(s) To Printer + +```shell +curl https://api.simplyprint.io/{id}/filament/Assign?pid=5123&fid=21812,31253 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "extruder": { + "21812": 0, + "31253": 1 + } +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint assigns filament(s) to a printer. + +| Required permissions | +|----------------------| +| `change_filament` | + +### Request + +`POST /{id}/filament/Assign` + +The request has both query parameters and a request body. + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|---------|----------|----------------------------------| +| `pid` | integer | yes | Printer id. | +| `fid` | integer | yes | Filament id(s), comma separated. | + +#### Request body + +| Parameter | Type | Required | Description | +|------------------|---------|----------|---------------------------------------------| +| `extruder` | object | yes | Which filament to assign to which extruder. | +| `extruder.{fid}` | integer | yes | Which extruder id to assign `{fid}` to. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Unassign Filament From Printer + +```shell +curl https://api.simplyprint.io/{id}/filament/Unassign?fid=21812 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint unassigns a filament from a printer by filament id. + +| Required permissions | +|----------------------| +| `change_filament` | + +### Request + +`GET /{id}/filament/Unassign` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|--------------------------| +| `fid` | integer | yes | Filament id to unassign. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Get Filament Types + +```shell +curl https://api.simplyprint.io/{id}/filament/type/Get \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 6030, + "org_id": 2, + "filament_type_name": "PLA", + "width": 1.75, + "nozzle_temp": 200, + "bed_temp": 60, + "print_speed": 70, + "finish_rate_factor": 0.5, + "min_speed": 15, + "density": 1.24, + "priority": 0, + "deleted": 1, + "cost": null, + "allowed_nozzle_temp_margin": 10, + "allowed_bed_temp_margin": 10 + }, + { + "id": 10548, + "org_id": 2, + "filament_type_name": "PolyMide PA6-CF", + "width": 1.75, + "nozzle_temp": 210, + "bed_temp": 60, + "print_speed": 60, + "finish_rate_factor": 0.5, + "min_speed": 15, + "density": 1.24, + "priority": 0, + "deleted": 0, + "cost": 1, + "allowed_nozzle_temp_margin": 10, + "allowed_bed_temp_margin": 10 + } + ] +} +``` + +This endpoint returns a list of filament types available. + +| Required permissions | +|----------------------| +| `see_filament_tab` | + +### Request + +`GET /{id}/filament/type/Get` + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | Array of filament types. | diff --git a/source/includes/_files.md b/source/includes/_files.md new file mode 100644 index 00000000000..af659ae5521 --- /dev/null +++ b/source/includes/_files.md @@ -0,0 +1,338 @@ +# Files + + + +## Add an API File to files + +`POST {id}/files/Upload?folder={folder}` + +| Parameter | Type | Required | Description | +|-----------------|---------|----------|-------------------------------------------------------------| +| `folder` (GET) | integer | no | Folder ID to get files for. **Defaults to 0 (root folder)** | +| `fileId` (POST) | string | yes | File ID from [API Files](#api-files) + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `id` | string | User file ID of newly added file | + +```shell +curl -X POST https://api.simplyprint.io/{id}/files/Upload?folder=5290 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -F 'fileId=43aaad56548c959f655d0524027b726a7514493ec8436f4942f876bb07eab731' +``` + +> Success Response + +```json +{ + "status": true, + "message": null, + "id": "6f7d79212f384c6b8eae2811c37d9338" +} +``` + +## List Files and Folders + +```shell +curl https://api.simplyprint.io/{id}/files/GetFiles?f=123&search=benchy \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "files": [ + { + "id": "d82ab9e1cc3c20850d94d5cf539390c0", + "name": "3DBenchy", + "ext": "stl", + "type": "model", + "size": 11285384, + "created": "December 23, 2022, 17:35", + "createdint": 1671813336, + "printData": { + "printsDone": 0, + "printsCancelled": 0, + "printsFailed": 0, + "timesSliced": 0 + }, + "user_id": 123, + "thumbnail": 1, + "folder": 0, + "user": 123 + }, + { + "id": "e82ab9e1cc3c20850d94d5cf539390c0", + "name": "3DBenchy", + "ext": "gcode", + "type": "printable", + "size": 1285384, + "created": "December 23, 2022, 18:00", + "createdint": 1671813330, + "printData": { + "printsDone": 10, + "printsCancelled": 5, + "printsFailed": 0, + "timesSliced": 0 + }, + "user_id": 123, + "thumbnail": 1, + "folder": 0, + "user": 123, + "forPrinters": [ + // list of printers IDs selected for file; key not present if no printers are selected + 1, + 2, + 3 + ], + "tags": { + "nozzle": 0.6, + "material": [ + { + "ext": 0, + "type": 123, + "color": "Green", + "hex": "#4CAF50" + } + ], + "custom": [ + 1, + 2, + 3 + ] + }, + "cost": { + "estimate": false, + "total_cost": 150, + "lines": [ + { + "id": 1, + "label": "Material usage (account default)", + "cost": 0.02 + }, + { + "id": 2, + "label": "Material markup", + "cost": null + }, + { + "id": 3, + "label": "Machine run time cost", + "cost": null + }, + { + "id": 4, + "label": "Energy cost", + "cost": null + }, + { + "id": 5, + "label": "Labor cost", + "cost": 1000 + } + ] + } + } + ], + "customFields": [ + { + "id": "student_id", + "value": { + "string": "1234567890" + } + } + ], + "folders": [ + { + "id": 5290, + "name": "random_folder_called_benchy", + "items": { + "files": 0, + "folders": 0 + }, + "created": "December 23, 2022", + "createdInt": 1671814215, + "parent_folder_id": 0, + "depth": 0 + } + ], + "path": [ + [ + "Your search...", + 0 + ] + ], + "sort_type": "", + "space": 10000000000, + "space_used": 131446609 +} +``` + +This endpoint returns a list of files and folders in a given folder. If no folder is specified, the root folder is used. + +### Request + +`GET /{id}/files/GetFiles` + +| Parameter | Type | Required | Description | +|-----------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `f` | integer | no | Folder ID to get files for. **Defaults to 0 (root folder)** | +| `search` | string | no | Search string to filter files by. | +| `global_search` | boolean | no | If true, search all files in the account, not just the folder specified by `f`. | +| `pid` | integer | no | For print cost calculation, if you want the files to use the material of a printer, request with the ID of the printer - don't include the `pid` argument otherwise | + +### Response + +| Parameter | Type | Description | +|--------------|---------|------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `files` | array | Array of file objects. | +| `folders` | array | Array of folder objects. | +| `path` | array | Array of arrays containing the path to the current folder. | +| `sort_type` | string | Sort type from user's settings. | +| `space` | integer | The total space available in bytes. | +| `space_used` | integer | The total space used in bytes. | + +## Move File(s) to Folder + +```shell +curl https://api.simplyprint.io/{id}/files/MoveFiles?files=d82ab9e1cc3c20850d94d5cf539390c0&folder=5290 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": "Moved 1 files" +} +``` + +This endpoint moves one or more files to a given folder. + +### Request + +`GET /{id}/files/MoveFiles` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|----------------------------------------------------------------| +| `files` | array | yes | Array of file IDs to move. Separate multiple IDs with a comma. | +| `folder` | integer | yes | Folder ID to move files to. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Get Folder Details + +```shell +curl https://api.simplyprint.io/{id}/files/GetFolder?id=5290 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "folder": { + "id": 5290, + "name": "org_folder_called_benchy", + "org": true, + "permissions": { + "view": [ + 112, + 151 + ], + "upload": [ + 112 + ], + "modify": [ + 112 + ] + } + } +} +``` + +This endpoint returns details about a given folder. + +### Request + +`GET /{id}/files/GetFolder` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-------------------------------| +| `id` | integer | yes | Folder ID to get details for. | + +### Response + +| Parameter | Type | Description | +|-----------------------------|-------------|--------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `folder` | object | Folder object. | +| `folder.id` | integer | Folder ID. | +| `folder.name` | string | Folder name. | +| `folder.org` | boolean | True if the folder is an organization folder.
**Requires Print Farm plan** | +| `folder.permissions` | object/null | Folder permissions. | +| `folder.permissions.view` | array | Array of [group IDs](#get-company-groups) that can view the folder. | +| `folder.permissions.upload` | array | Array of [group IDs](#get-company-groups) that can upload files to the folder. | +| `folder.permissions.modify` | array | Array of [group IDs](#get-company-groups) that can modify the folder. | + +## Move Folder + +```shell +curl https://api.simplyprint.io/{id}/files/MoveFolder?folder=5290&target=5291 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": "Moved folder 5298 to folder 5297" +} +``` + +This endpoint moves a folder to a given folder. + +Please note that the root folder cannot be moved, but folders can be moved into the root folder by setting `target=0`. +Also, folders cannot be moved into themselves. + +### Request + +`GET /{id}/files/MoveFolder` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-----------------------| +| `folder` | integer | yes | Folder ID to move. | +| `target` | integer | yes | Folder ID to move to. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | diff --git a/source/includes/_jobs.md b/source/includes/_jobs.md new file mode 100644 index 00000000000..a31e76061dc --- /dev/null +++ b/source/includes/_jobs.md @@ -0,0 +1,271 @@ +# Print Jobs + +## Get print jobs + +```shell +curl https://api.simplyprint.io/{id}/jobs/GetPaginatedPrintJobs \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "page": 1, + "page_size": 10, + "printer_ids": [ + 385 + ], + "status": [ + "cancelled", + "finished" + ], + "start_date": "2023-02-28" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 549145, + "uid": "7df103aa-b12c-4b33-8305-b55f91c11a4d", + "status": "cancelled", + "cancelReasonType": "5", + "rating": -2, + "filename": "Benchy.gcode", + "startDate": "2023-02-28T21:05:50+00:00", + "endDate": "2023-02-28T21:06:07+00:00", + "user": 5933, + "autoprint": false, + "outsideSystem": false, + "printer": 385, + "filament": "{\"e0\": {\"usage\": 60}}", + "filUsage": 60, + "filUsageGram": 0, + "currentPercentage": 48, + "printTime": 17, + "cost": { + "estimate": false, + "total_cost": 150, + "lines": [ + { + "id": 1, + "label": "Material usage (account default)", + "cost": 0.02 + }, + { + "id": 2, + "label": "Material markup", + "cost": null + }, + { + "id": 3, + "label": "Machine run time cost", + "cost": null + }, + { + "id": 4, + "label": "Energy cost", + "cost": null + }, + { + "id": 5, + "label": "Labor cost", + "cost": 1000 + } + ] + }, + "queueItem": { + "id": 1234, + "user": 51, + "queueNum": 3 + }, + "customFields": [ + { + "id": "student_id", + "value": { + "string": "1234567890" + } + } + ] + }, + ... + ], + "page_amount": 1 +} +``` + +Get paginated data about ongoing or finished print jobs. + +### Request + +`POST /{id}/jobs/GetPaginatedPrintJobs` + +| Parameter | Type | Required | Description | +|-----------------------|-----------|----------|------------------------------------------------------------------------------------------| +| `page` | integer | yes | The page number to get. | +| `page_size` | integer | yes | The number of items per page. (Between 1 and 100) | +| `printer_types[]` | integer[] | no | Array of printer type ids to filter on. | +| `printer_ids[]` | integer[] | no | Array of printer ids to filter on. | +| `user_ids[]` | integer[] | no | Array of user ids to filter on. | +| `accepted_statuses[]` | string[] | no | Array of job statuses to filter on. One of `ongoing`, `cancelled`, `failed`, `finished`. | +| `start_date` | string | no | The start date to filter on. In unix timestamp format. Can be set without `end_date`. | +| `end_date` | string | no | The end date to filter on. In unix timestamp format. Can be set without `start_date`. | + +### Response + +| Parameter | Type | Description | +|-----------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | The jobs. | +| `data[].id` | integer | The job id. | +| `data[].uid` | string | The job uid. | +| `data[].status` | string | The job status. One of `ongoing`, `cancelled`, `failed`, `done`. Note that `done` is the same as `finished` | +| `data[].cancelReasonType` | string | The job cancel reason type. | +| `data[].rating` | integer | The job rating. | +| `data[].filename` | string | The job filename. | +| `data[].startDate` | string | The job start date. | +| `data[].endDate` | string/null | The job end date. Is null if the job is ongoing. | +| `data[].user` | integer/null | The user id of the user who started the job. | +| `data[].autoprint` | boolean | If the job was started automatically using the Auto-print feature | +| `data[].outsideSystem` | boolean | If the job was started outside SimplyPrint, via SD card, OctoPrint, Mailsail, Fluidd or else how | +| `data[].printer` | integer | The printer id that was used to print the job. | +| `data[].filament` | string | The filament usage. JSON encoded string with usage per extruder. | +| `data[].filUsage` | integer | The filament usage in mm. | +| `data[].filUsageGram` | integer | The filament usage in grams. | +| `data[].currentPercentage` | integer | The current percentage of the job. | +| `data[].cost` | object/null | Potential calculated cost of job. | +| `data[].queueItem` | object/null | The queue item that was used to start the job. Please note that this is only shown if you have access to view the Print Queue. | +| `data[].queueItem.id` | integer | The id of the queue item that was used to start the job. | +| `data[].queueItem.user` | integer | The user id of the user who created the queue item. | +| `data[].queueItem.queueNum` | integer | The queue number of the queue item. | +| `page_amount` | integer | The total number of pages for the given parameters. | + +## Get details + +```shell +curl https://api.simplyprint.io/{id}/jobs/GetDetails \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "id": "job_id" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "job": { + "id": 123, + "filament": [ + ... + ], + "pauses": [ + ... + ], + "currentTime": 1697040000, + "pictures": [ + ... + ], + "notificationsSent": [ + ... + ], + "cost": 12.34, + "customFields": { + ... + }, + "ended": 3600, + "failedReason": "string", + "cancelInfo": { + "reason": "string", + "comment": "string", + "by": "string", + "byOther": 1 + }, + "analysis": { + ... + }, + "notifications": { + ... + }, + "outsideSystem": true, + "rating": 5, + "started": 7200, + "created": 10800, + "state": "string", + "file": "filename.gcode", + "percentage": 50, + "time": 1800, + "canPreview": true, + "layer": 10, + "ai": [ + 0.1, + 0.2, + 0.3 + ], + "printer": { + "id": 456, + "name": "Printer Name", + "extruders": 2, + "image": "https://cdn.simplyprint.io/prints/images/printer_image.jpg", + "deleted": 1 + }, + "spools": [ + ... + ] + } +} +``` + +`GET /{id}/jobs/GetDetails?id={job_id}` + +### Request Body + +| Parameter | Type | Description | +|-----------|--------|--------------| +| `id` | string | The job UID. | + +### Response + +| Parameter | Type | Description | +|-------------------------|---------|------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `job` | object | Details about the print job. | +| `job.id` | integer | Unique identifier for the job. | +| `job.filament` | array | Array of filament data. | +| `job.pauses` | array | Array of pause history. | +| `job.currentTime` | integer | Current timestamp. | +| `job.pictures` | array | Array of pictures related to the job. | +| `job.notificationsSent` | array | Array of notifications sent. | +| `job.cost` | float | Cost of the print job. | +| `job.customFields` | object | Custom fields for the job. | +| `job.ended` | integer | Time since the job ended. | +| `job.failedReason` | string | Reason for job failure, if any. | +| `job.cancelInfo` | object | Information about job cancellation. | +| `job.analysis` | object | G-code analysis data. | +| `job.notifications` | object | Notification data. | +| `job.outsideSystem` | boolean | `true` if the job is outside the system. | +| `job.rating` | integer | Rating of the job. | +| `job.started` | integer | Time since the job started. | +| `job.created` | integer | Time since the job was created. | +| `job.state` | string | Current state of the job. | +| `job.file` | string | Original filename of the job. | +| `job.percentage` | integer | Current completion percentage. | +| `job.time` | integer | Time left or time since the job ended. | +| `job.canPreview` | boolean | `true` if the job can be previewed. | +| `job.layer` | integer | Current layer of the print. | +| `job.ai` | array | Array of AI detection values. | +| `job.printer` | object | Details about the printer. | +| `job.spools` | array | Array of spool data. | diff --git a/source/includes/_partner.md b/source/includes/_partner.md new file mode 100644 index 00000000000..323b5ef7122 --- /dev/null +++ b/source/includes/_partner.md @@ -0,0 +1,532 @@ +# Partner + + + +## Get companies + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/GetCompanies \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "page": 1, + "page_size": 10, + "search": "example", + "sort_id": "name", + "sort_dir": "asc" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": [ + // List of companies + ], + "total": 100, + "page_amount": 10 +} +``` + + + +`POST /{id}/partner/GetCompanies` + +### Request Body + +| Parameter | Type | Description | +|-------------|---------|---------------------------------------------------| +| `page` | integer | The page number to retrieve. | +| `page_size` | integer | The number of items per page (between 1 and 100). | +| `search` | string | Search term to filter companies (max 50 chars). | +| `sort_id` | string | The field to sort by. | +| `sort_dir` | string | The direction to sort (asc or desc). | + +### Response + +| Parameter | Type | Description | +|---------------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `data` | array | The list of companies. | +| `total` | integer | The total number of companies. | +| `page_amount` | integer | The total number of pages. | + +## Get company + +```shell +curl https://api.simplyprint.io/{id}/partner/GetCompany?company=123&initial=true \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": { + "id": 123, + "name": "Example Company", + "vat": "12345678", + "ean": "1234567890123", + "trial_until": "2023-12-31T23:59:59", + "country": "US", + "uid": "unique-id", + "created": "2023-01-01T00:00:00", + "active": true, + "sponsored": false, + "public_edu": true, + "plan": "premium", + "type": "business", + "max_printers": 10, + "max_users": 50, + "user_max_gb": 100, + "address": "123 Example St", + "contact_person": "John Doe", + "contact_email": "john.doe@example.com", + "contact_phone": "+1234567890", + "user_count": 25, + "printers_count": 5, + "online_printers": 3, + "week_jobs": 10, + "total_jobs": 100, + "filament": 20, + "success_jobs": 8, + "online_user_count": 15, + "user_space_used": 50 + }, + "users_data": { + // Initial user data if applicable + } +} +``` + + + +`GET /{id}/partner/GetCompany` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------| +| `company` | integer | The ID of the company to retrieve. | +| `initial` | boolean | Whether to include initial user data (optional). | + +### Response + +| Parameter | Type | Description | +|--------------|---------|-------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `data` | object | The company details. | +| `users_data` | object | Initial user data if `initial` is `true`. | + +## Get overview stats + +```shell +curl https://api.simplyprint.io/{id}/partner/GetOverviewStats \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "total_active_managed_companies": 10, + "total_trial_managed_companies": 2, + "total_inactive_managed_companies": 3, + "total_printers": 50, + "total_online_printers": 30, + "total_print_jobs": 200, + "total_print_jobs_last_7_days": 20, + "total_users": 100, + "total_users_online_last_7_days": 15 +} +``` + + + +`GET /{id}/partner/GetOverviewStats` + +### Response + +| Parameter | Type | Description | +|------------------------------------|---------|------------------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `total_active_managed_companies` | integer | Total number of active managed companies. | +| `total_trial_managed_companies` | integer | Total number of managed companies in trial. | +| `total_inactive_managed_companies` | integer | Total number of inactive managed companies. | +| `total_printers` | integer | Total number of printers for all managed companies. | +| `total_online_printers` | integer | Total number of online printers for all managed companies. | +| `total_print_jobs` | integer | Total number of print jobs for all managed companies. | +| `total_print_jobs_last_7_days` | integer | Total number of print jobs in the last 7 days. | +| `total_users` | integer | Total number of users for all managed companies. | +| `total_users_online_last_7_days` | integer | Total number of users online in the last 7 days. | + +## Create/update company + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/CreateCompany \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "name": "Example Company", + "uid": "unique-id", + "active": 1, + "trial_until": "2023-12-31", + "public_edu": true, + "extra_printers": 5, + "extra_users": 50, + "extra_gb": 100, + "active_plan": 5, + "type": 1, + "contact_email": "contact@example.com", + "contact_phone": "+1234567890", + "att_person": "John Doe", + "uni_login": true, + "uni_login_ids": "id1,id2", + "address_stuff": { + "street": "123 Example St", + "city": "Example City", + "country": "US", + "postal_code": "12345" + } + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "id": 123 +} +``` + + + +`POST /{id}/partner/CreateCompany` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------------| +| `edit` | integer | The ID of the company to edit (optional). | + +### Request Body + +| Parameter | Type | Description | +|------------------|---------|----------------------------------------------------------------------| +| `name` | string | The name of the company (required, max 128 characters). | +| `uid` | string | The unique identifier for the company (required, max 32 characters). | +| `active` | integer | Whether the company is active (required, 0 or 1). | +| `trial_until` | date | The trial end date in `Y-m-d` format (optional). | +| `public_edu` | boolean | Whether the company is a public educational institution (required). | +| `extra_printers` | integer | The number of extra printers (required, min 0). | +| `extra_users` | integer | The number of extra users (required, min 0). | +| `extra_gb` | integer | The amount of extra storage in GB (required, min 0). | +| `active_plan` | integer | The active plan ID (required, must be 4 or 5). | +| `type` | integer | The type of company (required, must be 0, 1, 2, or 3). | +| `contact_email` | string | The contact email for the company (required, valid email format). | +| `contact_phone` | string | The contact phone number (optional, max 32 characters). | +| `att_person` | string | The name of the contact person (required, max 128 characters). | +| `uni_login` | boolean | Whether UniLogin is enabled (optional). | +| `uni_login_ids` | string | Comma-separated UniLogin IDs (optional). | +| `address_stuff` | array | The address details (required). | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `id` | integer | The ID of the created or updated company. | + +## Delete company + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/DeleteCompany?company=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +`POST /{id}/partner/DeleteCompany` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|----------------------------------| +| `company` | integer | The ID of the company to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Validate printer (partner-wide printer search) + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/move/ValidatePrinter \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "ids": [1, 2, 3], + "search": "example", + "not_in": [4, 5] + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "items": [ + { + "id": 1, + "name": "Printer 1", + "sku": "SKU123", + "org_id": 10, + "image": "https://example.com/printer1.jpg" + }, + { + "id": 2, + "name": "Printer 2", + "sku": "SKU456", + "org_id": 11, + "image": "https://example.com/printer2.jpg" + } + ] +} +``` + + + +Searches for printers across all partner-companies. +Useful for finding printers to move between companies. + +`POST /{id}/partner/move/ValidatePrinter` + +### Request Body + +| Parameter | Type | Description | +|------------|---------|-----------------------------------------------------------| +| `ids` | array | List of printer IDs to search (optional). | +| `ids.*` | integer | Each printer ID must be an integer. | +| `search` | string | Search term to filter printers (optional, max 256 chars). | +| `not_in` | array | List of printer IDs to exclude (optional). | +| `not_in.*` | integer | Each printer ID to exclude must be an integer. | + +### Response + +| Parameter | Type | Description | +|------------------|---------|-------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `items` | array | List of validated printers. | +| `items.*.id` | integer | The ID of the printer. | +| `items.*.name` | string | The name of the printer. | +| `items.*.sku` | string | The SKU of the printer. | +| `items.*.org_id` | integer | The ID of the company owning the printer. | +| `items.*.image` | string | URL of the printer's image. | + +## Move printer + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/move/MovePrinter \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "moveTo": 123, + "moveToGroup": 456, + "ids": [1, 2, 3] + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +Find printers to move with `ValidatePrinter` endpoint. + +`POST /{id}/partner/move/MovePrinter` + +### Request Parameters + +| Parameter | Type | Description | +|---------------|---------|------------------------------------------------| +| `moveTo` | integer | The ID of the target company (required). | +| `moveToGroup` | integer | The ID of the target printer group (required). | +| `ids` | array | List of printer IDs to move (required). | +| `ids.*` | integer | Each printer ID must be an integer. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Validate filament (partner-wide filament search) + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/move/ValidateFilament \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "ids": [1, 2, 3], + "search": "example filament", + "not_in": [4, 5] + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "items": [ + { + "id": 1, + "uniq_id": "UNIQ123", + "color_name": "Red", + "color_hex": "#FF0000", + "org_id": 10, + "brand": "Example Brand", + "type_id": 1, + "type_name": "PLA" + } + ] +} +``` + + + +Searches for filaments across all partner-companies. +Useful for finding filaments to move between companies. + +`POST /{id}/partner/move/ValidateFilament` + +### Request Body + +| Parameter | Type | Description | +|------------|---------|-----------------------------------------------------------| +| `ids` | array | List of filament IDs to search (optional). | +| `ids.*` | integer | Each filament ID must be an integer. | +| `search` | string | Search term to filter filament (optional, max 256 chars). | +| `not_in` | array | List of filament IDs to exclude (optional). | +| `not_in.*` | integer | Each filament ID to exclude must be an integer. | + +### Response + +| Parameter | Type | Description | +|----------------------|---------|--------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `items` | array | List of validated filaments. | +| `items.*.id` | integer | The ID of the filament. | +| `items.*.uniq_id` | string | The unique ID of the filament. | +| `items.*.color_name` | string | The name of the filament color. | +| `items.*.color_hex` | string | The hex code of the filament color. | +| `items.*.org_id` | integer | The ID of the company owning the filament. | +| `items.*.brand` | string | The brand of the filament. | +| `items.*.type_id` | integer | The ID of the filament type. | +| `items.*.type_name` | string | The name of the filament type. | + +## Move filament + +```shell +curl -X POST https://api.simplyprint.io/{id}/partner/move/MoveFilament \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "moveTo": 123, + "moveToFilamentType": 456, + "filamentMoveTypeClean": false, + "ids": [1, 2, 3] + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +Find filament to move with `ValidateFilament` endpoint. + +`POST /{id}/partner/move/MoveFilament` + +### Request Parameters + +| Parameter | Type | Description | +|-------------------------|---------|----------------------------------------------------------------------------------| +| `moveTo` | integer | The ID of the target company (required). | +| `moveToFilamentType` | integer | The ID of the target filament type (required). | +| `filamentMoveTypeClean` | boolean | Whether to only change the filament company, or also change the type (optional). | +| `ids` | array | List of printer IDs to move (required). | +| `ids.*` | integer | Each printer ID must be an integer. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | diff --git a/source/includes/_permissions_scopes.md b/source/includes/_permissions_scopes.md new file mode 100644 index 00000000000..027e0bd4e3c --- /dev/null +++ b/source/includes/_permissions_scopes.md @@ -0,0 +1,110 @@ +# Permissions and Scopes + +## Company permissions + +These permissions are used to control access within a company. The permissions are tied to the user groups within the +company. + +The owner of a company has all permissions. + +| Permission | Description | +|----------------------------------|------------------------------------------------------------------------------------------------------| +| `view_news` | "Allow viewing news in the application" | +| `org_admin` | "Allow administrating organization settings and permissions" | +| `panel_printing` | "Allow access to the printing panel" | +| `printer_restart` | "Allow restarting printers" | +| `printer_edit` | "Allow creating, editing, and deleting printers" | +| `bed_leveling` | "Allow performing bed leveling on printers" | +| `gcode_profiles` | "Allow managing GCode macros and snippets" | +| `printer_settings` | "Allow configuring printer settings" | +| `filament_settings` | "Allow managing filament settings" | +| `change_filament` | "Allow changing filament on printers" | +| `create_filament` | "Allow creating, editing, and deleting filament spools" | +| `see_filament_tab` | "Allow viewing the filament tab" | +| `view_users` | "Allow viewing user overview in the organization" | +| `change_user_rank` | "Allow changing users' group (rank) within the organization" | +| `assign_peer_rank` | "Allow assigning other users' group (rank) to the same rank as yours" | +| `manual_user_email_confirm` | "Allow manually confirming user email addresses" | +| `invite_users` | "Allow inviting other users to the organization" | +| `delete_user` | "Allow deleting users from the organization" | +| `org_user_registration_settings` | "Allow managing user registration settings for the organization" | +| `org_hub_settings` | "Allow managing hub settings for the organization" | +| `org_rank_management` | "Allow creating, editing, deleting, and reordering user groups (ranks)" | +| `org_view_statistics` | "Allow viewing organization-wide statistics (for all users)" | +| `refill_quota` | "Allow refilling user quota (coming soon)" | +| `custom_slicer_profiles` | "Allow creating and deleting custom slicer profiles" | +| `org_profiles` | "Allow creating and editing organization slicer profiles" | +| `all_slicer_modes` | "Allow accessing all slicer modes" | +| `see_slicer_default_profiles` | "Allow viewing default slicer profiles" | +| `queue_remove_all` | "Allow deleting other users' print queue items" | +| `org_api` | "Allow users' API key to be used with this organization" | +| `create_org_folder` | "Allow creating organization (shared) folders" | +| `cancel_others` | "Allow canceling other users' print jobs" | +| `see_who_printed` | "Allow viewing who printed specific items in various popups ("Print removed", "Cancel print", etc.)" | +| `edit_tags` | "Allow creating, updating, and deleting custom tags" | +| `goto_local` | "Allow going to local printer UI (OctoPrint, Mainsail, Fluidd, etc.)" | +| `printer_info` | "Allow viewing extra printer information ("Printer info" popup)" | +| `send_raw_gcode` | "Allow sending raw GCode commands to printers" | +| `widget_device_health` | "Allow access to device health widget" | +| `widget_control` | "Allow access to printer control widget" | +| `change_temps` | "Allow changing printer temperatures" | +| `change_print_speed` | "Allow changing the print speed" | +| `printer_delete` | "Allow deleting printers" | +| `printer_add` | "Allow adding new printers" | +| `print_queue` | "Allow access to the print queue" | +| `reorder_queue` | "Allow reordering print queue items" | +| `see_cam` | "Allow viewing printer camera feeds" | +| `clear_bed` | "Allow clearing the print bed" | +| `slice` | "Allow slicing models for printing" | +| `print` | "Allow starting print jobs" | +| `pause` | "Allow pausing print jobs" | +| `cancel` | "Allow canceling print jobs" | +| `queue_groups` | "Allow managing print queue groups" | +| `queue_edit_others` | "Allow editing other users' print queue items" | +| `queue_read_notes` | "Allow reading notes on other users' print queue items" | +| `queue_download_others` | "Allow downloading files from other users' print queue items" | +| `queue_see_done_items` | "Allow viewing completed print queue items" | +| `queue_revive_done_items` | "Allow reviving completed print queue items" | +| `queue_assign_printers` | "Allow assigning printers to print queue items" | +| `queue_print_slice` | "Allow printing directly from sliced items in the queue" | +| `queue_see_others` | "Allow viewing other users' print queue items" | +| `files_nozzle_tag` | "Allow managing nozzle tags for files" | +| `files_material_tag` | "Allow managing material tags for files" | +| `files_assign_custom_tags` | "Allow assigning custom tags to files" | +| `queue_nozzle_tag` | "Allow managing nozzle tags for queue items" | +| `queue_material_tag` | "Allow managing material tags for queue items" | +| `queue_assign_custom_tags` | "Allow assigning custom tags to queue items" | +| `can_export` | "Allow exporting data (CSV export)" | +| `autoprint_manage` | "Allow managing AutoPrint settings" | +| `courses_manage` | "Allow managing courses" | +| `courses_view` | "Allow viewing courses" | +| `webhooks_manage` | "Allow managing webhooks" | +| `set_user_teacher` | "Allow setting a user as a teacher ("School" plan only)" | +| `change_user_school_class` | "Allow changing user's school class ("School" plan only)" | +| `org_school_settings_manage` | "Allow managing school settings for the organization ("School" plan only)" | +| `access_all_printers` | "Allow access to all printers in the organization" | +| `custom_fields_manage` | "Allow creating and deleting custom fields" | + +## OAuth2 scopes + +These scopes are used to control access to the API. The scopes are tied to the OAuth2 access token. + +| Scope | Description | +|----------------------|-------------------------------------------| +| `user.read` | View user details | +| `printers.read` | View printer details | +| `printers.write` | Manage details of printers | +| `printers.actions` | Perform actions on printers | +| `spools.read` | View filament spools | +| `spools.write` | Manage filament spools | +| `files.read` | View file and folder details and contents | +| `files.write` | Manage files and folders | +| `files.temp_upload` | Upload temporary files | +| `queue.read` | View print queue | +| `queue.write` | Manage print queue | +| `statistics.read` | View printing statistics | +| `print_history.read` | View print history | +| `slicer.read` | View slicer profiles | +| `slicer.write` | Manage slicer profiles | +| `tags.read` | View tags | +| `tags.write` | Manage tags | diff --git a/source/includes/_printer_groups.md b/source/includes/_printer_groups.md new file mode 100644 index 00000000000..65d0afbf4c1 --- /dev/null +++ b/source/includes/_printer_groups.md @@ -0,0 +1,207 @@ +# Printer Groups + +## Get groups + +```shell +curl https://api.simplyprint.io/{id}/groups/Get \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "groups": [ + { + "id": 1, + "name": "Group 1" + }, + { + "id": 2, + "name": "Group 2" + } + ] +} +``` + +`GET /{id}/groups/Get` + +### Response + +| Parameter | Type | Description | +|-----------------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `groups` | array | Array of printer groups. | +| `groups[].id` | integer | Unique identifier for the group. | +| `groups[].name` | string | Name of the group. | + +## Create group + +```shell +curl https://api.simplyprint.io/{id}/groups/Create \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "name": "New Group Name" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "id": 123 +} +``` + +`POST /{id}/groups/Create` + +| Required permissions | +|----------------------| +| `printer_edit` | + +### Request Body + +| Parameter | Type | Description | +|-----------|--------|----------------------------| +| `name` | string | The name of the new group. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `id` | integer | Unique identifier for the new group. | + +## Update group + +```shell +curl https://api.simplyprint.io/{id}/groups/Update?group=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "name": "Updated Group Name" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/groups/Update` + +| Required permissions | +|----------------------| +| `printer_edit` | + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|--------------------------------| +| `group` | integer | The ID of the group to update. | + +### Request Body + +| Parameter | Type | Description | +|-----------|--------|-----------------------------| +| `name` | string | The new name for the group. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Delete group + +```shell +curl https://api.simplyprint.io/{id}/groups/Delete?group=123 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/groups/Delete` + +| Required permissions | +|----------------------| +| `printer_edit` | + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|--------------------------------| +| `group` | integer | The ID of the group to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Arrange groups + +```shell +curl https://api.simplyprint.io/{id}/groups/Arrange?pid=1234&group=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "from": 1, + "to": 2 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/groups/Arrange` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|-----------------------------------| +| `pid` | integer | The ID of the printer to arrange. | +| `group` | integer | The ID of the group to move to. | + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------| +| `from` | integer | The current position of the printer. | +| `to` | integer | The new position of the printer. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | diff --git a/source/includes/_printers.md b/source/includes/_printers.md new file mode 100644 index 00000000000..c2594901aa6 --- /dev/null +++ b/source/includes/_printers.md @@ -0,0 +1,1039 @@ +# Printers + +## Get printer info + +```shell +curl https://api.simplyprint.io/{id}/printers/Get \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "page": 1, + "page_size": 10, + "search": "Printer 1" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "page_amount": 1, + "data": [ + { + "id": 385, + "sort_order": 6, + "printer": { + "name": "Mini Printer 1", + "state": "printing", + "group": 99, + "position": 6, + "api": "OctoPrint", + "ui": "OctoPrint", + "ip": "10.78.16.46", + "public": 1, + "machine": "Raspberry Pi 4 Model B Rev 1.2", + "online": true, + "region": "eu-west-2", + "firmware": "Virtual Marlin", + "spVersion": "4.0.5", + "temps": { + "ambient": 22, + "current": { + "tool": [ + 210 + ], + "bed": null + }, + "target": { + "tool": [ + 210 + ], + "bed": null + } + }, + "hasPSU": 1, + "psuOn": true, + "hasFilSensor": true, + "filSensor": true, + "filamentRetraction": 250, + "model": { + "id": 91, + "name": "Fabrikator Mini", + "brand": "Turnigy", + "bedSize": [ + 80, + 80 + ], + "bedType": "square", + "maxHeight": 80, + "image": "https:\/\/cdn.simplyprint.io\/i\/printer_types\/turnigy\/fabrikator_mini\/silhouette_sm.png?cacheid=5fe9e77f49198", + "hasHeatedBed": false, + "extruders": 1, + "extruderSettings": null, + "maxToolTemp": 240, + "maxBedTemp": 0, + "filamentWidth": 1.75, + "nozzleDia": 0.4, + "axes": { + "e": { + "inverted": false, + "speed": 5 + }, + "x": { + "inverted": false, + "speed": 100 + }, + "y": { + "inverted": false, + "speed": 100 + }, + "z": { + "inverted": false, + "speed": 3.5 + } + }, + "screwOffset": 35, + "filamentRetraction": 250, + "customBoundingBox": false, + "extrudeAbs": 0, + "originCenter": 0, + "bedBelt": 0, + "fwRetract": 0, + "extrusionType": 1, + "noControl": 0 + }, + "hasCam": 1, + "hasQueue": { + "items": 6, + "fits": true + }, + "health": { + "usage": 24, + "temp": 61, + "memory": 19 + }, + "unsupported": 0, + "latency": null, + "outOfOrder": 0 + }, + "filament": null, + "job": { + "id": 552252, + "uid": "da69d2a4-e07e-48ff-128a-f88fab1b8f20", + "state": "printing", + "file": "Benchy.15mm_PLA_MK3S_7h40m.gcode", + "percentage": 50, + "time": 12627, + "canPreview": true, + "layer": null + }, + "tags": { + "nozzle": 0.6, + "material": [ + { + "ext": 0, + "type": 123, + "color": "Green", + "hex": "#4CAF50" + } + ], + "custom": [ + 1, + 2, + 3 + ] + } + }, + ... + ] +} +``` + +This endpoint returns a list of printers based on the given parameters. + +### Request + +`POST /{id}/printers/Get` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-------------------------------------------------------------------| +| `pid` | integer | no | Optional printer ID if you want to get info for a single printer. | + +#### Request body + +| Parameter | Type | Required | Description | +|-------------|---------|----------|-----------------------------------------------------------------| +| `page` | integer | no | Page number to get. Leave empty for page 1. | +| `page_size` | integer | no | Number of printers per page. (Between 1 and 100)
Default: 10 | +| `search` | string | no | Search string to filter printers by. | + +### Response + +Note that `data` will be an object if `pid` is specified, otherwise it will be an array. + +| Parameter | Type | Description | +|-------------------------------------|-----------------|----------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | object or array | Printer object(s). | +| `data.*.id` | integer | Printer ID. | +| `data.*.sort_order` | integer | The printer's sort index. | +| `data.*.printer` | object | Printer object. | +| `data.*.printer.name` | string | Printer's name. | +| `data.*.printer.state` | string | Printer's state. | +| `data.*.printer.group` | integer | Printer's group ID. | +| `data.*.printer.position` | integer | Printer's position in the group. | +| `data.*.printer.api` | string | Printer's API type. | +| `data.*.printer.ui` | string | Printer's UI type. | +| `data.*.printer.ip` | string | Printer's local IP address. | +| `data.*.printer.public` | boolean | Whether the printer is shown on the company hub. | +| `data.*.printer.machine` | string | Printer's machine type. | +| `data.*.printer.online` | boolean | Whether the printer is online. | +| `data.*.printer.region` | string | What region the printer is online in. | +| `data.*.printer.firmware` | string | Printer's firmware version. | +| `data.*.printer.spVersion` | string | Printer's SimplyPrint version. | +| `data.*.printer.temps` | object | Printer's current temperatures. | +| `data.*.printer.hasPSU` | boolean | Whether the printer has a SimplyPrint connected PSU. | +| `data.*.printer.psuOn` | boolean | Whether the printer's PSU is on. | +| `data.*.printer.hasFilSensor` | boolean | Whether the printer has a filament sensor. | +| `data.*.printer.filamentRetraction` | integer | Printer's filament retraction distance. | +| `data.*.printer.model` | string | Printer's model. | +| `data.*.printer.hasCam` | boolean | Whether the printer has a camera. | +| `data.*.printer.hasQueue` | object | Data about the printer's queue. Null if the printer doesn't have a queue. | +| `data.*.printer.hasQueue.items` | integer | Number of items in the printer's queue. | +| `data.*.printer.hasQueue.fits` | boolean | Whether the printer can physically fit any items in its queue. | +| `data.*.printer.health` | object | Printer's health data. (CPU usage, temperature, memory usage) | +| `data.*.printer.unsupported` | boolean | Whether the printer is unsupported. | +| `data.*.printer.latency` | integer | Printer's latency. | +| `data.*.printer.outOfOrder` | boolean | Whether the printer is out of order. | +| `data.*.filament` | object | Printer's filament data. | +| `data.*.job` | object | Printer's current job data. See [Get Print Jobs](#get-print-jobs) for more info. | +| `data.*.tags` | object/null | Tags for printer; custom tags, static material data & nozzle size | + +## Start print / create job + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/CreateJob?pid=1234&filesystem=291 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "pid": [ + 1234, + 1235 + ], + "filesystem": "196a1dd0b93a66c19192a39fa4c16e71" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "files": [ + { + "name": "Benchy.gcode", + "analysis": { + "slicer": "Simplify3D", + "filament": [ + 60 + ], + "estimate": 240, + "movement": { + "mRelative": 0, + "eRelative": 0 + }, + "temps": { + "tool": { + "T0": 210 + }, + "bed": 50, + "pset": 1 + }, + "modelSize": { + "x": 151, + "y": 16, + "z": 5 + }, + "printArea": { + "maxX": 156.05, + "minX": 5, + "maxY": 157.86, + "minY": 142.14, + "maxZ": 5, + "minZ": 0.2 + }, + "minDeltaRadius": 313.91, + "v": 5 + }, + "printers": [ + 1234, + 1235 + ], + "queued": false, + "cost": [ + { + "estimate": false, + "total_cost": 1006.76, + "lines": [ + { + "id": 1, + "label": "HIPS Material usage", + "cost": 0.05 + }, + { + "id": 2, + "label": "Material markup", + "cost": 0.03 + }, + { + "id": 3, + "label": "Machine run time cost", + "cost": 6.67 + }, + { + "id": 4, + "label": "Energy cost", + "cost": 0.01 + }, + { + "id": 5, + "label": "Labor cost", + "cost": 1000 + } + ] + } + ] + } + ], + "jobIds": [ + 495462, + 495463 + ] +} +``` + + + +This endpoint can be used to create a print job for one or more printers. The printers have to be in the `operational` +state. + +### Request + +`POST /{id}/printers/actions/CreateJob` + +To start a print job you must either specify a `filesystem` ID, a `queue_file` ID file, a `file_id` or set +`next_queue_item` to true. + +| Parameter | Type | Required | Description | +|-------------------|----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer or integer[] | yes | The ID(s) of the printer to create the job for. | +| `filesystem` | string | no | The filesystem ID of the file to print. | +| `queue_file` | integer | no | The queue ID of the queue item to print. | +| `multi_queue` | object | no | A map of queue item ID to an array of printer IDs. For example `{638: [12645, 12646]}`. | +| `next_queue_item` | boolean | no | If true, the next queue item will be printed.
**This requires the Print Farm plan** | +| `file_id` | string | no | File ID from [API Files](#api-files) - used to start a file without adding it as a queue item or user file. | +| `mms_map` | object | no | A map of printer ids to a map of the extruder specified in the gcode, and the printer extruder index. | +| `custom_fields` | array | no | An array with custom fields to assign to the print job. Each custom field consists of `{customFieldId: string, value: }` where the `` is a [Custom Field Submission Value](#custom-field-submission-value). | + +#### Extra settings for `next_queue_item` + +You can specify these parameters if `next_queue_item` is `true`. Note that you can specify more/all of the below +parameters. + +| Parameter | Type | Required | Description | +|-------------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| +| `analysis_strict` | boolean | no | Match the next item that has a valid gcode analysis.
**Defaults to true** | +| `fit_strict` | boolean | no | Match the next item if it fits on the printers print area.
**Defaults to true** | +| `temps_strict` | boolean | no | Match the next item where the printer can reach the temperatures specified in the gcode.
**Defaults to true** | +| `filament_strict` | boolean | no | Match the next item that was sliced for the same filament type that the printer is assigned to in SimplyPrint.
**Defaults to false** | +| `filament_temps_strict` | boolean | no | Match the next item that has the same filament temperatures as the printer has in SimplyPrint.
**Defaults to false** | + +### Response + +| Field | Type | Description | +|--------------------|-----------|---------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `files` | array | Array of started print job objects. | +| `files[].name` | string | The name of the file. | +| `files[].analysis` | object | The analysis of the file. This has been documented in the [Get queue items endpoint](#get-queue-items). | +| `files[].printers` | integer[] | The IDs of the printers that the print job was started on. | +| `files[].queued` | boolean | Whether the print job was from print queue. | +| `files[].cost` | object[] | nullable | Potential calculated cost of job. Potential of multiple costs if job is created for different printers with different material types assigned. | +| `jobIds` | integer[] | The IDs of the print jobs that were started. | + +## Pause print job + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/Pause?pid=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint can be used to pause one or multiple print jobs. The printers have to be in the `PRINTING` state. + +### Request + +`POST /{id}/printers/actions/Pause` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|----------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer or integer[] | yes | The ID(s) of the printer to pause. Pause multiple printers by comma separating printer ids.
**Printer must be in `PRINTING` state** | + +#### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Resume print job + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/Resume?pid=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +`POST /{id}/printers/actions/Resume` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|----------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer or integer[] | yes | The ID(s) of the printer to resume. Resume multiple printers by comma separating printer ids.
**Printer must be in `PRINTER_PAUSED` state** | + +#### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Cancel print job + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/Cancel?pid=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "reason": 3, + "comment": "Cancel comment" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permission | Description | +|------------------------|---------------------------------------------------------------------------------------------| +| `cancel_others_prints` | Need permission to cancel other users' prints if the print job was started by another user. | + +This endpoint can be used to cancel one or multiple print jobs. The printers have to be in the `PRINTING`, `PAUSED` or +`PAUSING` state. + +### Request + +`POST /{id}/printers/actions/Cancel` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|----------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer or integer[] | yes | The ID(s) of the printer to cancel. Cancel multiple printers by comma separating printer ids.
**Printer must be in `PRINTING`, `PAUSED` or `PAUSING` state** | + +#### Request body + +| Field | Type | Required | Description | +|-----------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `reason` | integer | no | The reason for cancelling the print job. See [Cancel reasons](#cancel-reasons). Depending on the `require_cancel_reason` organization setting, this field may be required. | +| `comment` | string | no | A comment for the cancel reason. Depending on the `require_comment` organization setting, this field may be required.
**Max length: 500 characters** | + +### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Clear print bed + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/ClearBed?pid=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "success": true, + "rating": 4 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint can be used to clear the print bed of a printer. + +### Request + +`POST /{id}/printers/actions/ClearBed` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer | yes | The ID(s) of the printer to clear, comma separated. These printers have to be in either the `operational` or `offline` states. | + +#### Request body + +| Field | Type | Required | Description | +|-----------|---------|----------|--------------------------------------------------------------------------------------| +| `success` | boolean | no | True if the print was successful.
**Default: false** | +| `rating` | integer | no | The rating of the print. Don't send this field if you do not want to rate the print. | + +### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Send raw gcode + +```shell +curl https://api.simplyprint.io/{id}/printers/actions/SendGcode?pid=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -H 'Content-Type: application/json' \ + -d '{ + "gcode": ["G28 XY"] + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `send_raw_gcode` | + +`POST /{id}/printers/actions/SendGcode` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|-----------|---------------------------------------------------| +| `pid` | integer[] | The ID(s) of the printer(s) to send the gcode to. | + +#### Request body + +| Parameter | Type | Required | Description | +|-----------|----------|----------|-------------------------------------------------| +| `gcode` | string[] | yes | Array of gcode commands to send to the printer. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Delete / disconnect printer + +```shell +curl https://api.simplyprint.io/{id}/printers/Delete?pid=1234&just_connection=1 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | +|----------------------| +| `printer_edit` | + +This endpoint can be used to delete a printer from the database, or to disconnect a pi from a printer. This is useful if +you want to change the printer that is connected to a pi. + +### Request + +`GET /{id}/printers/Delete` + +| Parameter | Type | Required | Description | +|-------------------|---------|----------|----------------------------------------------------------------------------------------------------------------------------| +| `pid` | integer | yes | The ID of the printer to delete. | +| `just_connection` | integer | no | If set to 1, only the Pi connection will be deleted. Otherwise, the printer will be permanently deleted.
**Default: 0** | + +### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## List 1-Click printers + + + +| Required permission | +|---------------------| +| `print_queue` | + +```shell +curl https://api.simplyprint.io/{id}/printers/OneClickPrint?pIds=1234,1235 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "bedsMustBeCleared": true, + "autoAddAvailable": true, + "settings": { + ... + }, + "canEditSettings": true, + "hasQueue": true, + "custom_fields": [ + ... + ], + "queue": [ + ... + ] +} +``` + +`GET /{id}/printers/OneClickPrint?pid=1234,1235` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|-----------|----------|------------------------------------------| +| `pid` | integer[] | yes | Printers you want to retrieve data about | + +### Response + +| Parameter | Type | Description | +|---------------------|---------|-------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `bedsMustBeCleared` | boolean | `true` if beds must be cleared before printing. | +| `autoAddAvailable` | boolean | `true` if auto-discover printers is available. | +| `settings` | object | Queue auto-start settings. | +| `canEditSettings` | boolean | `true` if the user can edit settings. | +| `hasQueue` | boolean | `true` if the company has a print queue. | +| `custom_fields` | array | Array of custom fields for the print queue. | +| `queue` | array | Array of next items in the print queue. | + +## AutoPrint enable / disable + + + +| Required permission | +|---------------------| +| `autoprint_manage` | + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/SetEnabled \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "on": true + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/printers/autoprint/SetEnabled` + +#### Request body + +| Parameter | Type | Required | Description | +|-----------|---------|----------|--------------------------------------------------------------| +| `on` | boolean | yes | Set to `true` to enable autoprint, or `false` to disable it. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## AutoPrint check state + + + +| Required permission | +|---------------------| +| `autoprint_manage` | + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/CheckState \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "printers": [ + { + ... + } + ] +} +``` + +`GET /{id}/printers/autoprint/CheckState` + +### Response + +| Parameter | Type | Description | +|----------------------------------------------|-------------|------------------------------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `printers` | array | Array of printers along with their AutoPrint status. | +| `printers[].printer` | integer | The printer id. | +| `printers[].ready` | boolean | Whether the printer is ready. | +| `printers[].issues` | array | An array of issues with the printer. | +| `printers[].state` | object | The state of the printer. | +| `printers[].state.awaitingBedCool` | boolean | True if the printer is awaiting the bed to cool down. | +| `printers[].state.awaitingSecondsPass` | boolean | True if the printer is awaiting a specified number of seconds to pass. | +| `printers[].state.awaitingManualClear` | boolean | True if the printer is awaiting manual clearance. | +| `printers[].state.maxCyclesReached` | boolean | True if the printer has reached the maximum number of print cycles. | +| `printers[].state.waitingForSystem` | boolean | True if the printer is waiting for the system. | +| `printers[].state.awaitingMatchingQueueItem` | boolean | True if the printer is awaiting a matching queue item. | +| `printers[].nextItem` | object/null | The next queue item formatted for the printer. | + +## AutoPrint get settings + + + +| Required permission | +|---------------------| +| `autoprint_manage` | + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/GetAutoPrintSettings \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "gcode": "...", + "printer_settings": { + ... + }, + "printer_has_settings": true, + "account_settings": { + ... + }, + "account_has_settings": true, + "queue_match_settings": { + ... + }, + "can_macro": true +} +``` + +`GET /{id}/printers/autoprint/GetAutoPrintSettings` + +### Response + +| Parameter | Type | Description | +|------------------------|---------|------------------------------------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `gcode` | string | G-code for clearing the auto print settings. | +| `printer_settings` | object | The auto print settings for the printer. | +| `printer_has_settings` | boolean | `true` if the printer has auto print settings. | +| `account_settings` | object | The auto print settings for the account. | +| `account_has_settings` | boolean | `true` if the account has auto print settings. | +| `queue_match_settings` | object | The queue match criteria settings for the account. | +| `can_macro` | boolean | `true` if the user has permission to manage G-code profiles for the company. | + +## AutoPrint save settings + + + +| Required permission | +|---------------------| +| `autoprint_manage` | + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/SaveAutoPrintSettings \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -H 'Content-Type: application/json' \ + -d '{ + "useDefault": true, + "saveAsDefault": false, + "bedReleaseTemp": 60, + "autoReleaseTime": 3600, + "maxPrints": 100, + "ackNoGcode": true, + "method": "loop" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/printers/autoprint/SaveAutoPrintSettings` + +### Request Body + +| Parameter | Type | Description | +|-------------------|---------|-------------------------------------------------------------------------------------------| +| `useDefault` | boolean | `true` to use company defaults, `false` to use custom settings. | +| `saveAsDefault` | boolean | `true` to save the settings as company defaults. | +| `bedReleaseTemp` | integer | Temperature at which the bed releases the print. | +| `autoReleaseTime` | integer | Time in seconds after which the print is automatically released. | +| `maxPrints` | integer | Maximum number of prints before requiring manual intervention. | +| `ackNoGcode` | boolean | `true` to acknowledge no G-code is required. | +| `method` | string | Method to use for auto print settings. One of `loop`, `jobox`, `3dque`, `belt`, `pushoff` | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## AutoPrint get gcode templates + +| Required permission | +|---------------------| +| `autoprint_manage` | + + + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/GetGcodeTemplates \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "methods": [ + { + "name": "loop", + "gcode": "..." + }, + { + "name": "jobox", + "gcode": "..." + }, + { + "name": "3dque", + "gcode": "..." + }, + { + "name": "belt", + "gcode": "..." + }, + { + "name": "pushoff", + "gcode": "..." + } + ] +} +``` + +`GET /{id}/printers/autoprint/GetGcodeTemplates` + +### Response + +| Parameter | Type | Description | +|-------------------|---------|--------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `methods` | array | Array of G-code templates for different methods. | +| `methods[].name` | string | Name of the method. | +| `methods[].gcode` | string | G-code template for the method. | + +## AutoPrint set cleared beds amount + + + +| Required permission | +|---------------------| +| `autoprint_manage` | + +```shell +curl https://api.simplyprint.io/{id}/printers/autoprint/SetClearedBedsAmount \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -H 'Content-Type: application/json' \ + -d '{ + "amount": 10 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/printers/autoprint/SetClearedBedsAmount` + +### Request Body + +| Parameter | Type | Description | +|-----------|-----------|-------------------------------------------------------------------------------------| +| `pid` | integer[] | The ID(s) of the printer(s) to set the cleared beds amount for. | +| `amount` | integer | The number of cleared beds to set for the printer(s). Must be between 0 and 100000. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Cancel reasons + +| ID | Description | +|----|------------------------------------| +| 1 | Print failed | +| 2 | Regretted print | +| 3 | No filament extruded / nozzle clog | +| 4 | Fell of the plate | +| 5 | Not enough filament | +| 6 | Other | diff --git a/source/includes/_queue.md b/source/includes/_queue.md new file mode 100644 index 00000000000..54dbd64bfc2 --- /dev/null +++ b/source/includes/_queue.md @@ -0,0 +1,964 @@ +# Queue + +## Add item to queue + +```shell +curl https://api.simplyprint.io/{id}/queue/AddItem \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "filesystem": "1a077dd6296417fe75555bf806b68089", + "amount": 5, + "group": 0 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "created_id": 1337 +} +``` + + + + + +This endpoint adds a file to the queue. The file can either be a file on the filesystem or an uploaded +stl/3mf/obj/gcode/gco/nc/npg file. + +**Note:** if you want to specify which printer/printer type/printer model the print job should be assigned, you +can [edit the print job](#update-queue-item) after it has been added to the queue. + +### Request + +`POST /{id}/queue/AddItem` + +| Parameter | Type | Required | Description | +|-----------------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `filesystem` | string | no | The [filesystem](#files) id of the file to add to the queue. | +| `amount` | integer | no | The amount of prints to add to the queue.
**Default: 1** | +| `group` | integer | no | If you have Queue Groups - ID of the group the item should be added to.
**Default: 0 - required if you have Queue Groups** | +| `fileId` | string | no | Optional File ID from [API File](#api-files) - use this to add a file uploaded via the API. | +| `tags` | object | no | Tags to assign. Only send [nozzle](#assign-nozzle-size-tag) body, [material](#assign-material-tag) body or [custom](#assign-custom-tag) body, without `type`, `id` or `edited` | +| `for_printers` | array | no | An array of printer ids to assign the queue item to. | +| `for_models` | array | no | An array of printer model ids to assign the queue item to. | +| `for_groups` | array | no | An array of group ids to assign the queue item to. | +| `custom_fields` | array | no | An array with custom fields to assign to the queue item. Each custom field consists of `{customFieldId: string, value: }` where the `` is a [Custom Field Submission Value](#custom-field-submission-value). | + +### Response + +| Parameter | Type | Description | +|--------------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `created_id` | integer | The id of the created queue item | + +## Get next queue item + +```shell +curl https://api.simplyprint.io/{id}/queue/GetNextItems?p=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "settings": { + "filament": false, + "filamentTemps": false, + "fit": true, + "gcodeAnalysis": false, + "printerTemps": false + } +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "queue": { + "total": 15, + "printers": [ + 385 + ], + "matches": [ + { + "id": 1212, + "index": 5, + "printer": 385, + "match": true, + "issues": [ + "size", + "temps" + ], + "missed": 0, + "name": "Benchy.gcode", + "printed": 2, + "left": 1, + "customFields": [ + { + "id": "student_id", + "value": { + "string": "1234567890" + } + } + ] + } + ] + } +} +``` + +> Failed response (Could not find any items that match the specified conditions) + +```json +{ + "status": true, + "message": null, + "queue": { + "total": 15, + "printers": [ + 385 + ], + "matches": [ + { + "printer": 385, + "match": false, + "issues": [ + "size", + "temps" + ], + "missed": 4 + } + ] + } +} +``` + + + +This endpoint gets the next item in the queue for the specified printer. The next item is the item that has the highest +priority. The result will have skipped all items that do not meet the specified conditions. + +### Request + +`POST /{id}/queue/GetNextItems` + +#### Request parameters + +| Parameter | Type | Required | Description | +|-----------|-----------|----------|----------------------------------------------------------------| +| p | integer[] | yes | Comma separated list of printer ids to get the next items for. | + +#### Request body + +| Parameter | Type | Required | Description | +|--------------------------|---------|----------|--------------------------------------------------------------------------------------------------------------| +| `settings` | object | no | Conditions that must be met for the next item. | +| `settings.filament` | boolean | no | Must have enough filament.
**Default: true** | +| `settings.filamentTemps` | boolean | no | Printer's filament temperature must match filament temperature of file.
**Default: true** | +| `settings.fit` | boolean | no | Print must fit printer's bed.
**Default: true** | +| `settings.gcodeAnalysis` | boolean | no | Must have gcode analysis.
**Default: true** | +| `settings.printerTemps` | boolean | no | File must have a max temperature that is lower than the printer's max temperature.
**Default: true** | +| `settings.tags` | boolean | no | Printer must match possible queue item tags (nozzle size, material data & custom tags).
**Default: true** | + +### Response + +| Parameter | Type | Description | +|---------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `queue` | object | The queue object. | +| `queue.total` | integer | The total amount of items in the queue. | +| `queue.printers` | integer[] | The printer ids that were requested. | +| `queue.matches` | array | The next items for each printer. | +| `queue.matches[].id` | integer | The id of the next item. Only present if `match` is true. | +| `queue.matches[].index` | integer | The index of the item in the queue. Only present if `match` is true. | +| `queue.matches[].printer` | integer | The id of the printer that the item is for. | +| `queue.matches[].match` | boolean | True if a match was found. | +| `queue.matches[].issues` | string[] | The issues that are present in the item. Can also have values if an item was matched but would have been catched by other settings. | +| `queue.matches[].missed` | integer | The amount of items that were skipped. | +| `queue.matches[].name` | string | The name of the item. Only present if `match` is true. | +| `queue.matches[].printed` | integer | The amount of completed prints of this item (from print queue). Only present if `match` is true. | +| `queue.matches[].left` | integer | The amount of prints left (from print queue). Only present if `match` is true. | + +## Get queue item + +```shell +curl https://api.simplyprint.io/{id}/queue/GetItem?id=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "queue": { + "id": 51293, + "index": 1, + "filename": "benchy.gcode", + "note": null, + "model": false, + "printable": true, + "type": "printable", + "zipPrintable": false, + "zipNoModel": false, + "left": 1, + "printed": 0, + "filesystem_id": "c00489ef361771ac098b5a60e6740757", + "group": 123, + "for": { + "printers": [ + 1234 + ], + "models": [ + 1234 + ], + "groups": [ + 1234 + ] + }, + "analysis": { + "slicer": "Simplify3D", + "filament": [ + 60 + ], + "estimate": 240, + "movement": { + "mRelative": 0, + "eRelative": 0 + }, + "temps": { + "tool": { + "T0": 210 + }, + "bed": 50, + "pset": 1 + }, + "modelSize": { + "x": 151, + "y": 16, + "z": 5 + }, + "printArea": { + "maxX": 156.05, + "minX": 5, + "maxY": 157.86, + "minY": 142.14, + "maxZ": 5, + "minZ": 0.2 + }, + "minDeltaRadius": 313.91, + "v": 5 + }, + "tags": { + "nozzle": 0.6, + "material": [ + { + "ext": 0, + "type": 123, + "color": "Green", + "hex": "#4CAF50" + } + ], + "custom": [ + 1, + 2, + 3 + ] + } + } +} +``` + + + +| Required permissions | +|----------------------| +| `print_queue` | + +This endpoint returns the queue item with the specified id. + +### Request + +`GET /{id}/queue/GetItem + +| Parameter | Type | Required | Description | +|-----------|---------|----------|---------------------------------------| +| `id` | integer | yes | The queue item id to get details for. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `item` | object | The queue item object. | + +## Get queue items + +```shell +curl https://api.simplyprint.io/{id}/queue/GetItems?p=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "queue": { + "fits": true, + "items": [ + { + "id": 51293, + "index": 1, + "filename": "benchy.gcode", + "note": null, + "model": false, + "printable": true, + "left": 1, + "printed": 0, + "filesystem_id": "c00489ef361771ac098b5a60e6740757", + "group": 123, + "for": { + "printers": [ + 1234 + ], + "models": [ + 1234 + ], + "groups": [ + 1234 + ] + }, + "analysis": { + "slicer": "Simplify3D", + "filament": [ + 60 + ], + "estimate": 240, + "movement": { + "mRelative": 0, + "eRelative": 0 + }, + "temps": { + "tool": { + "T0": 210 + }, + "bed": 50, + "pset": 1 + }, + "modelSize": { + "x": 151, + "y": 16, + "z": 5 + }, + "printArea": { + "maxX": 156.05, + "minX": 5, + "maxY": 157.86, + "minY": 142.14, + "maxZ": 5, + "minZ": 0.2 + }, + "minDeltaRadius": 313.91, + "v": 5 + }, + "user": "John Doe", + "user_id": 1234, + "tags": { + "nozzle": 0.6, + "material": [ + { + "ext": 0, + "type": 123, + "color": "Green", + "hex": "#4CAF50" + } + ], + "custom": [ + 1, + 2, + 3 + ] + }, + "customFields": [ + { + "id": "student_id", + "value": { + "string": "1234567890" + } + } + ] + } + ] + }, + "groups": [ + { + "id": 123, + "name": "Group 1", + "virtual": false, + "extensions": [ + "gcode", + "gco", + "stl" + ], + "sort_order": 0 + }, + ... + ] +} +``` + + + +| Required permissions | +|----------------------| +| `print_queue` | + +This endpoint returns the queue for the specified or all printers. + +### Request + +`GET /{id}/queue/GetItems` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-----------------------------------------------------------------------------------------------------| +| `p` | integer | no | The printer id to get the queue for. If not specified, the queue for all printers will be returned. | +| `groups` | boolean | no | Attaches a list of print queue groups to the response. Note: this argument does not take a value. | + +### Response + +| Parameter | Type | Description | +|-----------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `queue` | object | The queue object. | +| `queue.fits` | boolean | Whether any items in the queue can be printed on the printer. (due to space, temperature) | +| `queue.items` | array | An array of queue item objects. | +| `queue.items[].id` | integer | The queue item id. | +| `queue.items[].index` | integer | The queue item index. | +| `queue.items[].filename` | string | The queue item filename. | +| `queue.items[].note` | string/null | Optional note text. | +| `queue.items[].model` | boolean | True if the queue item is a model. | +| `queue.items[].printable` | boolean | True if the queue is printable. | +| `queue.items[].left` | integer | The amount of prints left to print. | +| `queue.items[].printed` | integer | The amount of prints that have been printed. | +| `queue.items[].filesystem_id` | string/null | File id if print is from SimplyPrint filesystem. | +| `queue.items[].group` | integer | Possible ID of Queue Group. | +| `queue.items[].for` | object | For which printers, models and groups this queue item is for. | +| `queue.items[].for.printers` | array | An array of printer ids. | +| `queue.items[].for.models` | array | An array of printer model ids. | +| `queue.items[].for.groups` | array | An array of group ids. | +| `queue.items[].analysis` | object | The analysis object. | +| `queue.items[].analysis.slicer` | string | The slicer used to slice the file. | +| `queue.items[].analysis.filament` | array | An array of filament lengths. | +| `queue.items[].analysis.estimate` | integer | The estimated print time in seconds. | +| `queue.items[].analysis.movement` | object | The movement object. | +| `queue.items[].analysis.temps` | object | The temperatures object. | +| `queue.items[].analysis.temps.tool` | object | Temperature for each tool (extruder). | +| `queue.items[].analysis.temps.bed` | integer | Temperature for the bed. | +| `queue.items[].analysis.modelSize` | object | The model size object. Represented as `x`, `y` and `z` values in millimeters. | +| `queue.items[].analysis.printArea` | object | The print area object. Represented as `maxX`, `minX`, `maxY`, `minY`, `maxZ` and `minZ` values in millimeters. | +| `queue.items[].analysis.minDeltaRadius` | float | Minimum radius for delta printers. | +| `queue.items[].analysis.v` | integer | The analysis version. | +| `queue.items[].user` | string | The user name of who added the queue item. | +| `queue.items[].user_id` | integer | The user id of who added the queue item. | +| `queue.items[].tags` | object/null | Tags for queue item; custom tags, static material data & nozzle size | +| `queue.done_items` | array | If `groups` GET is set, an array of done queue items, or ones where the last remaining item is being printed **includes all the same fields as queue items, with a few extra;**. | +| `queue.done_items[]....` | | *Fields inherited from regular queue items*. | +| `queue.done_items[].size` | integer | Byte-size used by this item - 0 if the file is from the filesystem. | +| `queue.done_items[].ongoing` | boolean | If the item is currently ongoing. | +| `queue.done_items[].done` | UTC date/null | UTC date that the item was finished. | +| `queue.done_items[].expires` | UTC date/null | UTC date that the item expires and is removed from the platform. | +| `groups` | array | If `groups` GET is set, an array of print queue groups. | +| `groups[].id` | integer | The group id. | +| `groups[].name` | string | The group name. | +| `groups[].virtual` | boolean | Whether the group is a virtual queue group. | +| `groups[].extensions` | array/null | An array of file extensions that are allowed in the group. | +| `groups[].sort_order` | integer | The sort index of the group. | + +## Update queue item + +```shell +curl https://api.simplyprint.io/{id}/queue/UpdateItem?job=1234 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "for_groups": [ + 1234 + ], + "for_models": [ + 1234 + ], + "for_printers": [ + 1234 + ] +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `print_queue` | + +This endpoint updates the queue item with the specified id. + +### Request + +`POST /{id}/queue/UpdateItem` + +#### Query parameters + +| Parameter | Type | Required | Description | +|-----------|---------|----------|------------------------------| +| `job` | integer | yes | The queue item id to update. | + +#### Request body + +| Parameter | Type | Required | Description | +|----------------|---------|----------|------------------------------------------------------------| +| `for_groups` | array | no | An array of group ids to assign the queue item to. | +| `for_models` | array | no | An array of printer model ids to assign the queue item to. | +| `for_printers` | array | no | An array of printer ids to assign the queue item to. | +| `amount` | integer | no | The new amount to set. | +| `amount` | integer | no | Set amount of "printed". | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Delete queue item + +```shell +curl https://api.simplyprint.io/{id}/queue/DeleteItem?job=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `print_queue` | + +This endpoint deletes the queue item with the specified id. + +### Request + +`? /{id}/queue/DeleteItem` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|------------------------------| +| `job` | integer | yes | The queue item id to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Change queue order + +```shell +curl https://api.simplyprint.io/{id}/queue/SetOrder?job=1234&from=0&to=1 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "success": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `print_queue` | +| `reorder_queue` | +| `queue_see_others` | + +This endpoint changes the order of the queue items by moving the queue item with the specified id. + +### Request + +`GET /{id}/queue/SetOrder` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-----------------------------------------| +| `job` | integer | yes | The queue item id to move. | +| `from` | integer | yes | The current position of the queue item. | +| `to` | integer | yes | The new position of the queue item. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------------------------| +| `success` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `success` is false. | + +## Empty queue + +```shell +curl https://api.simplyprint.io/{id}/queue/EmptyQueue \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required Permissions | +|--------------------------| +| `print_queue` | +| `print_queue_remove_all` | + +This endpoint empties the queue. + +### Request + +`GET /{id}/queue/EmptyQueue` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|---------------------------------------------------------------------------------| +| `group` | integer | no | ID of Queue Group to empty.
**Default: 0 - required if you have Queue Groups | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Revive item + + + +| Required permissions | +|---------------------------| +| `print_queue` | +| `queue_revive_done_items` | + +```shell +curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/queue/ReviveItem` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|------------------------------| +| `job` | integer | The ID of the job to revive. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Get groups + + + +| Required permissions | +|----------------------| +| `print_queue` | + +```shell +curl https://api.simplyprint.io/{id}/queue/groups/Get \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "list": [ + { + "id": 1, + "name": "Queue Group 1", + "virtual": false, + "extensions": [ + "gcode", + "bgcode" + ], + "sort_order": 1 + } + ] +} +``` + +`GET /{id}/queue/groups/Get` + +### Response + +| Parameter | Type | Description | +|---------------------|---------|----------------------------------------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `list` | array | Array of print queue groups. | +| `list[].id` | integer | Unique identifier for the group. | +| `list[].name` | string | Name of the group. | +| `list[].virtual` | boolean | Whether the group is a virtual queue group. | +| `list[].extensions` | array | An array of file extensions that are allowed in the group. (without punctuation) | +| `list[].sort_order` | integer | The sort order of the group. | +| `list[].for` | object | For which printers, models and groups this queue item is for. | + +## Save group + + + +| Required permissions | +|----------------------| +| `print_queue` | +| `queue_groups` | + +```shell +curl https://api.simplyprint.io/{id}/queue/groups/Save \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "id": 123, + "name": "New Queue Group", + "accepted_extensions": ["gcode", "bgcode"], + "virtual_only": false, + "for_printers": "1,2,3", + "for_models": "4,5,6", + "for_groups": "7,8,9" + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/queue/groups/Save` + +### Request Body + +| Parameter | Type | Description | +|-----------------------|---------|--------------------------------------------------------------------| +| `id` | integer | The ID of the group to update (optional for creating a new group). | +| `name` | string | The name of the queue group. | +| `accepted_extensions` | array | List of accepted file extensions. | +| `virtual_only` | boolean | Whether the group is virtual only. | +| `for_printers` | string | Comma-separated list of printer IDs. | +| `for_models` | string | Comma-separated list of printer model IDs. | +| `for_groups` | string | Comma-separated list of printer group IDs. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Delete group + + + +| Required permissions | +|----------------------| +| `print_queue` | +| `queue_groups` | + +```shell +curl https://api.simplyprint.io/{id}/queue/groups/Delete?id=123 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/queue/groups/Delete` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|--------------------------------| +| `id` | integer | The ID of the group to delete. | + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------------------| +| `move_to` | integer | The ID of the group to move items to. Defaults to any other group. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Set group order + + + +| Required permissions | +|----------------------| +| `queue_groups` | +| `reorder_queue` | + +```shell +curl https://api.simplyprint.io/{id}/queue/groups/SetOrder?queue_group=123 \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "from": 1, + "to": 2 + }' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /{id}/queue/groups/SetOrder` + +### Request Parameters + +| Parameter | Type | Description | +|---------------|---------|----------------------------| +| `queue_group` | integer | The ID of the queue group. | + +### Request Body + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `to` | integer | The new sorting order of the group. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | diff --git a/source/includes/_schools.md b/source/includes/_schools.md new file mode 100644 index 00000000000..4dec8b8ed8e --- /dev/null +++ b/source/includes/_schools.md @@ -0,0 +1,143 @@ +# Schools + +## List classes + + + +`GET /{id}/account/settings/school/classes/GetClasses` + +> Example request + +```shell +curl https://api.simplyprint.io/{id}/account/settings/school/classes/GetClasses \ +-H 'accept: application/json' \ +-H 'X-API-KEY: {API_KEY}' +``` + +> Example response + +```json +{ + "status": true, + "message": null, + "objects": { + "classes": [ + { + "id": 1, + "name": "Class A", + "endMonthDay": "06-30", + "fullStartDate": "2024-09-01", + "fullEndDate": "2025-06-30", + "nextClass": 2, + "deleteUserAfterClassEnd": false, + "autoNextClass": true, + "googleClassroomLink": "https://classroom.google.com/c/...", + "ssoGroupId": "group_id", + "lastSsoSync": "2024-09-01T12:00:00Z", + "updatedAt": "2024-09-07T08:30:00Z", + "createdAt": "2024-08-30T08:30:00Z", + "sortPosition": 1 + } + ], + "settings": { + "defaultClass": 1, + "maxClasses": 5, + "userCanAddClasses": true + } + } +} +``` + +### Response + +| Parameter | Type | Description | +|---------------------------------------------|---------|---------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `objects` | object | The main object containing the response data. | +| `objects.classes` | array | An array of classes. | +| `objects.classes[].id` | integer | The unique ID of the class. | +| `objects.classes[].name` | string | The name of the class. | +| `objects.classes[].endMonthDay` | string | The end month and day of the class (MM-DD format). | +| `objects.classes[].fullStartDate` | string | The full start date of the class (YYYY-MM-DD format). | +| `objects.classes[].fullEndDate` | string | The full end date of the class (YYYY-MM-DD format). | +| `objects.classes[].nextClass` | integer | The ID of the next class, if any. | +| `objects.classes[].deleteUserAfterClassEnd` | boolean | Whether to delete the user after the class ends. | +| `objects.classes[].autoNextClass` | boolean | Whether to automatically enroll in the next class. | +| `objects.classes[].googleClassroomLink` | string | The Google Classroom link associated with the class. | +| `objects.classes[].ssoGroupId` | string | The SSO group ID associated with the class. | +| `objects.classes[].lastSsoSync` | string | The timestamp of the last SSO sync, or null if never synced. | +| `objects.classes[].updatedAt` | string | The timestamp of the last update (UTC). | +| `objects.classes[].createdAt` | string | The timestamp of when the class was created (UTC). | +| `objects.classes[].sortPosition` | integer | The sort position of the class. | +| `objects.settings` | object | The settings related to school classes. | +| `objects.settings.defaultClass` | integer | The ID of the default class. | +| `objects.settings.maxClasses` | integer | The maximum number of classes per user, or null if unlimited. | +| `objects.settings.userCanAddClasses` | boolean | Whether the user has permission to add new classes. | + +## Create or update a class + + + +| Required permissions | +|------------------------------| +| `org_school_settings_manage` | + +`POST /{id}/account/settings/school/classes/SaveClass` + +> Example Request + +```json +{ + "id": 1, + "name": "Physics 101", + "endMonthDay": "12-31", + "fullStartDate": "2024-01-01", + "fullEndDate": "2024-12-31", + "autoNextClass": true, + "nextClass": 2, + "deleteUserAfterClassEnd": false, + "googleClassroomLink": "https://classroom.google.com/c/abc123", + "ssoGroupId": "group1" +} +``` + +### Request Parameters + +| Parameter | Type | Required | Description | +|---------------------------|---------|----------|----------------------------------------------------------------------------------------------------------------------| +| `id` | integer | No | The unique ID of the class. If provided, the endpoint updates the existing class; otherwise, a new class is created. | +| `name` | string | Yes | The name of the class (maximum length: 16 characters). | +| `endMonthDay` | string | No | The end month and day of the class in `MM-DD` format. | +| `fullStartDate` | string | No | The full start date of the class in `YYYY-MM-DD` format. | +| `fullEndDate` | string | No | The full end date of the class in `YYYY-MM-DD` format. | +| `autoNextClass` | boolean | No | Indicates if users should be automatically enrolled in the next class. | +| `nextClass` | integer | No | The ID of the next class, if `autoNextClass` is `true`. | +| `deleteUserAfterClassEnd` | boolean | No | Indicates if the user should be deleted after the class ends. | +| `googleClassroomLink` | string | No | The URL to the Google Classroom link associated with the class. Must be a valid HTTPS URL. | +| `ssoGroupId` | string | No | The SSO group ID associated with the class. | + +### Response + +| Parameter | Type | Description | +|-----------------------------------------|---------|-------------------------------------------------------------------------------------| +| `objects` | object | The main object containing the response data. | +| `objects.class` | object | The saved class object. | +| `objects.class.id` | integer | The unique ID of the class. | +| `objects.class.name` | string | The name of the class. | +| `objects.class.endMonthDay` | string | The end month and day of the class (MM-DD format). | +| `objects.class.fullStartDate` | string | The full start date of the class (YYYY-MM-DD format). | +| `objects.class.fullEndDate` | string | The full end date of the class (YYYY-MM-DD format). | +| `objects.class.autoNextClass` | boolean | Indicates if users are automatically enrolled in the next class. | +| `objects.class.nextClass` | integer | The ID of the next class, if applicable. | +| `objects.class.deleteUserAfterClassEnd` | boolean | Indicates if users should be deleted after the class ends. | +| `objects.class.googleClassroomLink` | string | The Google Classroom link associated with the class. | +| `objects.class.ssoGroupId` | string | The SSO group ID associated with the class. | +| `objects.class.lastSsoSync` | string | The date and time of the last SSO synchronization in UTC format, or `null` if none. | +| `objects.class.updatedAt` | string | The date and time when the class was last updated in UTC format, or `null` if none. | +| `objects.class.createdAt` | string | The date and time when the class was created in UTC format, or `null` if none. | +| `objects.class.sortPosition` | integer | The sort position of the class. | diff --git a/source/includes/_slicer.md b/source/includes/_slicer.md new file mode 100644 index 00000000000..7b5ad27d678 --- /dev/null +++ b/source/includes/_slicer.md @@ -0,0 +1,196 @@ +# Slicer + +## List Slicer Profiles + +```shell +curl https://api.simplyprint.io/{id}/slicer/ListProfiles \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "profiles": [ + { + "id": 785, + "name": "Prusa profile", + "for_printers": null, + "org": true + } + ] +} +``` + +This endpoint returns a list overview of slicer profiles that the user has access to. Includes personal and company +profiles. + +### Request + +`GET /{id}/slicer/ListProfiles` + +### Response + +| Field | Type | Description | +|---------------------------|---------|--------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `profiles` | array | An array of profile objects. | +| `profiles.*.id` | integer | The ID of the profile. | +| `profiles.*.name` | string | The name of the profile. | +| `profiles.*.for_printers` | array | The printers ids that this profile is made for. | +| `profiles.*.org` | boolean | True if this profile is owned by the company, and not by the user. | + +## Get Slicer Profile + +```shell +curl https://api.simplyprint.io/{id}/slicer/Get?id=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "profile": { + "id": 785, + "name": "Prusa profile", + "settings": { + "sliceHeight": 0.2, + "sliceFillSparse": 30, + "sliceShells": 2, + "sliceShellOrder": "in-out", + "sliceTopLayers": 3, + "sliceSolidLayers": 2, + "sliceBottomLayers": 2, + "outputFillMult": 1.1, + "sliceFillAngle": 45, + "outputShellMult": 1, + "outputCoastDist": 0, + "sliceSolidMinArea": 5, + "sliceMinHeight": 0, + "sliceLayerStart": "center", + "sliceFillType": "hex", + "sliceFillRate": 130, + "outputSparseMult": 1.1, + "sliceFillOverlap": 35, + "firstSliceHeight": 0.2, + "firstLayerLineMult": 100, + "firstLayerFillRate": 35, + "firstLayerRate": 10, + "firstLayerPrintMult": 1, + "firstLayerFanSpeed": 0, + "sliceSupportOutline": 1, + "sliceSupportAngle": 1, + "sliceSupportDensity": 25, + "sliceSupportSize": 6, + "sliceSupportOffset": 0.4, + "sliceSupportGap": 0, + "sliceSupportSpan": 5, + "sliceSupportArea": 0.25, + "sliceSupportExtra": 0, + "outputBrimCount": 0, + "outputBrimOffset": 2, + "outputRaftSpacing": 0.3, + "outputSeekrate": 150, + "outputFanLayer": 2, + "fanSpeed": 100, + "outputRetractDist": 1, + "outputRetractSpeed": 100, + "outputRetractDwell": 0, + "outputRetractWipe": 2, + "outputShortPoly": 50, + "zHopDistance": 0, + "antiBacklash": 0, + "gcodePause": 0, + "newLayerGcode": "", + "firstLayerBeltLead": 0, + "firstLayerBeltBump": 0, + "firstLayerFlatten": 0, + "firstLayerBrimIn": 0, + "sliceSupportEnable": 0, + "outputRaft": 0, + "outputLayerRetract": 0 + }, + "for_printers": null, + "org": true + } +} +``` + +This endpoint can be used to get a slicer profile by its ID. This includes the settings of the profile. + +### Request + +`GET /{id}/printers/Delete` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|---------------------------------| +| `id` | integer | yes | The id of the profile to fetch. | + +### Response + +| Field | Type | Description | +|------------------------|---------|--------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `profile` | object | The profile object. | +| `profile.id` | integer | The ID of the profile. | +| `profile.name` | string | The name of the profile. | +| `profile.settings` | object | The settings of the profile. | +| `profile.for_printers` | array | The printers ids that this profile is made for. | +| `profile.org` | boolean | True if this profile is owned by the company, and not by the user. | + +## Save or Create Slicer Profile + +```shell +curl https://api.simplyprint.io/{id}/slicer/SaveProfile?id=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +TODO + +## Delete Slicer Profile + +```shell +curl https://api.simplyprint.io/{id}/slicer/DeleteProfile?id=1234 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permissions | Description | +|-----------------------|-----------------------------------------| +| `slicer_org_profiles` | If the profile is owned by the company. | + +This endpoint can be used to delete a slicer profile by its ID. + +### Request + +`GET /{id}/printers/Delete` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|----------------------------------| +| `id` | integer | yes | The id of the profile to delete. | + +### Response + +| Field | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | diff --git a/source/includes/_tags.md b/source/includes/_tags.md new file mode 100644 index 00000000000..484a2287225 --- /dev/null +++ b/source/includes/_tags.md @@ -0,0 +1,456 @@ +# Tags + +## Create or Update Custom Tag + +```shell +curl -X POST https://api.simplyprint.io/{id}/tags/Create \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "name": "My Custom Tag", + "badge": "success" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "id": 2, + "tags": [ + { + "id": 1, + "name": "A tag", + "badge": "primary", + "used_by": { + "printers": 1, + "printer_groups": 0, + "files": 2, + "queue_items": 4 + } + }, + { + "id": 2, + "name": "My Custom Tag", + "badge": "success" + } + ] +} +``` + + + +| Required permissions | +|----------------------| +| `edit_tags` | + +This endpoint creates or updates a custom tag. + +### Request + +`POST /{id}/tags/Create` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-------------------------------------------------------------------------------------------------| +| `id` | integer | no | ID of the tag to update. Leave empty to create a new tag. | +| `name` | string | yes | Name of the tag. | +| `badge` | string | yes | Color of the tag. Please refer to the [Colors](#colors) section for a list of available colors. | + +### Response + +| Parameter | Type | Description | +|---------------------------------|---------|----------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `id` | integer | ID of the created or updated tag. | +| `tags` | array | Array of all tags. | +| `tags.*.id` | integer | ID of the tag. | +| `tags.*.name` | string | Name of the tag. | +| `tags.*.badge` | string | [Color](#colors) of the tag. | +| `tags.*.used_by` | object | Only present if the tag is used on any printers, printer groups, files or queue items. | +| `tags.*.used_by.printers` | integer | Number of printers the tag is used on. | +| `tags.*.used_by.printer_groups` | integer | Number of printer groups the tag is used on. | +| `tags.*.used_by.files` | integer | Number of files the tag is used on. | +| `tags.*.used_by.queue_items` | integer | Number of queue items the tag is used on. | + +## Get Custom Tag(s) + +> Get a single tag + +```shell +curl https://api.simplyprint.io/{id}/tags/Get?id=2 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "tag": { + "id": 2, + "name": "My Custom Tag", + "badge": "success" + } +} +``` + +> Get all tags + +```shell +curl https://api.simplyprint.io/{id}/tags/Get \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "tags": [ + { + "id": 1, + "name": "A tag", + "badge": "primary", + "used_by": { + "printers": 1, + "printer_groups": 0, + "files": 2, + "queue_items": 4 + } + }, + { + "id": 2, + "name": "My Custom Tag", + "badge": "success" + } + ] +} +``` + + + +This endpoint gets a single tag or all tags. + +### Request + +`GET /{id}/tags/Get` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|----------------------------------------------------| +| `id` | integer | no | ID of the tag to get. Leave empty to get all tags. | + +### Response + +| Parameter | Type | Description | +|---------------|---------|----------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `tag` | object | Only present if `id` is set. | +| `tag.id` | integer | ID of the tag. | +| `tag.name` | string | Name of the tag. | +| `tag.badge` | string | [Color](#colors) of the tag. | +| `tag.used_by` | object | Only present if the tag is used on any printers, printer groups, files or queue items. | +| `tags` | array | Only present if `id` is not set. Array of all tags. | +| `tags.*` | object | Tag data like in the `tag` object above. | + +## Delete Custom Tag + +```shell +curl https://api.simplyprint.io/{id}/tags/Delete?id=2 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "tags": [ + { + "id": 1, + "name": "A tag", + "badge": "primary", + "used_by": { + "printers": 1, + "printer_groups": 0, + "files": 2, + "queue_items": 4 + } + } + ] +} +``` + + + +| Required permissions | +|----------------------| +| `edit_tags` | + +This endpoint deletes a custom tag. + +### Request + +`GET /{id}/tags/Delete` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|--------------------------| +| `id` | integer | yes | ID of the tag to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | +| `tags` | array | Array of all tags. | + +## Assign Nozzle Size Tag + +```shell +curl -X POST https://api.simplyprint.io/{id}/tags/Assign \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Request body + +```json +{ + "type": 1, + "id": 2315, + "edited": "nozzle", + "nozzle": 0.4 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint assigns a nozzle size tag to a printer, printer group, file or queue item. + +Please note that to assign a tag to a printer, you need the `EDIT_PRINTER` permission. + +### Request + +`POST /{id}/tags/Assign` + +| Parameter | Type | Required | Description | +|-----------|----------------|----------|------------------------------------------------------------------------------------------------------| +| `type` | integer | yes | What to assign the tag to. `1` for printer, `2` for printer group, `3` for file, `4` for queue item. | +| `id` | integer/string | yes | ID of the printer, printer group, file or queue item to assign the tag to. | +| `edited` | string | yes | Set to `nozzle` to assign a nozzle size tag. | +| `nozzle` | float | yes | Nozzle size to assign in millimeters. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Assign Material Tag + +```shell +curl -X POST https://api.simplyprint.io/{id}/tags/Assign \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Request body + +```json +{ + "type": 1, + "id": 2315, + "edited": "material", + "material": [ + { + "ext": 0, + "type": 412, + "hex": "#ff0000", + "color": "Red" + } + ] +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +This endpoint assigns a material tag to a printer, printer group, file or queue item. + +Please note that to assign a tag to a printer, you need the `EDIT_PRINTER` permission. + +### Request + +`POST /{id}/tags/Assign` + +| Parameter | Type | Required | Description | +|--------------------|----------------|----------|------------------------------------------------------------------------------------------------------| +| `type` | integer | yes | What to assign the tag to. `1` for printer, `2` for printer group, `3` for file, `4` for queue item. | +| `id` | integer/string | yes | ID of the printer, printer group, file or queue item to assign the tag to. | +| `edited` | string | yes | Set to `material` to assign a material tag. | +| `material` | array | yes | Array of materials to assign. | +| `material.*.ext` | integer | yes | Material extruder to assign the tag to. (zero-indexed) | +| `material.*.type` | integer | yes | Material type id to assign. | +| `material.*.hex` | string | yes | Material color hex code. | +| `material.*.color` | string | yes | Material color name. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Assign Custom Tag + +```shell +curl -X POST https://api.simplyprint.io/{id}/tags/Assign \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Request body + +```json +{ + "type": 1, + "id": 2315, + "edited": "custom", + "tag_id": 1 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +This endpoint assigns a custom tag to a printer, printer group, file or queue item. + +Please note that to assign a tag to a printer, you need the `EDIT_PRINTER` permission. + +### Request + +`POST /{id}/tags/Assign` + +| Parameter | Type | Required | Description | +|-----------|----------------|----------|------------------------------------------------------------------------------------------------------| +| `type` | integer | yes | What to assign the tag to. `1` for printer, `2` for printer group, `3` for file, `4` for queue item. | +| `id` | integer/string | yes | ID of the printer, printer group, file or queue item to assign the tag to. | +| `edited` | string | yes | Set to `custom` to assign a custom tag. | +| `tag_id` | integer | yes | ID of the custom tag to assign. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Detach Custom Tag + +```shell +curl -X POST https://api.simplyprint.io/{id}/tags/Detach \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Request body + +```json +{ + "type": 1, + "id": 2315, + "tag_id": 1 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +This endpoint detaches a custom tag from a printer, printer group, file or queue item. + +Please note that to detach a tag from a printer, you need the `EDIT_PRINTER` permission. + +### Request + +`POST /{id}/tags/Detach` + +| Parameter | Type | Required | Description | +|-----------|----------------|----------|--------------------------------------------------------------------------------------------------------| +| `type` | integer | yes | What to detach the tag from. `1` for printer, `2` for printer group, `3` for file, `4` for queue item. | +| `id` | integer/string | yes | ID of the printer, printer group, file or queue item to detach the tag from. | +| `tag_id` | integer | yes | ID of the custom tag to detach. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|--------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Success message or error message if `status` is false. | + +## Colors + +| Color | Name | Preview | +|------------|-------------|--------------------------------------------------------------------------------------------------| +| Blue | `primary` | Primary | +| Purple | `secondary` | Secondary | +| Green | `success` | Success | +| Red | `danger` | Danger | +| Yellow | `warning` | Warning | +| Turquoise | `info` | Info | +| Light grey | `light` | Light | +| Dark | `dark` | Dark | diff --git a/source/includes/_users.md b/source/includes/_users.md new file mode 100644 index 00000000000..45cb97924cc --- /dev/null +++ b/source/includes/_users.md @@ -0,0 +1,401 @@ +# User Management + +## Get Company Users + +```shell +curl https://api.simplyprint.io/{id}/users/GetPaginatedUsers \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "page": 1, + "page_size": 10, + "approved": true, + "search": "John Doe", + "sort_id": 1, + "sort_dir": "asc" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 1234, + "relation_id": 4321, + "name": "John Doe", + "email_confirmed": true, + "email": "johndoe@example.com", + "phone": "", + "relation_created_at": "2022-07-28 23:30:14", + "last_online": "2023-03-02 15:44:44", + "approved_at": "2022-07-29 11:14:52", + "org_account": false, + "total_prints": 68, + "rank": 185, + "teacher": false, + "classes": [ + 1234, + 5678 + ] + } + ], + "page_amount": 1 +} +``` + + + +| Required permissions | +|----------------------| +| `view_users` | + +### Request + +`POST /{id}/users/GetPaginatedUsers` + +| Parameter | Type | Required | Description | +|-------------|---------|----------|-----------------------------------------------------------------------------------------------------------------------| +| `page` | integer | yes | The page number to retrieve. | +| `page_size` | integer | yes | The number of users to retrieve per page. | +| `approved` | boolean | no | If true, only approved users will be returned. If false, only pending users will be returned.
**Defaults to true** | +| `search` | string | no | A search string to filter the users by. Searches for name, email and phone number. | +| `sort_id` | string | no | Which field to sort by. Options: `name`, `contact`, `rank`, `lastOnline`, `added`, `totalPrints`. | +| `sort_dir` | string | no | The sort direction. Either `asc` or `desc`. | + +### Response + +| Parameter | Type | Description | +|------------------------------|---------|---------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `page_amount` | integer | The total number of pages. | +| `data` | array | An array of users. | +| `data[].id` | integer | The id of the user. | +| `data[].relation_id` | integer | The id of the user-company relation. | +| `data[].name` | string | The name of the user. | +| `data[].email_confirmed` | boolean | True if the user has confirmed their email address. | +| `data[].email` | string | The email address of the user. | +| `data[].phone` | string | The phone number of the user. | +| `data[].relation_created_at` | string | The date and time the user joined the company. | +| `data[].sso` | boolean | True if the user was created via SSO. | +| **Approved users only** | | | +| `data[].last_online` | string | The date and time the user was last online. | +| `data[].approved_at` | string | The date and time the user was approved. | +| `data[].org_account` | boolean | True if the user is an organization account. | +| `data[].total_prints` | integer | The total number of prints the user has made on this company. | +| `data[].rank` | integer | The id of the rank of the user. | +| **Schools only** | | | +| `data[].teacher` | boolean | True if the user is a teacher. | +| `data[].classes` | array | An array of class IDs the user is a member of. | + +## Create Invitation Link + +```shell +curl https://api.simplyprint.io/{id}/users/CreateInvitationLink \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "maxUses": 10 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "link": "https://simplyprint.io/accept_invitation/b3d9b5a0-5b5b-11e9-8d7c-2d3b9e84aafd" +} +``` + + + +| Required permissions | +|----------------------| +| `invite_users` | + +This endpoint creates an invitation link that can be used to invite new users to the company. +Please note that links with unlimited uses expire at the end of the day. + +### Request + +`POST /{id}/users/CreateInvitationLink` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|---------------------------------------------------------------------------------| +| `maxUses` | integer | no | The maximum number of times the link can be used. Specify 0 for unlimited uses. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `link` | string | The invitation link. | + +## Invite Users By Email + +```shell +curl https://api.simplyprint.io/{id}/users/InviteSpecificUser \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "emails": [ + "test@example.com", + "test2@example.com" + ], + "rank": 192, + "lang": "en" +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `invite_users` | + +This endpoint invites one or more users to the company by email. + +### Request + +`POST /{id}/users/InviteSpecificUser` + +| Parameter | Type | Required | Description | +|-----------|----------|----------|------------------------------------------------| +| `emails` | string[] | yes | The emails of the users to invite. | +| `rank` | integer | no | The rank id that the users should be assigned. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Accept or Deny Pending User + +```shell +curl https://api.simplyprint.io/{id}/users/SetPendingUserState \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "relation_id": 1234, + "approve": true, + "notify": true +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `invite_users` | + +### Request + +`POST /{id}/users/SetPendingUserState` + +| Parameter | Type | Required | Description | +|---------------|---------|----------|-----------------------------------------------------------------------------------------------| +| `relation_id` | integer | yes | The id of the pending user-company relation. | +| `approve` | boolean | yes | True to approve the user, false to deny. | +| `notify` | boolean | yes | True to notify the user of the decision. Will send an email if the user has an email address. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Change User Rank + +```shell +curl https://api.simplyprint.io/{id}/users/ChangeUserRank \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "relation_id": 1234, + "rank_id": 192 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +`POST /{id}/users/ChangeUserRank` + +| Parameter | Type | Required | Description | +|---------------|---------|----------|-------------------------------------------| +| `relation_id` | integer | yes | The id of the user-company relation. | +| `rank_id` | integer | yes | The id of the rank to assign to the user. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Delete User + +```shell +curl https://api.simplyprint.io/{id}/users/DeleteUser \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "user_id": 1234 +} +``` + +> Success response + +```json +{ + "status": true, + "message": null +} +``` + + + +| Required permissions | +|----------------------| +| `delete_user` | + +This endpoint deletes a user from the company. Use this endpoint with caution. + +### Request + +`POST /{id}/users/DeleteUser` + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-------------------------------| +| `user_id` | integer | yes | The id of the user to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Set Teacher + + + +`POST /{id}/users/SetIsTeacher` + +> Example request + +```shell +curl -X POST \ +https://api.simplyprint.io/{id}/users/SetIsTeacher \ +-H 'accept: application/json' \ +-H 'Content-Type: application/json' \ +-H 'X-API-KEY: {API_KEY}' \ +-d '{"relation_id": 123, "is_teacher": true}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|---------------|---------|----------|-------------------------------------------------------------------| +| `relation_id` | integer | yes | The ID of the company-user relation to update. | +| `is_teacher` | boolean | yes | Set to `true` to mark the user as a teacher or `false` otherwise. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | diff --git a/source/includes/_webhooks.md b/source/includes/_webhooks.md new file mode 100644 index 00000000000..bd38aec6f89 --- /dev/null +++ b/source/includes/_webhooks.md @@ -0,0 +1,291 @@ +# Webhooks + + + +Webhooks allow you to build or set up integrations that subscribe to certain events on SimplyPrint. +When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. + +## List webhooks + + + +| Required permissions | +|----------------------| +| `webhooks_manage` | + +`GET /{id}/webhooks/Get` + +> Example request + +```shell +curl "https://api.simplyprint.io/%7Bid%7D/webhooks/Get" \ + -H 'accept: application/json' \ + -H "X-API-KEY: {API_KEY}" +``` + +> Example response + +```json +{ + "status": true, + "message": null, + "data": [ + { + "id": 11, + "created_by": { + "id": 12640, + "first_name": "John", + "last_name": "Doe", + "avatar": "https://example.com/avatar.jpg" + }, + "name": "Example Webhook", + "url": "https:\/\/actions.nasa.gov\/print_events", + "events": [ + "job.started", + "job.paused", + "job.resumed", + "job.cancelled", + "job.done", + "job.failed", + "job.bed_cleared" + ], + "secret": null, + "enabled": true, + "oauth_client_id": null, + "created_at": "2024-09-07T18:16:51+00:00", + "updated_at": "2024-09-07T18:16:51+00:00" + } + ] +} +``` + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `data` | array | Array of webhooks. | + +## Create or update a webhook + + + +| Required permissions | +|----------------------| +| `webhooks_manage` | + +`POST /{id}/webhooks/Create` + +> Example request + +```shell +curl -X POST \ +https://api.simplyprint.io/{id}/webhooks/Create \ +-H 'accept: application/json' \ +-H 'Content-Type: application/json' \ +-H 'X-API-KEY: {API_KEY}' \ +-d '{ "name": "Order Created", "description": "Triggers when an order is created", "url": "https://example.com/webhook", "secret": "mysecret", "enabled": true, "events": ["order.created", "order.updated"] }' +``` + +> Example response + +```json +{ + "status": true, + "message": null, + "webhook": { + "id": 123, + "name": "Order Created", + "description": "Triggers when an order is created", + "url": "https://example.com/webhook", + "secret": "mysecret", + "enabled": true, + "events": [ + "order.created", + "order.updated" + ], + "created_by": "User Name", + "company": "Company Name" + } +} +``` + +### Request + +| Parameter | Type | Required | Description | +|---------------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| +| `id` | integer | no | The ID of the webhook. Required if updating an existing webhook. | +| `name` | string | yes | The name of the webhook. | +| `description` | string | no | A description of the webhook. | +| `url` | string | yes | The URL where the webhook will send requests. Must be a valid URL. | +| `secret` | string | no | A secret key used to sign the webhook payloads. | +| `enabled` | boolean | no | Whether the webhook is enabled or not. Default is `false`. | +| `events` | array | yes | A list of events that the webhook will listen to. Must be at least one. Each event should match a valid [WebhookEvent](#webhook-event). | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-----------------------------------------------------------------------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `webhook` | object | Details of the created or updated webhook. Contains fields like `id`, `name`, `url`, `events`, etc. | + +## Delete a webhook + + + +| Required permissions | +|----------------------| +| `webhooks_manage` | + +`POST /{id}/webhooks/Delete` + +> Example request + +```shell +curl -X POST \ +https://api.simplyprint.io/{id}/webhooks/Delete \ +-H 'accept: application/json' \ +-H 'Content-Type: application/json' \ +-H 'X-API-KEY: {API_KEY}' \ +-d '{"id": 123}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------|---------|----------|----------------------------------| +| `id` | integer | yes | The ID of the webhook to delete. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Enable or disable a webhook + + + +| Required permissions | +|----------------------| +| `webhooks_manage` | + +`POST /{id}/webhooks/SetEnabled` + +> Example request + +```shell +curl -X POST \ +https://api.simplyprint.io/{id}/webhooks/SetEnabled \ +-H 'accept: application/json' \ +-H 'Content-Type: application/json' \ +-H 'X-API-KEY: {API_KEY}' \ +-d '{"id": 123, "enabled": true}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------|---------|----------|------------------------------------------------| +| `id` | integer | yes | The ID of the webhook to enable or disable. | +| `enabled` | boolean | yes | Set to `true` to enable or `false` to disable. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## Manually trigger webhook + + + +The event type will be `test`. + +`POST /{id}/webhooks/TriggerTestWebhook` + +> Example request + +```shell +curl -X POST \ +https://api.simplyprint.io/{id}/webhooks/TriggerTestWebhook \ +-H 'accept: application/json' \ +-H 'Content-Type: application/json' \ +-H 'X-API-KEY: {API_KEY}' \ +-d '{"id": 123}' +``` + +> Example response + +```json +{ + "status": true, + "message": null +} +``` + +### Request + +| Parameter | Type | Required | Description | +|-----------|---------|----------|-----------------------------------| +| `id` | integer | yes | The ID of the webhook to trigger. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|-------------------------------------| +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | + +## WebhookEvent + +| Event Name | Description | +|-----------------------------------|-------------------------------------------------------------| +| `job.started` | Triggered when a job is started. | +| `job.paused` | Triggered when a job is paused. | +| `job.resumed` | Triggered when a job is resumed. | +| `job.cancelled` | Triggered when a job is cancelled. | +| `job.done` | Triggered when a job is done. | +| `job.failed` | Triggered when a job has failed. | +| `job.bed_cleared` | Triggered when the bed is cleared. | +| `printer.autoprint_state_changed` | Triggered when the autoprint state of a printer is changed. | +| `printer.nozzle_size_changed` | Triggered when the nozzle size of a printer is changed. | +| `printer.material_changed` | Triggered when the material of a printer is changed. | +| `printer.custom_tag_assigned` | Triggered when a custom tag is assigned to a printer. | +| `printer.custom_tag_detached` | Triggered when a custom tag is detached from a printer. | +| `company.autoprint_state_changed` | Triggered when the autoprint state of a company is changed. | + diff --git a/source/includes/gcode_macros.md b/source/includes/gcode_macros.md new file mode 100644 index 00000000000..d7cf81e0400 --- /dev/null +++ b/source/includes/gcode_macros.md @@ -0,0 +1,363 @@ +# GCode Macros + +## Get overview + +```shell +curl https://api.simplyprint.io/{id}/gcode_macros/GetOverview \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "gcodeCompletions": [ + { + "label": "G0", + "type": "variable", + "info": "Add a straight line movement to the planner", + "detail": "X, Y, Z, E, F, S" + } + ], + "macro_groups": [ + { + "name": "<\/i> AutoPrint (advanced)<\/i>", + "desc": "The AutoPrint feature can automatically start prints. Here you define what Gcode should be executed to make sure the bed is clear.", + "macros": [ + "is_autoprint_clear" + ], + "nopersonal": true + } + ], + "macros_cards": { + "is_start": { + "name": "Start print", + "description": "GCODE to be executed at start of print when using our slicer" + } + }, + "macros": { + "company": [ + { + "gcodes": { + "printer_225": [ + "{snippet:2731}" + ], + "printer_10063": null, + "printer_10372": [ + "{snippet:2796}" + ] + }, + "type": "is_start" + } + ], + "personal": null, + "sp": [ + { + "gcodes": { + "type_0": [ + "{snippet:26}" + ], + "type_236": [ + "{snippet:1103}", + "{snippet:26}" + ] + }, + "type": "is_pause" + } + ] + }, + "snippets": { + "company": [ + { + "id": 28, + "name": "Indentify Ender 5", + "description": "Identify printer specifically for Ender 5", + "priority": 0, + "created": "2020-04-22T09:19:37+00:00" + } + ] + }, + "variables": { + "bed_x": "Printer bed X length in mm", + "bed_y": "Printer bed Y length in mm" + }, + "slicerVariables": { + "temp": "Hot end temperature", + "bed_temp": "Bed temperature", + "fan_speed": "Active cooling fan speed (usually 0-255)" + } +} +``` + +`GET /{id}/gcode_macros/GetOverview` + +### Response + +See example response. + +## Get snippet + +```shell +curl https://api.simplyprint.io/{id}/gcode_macros/GetSnippet?id=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Success Response + +```json +{ + "status": true, + "message": null, + "snippet": { + "id": 123, + "name": "Example Snippet", + "description": "This is an example snippet", + "priority": 0, + "gcode": "G1 X10 Y10" + } +} +``` + +`GET /gcode_macros/GetSnippet` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|------------------------------------| +| `id` | integer | The ID of the snippet to retrieve. | + +### Response + +| Parameter | Type | Description | +|-----------------------|---------|----------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `snippet` | object | The details of the snippet. | +| `snippet.id` | integer | Unique identifier for the snippet. | +| `snippet.name` | string | Name of the snippet. | +| `snippet.description` | string | Description of the snippet. | +| `snippet.priority` | integer | Priority of the snippet. | +| `snippet.gcode` | string? | GCode content of the snippet (if any). | + +## Save snippet + +```shell +curl -X POST https://api.simplyprint.io/{id}/gcode_macros/SaveSnippet?id=123&type=private \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "name": "Updated Snippet", + "description": "This is an updated snippet.", + "gcode": ["G1 X10 Y10", "G1 X20 Y20"] + }' +``` + +> Success Response + +```json +{ + "status": true, + "message": null, + "new_data": { + // Updated data of the GCODE snippets + } +} +``` + +`POST /gcode_macros/SaveSnippet` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|------------------------------------------------------------------------| +| `id` | integer | The ID of the snippet to update (optional for creating a new snippet). | +| `type` | string | The type of the snippet (`org`, `private`, `public`). | + +### Request Body + +| Parameter | Type | Description | +|---------------|--------|------------------------------------| +| `name` | string | The name of the GCODE snippet. | +| `description` | string | The description of the snippet. | +| `gcode` | array | The GCODE commands of the snippet. | +| `gcode.*` | string | A single GCODE command. | + +### Response + +| Parameter | Type | Description | +|------------|---------|------------------------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `created` | integer | The ID of the newly created snippet (if applicable). | +| `new_data` | object | The updated data of the GCODE snippets. | + +## Delete snippet + +```shell +curl -X POST https://api.simplyprint.io/{id}/gcode_macros/DeleteSnippet?id=123 \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Success Response + +```json +{ + "status": true, + "message": null, + "new_data": { + // Updated data of the GCODE snippets + } +} +``` + +`POST /gcode_macros/DeleteSnippet` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------------------------------------------------------| +| `id` | integer | The ID of the snippet to delete (required if `ids` is not provided). | +| `ids` | string | Comma-separated list of IDs of snippets to delete (required if `id` is not provided). | + +### Response + +| Parameter | Type | Description | +|------------|---------|-----------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `new_data` | object | The updated data of the GCODE snippets. | + +## Get macro + +```shell +curl https://api.simplyprint.io/{id}/gcode_macros/GetMacroGcode?macro=is_start&printer=123&model=456&org=true&private=false&public=true \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ +``` + +> Success Response + +```json +{ + "status": true, + "message": null, + "gcode": [ + "G1 X10 Y10", + "G1 X20 Y20" + ], + "multiple": false +} +``` + +`GET /gcode_macros/GetMacroGcode` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|------------------------------------------------------------------------------| +| `macro` | string | The type of the macro. Must be one of the enums defined in `GcodeMacroType`. | +| `printer` | integer | The ID of the printer. | +| `model` | integer | The ID of the printer model. | +| `org` | boolean | Whether to include organization macros. | +| `private` | boolean | Whether to include private macros. | +| `public` | boolean | Whether to include public macros. | + +### Response + +| Parameter | Type | Description | +|------------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | +| `gcode` | array | The GCODE commands of the macro. | +| `multiple` | boolean | Whether multiple GCODEs are returned. | + +## Save macro + +```shell +curl -X POST https://api.simplyprint.io/gcode_macros/SaveMacro?type=private \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "type": "is_start", + "gcodes": {"printer_225": ["G1 X10 Y10"], "type_123": ["G1 X20 Y20", "{snippet:123}"]} + }' +``` + +> Success Response + +```json +{ + "status": true, + "message": null +} +``` + +| Required permission | Description | +|---------------------|-------------------------------------| +| `gcode_profiles` | Required if macro is of type `org`. | + +`POST /gcode_macros/SaveMacro` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|--------|-------------------------| +| `type` | string | One of `org`, `private` | + +### Request Body + +| Parameter | Type | Description | +|-----------------------|--------|-----------------------------------------------------------------------------------------| +| `type` | string | One of `is_start`, `is_end`, `is_cancel`, `is_pause`, `is_resume`, `is_autorpint_clear` | +| `gcodes` | object | Content of the macro. | +| `gcodes.printer_{id}` | array | GCODE commands for the printer with ID `{id}`. | +| `gcodes.type_{id}` | array | GCODE commands for the printer model with ID `{id}`. | +| `gcodes.*[]` | string | Can be a GCODE command or `{snippet:{id}}` to reference a snippet. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | + +## Arrange gcode order in macro + +```shell +curl -X POST https://api.simplyprint.io/gcode_macros/Arrange \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' \ + -d '{ + "order": [4,2,3,1] + }' +``` + +> Success Response + +```json +{ + "status": true, + "message": null +} +``` + +`POST /gcode_macros/Arrange` + +### Request Parameters + +| Parameter | Type | Description | +|-----------|---------|-----------------------------------------------| +| `order` | array | An array of snippet IDs in the desired order. | +| `order.*` | integer | A single snippet ID. | + +### Response + +| Parameter | Type | Description | +|-----------|---------|---------------------------------------| +| `status` | boolean | `true` if the request was successful. | +| `message` | string | Error message if `status` is `false`. | diff --git a/source/index.html.md b/source/index.html.md new file mode 100644 index 00000000000..94029e290b6 --- /dev/null +++ b/source/index.html.md @@ -0,0 +1,284 @@ +--- +title: SimplyPrint API Reference + +language_tabs: # must be one of https://git.io/vQNgJ + - shell: cURL + +toc_footers: + - SimplyPrint + - Need help? + +includes: + - printers + - filament + - jobs + - api_files + - queue + - printer_groups + - files + - account + - users + - schools + - slicer + - tags + - custom_fields + - webhooks + - gcode_macros + - courses + - partner + - permissions_scopes + - errors + +search: true + +code_clipboard: true + +meta: + - name: description + content: Documentation for the SimplyPrint API + - name: keywords + content: SimplyPrint API,SimplyPrint Documentation + - name: og:title + content: SimplyPrint API Reference + - name: og:description + content: Documentation for the SimplyPrint API + - name: og:image + content: https://cdn.simplyprint.io/i/static/logo/png/2x/icon_gradient.png + - name: og:url + content: https://apidocs.simplyprint.io + +--- + +# Getting Started + +Welcome to the **SimplyPrint API**! + +This documentation goes through authenticating and how to use the API. + +## The base URL + +The base URL for the SimplyPrint API is `https://api.simplyprint.io/{id}/`. + +To use the base API at , you will need to specify an id. + +The id represents the unique identifier for the company that you are using the API key for. This id is used to access the specific functionality within the API that is associated with the company. + +The endpoint represents the specific functionality that you want to access within the API. There are various endpoints available, each with its own specific purpose and functionality. + +For example, if you want to access the `account/Test` endpoint for a company with an id of 123, you would use the following API endpoint: + + + +If you are part of an organization, you might need to ask your organization administrator to allow API access for your account for the organization. + + + +## Gaining access to the API + +There are two ways to gain access to the SimplyPrint API: + +1. [Using an API key](#using-an-api-key-recommended) (recommended) + - This is the recommended method for most users. This method requires a SimplyPrint account and an API key. +2. [Using OAuth2](#using-oauth2) + - This method is only available for approved integrations. You can use OAuth2 to access SimplyPrint API endpoints on behalf of a user. + +## Using an API key (recommended) + +To get an API key you'll need a SimplyPrint account that is either a member of an organization, or have at least the [SimplyPrint Pro plan](https://simplyprint.io/pricing). + +To create your own API key you first need a SimplyPrint account, you can go to your [account settings](https://simplyprint.io/panel/user_settings/api) and create a new API key. + +### Using the API key + +```shell +curl {base_url}/account/Test \ + --header 'X-API-KEY: {API_KEY}' +``` + +> Success return: + +```json +{ + "status": true, + "message": "Your API key is valid!" +} +``` + +> Error return in case of an invalid or missing API key: + +```json +{ + "status": false, + "message": "No API key provided, or not logged in" +} +``` + +> Error return in case of missing permissions for the organization: + +```json +{ + "status": false, + "message": "You don't have access to this account" +} +``` + +To verify that your API key is valid and that you have access to the desired organization, you can make a request to the `/account/Test` endpoint. + +To make any request to the SimplyPrint API, you will need to include your API key in the request header. You can do this by including the `X-API-KEY` header in your request. On the right side of this page, you can see an example of how to make a request to the `/account/Test` endpoint using cURL. + +If you are unable to successfully make a request to the `/account/Test` endpoint using the provided example, there may be a few possible issues: + +- Your API key may be invalid or missing. Make sure that you have a valid API key and that you are including it in the request header as shown in the example. +- You may not have access to the organization specified in the `id` parameter. Make sure that you are using the correct `id` for the organization that you have access to. +- There may be a problem with the base API URL or endpoint. Double check that you are using the correct base API URL and endpoint in your request. + +If you are unable to resolve the issue after troubleshooting these potential issues, you may need to contact your organization administrator for further assistance. Otherwise, feel free to contact us via our [helpdesk](https://help.simplyprint.io/). + +## Using OAuth2 + +SimplyPrint supports OAuth2 logins for all users, regardless of their subscription, for approved integrations such as the [Cura slicer integration](https://simplyprint.io/integrations/cura). + +The OAuth2 method can be used to link a user's SimplyPrint account with a third party platform/software, and use the SimplyPrint API on behalf of the user. + +To obtain OAuth2 access, you must be added as an OAuth2 provider by SimplyPrint. To request this, please fill out the [OAuth2 Client Request Form](https://forms.gle/rC9AzWwNtwMmWXE68). + +Once you have been added as an OAuth2 provider, you can use the following documentation to implement OAuth2 in your application. + +### Authorizing your application + +For users to grant your application access to their SimplyPrint account, you must first redirect them to the SimplyPrint OAuth2 authorization page. You can do this by redirecting the user to the following URL: + +`https://simplyprint.io/panel/oauth2/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}` + +The following parameters can be supplied as query parameters in the URL: + +| Parameter | Type | Required | Description | +| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------- | +| `client_id` | string | yes | The client ID of your OAuth2 application | +| `redirect_uri` | string | yes | The redirect URI of your OAuth2 application | +| `scope` | string | yes | The [scope](#oauth2-scopes) of the OAuth2 access token. This can be a `+`-separated list of scopes. | +| `response_type` | string | yes | This must be set to `code` | +| `state` | string | no | The value of this parameter will be returned to your application when the user is redirected back | + +Once the user has granted access to your application, they will be redirected to `{redirect_uri}?code={code}&state={state}`. The `code` parameter is the authorization code that you will use to obtain an access token. The `state` parameter will only be returned if you specified a `state` parameter in the authorization URL. + +### Obtaining an access token + +> Obtaining an access token + +```shell +curl https://api.simplyprint.io/oauth2/Token \ + -X POST \ + -H 'accept: application/json' \ + -H 'X-API-KEY: {API_KEY}' +``` + +> Request body + +```json +{ + "grant_type": "authorization_code", + "client_id": "{client_id}", + "client_secret": "{client_secret}", + "code": "{code}", + "redirect_uri": "{redirect_uri}" +} +``` + +> Success response + +```json +{ + "token_type": "Bearer", + "expires_in": 3600, + "access_token": "{access_token}", + "refresh_token": "{refresh_token}" +} +``` + +Now that you have a `code` parameter, you can use it to obtain an access token. To do this, you must make a `POST` request to the following URL: + +`https://api.simplyprint.io/oauth2/Token` + +This will return an access token that you can use to make requests to the SimplyPrint API on behalf of the user. + +This access token will expire after 1 hour. Once it expires, you can use the `refresh_token` parameter to obtain a new access token. To do this, you must make a `POST` request to the same URL as above, but with the following request parameters: + +| Parameter | Type | Description | +| --------------- | ------ | ---------------------------------------------------------------------- | +| `grant_type` | string | This must be set to `refresh_token` | +| `client_id` | string | The client ID of your application | +| `client_secret` | string | The client secret of your application | +| `refresh_token` | string | The refresh token that was returned when you obtained the access token | + +To refresh your access token, you can make a `POST` request to the same URL as above, but with the following request parameters: + +| Parameter | Type | Description | +| --------------- | ------ | ---------------------------------------------------------------------- | +| `grant_type` | string | This must be set to `refresh_token` | +| `client_id` | string | The client ID of your application | +| `client_secret` | string | The client secret of your application | +| `refresh_token` | string | The refresh token that was returned when you obtained the access token | + +This will return a new access token that you can use to make requests to the SimplyPrint API on behalf of the user. + +### Testing your access token + +> Testing your access token + +```shell +curl https://api.simplyprint.io/oauth2/TokenInfo \ + -H 'accept: application/json' \ + -H 'Authorization: Bearer {access_token}' +``` + +> Success response + +```json +{ + "status": true, + "message": null, + "user": { + "id": 112, + "name": "John Doe", + "email": "john@doe.com", + }, + "company": { + "id": 123, + "name": "My Company" + }, + "scopes": [ + ... + ], + "expires_at": 1706292803 +} +``` + +To test your access token, you can make a `GET` request to the following URL: + +`https://api.simplyprint.io/oauth2/TokenInfo` + +This endpoint returns the following information: + +| Parameter | Type | Description | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| `status` | boolean | True if the request was successful. | +| `message` | string | Error message if `status` is false. | +| `user` | object | User object. | +| `user.id` | integer | User ID. | +| `user.name` | string | User name. This is only returned if the `user.read` scope is included in the access token. | +| `user.email` | string | User email. This is only returned if the `user.read` scope is included in the access token. | +| `company` | object | Company object. | +| `company.id` | integer | Company ID. | +| `company.name` | string | Company name. | +| `scopes` | array | Array of scopes that are included in the access token. | +| `expires_at` | integer | The unix timestamp of when the access token expires. | + +The company id is especially important, as you will need to use this in the base URL for all requests to the SimplyPrint API. 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..026e5a20039 100644 --- a/source/javascripts/all_nosearch.js +++ b/source/javascripts/all_nosearch.js @@ -1,3 +1,27 @@ //= require ./lib/_energize -//= require ./app/_lang +//= require ./app/_copy //= require ./app/_toc +//= require ./app/_lang + +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/_lang.js b/source/javascripts/app/_lang.js index 1a124bb68ae..cc5ac8b6bd8 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,11 +129,16 @@ 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; @@ -137,7 +147,9 @@ under the License. // 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( " + <%= stylesheet_link_tag :custom, media: :screen %> <% 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.png?v=2", class: 'logo' %> + <% if language_tabs.any? %>
      <% language_tabs.each do |lang| %> <% if lang.is_a? Hash %> @@ -66,8 +93,22 @@ under the License.
        <% end %> -
        -
        +
          + <% toc_data(page_content).each do |h1| %> +
        • + <%= h1[:content] %> + <% if h1[:children].length > 0 %> + + <% end %> +
        • + <% end %> +
        <% if current_page.data.toc_footers %>