├── .ci
    ├── .gitignore
    └── dead-links.rb
├── .eslintignore
├── .github
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   └── content_request.md
    ├── actions
    │   ├── dead-links
    │   │   └── action.yml
    │   ├── deploy_fw_artifacts
    │   │   └── action.yml
    │   └── deploy_repo
    │   │   └── action.yml
    ├── issue_template.md
    ├── pull_request_template.md
    └── workflows
    │   ├── child_repo.workflow.yml
    │   ├── dead_links.workflow.yml
    │   └── deploy_whole_doc.yml
├── .gitignore
├── .prettierrc
├── .repos
    └── repositories.json
├── .vscode
    └── launch.json
├── Dockerfile
├── LICENSE.md
├── README.md
├── package-lock.json
├── package.json
├── scaffolding
    ├── add_cpp_signature.rb
    ├── lib
    │   ├── copyCommand.js
    │   ├── generateCommand.js
    │   └── utils.js
    ├── scaffold
    └── templates
    │   ├── action.cpp.md
    │   ├── action.go.md
    │   ├── action.java.md
    │   ├── action.js.md
    │   └── usage-snippets
    │       ├── usage.cpp
    │       ├── usage.go
    │       ├── usage.java
    │       ├── usage.js
    │       └── usage.test.yml
└── src
    ├── .vuepress
        ├── client.ts
        ├── components
        │   ├── AlgoliaTags.vue
        │   ├── Badge.vue
        │   ├── ClosedSourcesBanner.vue
        │   ├── CodeSnippet.vue
        │   ├── Cta.vue
        │   ├── CustomBadge.vue
        │   ├── DeprecatedBadge.vue
        │   ├── DeprecatedBanner.vue
        │   ├── GuidesLinks.vue
        │   ├── Home.vue
        │   ├── HomeV1.vue
        │   ├── HowToCategory.vue
        │   ├── HowToIndex.vue
        │   ├── JavaDeprecatedBanner.vue
        │   ├── MajorVersionDeprecation.vue
        │   ├── MajorVersionSelector.vue
        │   ├── MenuDropdown.vue
        │   ├── ModulesIndex.vue
        │   ├── PluginsIndex.vue
        │   ├── Redirect.vue
        │   ├── RedirectLink.vue
        │   ├── RedirectToFirstChild.vue
        │   ├── SDKIndex.vue
        │   ├── SDKSelector.vue
        │   └── SinceBadge.vue
        ├── config.ts
        ├── external-plugins.json
        ├── frontmatter-in-route-meta
        │   ├── index.ts
        │   └── plugin.ts
        ├── frontmatter-lint
        │   ├── append-fixes.ts
        │   ├── index.ts
        │   ├── plugin.ts
        │   └── types.ts
        ├── getVersionString.ts
        ├── helpers.ts
        ├── markdown
        │   ├── code-snippet.ts
        │   ├── index.ts
        │   └── plugin.ts
        ├── meta-tags-plugin
        │   ├── client.ts
        │   ├── index.ts
        │   └── plugin.ts
        ├── page-attributes
        │   ├── index.ts
        │   ├── plugin.ts
        │   └── types.ts
        ├── public
        │   ├── demo_aws_console.gif
        │   ├── favicon
        │   │   ├── apple-touch-icon-114x114.png
        │   │   ├── apple-touch-icon-120x120.png
        │   │   ├── apple-touch-icon-144x144.png
        │   │   ├── apple-touch-icon-152x152.png
        │   │   ├── apple-touch-icon-57x57.png
        │   │   ├── apple-touch-icon-60x60.png
        │   │   ├── apple-touch-icon-72x72.png
        │   │   ├── apple-touch-icon-76x76.png
        │   │   ├── favicon-128.png
        │   │   ├── favicon-16x16.png
        │   │   ├── favicon-196x196.png
        │   │   ├── favicon-32x32.png
        │   │   ├── favicon-96x96.png
        │   │   ├── favicon.ico
        │   │   ├── mstile-144x144.png
        │   │   ├── mstile-150x150.png
        │   │   ├── mstile-310x150.png
        │   │   ├── mstile-310x310.png
        │   │   └── mstile-70x70.png
        │   ├── geolocation
        │   │   ├── geoBoundingBox.png
        │   │   ├── geoDistance.png
        │   │   ├── geoDistanceRange.png
        │   │   └── geoPolygon.png
        │   ├── icons.svg
        │   ├── logo-57x57.png
        │   ├── logo-min.png
        │   ├── logos
        │   │   ├── android.png
        │   │   ├── android.svg
        │   │   ├── book.svg
        │   │   ├── brackets.svg
        │   │   ├── cluster.svg
        │   │   ├── computed.svg
        │   │   ├── cpp.png
        │   │   ├── cpp.svg
        │   │   ├── csharp.png
        │   │   ├── csharp.svg
        │   │   ├── dart.svg
        │   │   ├── device-manager.svg
        │   │   ├── discord.png
        │   │   ├── go.png
        │   │   ├── go.svg
        │   │   ├── hermes.svg
        │   │   ├── java.png
        │   │   ├── java.svg
        │   │   ├── javascript.png
        │   │   ├── javascript.svg
        │   │   ├── js.png
        │   │   ├── js.svg
        │   │   ├── keycloak.svg
        │   │   ├── logger.svg
        │   │   ├── logo-dashboard.svg
        │   │   ├── logo-data.svg
        │   │   ├── logo-database.svg
        │   │   ├── logo-discord.svg
        │   │   ├── logo-espressif.svg
        │   │   ├── logo-github.svg
        │   │   ├── logo-stack-overflow.svg
        │   │   ├── logo-warm-data.svg
        │   │   ├── logo-youtube.svg
        │   │   ├── lua.png
        │   │   ├── lua.svg
        │   │   ├── module-logger.svg
        │   │   ├── open-id.svg
        │   │   ├── paas-logo.svg
        │   │   ├── passport.svg
        │   │   ├── php.png
        │   │   ├── php.svg
        │   │   ├── plugin-cloudinary.svg
        │   │   ├── plugin-multi-tenancy.svg
        │   │   ├── plugin-prometheus.svg
        │   │   ├── plugin-s3.svg
        │   │   ├── plugin.svg
        │   │   ├── postgresql.svg
        │   │   ├── probe.svg
        │   │   ├── python.png
        │   │   ├── python.svg
        │   │   ├── rocket.svg
        │   │   ├── ruby.png
        │   │   ├── ruby.svg
        │   │   ├── rust.svg
        │   │   ├── scheduler.svg
        │   │   ├── search.svg
        │   │   ├── settings.svg
        │   │   ├── tools.svg
        │   │   ├── workflows.svg
        │   │   └── write-code.svg
        │   └── og-image.png
        ├── sections.json
        ├── sections.schema.json
        ├── theme
        │   ├── Footer.vue
        │   ├── Header.vue
        │   ├── Layout.vue
        │   ├── NotFound.vue
        │   ├── Sidebar.vue
        │   ├── TOC.vue
        │   ├── TopMenu.vue
        │   ├── TopMenuV1.vue
        │   ├── client.ts
        │   ├── index.ts
        │   ├── styles
        │   │   ├── _config.scss
        │   │   ├── base
        │   │   │   ├── _icons.scss
        │   │   │   ├── _reset.scss
        │   │   │   └── _typeset.scss
        │   │   ├── extensions
        │   │   │   ├── _admonition.scss
        │   │   │   ├── _alert.scss
        │   │   │   ├── _badge.scss
        │   │   │   ├── _codehilite.scss
        │   │   │   ├── _docsearch.scss
        │   │   │   ├── _external-links.scss
        │   │   │   ├── _footnotes.scss
        │   │   │   ├── _material-color.scss
        │   │   │   ├── _material-shadows.scss
        │   │   │   ├── _menuDropdown.scss
        │   │   │   ├── _permalinks.scss
        │   │   │   ├── _ribbon.scss
        │   │   │   ├── _sdk-selector.scss
        │   │   │   ├── _select2.scss
        │   │   │   ├── _tiles.scss
        │   │   │   ├── modularscale
        │   │   │   │   ├── _function.scss
        │   │   │   │   ├── _pow.scss
        │   │   │   │   ├── _respond.scss
        │   │   │   │   ├── _round-px.scss
        │   │   │   │   ├── _settings.scss
        │   │   │   │   ├── _sort.scss
        │   │   │   │   ├── _strip-units.scss
        │   │   │   │   ├── _sugar.scss
        │   │   │   │   ├── _target.scss
        │   │   │   │   └── _vars.scss
        │   │   │   └── pymdown
        │   │   │   │   ├── _arithmatex.scss
        │   │   │   │   ├── _critic.scss
        │   │   │   │   ├── _details.scss
        │   │   │   │   ├── _emoji.scss
        │   │   │   │   ├── _inlinehilite.scss
        │   │   │   │   └── _tasklist.scss
        │   │   ├── helpers
        │   │   │   ├── _break.scss
        │   │   │   └── _px2em.scss
        │   │   ├── layout
        │   │   │   ├── _base.scss
        │   │   │   ├── _content.scss
        │   │   │   ├── _footer.scss
        │   │   │   ├── _header.scss
        │   │   │   ├── _hero.scss
        │   │   │   ├── _icontable.scss
        │   │   │   ├── _nav.scss
        │   │   │   ├── _sidebar.scss
        │   │   │   ├── _source.scss
        │   │   │   ├── _tabs.scss
        │   │   │   ├── _topMenu.scss
        │   │   │   └── _versions.scss
        │   │   ├── libs
        │   │   │   ├── _copy-code.scss
        │   │   │   ├── _fontawesome.scss
        │   │   │   ├── _google-fonts.scss
        │   │   │   ├── _monokai.scss
        │   │   │   └── _select2.scss
        │   │   └── main.scss
        │   └── theme.ts
        └── util.ts
    ├── core
        └── index.md
    ├── how-to
        ├── index.md
        ├── v1.md
        └── v2.md
    ├── index.md
    ├── modules
        ├── index.md
        └── v2.md
    ├── official-plugins
        ├── index.md
        ├── v1.md
        └── v2.md
    ├── sdk
        ├── index.md
        ├── v1.md
        └── v2.md
    ├── v1.md
    └── v2.md


/.ci/.gitignore:
--------------------------------------------------------------------------------
1 | data.json
2 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | README.md
2 | *.yml
3 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Report wrong content or buggy UI
 4 | title: '[bug] '
 5 | labels: bug
 6 | assignees: ''
 7 | ---
 8 | 
 9 | <!--- Provide a general summary of the issue in the Title above -->
10 | 
11 | ## Expected Behavior
12 | 
13 | <!--- Tell us what should happen -->
14 | 
15 | ## Current Behavior
16 | 
17 | <!--- Tell us what happens instead of the expected behavior -->
18 | 
19 | ## Possible Solution
20 | 
21 | <!--- Not obligatory, but suggest a fix/reason for the bug, -->
22 | 
23 | ## Steps to Reproduce
24 | 
25 | <!--- Provide a link to a live example, or an unambiguous set of steps to -->
26 | <!--- reproduce this bug. Include code to reproduce, if relevant -->
27 | 
28 | 1. 2. 3. 4.
29 | 
30 | ## Context (Environment)
31 | 
32 | <!--- How has this issue affected you? What are you trying to accomplish? -->
33 | <!--- Providing context helps us come up with a solution that is most useful in the real world -->
34 | <!--- Include NodeJS version, SDK version, Kuzzle version, ElasticSearch version, ... -->
35 | 
36 | ## Screenshots (if appropriate)


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/content_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: New content request
 3 | about: Report missing or incomplete content
 4 | title: '[content-request] '
 5 | labels: enhancement
 6 | assignees: ''
 7 | ---
 8 | 
 9 | **What were you trying to do?**
10 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11 | 
12 | **Where would you expect to find the documentation you were looking for?**
13 | Can be an existing or new section of this doc.
14 | 
15 | **Did you find a workaround?**
16 | A clear and concise description of any solution or feature you've considered.
17 | 
18 | **Additional context**
19 | Add any other context or screenshots about your request.


--------------------------------------------------------------------------------
/.github/actions/dead-links/action.yml:
--------------------------------------------------------------------------------
 1 | name: Dead Link Check
 2 | description: Tests the existence of dead links in the documentation of a repo.
 3 | 
 4 | inputs:
 5 |   repo_name:
 6 |     description: The name of the repository to deploy
 7 |     required: true
 8 |   repo_branch:
 9 |     description: The branch of the repo to deploy
10 |     required: true
11 |   repo_version:
12 |     description: The version of the repo to deploy
13 |     required: true
14 | 
15 | runs:
16 |   using: 'composite'
17 |   steps:
18 |     - name: Install deps
19 |       run: npm i --production=false
20 |       shell: bash
21 |     - name: Install typhoeus
22 |       run: sudo gem install typhoeus
23 |       shell: bash
24 |     - name: Checks kuzdoc version
25 |       run: npx kuzdoc --version
26 |       shell: bash
27 |     - name: Installs the repo
28 |       shell: bash
29 |       run: npx kuzdoc install --repo=${{ inputs.repo_name }}-${{ inputs.repo_version }} --repoBranch=${{ inputs.repo_branch }}
30 |     - name: Run dead links tests
31 |       run: npx kuzdoc dead-links --repo=${{ inputs.repo_name }}-${{ inputs.repo_version }}
32 |       shell: bash
33 | 


--------------------------------------------------------------------------------
/.github/actions/deploy_fw_artifacts/action.yml:
--------------------------------------------------------------------------------
 1 | name: Deploy documentation artifacts
 2 | description: Deploy documentation artifacts
 3 | 
 4 | inputs:
 5 |   S3_BUCKET:
 6 |     description: S3 bucket name
 7 |     required: true
 8 |   CLOUDFRONT_ID:
 9 |     description: Cloudfront distribution ID
10 |     required: true
11 | 
12 | runs:
13 |   using: "composite"
14 |   steps:
15 |     - name: Install dependencies
16 |       run: npm i
17 |       shell: bash
18 |     - name: Build framework
19 |       run: npm run build
20 |       shell: bash
21 |     - name: Upload to S3
22 |       run: aws s3 sync src/.vuepress/dist ${{ inputs.S3_BUCKET }}
23 |       shell: bash
24 | 


--------------------------------------------------------------------------------
/.github/actions/deploy_repo/action.yml:
--------------------------------------------------------------------------------
 1 | name: Deploy docs for repo
 2 | description: Deploys the docs of a given repository.
 3 | 
 4 | inputs:
 5 |   repo_name:
 6 |     description: The name of the repository to deploy
 7 |     required: true
 8 |   repo_branch:
 9 |     description: The branch of the repo to deploy
10 |     required: true
11 |   repo_version:
12 |     description: The version of the repo to deploy
13 |     required: true
14 |   repo_deploy_path:
15 |     description: The path in the destination bucket to deploy the built documentation to
16 |     required: true
17 |   NO_INVALIDATION:
18 |     description: If set to true, the Cloudfront invalidation will not be triggered
19 |     required: false
20 |     default: false
21 |   AWS_ACCESS_KEY_ID:
22 |     description: AWS Access key ID
23 |     required: true
24 |   AWS_SECRET_ACCESS_KEY:
25 |     description: AWS secret key
26 |     required: true
27 |   S3_BUCKET:
28 |     description: S3 bucket name
29 |     required: true
30 |   CLOUDFRONT_ID:
31 |     description: Cloudfront distribution ID
32 |     required: true
33 |   REGION:
34 |     description: AWS default region
35 |     required: true
36 | 
37 | runs:
38 |   using: "composite"
39 |   steps:
40 |     - name: Install dependencies
41 |       run: npm i
42 |       shell: bash
43 | 
44 |     - name: Checks kuzdoc version
45 |       run: npx kuzdoc --version
46 |       shell: bash
47 | 
48 |     - name: Installs the repo
49 |       shell: bash
50 |       run: npx kuzdoc install --repo=${{ inputs.repo_name }}-${{ inputs.repo_version }} --repoBranch=${{ inputs.repo_branch }}
51 | 
52 |     - name: Builds and deploys the repo
53 |       if: ${{ inputs.NO_INVALIDATION == 'true' }}
54 |       run: npx kuzdoc build-and-deploy --repo=${{ inputs.repo_name }}-${{ inputs.repo_version }} --s3Bucket=${{ inputs.S3_BUCKET }} --cloudfrontId=${{ inputs.CLOUDFRONT_ID }} --noInvalidation
55 |       env:
56 |         AWS_DEFAULT_REGION: ${{ inputs.REGION }}
57 |         AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}
58 |         AWS_SECRET_ACCESS_KEY: ${{ inputs.AWS_SECRET_ACCESS_KEY }}
59 |         NODE_OPTIONS: --max-old-space-size=4096
60 |       shell: bash
61 | 
62 |     - name: Builds and deploys the repo
63 |       if: ${{ inputs.NO_INVALIDATION == 'false' }}
64 |       run: npx kuzdoc build-and-deploy --repo=${{ inputs.repo_name }}-${{ inputs.repo_version }} --s3Bucket=${{ inputs.S3_BUCKET }} --cloudfrontId=${{ inputs.CLOUDFRONT_ID }}
65 |       env:
66 |         AWS_DEFAULT_REGION: ${{ inputs.REGION }}
67 |         AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}
68 |         AWS_SECRET_ACCESS_KEY: ${{ inputs.AWS_SECRET_ACCESS_KEY }}
69 |         NODE_OPTIONS: --max-old-space-size=4096
70 |       shell: bash
71 | 


--------------------------------------------------------------------------------
/.github/issue_template.md:
--------------------------------------------------------------------------------
 1 | <!--- If you have a question about Kuzzle usage, please use Stackoverflow instead >
 2 | <!--- Post here and we will respond https://stackoverflow.com/questions/ask >
 3 | <!--- Github issues are limited to bugs and features requests >
 4 | 
 5 | 
 6 | <!--- Provide a general summary of the issue in the Title above -->
 7 | 
 8 | ## Expected Behavior
 9 | <!--- Tell us what should happen -->
10 | 
11 | ## Current Behavior
12 | <!--- Tell us what happens instead of the expected behavior -->
13 | 
14 | ## Possible Solution
15 | <!--- Not obligatory, but suggest a fix/reason for the bug, -->
16 | 
17 | ## Steps to Reproduce
18 | <!--- Provide a link to a live example, or an unambiguous set of steps to -->
19 | <!--- reproduce this bug. -->
20 | <!--- Please try to provide scripts or commands to reproduce the bug -->
21 | <!--- Use https://gist.github.com/ to host code snippets -->
22 | 1.
23 | 2.
24 | 3.
25 | 4.
26 | 
27 | ## Context (Environment)
28 | <!--- How has this issue affected you? What are you trying to accomplish? -->
29 | <!--- Providing context helps us come up with a solution that is most useful in the real world -->
30 | <!--- Include NodeJS version, SDK version, Kuzzle version, ElasticSearch version, ... -->
31 | Kuzzle version:
32 | Node.js version:
33 | SDK version:
34 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 |   This template is optional.
 3 |   It simply serves to provide a guide to allow a better review of pull requests.
 4 | -->
 5 | 
 6 | <!--
 7 |   IMPORTANT
 8 |   Don't forget to add the corresponding "changelog:xxx" label to your PR.
 9 |   This is part of our release process in order to generate the change log.
10 | -->
11 | 
12 | 
13 | ## What does this PR do?
14 | <!-- Please fulfill this section -->
15 | 
16 | <!--
17 |   Please include a summary of the change and which issue is fixed.
18 |   Please also include relevant motivation and context.
19 |   List any dependencies that are required for this change.
20 | -->
21 | 
22 | ### How should this be manually tested?
23 | 
24 | <!--
25 |   Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
26 |   Please also list any relevant details for your test configuration
27 | -->
28 |   - Step 1 :
29 |   - Step 2 :
30 |   - Step 3 :  
31 |   ...
32 | 
33 | ### Other changes
34 | 
35 | <!--
36 |   Please describe here all changes not directly linked to the main issue, but made because of it.
37 |   For instance: issues spotted during this PR and fixed on-the-fly, dependencies update, and so on
38 | -->
39 | 
40 | ### Boyscout
41 | 
42 | <!--
43 |   Describe here minor improvements in the code base and not directly linked to the main changes:
44 |   typos fixes, better/new comments, small code simplification, new debug messages, and so on.
45 | -->
46 | 


--------------------------------------------------------------------------------
/.github/workflows/dead_links.workflow.yml:
--------------------------------------------------------------------------------
 1 | name: Child repo triggered dead-link check
 2 | 
 3 | on:
 4 |   workflow_dispatch:
 5 |     inputs:
 6 |       repo_name:
 7 |         description: "The name of the repository that triggered the workflow"
 8 |         required: true
 9 |       branch:
10 |         description: "The branch of the child repo to deploy"
11 |         required: false
12 |       version:
13 |         description: "The version of the product in the child repo"
14 |         required: true
15 | 
16 | env:
17 |   NODE_VERSION: 20
18 | 
19 | jobs:
20 |   dead-links:
21 |     name: Check the dead-links on the repo
22 |     runs-on: ubuntu-24.04
23 |     steps:
24 |       - name: Checkout repository
25 |         uses: actions/checkout@v4
26 | 
27 |       - name: Output event inputs for debug
28 |         run: echo "Repo ${{ github.event.inputs.repo_name }} triggered this workflow from branch ${{ github.event.inputs.branch }} v${{ github.event.inputs.version }}"
29 | 
30 |       - name: Install SSH key
31 |         uses: shimataro/ssh-key-action@v2
32 |         with:
33 |           key: ${{ secrets.SSH_KEY }}
34 |           name: id_rsa
35 |           known_hosts: unnecessary
36 | 
37 |       - name: Set up Node
38 |         uses: actions/setup-node@v4
39 |         with:
40 |           node-version: ${{ env.NODE_VERSION }}
41 |           cache: 'npm'
42 | 
43 |       - name: Check dead links
44 |         uses: ./.github/actions/dead-links
45 |         with:
46 |           repo_name: ${{ github.event.inputs.repo_name }}
47 |           repo_version: ${{ github.event.inputs.version }}
48 |           repo_branch: ${{ github.event.inputs.branch }}
49 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | /.idea
 2 | .DS_Store
 3 | node_modules
 4 | dist
 5 | algolia-records.json
 6 | frontmatter-errors.json
 7 | frontmatter-fixes.json
 8 | dead_links.json
 9 | .vscode
10 | .cache
11 | .temp
12 | 
13 | .repos/plugin*
14 | .repos/sdk-*
15 | .repos/kuzzle*
16 | .repos/paas*
17 | .repos/iot-platform*
18 | 
19 | version.md
20 | frontmatter-lint-errors.json
21 | 


--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 |   "singleQuote": true,
3 |   "semi": true
4 | }
5 | 


--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   // Use IntelliSense to learn about possible attributes.
 3 |   // Hover to view descriptions of existing attributes.
 4 |   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 5 |   "version": "0.2.0",
 6 |   "configurations": [
 7 |     {
 8 |       "type": "node",
 9 |       "request": "launch",
10 |       "name": "Debug Frontmatter Fix Tool",
11 |       "program": "${workspaceFolder}/src/.vuepress/validate-frontmatter/fix.js",
12 |       "args": ["-e", "frontmatter-errors.json", "-d", "src", "-y"],
13 |       "cwd": "${workspaceFolder}"
14 |     },
15 |     {
16 |       "type": "node",
17 |       "request": "launch",
18 |       "name": "Debug VuePress",
19 |       "console": "integratedTerminal",
20 |       "runtimeExecutable": "npm",
21 |       "runtimeArgs": ["run-script", "debug"],
22 |       // "localRoot": "${workspaceFolder}/src/.vuepress/",
23 |       "env": {
24 |         "ALGOLIA_WRITE_KEY": "1"
25 |       },
26 |       // "remoteRoot": "/",
27 |       "port": 9229
28 |     }
29 |   ]
30 | }
31 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM node:alpine 
 2 | 
 3 | LABEL io.kuzzle.vendor="Kuzzle <support@kuzzle.io>"
 4 | LABEL description="Documentation website with running tests"
 5 | 
 6 | WORKDIR /var/app
 7 | 
 8 | COPY . /var/app
 9 | 
10 | RUN set -eux \
11 |   \
12 |   && npm install
13 | 
14 | ENTRYPOINT ["npm", "run"]
15 | CMD ["dev"]
16 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "kuzzleio-documentation",
 3 |   "version": "4.0.0",
 4 |   "description": "",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "dev": "vuepress dev src --clean-cache",
 8 |     "vuepress": "vuepress",
 9 |     "build": "vuepress build src --clean-cache"
10 |   },
11 |   "repository": {
12 |     "type": "git",
13 |     "url": "git://github.com/kuzzleio/documentation.git"
14 |   },
15 |   "author": "The Kuzzle Team <support@kuzzle.io>",
16 |   "license": "Apache-2.0",
17 |   "dependencies": {
18 |     "@fortawesome/fontawesome-free": "^6.6.0",
19 |     "@fortawesome/fontawesome-svg-core": "^6.6.0",
20 |     "@fortawesome/free-brands-svg-icons": "^6.6.0",
21 |     "@fortawesome/free-solid-svg-icons": "^6.6.0",
22 |     "@fortawesome/vue-fontawesome": "^3.0.8",
23 |     "fix-indents": "^0.1.2092",
24 |     "lodash-es": "^4.17.21"
25 |   },
26 |   "devDependencies": {
27 |     "@types/lodash-es": "^4.17.12",
28 |     "@types/markdown-it": "^14.1.2",
29 |     "@types/micromatch": "^4.0.9",
30 |     "@vuepress/bundler-vite": "^2.0.0-rc.17",
31 |     "@vuepress/plugin-active-header-links": "^2.0.0-rc.103",
32 |     "@vuepress/plugin-back-to-top": "^2.0.0-rc.103",
33 |     "@vuepress/plugin-copy-code": "^2.0.0-rc.103",
34 |     "@vuepress/plugin-docsearch": "^2.0.0-rc.103",
35 |     "@vuepress/plugin-google-analytics": "^2.0.0-rc.103",
36 |     "@vuepress/plugin-markdown-container": "^2.0.0-rc.103",
37 |     "@vuepress/plugin-register-components": "^2.0.0-rc.103",
38 |     "@vuepress/plugin-shiki": "^2.0.0-rc.103",
39 |     "@vuepress/plugin-sitemap": "^2.0.0-rc.103",
40 |     "@vuepress/utils": "^2.0.0-rc.17",
41 |     "commander": "^12.1.0",
42 |     "eslint": "^9.11.1",
43 |     "micromatch": "^4.0.8",
44 |     "sass-embedded": "^1.79.4",
45 |     "vite-plugin-node-polyfills": "^0.22.0",
46 |     "vuepress": "^2.0.0-rc.23"
47 |   }
48 | }
49 | 


--------------------------------------------------------------------------------
/scaffolding/lib/generateCommand.js:
--------------------------------------------------------------------------------
 1 | const
 2 |   {
 3 |     explodeSdkPath,
 4 |     renderSnippetTemplate,
 5 |     renderMarkdownTemplate,
 6 |     renderSnippetConfigTemplate,
 7 |     injectSignatures,
 8 |     injectDescription
 9 |   } = require('./utils'),
10 |   _ = require('lodash'),
11 |   path = require('path');
12 | 
13 | async function generateCommand (actionPath) {
14 |   if (! actionPath) {
15 |     // eslint-disable-next-line no-console
16 |     console.error('You must provide a path for the action');
17 |     process.exit(1);
18 |   }
19 | 
20 |   try {
21 |     const sdkInfos = explodeSdkPath(actionPath);
22 | 
23 |     console.log(`Scaffolding: ${sdkInfos.controller}:${sdkInfos.action} (${sdkInfos.language}/${sdkInfos.version})`);
24 | 
25 |     await renderMarkdownTemplate(sdkInfos, actionPath);
26 |     await renderSnippetTemplate(sdkInfos, actionPath);
27 |     await renderSnippetConfigTemplate(sdkInfos, actionPath);
28 | 
29 |     injectDescription(sdkInfos, actionPath);
30 |     injectSignatures(sdkInfos, actionPath);
31 |   } catch (error) {
32 |     console.error(error);
33 |     process.exit(1);
34 |   }
35 | }
36 | 
37 | module.exports = generateCommand;
38 | 


--------------------------------------------------------------------------------
/scaffolding/scaffold:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env node
 2 | 
 3 | const
 4 |   program = require('commander');
 5 | 
 6 | program
 7 |   .command('generate <path>')
 8 |   .description('generate a full scaffold for a controller action')
 9 |   .action(require('./lib/generateCommand.js'));
10 | 
11 | program
12 |   .command('copy <src> <dest>')
13 |   .description('generate a scaffold for a controller action based an existing sdk')
14 |   .action(require('./lib/copyCommand.js'));
15 | 
16 | program.parse(process.argv);
17 | 


--------------------------------------------------------------------------------
/scaffolding/templates/action.cpp.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: sdk.html.hbs
 3 | title: <%= _.camelCase(action) %>
 4 | description:
 5 | ---
 6 | 
 7 | # <%= _.camelCase(action) %>
 8 | 
 9 | ## Arguments
10 | 
11 | ```cpp
12 | void <%= _.camelCase(action) %>()
13 | ```
14 | 
15 | <br/>
16 | 
17 | | Argument | Type | Description |
18 | | --- | --- | --- |
19 | | `index` | <pre>std::string</pre> | Index name |
20 | | `collection` | <pre>std::string</pre> | Collection name |
21 | | `id` | <pre>std::string</pre> | The document id |
22 | | `body` | <pre>std::string</pre> | A JSON string containing the body of the document |
23 | | `options` | <pre>kuzzleio::query_options</pre> | A pointer to a `kuzzleio::query_options` containing query options |
24 | 
25 | ### options
26 | 
27 | | Options    | Type (default) | Description                       |
28 | | ---------- | -------------- | --------------------------------- |
29 | | `queuable` | <pre>boolean</pre> (`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
30 | | `refresh` | <pre>std::string</pre> | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
31 | 
32 | ## Return
33 | 
34 | ## Exceptions
35 | 
36 | Throws a `KuzzleException` if there is an error. See how to [handle errors]({{ site_base_path }}sdk-reference/cpp/1/error-handling).
37 | 
38 | ## Usage
39 | 
40 | [snippet=<%= _.kebabCase(action) %>]
41 | 


--------------------------------------------------------------------------------
/scaffolding/templates/action.go.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: sdk.html.hbs
 3 | title: <%= _.camelCase(action) %>
 4 | description:
 5 | ---
 6 | 
 7 | # <%= _.camelCase(action) %>
 8 | 
 9 | ## Arguments
10 | 
11 | ```go
12 | <%= _.upperFirst(_.camelCase(action)) %>() error
13 | ```
14 | 
15 | <br/>
16 | 
17 | | Arguments    | Type    | Description |
18 | |--------------|---------|-------------|
19 | | ``changeme`` | <pre>changme</pre> | changeme    |
20 | 
21 | ### options
22 | 
23 | | Options    | Type (default) | Description                       |
24 | | ---------- | -------------- | --------------------------------- |
25 | | `queuable` | <pre>bool</pre> (`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
26 | | `refresh` | <pre>string</pre> | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
27 | 
28 | ## Return
29 | 
30 | ## Usage
31 | 
32 | [snippet=<%= _.kebabCase(action) %>]
33 | 


--------------------------------------------------------------------------------
/scaffolding/templates/action.java.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: sdk.html.hbs
 3 | title: <%= _.camelCase(action) %>
 4 | description:
 5 | ---
 6 | 
 7 | # <%= _.camelCase(action) %>
 8 | 
 9 | ## Arguments
10 | 
11 | ```java
12 | void <%= _.camelCase(action) %>()
13 | ```
14 | 
15 | <br/>
16 | 
17 | | Argument | Type | Description |
18 | | --- | --- | --- |
19 | | `index` | <pre>String</pre> | Index name |
20 | | `collection` | <pre>String</pre> | Collection name |
21 | | `id` | <pre>String</pre> | Optional document id. If set to a blank string, will use a auto-generated id |
22 | | `body` | <pre>String</pre> | A JSON string containing the body of the document |
23 | | `options` | <pre>io.kuzzle.sdk.QueryOptions</pre> | The query options |
24 | 
25 | ### Options
26 | 
27 | | Option     | Type (default) | Description                       |
28 | | ---------- | -------------- | --------------------------------- |
29 | | `queuable` | <pre>boolean</pre> (`true`) | Make this request queuable or not |
30 | | `refresh` | <pre>String</pre> | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
31 | 
32 | ## Return
33 | 
34 | ## Exceptions
35 | 
36 | Throws a `io.kuzzle.sdk.KuzzleException` if there is an error. See how to [handle error]({{ site_base_path }}sdk-reference/java/1/error-handling).
37 | 
38 | ## Usage
39 | 
40 | [snippet=<%= _.kebabCase(action) %>]
41 | 


--------------------------------------------------------------------------------
/scaffolding/templates/action.js.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: sdk.html.hbs
 3 | title: <%= _.camelCase(action) %>
 4 | description:
 5 | ---
 6 | 
 7 | # <%= _.camelCase(action) %>
 8 | 
 9 | ## Arguments
10 | 
11 | ```js
12 | <%= _.camelCase(action) %>()
13 | ```
14 | 
15 | <br/>
16 | 
17 | | Argument | Type | Description |
18 | | --- | --- | --- |
19 | | `index` | <pre>string</pre> | Index name |
20 | | `collection` | <pre>string</pre> | Collection name |
21 | | `id` | <pre>string</pre> | Optional document id |
22 | | `body` | <pre>object</pre> | The query to match |
23 | | `options` | <pre>object</pre> | An object containing query options. |
24 | 
25 | ### options
26 | 
27 | | Option     | Type (default)    | Description                       |
28 | | ---------- | ----------------- | --------------------------------- |
29 | | `queuable` | <pre>boolean</pre> (`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
30 | | `refresh` | <pre>string</pre> | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
31 | 
32 | ## Resolve
33 | 
34 | ## Usage
35 | 
36 | [snippet=<%= _.kebabCase(action) %>]
37 | 


--------------------------------------------------------------------------------
/scaffolding/templates/usage-snippets/usage.cpp:
--------------------------------------------------------------------------------
1 | try {
2 |   kuzzle-><%= _.camelCase(controller) %>-><%= _.camelCase(action) %>();
3 |   
4 |   std::cout << "Success" << std::endl;
5 | } catch (kuzzleio::KuzzleException &e) {
6 |   std::cerr << e.getMessage() << std::endl;
7 | }
8 | 


--------------------------------------------------------------------------------
/scaffolding/templates/usage-snippets/usage.go:
--------------------------------------------------------------------------------
1 | err := kuzzle.<%= _.upperFirst(_.camelCase(controller)) %>.<%= _.upperFirst(_.camelCase(action)) %>()
2 | 
3 | if err != nil {
4 |   log.Fatal(err)
5 | } else {
6 |   fmt.Println("Success")
7 | }
8 | 


--------------------------------------------------------------------------------
/scaffolding/templates/usage-snippets/usage.java:
--------------------------------------------------------------------------------
1 | try {
2 |     kuzzle.get<%= _.upperFirst(_.camelCase(controller)) %>().<%= _.camelCase(action) %>();
3 |     System.out.println("Success");
4 | } catch (KuzzleException e) {
5 |     System.err.println(e.getMessage());
6 | }
7 | 


--------------------------------------------------------------------------------
/scaffolding/templates/usage-snippets/usage.js:
--------------------------------------------------------------------------------
1 | try {
2 |   await kuzzle.<%= _.camelCase(controller) %>.<%= _.camelCase(action) %>();
3 |   console.log('Success');
4 | } catch (error) {
5 |   console.error(error.message);
6 | }
7 | 


--------------------------------------------------------------------------------
/scaffolding/templates/usage-snippets/usage.test.yml:
--------------------------------------------------------------------------------
1 | name: <%= _.camelCase(controller) %>#<%= _.camelCase(action) %>
2 | description:
3 | hooks:
4 |   before:
5 |   after:
6 | template: default
7 | expected: Success
8 | 


--------------------------------------------------------------------------------
/src/.vuepress/client.ts:
--------------------------------------------------------------------------------
 1 | import { library } from '@fortawesome/fontawesome-svg-core';
 2 | import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome';
 3 | import { defineClientConfig } from 'vuepress/client';
 4 | 
 5 | import {
 6 |   faAngleLeft,
 7 |   faArrowUpRightFromSquare,
 8 |   faBars,
 9 |   faCaretDown,
10 |   faCaretRight,
11 |   faCircleCheck,
12 |   faCircleInfo,
13 |   faGlobe,
14 |   faMagnifyingGlass,
15 |   faTriangleExclamation,
16 | } from '@fortawesome/free-solid-svg-icons';
17 | 
18 | import {
19 |   faDiscord,
20 |   faGithub,
21 |   faLinkedinIn,
22 |   faStackOverflow,
23 |   faXTwitter,
24 |   faYoutube,
25 | } from '@fortawesome/free-brands-svg-icons';
26 | 
27 | library.add(
28 |   faAngleLeft,
29 |   faArrowUpRightFromSquare,
30 |   faBars,
31 |   faCaretDown,
32 |   faCaretRight,
33 |   faCircleCheck,
34 |   faCircleInfo,
35 |   faDiscord,
36 |   faGithub,
37 |   faGlobe,
38 |   faLinkedinIn,
39 |   faMagnifyingGlass,
40 |   faStackOverflow,
41 |   faTriangleExclamation,
42 |   faXTwitter,
43 |   faYoutube,
44 | );
45 | 
46 | export default defineClientConfig({
47 |   enhance({ app, router }) {
48 |     // Register the FontAwesomeIcon component
49 |     app.component('font-awesome-icon', FontAwesomeIcon);
50 | 
51 |     // Override the VuePress scroll behavior to set a custom top offset
52 |     router.options.scrollBehavior = async (to, from, savedPosition) => {
53 |       if (savedPosition) {
54 |         return savedPosition;
55 |       }
56 | 
57 |       if (to.hash.length > 1) {
58 |         const elem = document.querySelector(to.hash);
59 | 
60 |         if (elem !== null) {
61 |           const top = parseFloat(getComputedStyle(elem).scrollMarginTop);
62 | 
63 |           return {
64 |             el: to.hash,
65 |             behavior: 'smooth',
66 |             top,
67 |           };
68 |         }
69 |       }
70 | 
71 |       const behavior = to.path === from.path ? 'smooth' : 'instant';
72 |       return { top: 0, left: 0, behavior };
73 |     }
74 |   },
75 | });
76 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/AlgoliaTags.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div style="display: none">
 3 |     <div data-algolia-lvl="0">{{ algoliaLevel[0] }}</div>
 4 |     <div data-algolia-lvl="1">{{ algoliaLevel[1] }}</div>
 5 |     <div data-algolia="major-version">{{ kuzzleMajor }}</div>
 6 |   </div>
 7 | </template>
 8 | 
 9 | <script>
10 | import { usePageData } from 'vuepress/client';
11 | 
12 | export default {
13 |   props: {
14 |     kuzzleMajor: {
15 |       type: Number,
16 |       required: true,
17 |     },
18 |   },
19 |   computed: {
20 |     algoliaLevel() {
21 |       if (!this.page$.currentSection) {
22 |         return ['Kuzzle', 'Documentation'];
23 |       }
24 | 
25 |       if (this.page$.currentSection.section === 'sdk') {
26 |         return [
27 |           'SDK',
28 |           `SDK ${this.page$.currentSection.name} v${this.page$.currentSection.version}.x`,
29 |         ];
30 |       }
31 | 
32 |       if (this.page$.currentSection.section === 'how-to') {
33 |         return [
34 |           `How-To (Kuzzle v${this.page$.currentSection.kuzzleMajor}.x)`,
35 |           `${this.page$.currentSection.name}`,
36 |         ];
37 |       }
38 | 
39 |       if (this.page$.currentSection.section === 'official-plugins') {
40 |         return [
41 |           `Official Plugins (Kuzzle v${this.page$.currentSection.kuzzleMajor}.x)`,
42 |           `${this.page$.currentSection.name} v${this.page$.currentSection.version}.x`,
43 |         ];
44 |       }
45 | 
46 |       return [
47 |         'Core',
48 |         `${this.page$.currentSection.name} v${
49 |           this.page$.currentSection.version
50 |             ? this.page$.currentSection.version
51 |             : this.page$.currentSection.kuzzleMajor
52 |         }.x`,
53 |       ];
54 |     },
55 |   },
56 |   setup() {
57 |     return { page$: usePageData() };
58 |   },
59 |   mounted() {
60 |     // https://docsearch.algolia.com/docs/required-configuration/#introduce-global-information-as-meta-tags
61 |     const head = document.head;
62 |     const tag = document.createElement('meta');
63 |     tag.setAttribute('property', 'docsearch:version');
64 |     tag.setAttribute('content', `${this.kuzzleMajor}.0.0`);
65 |     head.appendChild(tag);
66 |     document.title = `${document.title} v${this.kuzzleMajor}`
67 |   },
68 | };
69 | </script>
70 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/Badge.vue:
--------------------------------------------------------------------------------
 1 | <script setup lang="ts">
 2 | import type { VNode } from 'vue'
 3 | 
 4 | withDefaults(
 5 |   defineProps<{
 6 |     /**
 7 |      * The type of the badge
 8 |      */
 9 |     type?: string
10 |     /**
11 |      * The text of the badge
12 |      */
13 |     text?: string
14 |     /**
15 |      * The vertical align of the badge
16 |      */
17 |     vertical?: string
18 |   }>(),
19 |   {
20 |     type: 'tip',
21 |     text: '',
22 |     vertical: undefined,
23 |   },
24 | )
25 | 
26 | defineSlots<{
27 |   default?: () => VNode | VNode[] | string | null
28 | }>()
29 | </script>
30 | 
31 | <template>
32 |   <span
33 |     class="vp-badge"
34 |     :class="type"
35 |     :style="{
36 |       verticalAlign: vertical,
37 |     }"
38 |   >
39 |     <slot>{{ text }}</slot>
40 |   </span>
41 | </template>


--------------------------------------------------------------------------------
/src/.vuepress/components/ClosedSourcesBanner.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="alert alert-message">
 3 |     <p>
 4 |       This plugin is part of the Kuzzle Enterprise Plan. If you are
 5 |       interested,
 6 |       <a href="https://info.kuzzle.io/contact-us" target="_blank"
 7 |         >please contact us</a
 8 |       >.
 9 |     </p>
10 |   </div>
11 | </template>
12 | 
13 | <script>
14 | export default {};
15 | </script>
16 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/CodeSnippet.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div></div>
 3 | </template>
 4 | 
 5 | <script>
 6 | export default {
 7 |   name: 'CodeSnippet'
 8 | };
 9 | </script>
10 | 
11 | <style>
12 | </style>
13 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/Cta.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <a :href="btnUrl" class="btnCta">{{ btnTextInside }}</a>
 3 | </template>
 4 | 
 5 | <script>
 6 | export default {
 7 |   name: 'Cta',
 8 |   props: {
 9 |     btnTextInside: {
10 |       type: String,
11 |       required: true
12 |     },
13 |     btnUrl: {
14 |       type: String,
15 |       required: true
16 |     }
17 |   }
18 | };
19 | </script>
20 | 
21 | <style lang="scss">
22 | .btnCta {
23 |   color: white;
24 |   min-height: 30px;
25 |   min-width: 140px;
26 |   padding: 10px 20px;
27 |   font-size: 1.3em;
28 |   color: #fff !important;
29 |   background-color: #e94e77;
30 | }
31 | </style>
32 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/CustomBadge.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <Badge :type="type" :text="text" />
 4 |   </div>
 5 | </template>
 6 | 
 7 | <script>
 8 | import Badge from './Badge.vue';
 9 | 
10 | export default {
11 |   components: {
12 |     Badge
13 |   },
14 |   props: {
15 |     text: {
16 |       type: String,
17 |       required: true
18 |     },
19 |     type: {
20 |       type: String,
21 |       required: true,
22 |       validator: function(value) {
23 |         return ['tip', 'error', 'warning'].indexOf(value) !== -1;
24 |       }
25 |     }
26 |   }
27 | };
28 | </script>
29 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/DeprecatedBadge.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <details v-if="$slots.default">
 4 |       <summary><Badge type="danger" :text="`Deprecated since ${version}`"/></summary>
 5 |       <slot></slot>
 6 |     </details>
 7 |     <Badge v-else type="danger" :text="`Deprecated since ${version}`"/>
 8 |   </div>
 9 | </template>
10 | 
11 | <script>
12 | import Badge from './Badge.vue';
13 | 
14 | export default {
15 |   components: {
16 |     Badge
17 |   },
18 |   props: {
19 |     version: {
20 |       type: String,
21 |       required: true
22 |     }
23 |   }
24 | };
25 | </script>
26 | 
27 | <style>
28 | </style>
29 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/DeprecatedBanner.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="alert alert-warning deprecatedBanner">
 3 |     <p>
 4 |       This SDK has been deprecated because of stability issues. It is not
 5 |       advised to use it in a production environment.
 6 |     </p>
 7 |   </div>
 8 | </template>
 9 | 
10 | <script>
11 | export default {};
12 | </script>
13 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/GuidesLinks.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="GuidesLinks">
 3 |     <span class="GuidesLinks-prev" v-if="prev">
 4 |       <RouteLink :to="prevUrl">◄ {{ prev.text }}</RouteLink>
 5 |     </span>
 6 |     <span class="GuidesLinks-next" v-if="next">
 7 |       <RouteLink :to="nextUrl">{{ next.text }} ►</RouteLink>
 8 |     </span>
 9 |   </div>
10 | </template>
11 | 
12 | <script>
13 | function formatUrl(url) {
14 |   if (url === undefined) {
15 |     return undefined;
16 |   }
17 | 
18 |   if (!url.endsWith('/')) {
19 |     url += '/';
20 |   }
21 | 
22 |   return url;
23 | }
24 | 
25 | export default {
26 |   name: 'GuidesLinks',
27 |   props: {
28 |     next: {
29 |       type: Object
30 |     },
31 |     prev: {
32 |       type: Object
33 |     }
34 |   },
35 |   computed: {
36 |     prevUrl() {
37 |       return formatUrl(this.prev?.url);
38 |     },
39 |     nextUrl() {
40 |       return formatUrl(this.next?.url);
41 |     },
42 |   },
43 | };
44 | </script>
45 | 
46 | <style lang="scss">
47 | .GuidesLinks {
48 |   padding: 2em 0 2em 0;
49 |   font-weight: 600;
50 | 
51 |   &-prev {
52 |     float: left;
53 |   }
54 | 
55 |   &-next {
56 |     float: right;
57 |   }
58 | }
59 | </style>
60 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/Home.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <h2>What is Kuzzle</h2>
 4 |     <p>
 5 |       Kuzzle is a ready-to-use, open-source, on-premises suite that allows you
 6 |       to build modern web, mobile and IoT applications in no time.
 7 |     </p>
 8 | 
 9 |     <h2>Learn more about Kuzzle now</h2>
10 |     <div class="Tiles">
11 |       <a
12 |         :href="getPath('/guides/getting-started/run-kuzzle/')"
13 |         class="Tiles-item medium"
14 |       >
15 |         <img
16 |           :src="$withBase('/logos/rocket.svg')"
17 |           alt="Running Kuzzle logo"
18 |           class="Tiles-item-logo"
19 |         />
20 |         <div class="Tiles-item-name">Running Kuzzle</div>
21 |       </a>
22 |       <a
23 |         :href="getPath('/framework/classes/backend/properties/')"
24 |         class="Tiles-item medium"
25 |       >
26 |         <img
27 |           :src="$withBase('/logos/write-code.svg')"
28 |           alt="Running Kuzzle logo"
29 |           class="Tiles-item-logo"
30 |         />
31 |         <div class="Tiles-item-name">Framework references</div>
32 |       </a>
33 |       <a :href="getPath('/api/payloads/request/')" class="Tiles-item medium">
34 |         <img
35 |           :src="$withBase('/logos/search.svg')"
36 |           alt="Learn API logo"
37 |           class="Tiles-item-logo"
38 |         />
39 |         <div class="Tiles-item-name">Learn API</div>
40 |       </a>
41 |       <a href="/sdk/" class="Tiles-item medium">
42 |         <img :src="$withBase('/logos/brackets.svg')" alt="SDK logo" class="Tiles-item-logo" />
43 |         <div class="Tiles-item-name">Find your SDK</div>
44 |       </a>
45 |       <a href="/official-plugins/" class="Tiles-item medium">
46 |         <img
47 |           :src="$withBase('/logos/plugin.svg')"
48 |           alt="Plugins logo"
49 |           class="Tiles-item-logo"
50 |         />
51 |         <div class="Tiles-item-name">Official plugins</div>
52 |       </a>
53 |       <a
54 |         :href="getPath('/guides/main-concepts')"
55 |         class="Tiles-item medium"
56 |       >
57 |         <img :src="$withBase('/logos/book.svg')" alt="Plugins logo" class="Tiles-item-logo" />
58 |         <div class="Tiles-item-name">More guides</div>
59 |       </a>
60 |     </div>
61 |   </div>
62 | </template>
63 | 
64 | <script>
65 | export default {
66 |   name: 'Home',
67 |   props: {
68 |     kuzzleMajor: {
69 |       type: Number
70 |     }
71 |   },
72 |   methods: {
73 |     getPath(path) {
74 |       return `/core/${this.kuzzleMajor}${path}`;
75 |     }
76 |   }
77 | };
78 | </script>
79 | 
80 | <style></style>
81 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/HomeV1.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <h2>What is Kuzzle</h2>
 4 |     <p>
 5 |       Kuzzle is a ready-to-use, open-source, on-premises suite that allows you
 6 |       to build modern web, mobile and IoT applications in no time.
 7 |     </p>
 8 | 
 9 |     <h2>Learn more about Kuzzle now</h2>
10 |     <div class="Tiles">
11 |       <a
12 |         :href="getPath('/guides/getting-started/running-kuzzle/')"
13 |         class="Tiles-item medium"
14 |       >
15 |         <img
16 |           :src="$withBase('/logos/rocket.svg')"
17 |           alt="Running Kuzzle logo"
18 |           class="Tiles-item-logo"
19 |         />
20 |         <div class="Tiles-item-name">Running Kuzzle</div>
21 |       </a>
22 |       <a
23 |         :href="getPath('/api/essentials/connecting-to-kuzzle/')"
24 |         class="Tiles-item medium"
25 |       >
26 |         <img
27 |           :src="$withBase('/logos/search.svg')"
28 |           alt="Explore API logo"
29 |           class="Tiles-item-logo"
30 |         />
31 |         <div class="Tiles-item-name">Explore API</div>
32 |       </a>
33 |       <a href="/sdk/" class="Tiles-item medium">
34 |         <img :src="$withBase('/logos/brackets.svg')" alt="SDK logo" class="Tiles-item-logo" />
35 |         <div class="Tiles-item-name">Find your SDK</div>
36 |       </a>
37 |       <a
38 |         :href="getPath('/guides/essentials/admin-console/')"
39 |         class="Tiles-item medium"
40 |       >
41 |         <img
42 |           :src="$withBase('/logos/tools.svg')"
43 |           alt="Admin console logo"
44 |           class="Tiles-item-logo"
45 |         />
46 |         <div class="Tiles-item-name">Admin console</div>
47 |       </a>
48 |       <a
49 |         :href="getPath('/guides/essentials/configuration/')"
50 |         class="Tiles-item medium"
51 |       >
52 |         <img
53 |           :src="$withBase('/logos/settings.svg')"
54 |           alt="Configure Kuzzle logo"
55 |           class="Tiles-item-logo"
56 |         />
57 |         <div class="Tiles-item-name">Configure Kuzzle</div>
58 |       </a>
59 |       <a href="/official-plugins/" class="Tiles-item medium">
60 |         <img
61 |           :src="$withBase('/logos/plugin.svg')"
62 |           alt="Plugins logo"
63 |           class="Tiles-item-logo"
64 |         />
65 |         <div class="Tiles-item-name">Plugins</div>
66 |       </a>
67 |       <a
68 |         :href="getPath('/guides/essentials/introduction/')"
69 |         class="Tiles-item medium"
70 |       >
71 |         <img
72 |           :src="$withBase('/logos/book.svg')"
73 |           alt="More guides logo"
74 |           class="Tiles-item-logo"
75 |         />
76 |         <div class="Tiles-item-name">More guides</div>
77 |       </a>
78 |     </div>
79 |   </div>
80 | </template>
81 | 
82 | <script>
83 | export default {
84 |   name: 'Home',
85 |   props: {
86 |     kuzzleMajor: {
87 |       type: Number
88 |     }
89 |   },
90 |   methods: {
91 |     getPath(path) {
92 |       return `/core/${this.kuzzleMajor}${path}`;
93 |     }
94 |   }
95 | };
96 | </script>
97 | 
98 | <style></style>
99 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/HowToCategory.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <h2>{{ categorie }}</h2>
 4 |     <div class="Tiles">
 5 |       <a v-for="howTo in howToList" :key="howTo.name" :href="howTo.path" class="Tiles-item">
 6 |         <img :src="$withBase(howTo.icon)" :alt="`${howTo.name} logo`" class="Tiles-item-logo" />
 7 |         <div class="Tiles-item-name">{{ howTo.name }}</div>
 8 |       </a>
 9 |     </div>
10 |   </div>
11 | </template>
12 | 
13 | <script>
14 | export default {
15 |   name: 'HowToCategory',
16 |   props: {
17 |     categorie: {
18 |       type: String,
19 |       required: true,
20 |     },
21 |     howToList: {
22 |       type: Array,
23 |       required: true,
24 |     },
25 |   },
26 | };
27 | </script>
28 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/HowToIndex.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <HowToCategory
 4 |       v-for="cat in categories"
 5 |       :key="cat"
 6 |       :categorie="cat"
 7 |       :howToList="howToListByCategories[cat]"
 8 |     />
 9 |   </div>
10 | </template>
11 | 
12 | <script>
13 | import { transform } from 'lodash-es';
14 | import { usePageData } from 'vuepress/client';
15 | 
16 | export default {
17 |   name: 'HowToIndex',
18 |   props: {
19 |     kuzzleMajor: {
20 |       type: Number,
21 |       required: true,
22 |     },
23 |   },
24 |   computed: {
25 |     howToList() {
26 |       return this.page$.sectionList.filter(
27 |         (s) =>
28 |           s.kuzzleMajor === this.kuzzleMajor &&
29 |           s.section === 'how-to' &&
30 |           s.subsection &&
31 |           // If we are deploying to the master branch, exclude the
32 |           // sections that are not released yet
33 |           (BRANCH === 'master' ? s.released === true : true)
34 |       );
35 |     },
36 |     howToListByCategories() {
37 |       return transform(
38 |         this.howToList,
39 |         (result, value, key) => {
40 |           if (!result[value.subsection]) {
41 |             result[value.subsection] = [];
42 |           }
43 |           result[value.subsection].push(value);
44 |         },
45 |         {}
46 |       );
47 |     },
48 |     categories() {
49 |       return Object.keys(this.howToListByCategories);
50 |     },
51 |   },
52 |   setup() {
53 |     return { page$: usePageData() };
54 |   },
55 | };
56 | </script>
57 | 
58 | <style>
59 | </style>
60 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/JavaDeprecatedBanner.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="alert alert-warning deprecatedBanner">
 3 |     <p>
 4 |       This SDK is deprecated. We recommend to use the
 5 |       <a href="/sdk/jvm/1/core-classes/kuzzle/constructor/">Kuzzle SDK-JVM</a
 6 |       >.<br />
 7 |       A migration guide is available
 8 | 
 9 |       <a href="/sdk/java/3/migration/how-to/">here</a>
10 |     </p>
11 |   </div>
12 | </template>
13 | 
14 | <script>
15 | export default {};
16 | </script>
17 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/MajorVersionDeprecation.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="alert alert-warning deprecatedBanner">
 3 |     <p>
 4 |       You are currently looking at the documentation of a previous version of
 5 |       Kuzzle. We strongly recommend that you use the
 6 |       <a :href="`/core/${kuzzleLatestMajor}/guides/introduction/what-is-kuzzle/`">latest version</a>.
 7 |       You can also use the version selector in the top menu.
 8 |     </p>
 9 |   </div>
10 | </template>
11 | 
12 | <script>
13 | import { DEFAULT_VERSION } from "../helpers";
14 | 
15 | export default {
16 |   computed: {
17 |     kuzzleLatestMajor() {
18 |       return DEFAULT_VERSION;
19 |     },
20 |   },
21 | };
22 | </script>
23 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/MenuDropdown.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <span
 3 |     class="MenuDropdown"
 4 |     :class="{ active: isActive }"
 5 |     @mouseenter="isListVisible = true"
 6 |     @mouseleave="isListVisible = false"
 7 |   >
 8 |     <span class="MenuDropdown-title">
 9 |       {{ title }}
10 |       <font-awesome-icon icon="fa-solid fa-caret-down" size="xs" />
11 |     </span>
12 |     <ul class="MenuDropdown-list" :class="{ visible: isListVisible }">
13 |       <li v-for="item in items" class="MenuDropdown-list-item" :key="item.name">
14 |         <a
15 |           class="MenuDropdown-list-item-link"
16 |           :href="item.url"
17 |           :class="{ active: isItemActive(item.url) }"
18 |         >
19 |           {{ item.name }}
20 |         </a>
21 |       </li>
22 |     </ul>
23 |   </span>
24 | </template>
25 | 
26 | <script>
27 | import { usePageData } from 'vuepress/client';
28 | 
29 | export default {
30 |   props: {
31 |     items: {
32 |       type: Array,
33 |       required: true,
34 |       validator(items) {
35 |         for (const item of items) {
36 |           if (
37 |             !Object.keys(item).includes('name') ||
38 |             !Object.keys(item).includes('url')
39 |           ) {
40 |             return false;
41 |           }
42 |         }
43 | 
44 |         return true;
45 |       }
46 |     },
47 |     title: {
48 |       type: String,
49 |       required: true
50 |     }
51 |   },
52 |   data() {
53 |     return {
54 |       isListVisible: false
55 |     };
56 |   },
57 |   setup() {
58 |     return { page$: usePageData() };
59 |   },
60 |   computed: {
61 |     isActive() {
62 |       let isActive = false;
63 | 
64 |       for (const item of this.items) {
65 |         if (this.isItemActive(item.url)) {
66 |           isActive = true;
67 |         }
68 |       }
69 | 
70 |       return isActive;
71 |     }
72 |   },
73 |   methods: {
74 |     isItemActive(itemUrl) {
75 |       if (!this.page$ || !this.page$.fullPath) {
76 |         return false;
77 |       }
78 |       return this.page$.fullPath.startsWith(itemUrl);
79 |     }
80 |   }
81 | };
82 | </script>
83 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/ModulesIndex.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="Tiles">
 3 |     <a
 4 |       v-for="mod in modList"
 5 |       :key="mod.name + mod.version"
 6 |       :href="mod.path"
 7 |       class="Tiles-item"
 8 |     >
 9 |       <img :src="$withBase(mod.icon)" :alt="mod.name" class="Tiles-item-logo" />
10 |       <div class="Tiles-item-name">
11 |         {{ `${mod.name} v${mod.version}` }}
12 |       </div>
13 |     </a>
14 |   </div>
15 | </template>
16 | 
17 | <script>
18 | import { usePageData } from 'vuepress/client';
19 | 
20 | export default {
21 |   name: 'ModulesIndex',
22 |   methods: {},
23 |   props: {
24 |     kuzzleMajor: {
25 |       type: Number,
26 |       required: true,
27 |     },
28 |   },
29 |   computed: {
30 |     modList() {
31 |       return this.page$.sectionList
32 |         .filter(
33 |           (s) =>
34 |             s.kuzzleMajor === this.kuzzleMajor &&
35 |             s.section === 'modules' &&
36 |             s.subsection &&
37 |             // If we are deploying to the master branch, exclude the
38 |             // sections that are not released yet
39 |             (BRANCH === 'master' ? s.released === true : true)
40 |         )
41 |     },
42 |   },
43 |   setup() {
44 |     return { page$: usePageData() };
45 |   },
46 | };
47 | </script>
48 | 
49 | <style></style>
50 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/PluginsIndex.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div class="Tiles">
 3 |     <a
 4 |       v-for="plugin in pluginList"
 5 |       :key="plugin.name + plugin.version"
 6 |       :href="plugin.path"
 7 |       class="Tiles-item"
 8 |     >
 9 |       <img :src="$withBase(plugin.icon)" :alt="plugin.name" class="Tiles-item-logo" />
10 |       <div class="Tiles-item-name">
11 |         {{ `${plugin.name} v${plugin.version}` }}
12 |       </div>
13 |     </a>
14 |   </div>
15 | </template>
16 | 
17 | <script>
18 | import { usePageData } from 'vuepress/client';
19 | 
20 | import externalPlugins from '../external-plugins.json';
21 | 
22 | export default {
23 |   name: 'PluginsIndex',
24 |   methods: {},
25 |   props: {
26 |     kuzzleMajor: {
27 |       type: Number,
28 |       required: true,
29 |     },
30 |   },
31 |   computed: {
32 |     pluginList() {
33 |       return this.page$.sectionList
34 |         .filter(
35 |           (s) =>
36 |             s.kuzzleMajor === this.kuzzleMajor &&
37 |             s.section === 'official-plugins' &&
38 |             s.subsection &&
39 |             // If we are deploying to the master branch, exclude the
40 |             // sections that are not released yet
41 |             (BRANCH === 'master' ? s.released === true : true)
42 |         )
43 |         .concat(externalPlugins[this.kuzzleMajor]);
44 |     },
45 |   },
46 |   setup() {
47 |     return { page$: usePageData() };
48 |   },
49 | };
50 | </script>
51 | 
52 | <style></style>
53 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/Redirect.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>Redirecting...</div>
 3 | </template>
 4 | 
 5 | <script>
 6 | import { useRouter } from 'vuepress/client';
 7 | 
 8 | export default {
 9 |   name: 'redirect',
10 |   props: {
11 |     reload: {
12 |       type: Boolean,
13 |       default: false,
14 |     },
15 |     to: {
16 |       type: String,
17 |       required: true,
18 |     },
19 |   },
20 |   setup() {
21 |     return { router$: useRouter() };
22 |   },
23 |   mounted() {
24 |     let target = this.to;
25 |     if (!target.endsWith('/')) {
26 |       target += '/';
27 |     }
28 | 
29 |     if (!this.reload) {
30 |       this.router$
31 |         .push(target)
32 |         .then(() => {
33 |           console.log(`Redirected to ${target}`);
34 |         })
35 |         .catch((err) => {
36 |           if (err) {
37 |             // Nothing with the error
38 |           }
39 |         });
40 |     } else {
41 |       window.location.href = target;
42 |     }
43 |   },
44 | };
45 | </script>
46 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/RedirectLink.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <a :href="this.to">
 3 |     <slot />
 4 |   </a>
 5 | </template>
 6 | 
 7 | <script>
 8 | export default {
 9 |   name: 'RedirectLink',
10 |   props: {
11 |     to: {
12 |       type: String,
13 |       required: true,
14 |     },
15 |   }
16 | };
17 | </script>
18 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/RedirectToFirstChild.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <Redirect v-if="firstChild" :to="firstChild.path" />
 3 | </template>
 4 | 
 5 | <script>
 6 | import {
 7 |   resolveRoute,
 8 |   usePageData,
 9 |   useRoutes,
10 | } from 'vuepress/client';
11 | 
12 | import Redirect from './Redirect.vue';
13 | import { getFirstValidChild } from '../util';
14 | 
15 | export default {
16 |   name: 'RedirectToFirstChild',
17 |   components: {
18 |     Redirect
19 |   },
20 |   computed: {
21 |     firstChild() {
22 |       return getFirstValidChild(this.page$, this.pages);
23 |     },
24 |     pages() {
25 |       return Object.keys(this.routes$).map(resolveRoute);
26 |     },
27 |   },
28 |   setup() {
29 |     return {
30 |       page$: usePageData(),
31 |       routes$: useRoutes()
32 |     };
33 |   },
34 | };
35 | </script>
36 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/SDKIndex.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <div class="Tiles">
 4 |       <a
 5 |         v-for="sdk in sdkList"
 6 |         :key="sdk.name + sdk.version"
 7 |         :href="sdk.path"
 8 |         class="Tiles-item"
 9 |       >
10 |         <div class="ribbon" v-if="sdk.kuzzleMajor === 2 && sdk.deprecated"><span>Deprecated</span></div>
11 |         <img :src="$withBase(sdk.icon)" :alt="`${sdk.name} logo`" class="Tiles-item-logo" />
12 |         <div class="Tiles-item-name">{{ sdk.name }} v{{ sdk.version }}.x</div>
13 |       </a>
14 |     </div>
15 |     <div v-if="kuzzleMajor === 1">
16 |       <h3>Community SDKs</h3>
17 |       <span>the SDKs handcrafted by the community:</span>
18 | 
19 |       <div class="Tiles">
20 |         <a
21 |           href="https://github.com/kuzzleio/kuzzle_dart"
22 |           class="Tiles-item min"
23 |         >
24 |           <img :src="$withBase('/logos/dart.svg')" alt="dart logo" class="Tiles-item-logo" />
25 |           <div class="Tiles-item-name">Dart</div>
26 |         </a>
27 |         <a
28 |           href="https://github.com/alexandrebouthinon/kuzzle-sdk-rust"
29 |           class="Tiles-item min"
30 |         >
31 |           <img :src="$withBase('/logos/rust.svg')" alt="rust logo" class="Tiles-item-logo" />
32 |           <div class="Tiles-item-name">Rust</div>
33 |         </a>
34 |       </div>
35 |       <span>
36 |         Do not hesitate to contact us or come on our
37 |         <a href="http://join.discord.kuzzle.io" target="_blank">Discord chat</a>
38 |         to add your contribution to this list.
39 |       </span>
40 |     </div>
41 |   </div>
42 | </template>
43 | 
44 | <script>
45 | import { usePageData } from 'vuepress/client';
46 | 
47 | export default {
48 |   name: 'SDKIndex',
49 |   props: {
50 |     kuzzleMajor: {
51 |       type: Number,
52 |       required: true,
53 |     },
54 |   },
55 |   computed: {
56 |     sdkList() {
57 |       const sdks = this.page$.sectionList
58 |         .filter(s => s.kuzzleMajor === this.kuzzleMajor)
59 |         .filter(s => s.section === 'sdk')
60 |         .filter(s => s.subsection)
61 |         .filter(s => (BRANCH === 'master' ? s.released === true : true));
62 | 
63 |       const deprecatedSdks = sdks
64 |         .filter(s => s.deprecated)
65 | 
66 |       return sdks
67 |         .filter(s => !s.deprecated)
68 |         .concat(deprecatedSdks)
69 |     },
70 |   },
71 |   setup() {
72 |     return { page$: usePageData() };
73 |   },
74 | };
75 | </script>
76 | 
77 | <style>
78 | </style>
79 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/SDKSelector.vue:
--------------------------------------------------------------------------------
  1 | <template>
  2 |   <div class="selector" ref="selector" v-if="items.length">
  3 |     <div class="selector-selectedItem" @click="toggleList()">
  4 |       <img
  5 |         v-if="currentItem?.icon"
  6 |         class="selector-selectedItem-icon"
  7 |         :src="$withBase(currentItem.icon)"
  8 |         :alt="currentItem.name"
  9 |       />
 10 |       <img
 11 |         v-else
 12 |         class="selector-selectedItem-icon"
 13 |         :src="$withBase('/logo-57x57.png')"
 14 |         alt="Kuzzle logo"
 15 |       />
 16 |       <span v-if="currentItem" class="selector-selectedItem-name"
 17 |         >{{ currentItem.name }} v{{ currentItem.version }}.x</span
 18 |       >
 19 |       <font-awesome-icon icon="fa-solid fa-caret-down" size="xs" aria-hidden="true"/>
 20 |     </div>
 21 |     <ul
 22 |       :class="`selector-list selector-list-${showList ? 'opened' : 'closed'}`"
 23 |     >
 24 |       <li
 25 |         v-for="item in filteredItems"
 26 |         :key="`${item.name}.${item.version}`"
 27 |         @click="toggleList()"
 28 |       >
 29 |         <a
 30 |           :class="
 31 |             `selector-list-item-link ${item.subsection === 'api' ? 'api' : ''}`
 32 |           "
 33 |           :href="item.path"
 34 |         >
 35 |           <img
 36 |             v-if="item.subsection !== 'api'"
 37 |             class="selector-list-item-icon"
 38 |             :src="$withBase(item.icon)"
 39 |             :alt="item.name"
 40 |           />
 41 |           <span
 42 |             :class="
 43 |               `selector-list-item-name${
 44 |                 item.subsection === 'api' ? '-api' : ''
 45 |               }`
 46 |             "
 47 |             >{{ item.name }} v{{ item.version }}.x</span
 48 |           >
 49 |         </a>
 50 |       </li>
 51 |     </ul>
 52 |   </div>
 53 | </template>
 54 | 
 55 | <script>
 56 | import { usePageData } from 'vuepress/client';
 57 | 
 58 | export default {
 59 |   name: 'SDKSelector',
 60 |   props: {
 61 |     items: { type: Array, required: true },
 62 |     kuzzleMajor: { type: Number, required: true }
 63 |   },
 64 |   data() {
 65 |     return {
 66 |       showList: false
 67 |     };
 68 |   },
 69 |   computed: {
 70 |     currentText() {
 71 |       return this.currentItem ? this.currentItem.name : 'Select SDK or API';
 72 |     },
 73 |     filteredItems() {
 74 |       return this.items.filter(item => item !== this.currentItem && item.icon !== undefined);
 75 |     },
 76 |     currentItem() {
 77 |       return this.items.find(i => this.page$.fullPath.startsWith(i.path));
 78 |     }
 79 |   },
 80 |   methods: {
 81 |     toggleList: function() {
 82 |       this.showList = !this.showList;
 83 |     },
 84 |     onClickOutside: function(e) {
 85 |       const el = this.$refs.selector,
 86 |         target = e.target;
 87 | 
 88 |       if (el && el !== target && !el.contains(target)) {
 89 |         this.showList = false;
 90 |       }
 91 |     }
 92 |   },
 93 |   setup() {
 94 |     return { page$: usePageData() };
 95 |   },
 96 |   mounted() {
 97 |     document.addEventListener('click', this.onClickOutside);
 98 |   }
 99 | };
100 | </script>
101 | 
102 | <style lang="sass" scoped></style>
103 | 


--------------------------------------------------------------------------------
/src/.vuepress/components/SinceBadge.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <details v-if="$slots.default">
 4 |       <summary><Badge type="warning" :text="`Available since ${version}`"/></summary>
 5 |       <slot></slot>
 6 |     </details>
 7 |     <Badge v-else type="warning" :text="`Available since ${version}`"/>
 8 |   </div>
 9 | </template>
10 | <script>
11 | 
12 | import Badge from './Badge.vue';
13 | 
14 | export default {
15 |   name: 'SinceBadge',
16 |   components: {
17 |     Badge
18 |   },
19 |   props: {
20 |     version: {
21 |       type: String,
22 |       required: true
23 |     }
24 |   }
25 | };
26 | </script>
27 | 
28 | <style>
29 | </style>
30 | 


--------------------------------------------------------------------------------
/src/.vuepress/external-plugins.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "1": [
 3 |     {
 4 |       "name": "Prometheus",
 5 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-prometheus/tree/1-stable",
 6 |       "version": "1",
 7 |       "icon": "/logos/plugin-prometheus.svg",
 8 |       "iconAlt": "prometheus logo"
 9 |     },
10 |     {
11 |       "name": "Passport local",
12 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/tree/5-stable",
13 |       "version": "5",
14 |       "icon": "/logos/passport.svg",
15 |       "iconAlt": "Passport local logo"
16 |     },
17 |     {
18 |       "name": "Passport OAuth",
19 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth/tree/4-stable",
20 |       "version": "4",
21 |       "icon": "/logos/passport.svg",
22 |       "iconAlt": "Passport oauth logo"
23 |     },
24 |     {
25 |       "name": "Cluster",
26 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-cluster/tree/3-stable",
27 |       "version": "3",
28 |       "icon": "/logos/cluster.svg",
29 |       "iconAlt": "cluster logo"
30 |     },
31 |     {
32 |       "name": "Computed fields",
33 |       "path": "https://github.com/kuzzleio/computed-fields-plugin",
34 |       "version": "1",
35 |       "icon": "/logos/computed.svg",
36 |       "iconAlt": "computed fields logo"
37 |     },
38 |     {
39 |       "name": "Logger",
40 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-logger/tree/2-stable",
41 |       "version": "2",
42 |       "icon": "/logos/logger.svg",
43 |       "iconAlt": "logger logo"
44 |     },
45 |     {
46 |       "name": "Probe",
47 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-probe",
48 |       "version": "1",
49 |       "icon": "/logos/probe.svg",
50 |       "iconAlt": "probe logo"
51 |     },
52 |     {
53 |       "name": "Probe listener",
54 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-probe-listener",
55 |       "version": "1",
56 |       "icon": "/logos/probe.svg",
57 |       "iconAlt": "probe listener logo"
58 |     }
59 |   ],
60 |   "2": [
61 |     {
62 |       "name": "Prometheus",
63 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-prometheus",
64 |       "version": "2",
65 |       "icon": "/logos/plugin-prometheus.svg",
66 |       "iconAlt": "prometheus logo"
67 |     },
68 |     {
69 |       "name": "Passport OAuth",
70 |       "path": "https://github.com/kuzzleio/kuzzle-plugin-auth-passport-oauth",
71 |       "version": "6",
72 |       "icon": "/logos/passport.svg",
73 |       "iconAlt": "Passport oauth logo"
74 |     }
75 |   ]
76 | }
77 | 


--------------------------------------------------------------------------------
/src/.vuepress/frontmatter-in-route-meta/index.ts:
--------------------------------------------------------------------------------
1 | export * from './plugin';
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/frontmatter-in-route-meta/plugin.ts:
--------------------------------------------------------------------------------
 1 | import { PluginFunction } from 'vuepress';
 2 | 
 3 | export const PLUGIN_NAME = '@kuzzleio/vuepress-plugin-frontmatter-in-route-meta';
 4 | 
 5 | export const frontmatterInRouteMetaPlugin =
 6 |   (): PluginFunction =>
 7 |   () => {
 8 |     return {
 9 |       name: PLUGIN_NAME,
10 |       extendsPage: (page) => {
11 |         page.routeMeta.frontmatter = page.frontmatter;
12 |       },
13 |     };
14 |   }
15 | 


--------------------------------------------------------------------------------
/src/.vuepress/frontmatter-lint/append-fixes.ts:
--------------------------------------------------------------------------------
 1 | import { path } from '@vuepress/utils';
 2 | import { assign, endsWith, mapValues } from 'lodash-es';
 3 | import { App, Page } from "vuepress";
 4 | 
 5 | import { LintError, MissingKeyLintError } from "./types";
 6 | 
 7 | const codeRE = /api-reference\/.+|protocols\/context\/|protocols\/entrypoint\/|protocols\/methods\/|plugins\/events\/.+|plugin-context|controllers\/.+|core-classes\/.+|virtual-classes\/.+|sdk\/.+\/protocols\/.+|core-structs\/.+|sdk\/.+\/classes\/.+/;
 8 | 
 9 | function computeMissingKeyFix(url: string, error: MissingKeyLintError, nodes: Page[]) {
10 |   const node = getNodeByPath(url, nodes);
11 | 
12 |   if (!node) {
13 |     return;
14 |   }
15 | 
16 |   if (error.key === 'code') {
17 |     if (codeRE.test(node.path)) {
18 |       return {
19 |         code: true
20 |       };
21 |     } else {
22 |       return {
23 |         code: false
24 |       };
25 |     }
26 |   }
27 | 
28 |   if (error.key === 'type') {
29 |     const children = getChildren(node, nodes);
30 |     if (children.length) {
31 |       if (
32 |         node.frontmatter.type !== 'branch' &&
33 |         node.frontmatter.type !== 'root'
34 |       ) {
35 |         return { type: 'branch' };
36 |       }
37 |     } else {
38 |       if (node.frontmatter.type !== 'page') {
39 |         return { type: 'page' };
40 |       }
41 |     }
42 |   }
43 | }
44 | 
45 | function getChildren(node: Page, nodes: Page[]) {
46 |   const pathRE = new RegExp(`^${getNodeDirectory(node)}[a-zA-z_0-9\-]+/?$`);
47 |   return nodes.filter(p => p.path.match(pathRE) && p.path !== node.path);
48 | }
49 | 
50 | function getNodeDirectory(node: Page) {
51 |   if (endsWith(node.path, '/')) {
52 |     return node.path;
53 |   } else {
54 |     return path.parse(node.path).dir;
55 |   }
56 | }
57 | 
58 | function getNodeByPath(path: string, nodes: Page[]) {
59 |   return nodes.find(p => p.path === path);
60 | }
61 | 
62 | export function appendFixes(errorsByPath: Record<string, LintError[]>, ctx: App) {
63 |   return mapValues(errorsByPath, (errors, url) => {
64 |     return errors.map(e => {
65 |       if (e.error !== 'MISSING_KEY') {
66 |         return e;
67 |       }
68 | 
69 |       const fix = computeMissingKeyFix(url, e, ctx.pages);
70 |       if (fix) {
71 |         return assign({ fix }, e);
72 |       } else {
73 |         return e;
74 |       }
75 |     });
76 |   });
77 | }
78 | 


--------------------------------------------------------------------------------
/src/.vuepress/frontmatter-lint/index.ts:
--------------------------------------------------------------------------------
1 | export * from './plugin';
2 | export * from './types';
3 | 


--------------------------------------------------------------------------------
/src/.vuepress/frontmatter-lint/types.ts:
--------------------------------------------------------------------------------
 1 | export type CommonSpec = {
 2 |   required: boolean;
 3 | };
 4 | 
 5 | export type StringSpec = {
 6 |   type: 'string';
 7 |   allowedValues?: string[];
 8 | };
 9 | 
10 | export type NumberSpec = {
11 |   type: 'number';
12 | };
13 | 
14 | export type BooleanSpec = {
15 |   type: 'boolean';
16 | };
17 | 
18 | export type ArraySpec = {
19 |   type: 'array';
20 | };
21 | 
22 | export type Spec = CommonSpec & (StringSpec | NumberSpec | BooleanSpec | ArraySpec);
23 | 
24 | export type FrontmatterLintPluginOptions = {
25 |   abortBuild: boolean;
26 |   exclude?: string[];
27 |   dumpFile?: string;
28 |   dumpToFile: boolean;
29 |   specs: Record<string, Spec>;
30 | };
31 | 
32 | export type MissingKeyLintError = {
33 |   error: 'MISSING_KEY';
34 |   key: string;
35 | };
36 | 
37 | export type EmptyKeyLintError = {
38 |   error: 'EMPTY_KEY';
39 | };
40 | 
41 | export type InvalidKeyLintError = {
42 |   error: 'INVALID_KEY';
43 |   key: string;
44 | };
45 | 
46 | export type EmptyValueLintError = {
47 |   error: 'EMPTY_VALUE';
48 |   key: string;
49 | };
50 | 
51 | export type InvalidTypeLintError = {
52 |   error: 'INVALID_TYPE';
53 |   key: string;
54 |   expected: string;
55 |   got: string;
56 | };
57 | 
58 | export type InvalidValueLintError = {
59 |   error: 'INVALID_VALUE';
60 |   key: string;
61 |   expected: string;
62 |   got: string;
63 | };
64 | 
65 | export type LintError =
66 |   | MissingKeyLintError
67 |   | EmptyKeyLintError
68 |   | InvalidKeyLintError
69 |   | EmptyValueLintError
70 |   | InvalidTypeLintError
71 |   | InvalidValueLintError;
72 | 


--------------------------------------------------------------------------------
/src/.vuepress/getVersionString.ts:
--------------------------------------------------------------------------------
1 | let version = 'local-build'
2 | 
3 | if (process.env.CI) {
4 |   version = `${process.env.TRAVIS_REPO_SLUG}:${process.env.TRAVIS_BRANCH}@${process.env.TRAVIS_COMMIT}--job:${process.env.TRAVIS_JOB_WEB_URL}`;
5 | }
6 | 
7 | export default version;
8 | 


--------------------------------------------------------------------------------
/src/.vuepress/helpers.ts:
--------------------------------------------------------------------------------
 1 | import { PageData } from "vuepress";
 2 | 
 3 | import { ExtraPageData } from "./page-attributes";
 4 | 
 5 | export const VERSION_QUERY_KEY = 'version';
 6 | export const DEFAULT_VERSION = 2;
 7 | 
 8 | export const getCurrentVersion = (page: PageData<ExtraPageData>) => {
 9 |   if (!page.currentSection) {
10 |     return DEFAULT_VERSION;
11 |   }
12 | 
13 |   return page.currentSection.kuzzleMajor;
14 | };
15 | 
16 | export const createMetaTag = (property: string, content: string) => {
17 |   const meta = document.createElement('meta');
18 |   meta.setAttribute('property', property);
19 |   meta.setAttribute('content', content);
20 | 
21 |   return meta;
22 | };
23 | 


--------------------------------------------------------------------------------
/src/.vuepress/markdown/index.ts:
--------------------------------------------------------------------------------
1 | export * from './plugin';
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/markdown/plugin.ts:
--------------------------------------------------------------------------------
 1 | import { Logger } from '@vuepress/helper';
 2 | import { PluginFunction } from 'vuepress';
 3 | 
 4 | import codeSnippet from './code-snippet';
 5 | 
 6 | export const PLUGIN_NAME = '@kuzzleio/vuepress-plugin-markdown';
 7 | const logger = new Logger(PLUGIN_NAME);
 8 | 
 9 | export const markdownPlugin =
10 |   (): PluginFunction =>
11 |   (app) => {
12 |     return {
13 |       name: PLUGIN_NAME,
14 |       extendsMarkdown: (md) => {
15 |         md.use(codeSnippet, {
16 |           docsDir: app.dir.source(),
17 |           logger,
18 |         });
19 |       },
20 |     };
21 |   }
22 | 


--------------------------------------------------------------------------------
/src/.vuepress/meta-tags-plugin/client.ts:
--------------------------------------------------------------------------------
 1 | import { onMounted } from 'vue';
 2 | import { defineClientConfig, usePageData } from 'vuepress/client';
 3 | 
 4 | import { DEFAULT_VERSION, createMetaTag } from '../helpers';
 5 | import { ExtraPageData } from '../page-attributes';
 6 | 
 7 | export default defineClientConfig({
 8 |   setup() {
 9 |     onMounted(() => {
10 |       const pageData = usePageData<ExtraPageData>();
11 |       const head = document.head;
12 | 
13 |       head.appendChild(createMetaTag('article:tag', pageData.value.title));
14 |       head.appendChild(createMetaTag('og:title', pageData.value.title));
15 |       head.appendChild(createMetaTag('og:url', document.URL));
16 |       head.appendChild(
17 |         createMetaTag(
18 |           'og:description',
19 |           pageData.value.frontmatter.description || this.$site?.description
20 |         )
21 |       );
22 | 
23 |       if (pageData.value.currentSection) {
24 |         head.appendChild(
25 |           createMetaTag('article:section', pageData.value.currentSection.name)
26 |         );
27 | 
28 |         if (pageData.value.currentSection.kuzzleMajor < DEFAULT_VERSION) {
29 |           head.appendChild(createMetaTag('robot', 'noindex'));
30 |         }
31 |       }
32 |     })
33 |   },
34 | });
35 | 


--------------------------------------------------------------------------------
/src/.vuepress/meta-tags-plugin/index.ts:
--------------------------------------------------------------------------------
1 | export * from './plugin';
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/meta-tags-plugin/plugin.ts:
--------------------------------------------------------------------------------
 1 | import { PluginFunction } from 'vuepress';
 2 | import { getDirname, path } from 'vuepress/utils';
 3 | 
 4 | const __dirname = getDirname(import.meta.url);
 5 | 
 6 | export const PLUGIN_NAME = '@kuzzleio/vuepress-plugin-meta-tags';
 7 | 
 8 | export const metaTagsPlugin =
 9 |   (): PluginFunction =>
10 |   () => {
11 |     return {
12 |       name: PLUGIN_NAME,
13 |       clientConfigFile: path.resolve(__dirname, './client.ts'),
14 |     }
15 |   }
16 | 


--------------------------------------------------------------------------------
/src/.vuepress/page-attributes/index.ts:
--------------------------------------------------------------------------------
1 | export * from './plugin';
2 | export * from './types';
3 | 


--------------------------------------------------------------------------------
/src/.vuepress/page-attributes/plugin.ts:
--------------------------------------------------------------------------------
 1 | import { transform } from 'lodash-es';
 2 | import { Page, PluginFunction } from 'vuepress';
 3 | 
 4 | import {
 5 |   ExtraPageData,
 6 |   PageAttributesPluginOptions,
 7 |   PageAttributesSection,
 8 |   PageAttributesSectionWithPath,
 9 |  } from './types';
10 | 
11 | export const PLUGIN_NAME = '@kuzzleio/vuepress-plugin-page-attributes';
12 | 
13 | export const pageAttributesPlugin =
14 |   ({ sections }: PageAttributesPluginOptions): PluginFunction =>
15 |   (app) => {
16 |     return {
17 |       name: PLUGIN_NAME,
18 |       extendsPage: (page: Page<Partial<ExtraPageData>>) => {
19 |         const fullPath = `${app.siteData.base}${page.path}`.replace('//', '/');
20 |         page.data.fullPath = fullPath;
21 | 
22 |         page.data.sectionsByPath = sections;
23 |         page.data.sectionList = transform<PageAttributesSection, PageAttributesSectionWithPath[]>(
24 |           sections,
25 |           (result, value, key) => {
26 |             result.push({ ...value, path: key });
27 |           },
28 |           []
29 |         );
30 |         page.data.currentSection = page.data.sectionList.find(s => fullPath.startsWith(s.path))
31 |       },
32 |     };
33 |   }
34 | 


--------------------------------------------------------------------------------
/src/.vuepress/page-attributes/types.ts:
--------------------------------------------------------------------------------
 1 | export type PageAttributesSection = {
 2 |   name: string;
 3 |   version?: number;
 4 |   kuzzleMajor: number;
 5 |   section: string;
 6 |   subsection?: string;
 7 |   icon?: string;
 8 |   released: boolean;
 9 |   deprecated?: boolean;
10 |   closedSources?: boolean;
11 |   deprecatedBannerComponent?: string;
12 | };
13 | 
14 | export type PageAttributesSectionWithPath = PageAttributesSection & { path: string };
15 | 
16 | export type PageAttributesPluginOptions = {
17 |   sections: Record<string, PageAttributesSection>;
18 | };
19 | 
20 | export type ExtraPageData = {
21 |   fullPath: string;
22 |   sectionsByPath: Record<string, PageAttributesSection>;
23 |   sectionList: PageAttributesSectionWithPath[];
24 |   currentSection: PageAttributesSectionWithPath;
25 | };
26 | 


--------------------------------------------------------------------------------
/src/.vuepress/public/demo_aws_console.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/demo_aws_console.gif


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-114x114.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-114x114.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-120x120.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-120x120.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-144x144.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-152x152.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-152x152.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-57x57.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-57x57.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-60x60.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-60x60.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-72x72.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-72x72.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/apple-touch-icon-76x76.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/apple-touch-icon-76x76.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon-128.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon-128.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon-16x16.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon-196x196.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon-196x196.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon-32x32.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon-96x96.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon-96x96.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/favicon.ico


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/mstile-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/mstile-144x144.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/mstile-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/mstile-150x150.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/mstile-310x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/mstile-310x150.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/mstile-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/mstile-310x310.png


--------------------------------------------------------------------------------
/src/.vuepress/public/favicon/mstile-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/favicon/mstile-70x70.png


--------------------------------------------------------------------------------
/src/.vuepress/public/geolocation/geoBoundingBox.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/geolocation/geoBoundingBox.png


--------------------------------------------------------------------------------
/src/.vuepress/public/geolocation/geoDistance.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/geolocation/geoDistance.png


--------------------------------------------------------------------------------
/src/.vuepress/public/geolocation/geoDistanceRange.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/geolocation/geoDistanceRange.png


--------------------------------------------------------------------------------
/src/.vuepress/public/geolocation/geoPolygon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/geolocation/geoPolygon.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logo-57x57.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logo-57x57.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logo-min.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logo-min.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/android.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/android.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/android.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg2" version="1.1" viewBox="0 0 128 128"><metadata id="metadata10"/><path id="path4" fill="#002835" fill-opacity="1" d="M21.005 43.003c-4.053-.002-7.338 3.291-7.339 7.341l.005 30.736c.001 4.064 3.288 7.344 7.342 7.343 4.056 0 7.342-3.28 7.338-7.342v-30.741c-.002-4.049-3.291-7.339-7.346-7.337m59.193-27.602l5.123-9.355c.273-.489.094-1.111-.401-1.388-.5-.265-1.117-.085-1.382.407l-5.175 9.453c-4.354-1.938-9.227-3.024-14.383-3.019-5.142-.005-10.013 1.078-14.349 3.005l-5.181-9.429c-.269-.497-.889-.677-1.378-.406-.498.269-.681.892-.404 1.38l5.125 9.349c-10.07 5.193-16.874 15.083-16.868 26.438l66.118-.008c.002-11.351-6.79-21.221-16.845-26.427m-31.256 14.457c-1.521-.003-2.763-1.241-2.763-2.771 0-1.523 1.238-2.775 2.766-2.774 1.533-.001 2.773 1.251 2.775 2.774 0 1.528-1.243 2.77-2.778 2.771m30.106-.005c-1.528.002-2.772-1.237-2.772-2.771.006-1.52 1.242-2.772 2.773-2.778 1.521.005 2.768 1.258 2.767 2.779.003 1.53-1.24 2.771-2.768 2.77m-47.853 14.537l.011 47.635c-.003 4.333 3.502 7.831 7.832 7.831l5.333.002.006 16.264c-.001 4.05 3.291 7.342 7.335 7.342 4.056 0 7.342-3.295 7.343-7.347l-.004-16.26 9.909-.003.004 16.263c0 4.047 3.293 7.346 7.338 7.338 4.056.003 7.344-3.292 7.343-7.344l-.005-16.259 5.352-.004c4.32.002 7.834-3.5 7.836-7.834l-.009-47.635-65.624.011zm83.134 5.943c-.001-4.055-3.286-7.341-7.341-7.339-4.053-.004-7.337 3.287-7.337 7.342l.006 30.738c-.001 4.058 3.283 7.338 7.339 7.339 4.054-.001 7.337-3.281 7.338-7.343l-.005-30.737z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/book.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-book fa-w-14" data-icon="book" data-prefix="fas" focusable="false" role="img" viewBox="0 0 448 512"><path fill="#002835" d="M448 360V24c0-13.3-10.7-24-24-24H96C43 0 0 43 0 96v320c0 53 43 96 96 96h328c13.3 0 24-10.7 24-24v-16c0-7.5-3.5-14.3-8.9-18.7-4.2-15.4-4.2-59.3 0-74.7 5.4-4.3 8.9-11.1 8.9-18.6zM128 134c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm0 64c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm253.4 250H96c-17.7 0-32-14.3-32-32 0-17.6 14.4-32 32-32h285.4c-1.9 17.1-1.9 46.9 0 64z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/computed.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="628" height="400pt" version="1.1" viewBox="0 0 471 400"><g id="surface1"><path fill="#000" fill-opacity="1" fill-rule="nonzero" stroke="none" d="M 327.082031 0 L 90.234375 0 C 74.332031 0 61.382812 11.003906 61.382812 24.507812 L 61.382812 375.136719 C 61.382812 388.660156 74.332031 399.648438 90.234375 399.648438 L 380.351562 399.648438 C 396.265625 399.648438 409.203125 388.660156 409.203125 375.136719 L 409.203125 75.78125 Z M 333.890625 36.675781 L 369.886719 69.898438 L 333.890625 69.898438 Z M 384.972656 375.136719 C 384.972656 377.296875 382.890625 379.066406 380.335938 379.066406 L 90.234375 379.066406 C 87.683594 379.066406 85.613281 377.296875 85.613281 375.136719 L 85.613281 24.507812 C 85.613281 22.34375 87.683594 20.589844 90.234375 20.589844 L 309.644531 20.589844 L 309.644531 80.191406 C 309.644531 85.867188 315.089844 90.46875 321.773438 90.46875 L 384.972656 90.46875 Z M 128.363281 109.460938 L 334.148438 109.460938 C 339.164062 109.460938 343.230469 112.914062 343.230469 117.171875 C 343.230469 121.429688 339.164062 124.882812 334.148438 124.882812 L 128.363281 124.882812 C 123.351562 124.882812 119.285156 121.429688 119.285156 117.171875 C 119.285156 112.914062 123.351562 109.460938 128.363281 109.460938 Z M 343.230469 168.984375 C 343.230469 173.242188 339.164062 176.695312 334.148438 176.695312 L 128.363281 176.695312 C 123.351562 176.695312 119.285156 173.242188 119.285156 168.984375 C 119.285156 164.726562 123.351562 161.273438 128.363281 161.273438 L 334.148438 161.273438 C 339.164062 161.273438 343.230469 164.730469 343.230469 168.984375 Z M 343.230469 219.101562 C 343.230469 223.359375 339.164062 226.8125 334.148438 226.8125 L 128.363281 226.8125 C 123.351562 226.8125 119.285156 223.359375 119.285156 219.101562 C 119.285156 214.84375 123.351562 211.390625 128.363281 211.390625 L 334.148438 211.390625 C 339.164062 211.390625 343.230469 214.84375 343.230469 219.101562 Z M 343.230469 270.074219 C 343.230469 274.332031 339.164062 277.785156 334.148438 277.785156 L 128.363281 277.785156 C 123.351562 277.785156 119.285156 274.332031 119.285156 270.074219 C 119.285156 265.816406 123.351562 262.363281 128.363281 262.363281 L 334.148438 262.363281 C 339.164062 262.363281 343.230469 265.816406 343.230469 270.074219 Z M 343.230469 270.074219"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/cpp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/cpp.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/cpp.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg3384" version="1.1" viewBox="0 0 128 128"><metadata id="metadata3392"/><path id="path3386" fill="#002835" fill-opacity="1" d="m 117.5,33.5 v 0 c -0.6,-1.1 -1.2,-2.3 -2.1,-2.8 L 67.1,2.9 C 66.3,2.4 65.2,2.2 64,2.2 c -1.2,0 -2.3,0.3 -3.1,0.7 l -48,27.9 c -1.7,1 -2.9,3.5 -2.9,5.4 v 55.7 c 0,1.1 0,2.4 0.7,3.5 v 0 c 0.5,0.8 1.2,1.5 1.9,1.9 l 48.2,27.9 c 0.8,0.5 1.9,0.7 3.1,0.7 1.2,0 2.3,-0.3 3.1,-0.7 l 48,-27.9 c 1.7,-1 2.9,-3.5 2.9,-5.4 V 36.1 c 0.1,-0.8 0,-1.7 -0.4,-2.6 z M 82,66 v -4 h 5 v -5 h 5 v 5 h 5 v 4 h -5 v 5 H 87 V 66 Z M 85.3,52 C 81.1,44.5 73.1,39.5 64,39.5 c -13.5,0 -24.5,11 -24.5,24.5 0,13.5 11,24.5 24.5,24.5 9.1,0 17.1,-5 21.3,-12.4 l 12.9,7.6 C 91.4,95.5 78.6,103.5 64,103.5 42.2,103.5 24.5,85.8 24.5,64 24.5,42.2 42.2,24.5 64,24.5 c 14.7,0 27.5,8.1 34.3,20 z M 115,66 h -5 v 5 h -4 v -5 h -6 v -4 h 6 v -5 h 4 v 5 h 5 z"/><path id="path6330" fill="#ea2d2e" d="m 185.36756,96.11972 c -19.192,5.362 11.677,16.439 36.115,5.969 -4.003,-1.556 -6.874,-3.351 -6.874,-3.351 -10.897,2.06 -15.952,2.222 -25.844,1.092 -8.164,-0.935 -3.397,-3.71 -3.397,-3.71 z m 33.189,-10.46 c -14.444,2.779 -22.787,2.69 -33.354,1.6 -8.171,-0.845 -2.822,-4.805 -2.822,-4.805 -21.137,7.016 11.767,14.977 41.309,6.336 -3.14,-1.106 -5.133,-3.131 -5.133,-3.131 z m 11.319,-60.575 c 0.001,0 -42.731,10.669 -22.323,34.187 6.024,6.935 -1.58,13.17 -1.58,13.17 0,0 15.289,-7.891 8.269,-17.777 -6.559,-9.215 -11.587,-13.793 15.634,-29.58 z m 9.998,81.144 c 0,0 3.529,2.91 -3.888,5.159 -14.102,4.272 -58.706,5.56 -71.095,0.171 -4.45,-1.938 3.899,-4.625 6.526,-5.192 2.739,-0.593 4.303,-0.485 4.303,-0.485 -4.952,-3.487 -32.013,6.85 -13.742,9.815 49.821,8.076 90.817,-3.637 77.896,-9.468 z m -17.123,-30.333 c 2.395,-1.634 5.703,-3.053 5.703,-3.053 0,0 -9.424,1.685 -18.813,2.474 -11.494,0.964 -23.823,1.154 -30.012,0.326 -14.652,-1.959 8.033,-7.348 8.033,-7.348 0,0 -8.812,-0.596 -19.644,4.644 -12.812,6.195 31.691,9.019 54.733,2.957 z m 5.609,15.145 c -0.108,0.29 -0.468,0.616 -0.468,0.616 31.273,-8.221 19.775,-28.979 4.822,-23.725 -1.312,0.464 -2,1.543 -2,1.543 0,0 0.829,-0.334 2.678,-0.72 7.559,-1.575 18.389,10.119 -5.032,22.286 z m -26.428,-22.972 c -4.614,-10.429 -20.26,-19.553 0.007,-35.559 25.271,-19.947 12.304,-32.9229998 12.304,-32.9229998 5.23,20.6079998 -18.451,26.8329998 -26.999,39.6669998 -5.821,8.745 2.857,18.142 14.688,28.815 z m 27.274,51.748 c -19.187,3.612 -42.854,3.191 -56.887,0.874 0,0 2.874,2.38 17.646,3.331 22.476,1.437 57,-0.8 57.816,-11.436 0.001,0 -1.57,4.032 -18.575,7.231 z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/csharp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/csharp.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/csharp.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg2" version="1.1" viewBox="0 0 128 128"><metadata id="metadata12"/><g id="g4" fill="#68217A"><path id="path6" fill="#002835" fill-opacity="1" d="M117.5 33.5l.3-.2c-.6-1.1-1.5-2.1-2.4-2.6l-48.3-27.8c-.8-.5-1.9-.7-3.1-.7-1.2 0-2.3.3-3.1.7l-48 27.9c-1.7 1-2.9 3.5-2.9 5.4v55.7c0 1.1.2 2.3.9 3.4l-.2.1c.5.8 1.2 1.5 1.9 1.9l48.2 27.9c.8.5 1.9.7 3.1.7 1.2 0 2.3-.3 3.1-.7l48-27.9c1.7-1 2.9-3.5 2.9-5.4v-55.8c.1-.8 0-1.7-.4-2.6zm-53.5 70c-21.8 0-39.5-17.7-39.5-39.5s17.7-39.5 39.5-39.5c14.7 0 27.5 8.1 34.3 20l-13 7.5c-4.2-7.5-12.2-12.5-21.3-12.5-13.5 0-24.5 11-24.5 24.5s11 24.5 24.5 24.5c9.1 0 17.1-5 21.3-12.4l12.9 7.6c-6.8 11.8-19.6 19.8-34.2 19.8zm51-41.5h-3.2l-.9 4h4.1v5h-5l-1.2 6h-4.9l1.2-6h-3.8l-1.2 6h-4.8l1.2-6h-2.5v-5h3.5l.9-4h-4.4v-5h5.3l1.2-6h4.9l-1.2 6h3.8l1.2-6h4.8l-1.2 6h2.2v5zM102.3 66h3.8l.9-4h-3.8z"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/dart.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="Layer_1" width="110.5" height="110.5" x="0" y="0" enable-background="new 188 251.8 415.8 110.5" version="1.1" viewBox="188 251.8 110.5 110.5" xml:space="preserve"><metadata id="metadata4608"/><path id="path4591" fill="#002835" fill-opacity="1" stroke="#eefbff" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width=".1" d="m 217.7,281.7 -7.1,-7.1 v 51.2 l 0.1,2.4 c 0,1.1 0.2,2.4 0.6,3.7 l 56.2,19.8 14,-6.2 v 0 z"/><path id="path4593" fill="#002835" fill-opacity="1" stroke="#000" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width=".1" d="m 211.3,331.9 v 0 c 0,0 0,0 0,0 0,0 0,0 0,0 z m 70.2,13.6 -14,6.2 -56.1,-19.8 c 1.1,4.1 3.4,8.7 6,11.3 l 18.3,18.2 40.8,0.1 z"/><path id="path4595" fill="#002835" fill-opacity="1" stroke="#eefbff" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width="1" d="m 210.8,274.6 -21.8,33 c -1.8,1.9 -0.9,5.9 2,8.9 l 12.6,12.7 7.9,2.8 c -0.3,-1.3 -0.6,-2.6 -0.6,-3.7 l -0.1,-2.4 z"/><path id="path4597" fill="#002835" fill-opacity="1" stroke="#eefbff" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width=".1" d="m 267.9,275.2 c -1.3,-0.3 -2.6,-0.5 -3.7,-0.6 l -2.5,-0.1 h -51.1 l 70.9,70.9 v 0 l 6.2,-14 z"/><path id="path4599" fill="#002835" fill-opacity="1" stroke="#000" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width=".1" d="m 267.8,275.2 c 0.1,0 0.1,0 0,0 v 0 c 0.1,0 0.1,0 0,0 z m 11.4,6 c -2.6,-2.6 -7.1,-5 -11.3,-6 l 19.8,56.2 -6.2,14 v 0 l 15.2,-4.9 v -41.7 z"/><path id="path4601" fill="#002835" fill-opacity="1" stroke="#eefbff" stroke-dasharray="none" stroke-miterlimit="4" stroke-opacity="1" stroke-width="1" d="m 265.1,267.4 -12.7,-12.6 c -2.9,-2.9 -6.9,-3.8 -8.9,-2 l -33,21.8 h 51.1 l 2.5,0.1 c 1.1,0 2.4,0.2 3.7,0.6 z" display="inline"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/device-manager.svg:
--------------------------------------------------------------------------------
1 | <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="microchip" class="svg-inline--fa fa-microchip fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="#002835" d="M416 48v416c0 26.51-21.49 48-48 48H144c-26.51 0-48-21.49-48-48V48c0-26.51 21.49-48 48-48h224c26.51 0 48 21.49 48 48zm96 58v12a6 6 0 0 1-6 6h-18v6a6 6 0 0 1-6 6h-42V88h42a6 6 0 0 1 6 6v6h18a6 6 0 0 1 6 6zm0 96v12a6 6 0 0 1-6 6h-18v6a6 6 0 0 1-6 6h-42v-48h42a6 6 0 0 1 6 6v6h18a6 6 0 0 1 6 6zm0 96v12a6 6 0 0 1-6 6h-18v6a6 6 0 0 1-6 6h-42v-48h42a6 6 0 0 1 6 6v6h18a6 6 0 0 1 6 6zm0 96v12a6 6 0 0 1-6 6h-18v6a6 6 0 0 1-6 6h-42v-48h42a6 6 0 0 1 6 6v6h18a6 6 0 0 1 6 6zM30 376h42v48H30a6 6 0 0 1-6-6v-6H6a6 6 0 0 1-6-6v-12a6 6 0 0 1 6-6h18v-6a6 6 0 0 1 6-6zm0-96h42v48H30a6 6 0 0 1-6-6v-6H6a6 6 0 0 1-6-6v-12a6 6 0 0 1 6-6h18v-6a6 6 0 0 1 6-6zm0-96h42v48H30a6 6 0 0 1-6-6v-6H6a6 6 0 0 1-6-6v-12a6 6 0 0 1 6-6h18v-6a6 6 0 0 1 6-6zm0-96h42v48H30a6 6 0 0 1-6-6v-6H6a6 6 0 0 1-6-6v-12a6 6 0 0 1 6-6h18v-6a6 6 0 0 1 6-6z"></path></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/discord.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/discord.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/go.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/go.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/go.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg8" width="300" height="300" version="1.1" viewBox="0 0 79.375 79.375"><metadata id="metadata5"/><g id="layer1" display="inline" transform="translate(0,-217.625)"><g id="g887" fill="#002835" fill-opacity="1" display="inline" opacity="1" transform="matrix(0.36608414,0,0,0.36608414,0.24914016,242.94999)"><path id="path883" fill="#002835" fill-opacity="1" d="m 16.2,24.1 c -0.4,0 -0.5,-0.2 -0.3,-0.5 L 18,20.9 c 0.2,-0.3 0.7,-0.5 1.1,-0.5 h 35.7 c 0.4,0 0.5,0.3 0.3,0.6 l -1.7,2.6 c -0.2,0.3 -0.7,0.6 -1,0.6 z M 1.1,33.3 C 0.7,33.3 0.6,33.1 0.8,32.8 L 2.9,30.1 C 3.1,29.8 3.6,29.6 4,29.6 h 45.6 c 0.4,0 0.6,0.3 0.5,0.6 l -0.8,2.4 c -0.1,0.4 -0.5,0.6 -0.9,0.6 z m 24.2,9.2 c -0.4,0 -0.5,-0.3 -0.3,-0.6 l 1.4,-2.5 c 0.2,-0.3 0.6,-0.6 1,-0.6 h 20 c 0.4,0 0.6,0.3 0.6,0.7 l -0.2,2.4 c 0,0.4 -0.4,0.7 -0.7,0.7 z M 129.1,22.3 c -6.3,1.6 -10.6,2.8 -16.8,4.4 -1.5,0.4 -1.6,0.5 -2.9,-1 -1.5,-1.7 -2.6,-2.8 -4.7,-3.8 -6.3,-3.1 -12.4,-2.2 -18.1,1.5 -6.8,4.4 -10.3,10.9 -10.2,19 0.1,8 5.6,14.6 13.5,15.7 6.8,0.9 12.5,-1.5 17,-6.6 0.9,-1.1 1.7,-2.3 2.7,-3.7 H 90.3 c -2.1,0 -2.6,-1.3 -1.9,-3 1.3,-3.1 3.7,-8.3 5.1,-10.9 0.3,-0.6 1,-1.6 2.5,-1.6 h 36.4 c -0.2,2.7 -0.2,5.4 -0.6,8.1 C 130.7,47.6 128,54.2 123.6,60 116.4,69.5 107,75.4 95.1,77 85.3,78.3 76.2,76.4 68.2,70.4 60.8,64.8 56.6,57.4 55.5,48.2 54.2,37.3 57.4,27.5 64,18.9 71.1,9.6 80.5,3.7 92,1.6 c 9.4,-1.7 18.4,-0.6 26.5,4.9 5.3,3.5 9.1,8.3 11.6,14.1 0.6,0.9 0.2,1.4 -1,1.7 z"/><path id="path885" fill="#002835" fill-opacity="1" d="m 162.2,77.6 c -9.1,-0.2 -17.4,-2.8 -24.4,-8.8 -5.9,-5.1 -9.6,-11.6 -10.8,-19.3 -1.8,-11.3 1.3,-21.3 8.1,-30.2 7.3,-9.6 16.1,-14.6 28,-16.7 10.2,-1.8 19.8,-0.8 28.5,5.1 7.9,5.4 12.8,12.7 14.1,22.3 1.7,13.5 -2.2,24.5 -11.5,33.9 -6.6,6.7 -14.7,10.9 -24,12.8 -2.7,0.5 -5.4,0.6 -8,0.9 z M 186,37.2 c -0.1,-1.3 -0.1,-2.3 -0.3,-3.3 -1.8,-9.9 -10.9,-15.5 -20.4,-13.3 -9.3,2.1 -15.3,8 -17.5,17.4 -1.8,7.8 2,15.7 9.2,18.9 5.5,2.4 11,2.1 16.3,-0.6 7.9,-4.1 12.2,-10.5 12.7,-19.1 z"/></g></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/java.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/java.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/java.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg881" version="1.1" viewBox="0 0 128 128"><metadata id="metadata887"/><path id="path879" fill="#002835" fill-opacity="1" d="M47.617 98.12c-19.192 5.362 11.677 16.439 36.115 5.969-4.003-1.556-6.874-3.351-6.874-3.351-10.897 2.06-15.952 2.222-25.844 1.092-8.164-.935-3.397-3.71-3.397-3.71zM80.806 87.66c-14.444 2.779-22.787 2.69-33.354 1.6-8.171-.845-2.822-4.805-2.822-4.805-21.137 7.016 11.767 14.977 41.309 6.336-3.14-1.106-5.133-3.131-5.133-3.131zM92.125 27.085c.001 0-42.731 10.669-22.323 34.187 6.024 6.935-1.58 13.17-1.58 13.17s15.289-7.891 8.269-17.777c-6.559-9.215-11.587-13.793 15.634-29.58zM102.123 108.229s3.529 2.91-3.888 5.159c-14.102 4.272-58.706 5.56-71.095.171-4.45-1.938 3.899-4.625 6.526-5.192 2.739-.593 4.303-.485 4.303-.485-4.952-3.487-32.013 6.85-13.742 9.815 49.821 8.076 90.817-3.637 77.896-9.468zM85 77.896c2.395-1.634 5.703-3.053 5.703-3.053s-9.424 1.685-18.813 2.474c-11.494.964-23.823 1.154-30.012.326-14.652-1.959 8.033-7.348 8.033-7.348s-8.812-.596-19.644 4.644c-12.812 6.195 31.691 9.019 54.733 2.957zM90.609 93.041c-.108.29-.468.616-.468.616 31.273-8.221 19.775-28.979 4.822-23.725-1.312.464-2 1.543-2 1.543s.829-.334 2.678-.72c7.559-1.575 18.389 10.119-5.032 22.286zM64.181 70.069c-4.614-10.429-20.26-19.553.007-35.559 25.271-19.947 12.304-32.923 12.304-32.923 5.23 20.608-18.451 26.833-26.999 39.667-5.821 8.745 2.857 18.142 14.688 28.815zM91.455 121.817c-19.187 3.612-42.854 3.191-56.887.874 0 0 2.874 2.38 17.646 3.331 22.476 1.437 57-.8 57.816-11.436.001 0-1.57 4.032-18.575 7.231z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/javascript.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/javascript.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/javascript.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg1491" version="1.1" viewBox="0 0 128 128"><metadata id="metadata1497"/><path id="path1487" fill="#002835" fill-opacity="1" d="M1.408 1.408h125.184v125.185h-125.184z"/><path id="path1489" fill="#f2f3f2" fill-opacity="1" d="M116.347 96.736c-.917-5.711-4.641-10.508-15.672-14.981-3.832-1.761-8.104-3.022-9.377-5.926-.452-1.69-.512-2.642-.226-3.665.821-3.32 4.784-4.355 7.925-3.403 2.023.678 3.938 2.237 5.093 4.724 5.402-3.498 5.391-3.475 9.163-5.879-1.381-2.141-2.118-3.129-3.022-4.045-3.249-3.629-7.676-5.498-14.756-5.355l-3.688.477c-3.534.893-6.902 2.748-8.877 5.235-5.926 6.724-4.236 18.492 2.975 23.335 7.104 5.332 17.54 6.545 18.873 11.531 1.297 6.104-4.486 8.08-10.234 7.378-4.236-.881-6.592-3.034-9.139-6.949-4.688 2.713-4.688 2.713-9.508 5.485 1.143 2.499 2.344 3.63 4.26 5.795 9.068 9.198 31.76 8.746 35.83-5.176.165-.478 1.261-3.666.38-8.581zm-46.885-37.793h-11.709l-.048 30.272c0 6.438.333 12.34-.714 14.149-1.713 3.558-6.152 3.117-8.175 2.427-2.059-1.012-3.106-2.451-4.319-4.485-.333-.584-.583-1.036-.667-1.071l-9.52 5.83c1.583 3.249 3.915 6.069 6.902 7.901 4.462 2.678 10.459 3.499 16.731 2.059 4.082-1.189 7.604-3.652 9.448-7.401 2.666-4.915 2.094-10.864 2.07-17.444.06-10.735.001-21.468.001-32.237z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/js.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/js.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/js.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg1491" version="1.1" viewBox="0 0 128 128"><metadata id="metadata1497"/><path id="path1487" fill="#002835" fill-opacity="1" d="M1.408 1.408h125.184v125.185h-125.184z"/><path id="path1489" fill="#f2f3f2" fill-opacity="1" d="M116.347 96.736c-.917-5.711-4.641-10.508-15.672-14.981-3.832-1.761-8.104-3.022-9.377-5.926-.452-1.69-.512-2.642-.226-3.665.821-3.32 4.784-4.355 7.925-3.403 2.023.678 3.938 2.237 5.093 4.724 5.402-3.498 5.391-3.475 9.163-5.879-1.381-2.141-2.118-3.129-3.022-4.045-3.249-3.629-7.676-5.498-14.756-5.355l-3.688.477c-3.534.893-6.902 2.748-8.877 5.235-5.926 6.724-4.236 18.492 2.975 23.335 7.104 5.332 17.54 6.545 18.873 11.531 1.297 6.104-4.486 8.08-10.234 7.378-4.236-.881-6.592-3.034-9.139-6.949-4.688 2.713-4.688 2.713-9.508 5.485 1.143 2.499 2.344 3.63 4.26 5.795 9.068 9.198 31.76 8.746 35.83-5.176.165-.478 1.261-3.666.38-8.581zm-46.885-37.793h-11.709l-.048 30.272c0 6.438.333 12.34-.714 14.149-1.713 3.558-6.152 3.117-8.175 2.427-2.059-1.012-3.106-2.451-4.319-4.485-.333-.584-.583-1.036-.667-1.071l-9.52 5.83c1.583 3.249 3.915 6.069 6.902 7.901 4.462 2.678 10.459 3.499 16.731 2.059 4.082-1.189 7.604-3.652 9.448-7.401 2.666-4.915 2.094-10.864 2.07-17.444.06-10.735.001-21.468.001-32.237z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/keycloak.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Pro 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><g fill="#002835" stroke="none"><path d="M256 0c4.6 0 9.2 1 13.4 2.9L457.7 82.8c22 9.3 38.4 31 38.3 57.2c-.5 99.2-41.3 280.7-213.6 363.2c-16.7 8-36.1 8-52.8 0C57.3 420.7 16.5 239.2 16 140c-.1-26.2 16.3-47.9 38.3-57.2L242.7 2.9C246.8 1 251.4 0 256 0zm0 66.8V444.8C394 378 431.1 230.1 432 141.4L256 66.8l0 0z"/></g></svg>
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logger.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0" y="0" enable-background="new 0 0 1000 1000" version="1.1" viewBox="0 0 1000 1000" xml:space="preserve"><metadata>Svg Vector Icons : http://www.onlinewebfonts.com/icon</metadata><g fill="#002835"><path d="M907.8,163h-5.1v-32.8c0-27.2-22.1-49.3-49.3-49.3h-0.3c-265.6,0-309.3,113.4-330.4,167.9c-1.3,3.2-2.8,7.2-4,10.1l-24.3-13.7c0-45.3-36.9-82.2-82.2-82.2h-320C46.9,163,10,199.9,10,245.2v558.9c0,45.3,36.9,82.2,82.2,82.2h320c4.8,0,9.3-0.6,13.9-1.4v1.4c0,18.2,14.7,32.9,32.9,32.9h82.2c18.2,0,32.9-14.7,32.9-32.9v-1.4c4.5,0.8,9.2,1.4,13.9,1.4h319.9c45.3,0,82.2-36.9,82.2-82.2V245.2C990,199.9,953.1,163,907.8,163L907.8,163z M445.1,804.1c0,18.2-14.7,32.9-32.9,32.9h-320c-18.2,0-32.9-14.7-32.9-32.9V245.2c0-18.2,14.7-32.9,32.9-32.9h320c18.2,0,32.9,14.7,32.9,32.9V804.1L445.1,804.1z M557.6,290.4c24.5-33.4,16.5-160.2,295.6-160.2h0.3v560c-18.7-2.2-36.4-3.2-53.2-3.2c-152.5,0-228.3,83.3-242.7,100.5V290.4L557.6,290.4z M940.7,804.1c0,18.2-14.7,32.9-32.9,32.9H587.9c-5,0-9.8-1.2-14.1-3.3c8.2-2.9,15.8-7.7,21.6-14.7c11.5-13.8,75.5-82.8,204.8-82.8c15.3,0,31.2,1,47.4,2.9c1.9,0.2,3.9,0.3,5.8,0.3c12,0,23.7-4.4,32.7-12.4c10.5-9.4,16.6-22.8,16.6-36.9V212.3h5.1c18.1,0,32.9,14.7,32.9,32.9V804.1L940.7,804.1z"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-dashboard.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="1024" height="1024" class="icon"><g><title>background</title><rect id="canvas_background" width="582" height="402" x="-1" y="-1" fill="none"/></g><g><title>Layer 1</title><path id="svg_1" fill="#002835" d="m512,512l228.21888,156.89728a290.7648,290.7648 0 0 1 -235.264,118.9376c-160.11264,0 -289.91488,-127.65184 -289.91488,-285.11232c0,-157.47072 129.80224,-285.12256 289.91488,-285.12256c2.38592,0 4.67968,0.28672 7.04512,0.34816l0,294.05184z"/><path id="svg_2" fill="#002835" d="m835.21216,469.04l-274.01216,0l0,-294.92224c152.9344,7.90528 274.55488,131.9936 274.55488,284.3648c0,3.56352 -0.4096,7.02464 -0.54272,10.55744z"/><path id="svg_3" fill="#002835" d="m847.98464,501.76a279.71584,279.71584 0 0 1 -32.37888,130.27328l-246.65088,-127.30368l0,-2.9696l279.02976,0z"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-database.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="110.103" height="110.103"><g><title>background</title><rect id="canvas_background" width="112.103" height="112.103" x="-1" y="-1" fill="none"/></g><g><title>Layer 1</title><g id="svg_1"><g id="Layer_1_14_"><g id="svg_2"><g id="svg_3"><g id="svg_4"><path id="svg_5" fill="#002835" d="m55.060951,7.500502c-21.633,0 -39.171,6.393 -39.171,14.283l0,11.72c0,7.891 17.538,14.282 39.171,14.282c21.632,0 39.17,-6.392 39.17,-14.282l0,-11.72c0,-7.89 -17.538,-14.283 -39.17,-14.283z"/></g></g><g id="svg_6"><g id="svg_7"><path id="svg_8" fill="#002835" d="m55.060951,54.615502c-20.654,0 -37.682,-5.832 -39.171,-13.227c-0.071,0.353 0,19.355 0,19.355c0,7.892 17.538,14.283 39.171,14.283c21.632,0 39.17,-6.393 39.17,-14.283c0,0 0.044,-19.003 -0.026,-19.355c-1.491,7.396 -18.491,13.227 -39.144,13.227z"/></g></g><path id="svg_9" fill="#002835" d="m94.193951,68.964502c-1.488,7.391 -18.479,13.226 -39.133,13.226s-37.686,-5.836 -39.175,-13.226l0.004,19.356c0,7.891 17.538,14.282 39.171,14.282c21.632,0 39.17,-6.393 39.17,-14.282l-0.037,-19.356z"/></g></g></g></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-discord.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 245 240"><path fill="#002835" d="M104.4 103.9c-5.7 0-10.2 5-10.2 11.1s4.6 11.1 10.2 11.1c5.7 0 10.2-5 10.2-11.1.1-6.1-4.5-11.1-10.2-11.1zM140.9 103.9c-5.7 0-10.2 5-10.2 11.1s4.6 11.1 10.2 11.1c5.7 0 10.2-5 10.2-11.1s-4.5-11.1-10.2-11.1z"/><path fill="#002835" d="M189.5 20h-134C44.2 20 35 29.2 35 40.6v135.2c0 11.4 9.2 20.6 20.5 20.6h113.4l-5.3-18.5 12.8 11.9 12.1 11.2 21.5 19V40.6c0-11.4-9.2-20.6-20.5-20.6zm-38.6 130.6s-3.6-4.3-6.6-8.1c13.1-3.7 18.1-11.9 18.1-11.9-4.1 2.7-8 4.6-11.5 5.9-5 2.1-9.8 3.5-14.5 4.3-9.6 1.8-18.4 1.3-25.9-.1-5.7-1.1-10.6-2.7-14.7-4.3-2.3-.9-4.8-2-7.3-3.4-.3-.2-.6-.3-.9-.5-.2-.1-.3-.2-.4-.3-1.8-1-2.8-1.7-2.8-1.7s4.8 8 17.5 11.8c-3 3.8-6.7 8.3-6.7 8.3-22.1-.7-30.5-15.2-30.5-15.2 0-32.2 14.4-58.3 14.4-58.3 14.4-10.8 28.1-10.5 28.1-10.5l1 1.2c-18 5.2-26.3 13.1-26.3 13.1s2.2-1.2 5.9-2.9c10.7-4.7 19.2-6 22.7-6.3.6-.1 1.1-.2 1.7-.2 6.1-.8 13-1 20.2-.2 9.5 1.1 19.7 3.9 30.1 9.6 0 0-7.9-7.5-24.9-12.7l1.4-1.6s13.7-.3 28.1 10.5c0 0 14.4 26.1 14.4 58.3 0 0-8.5 14.5-30.6 15.2z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-github.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="64" height="64"><g><title>background</title><rect id="canvas_background" width="582" height="402" x="-1" y="-1" fill="none"/></g><g><title>Layer 1</title><path id="svg_1" fill="#002835" fill-rule="evenodd" d="m31.998,2c-16.565,0 -29.998,13.431 -29.998,30.002c0,13.253 8.595,24.498 20.517,28.465c1.5,0.275 2.048,-0.651 2.048,-1.446c0,-0.712 -0.026,-2.599 -0.041,-5.102c-8.345,1.813 -10.106,-4.021 -10.106,-4.021c-1.364,-3.466 -3.331,-4.388 -3.331,-4.388c-2.724,-1.861 0.206,-1.824 0.206,-1.824c3.011,0.212 4.595,3.092 4.595,3.092c2.676,4.584 7.021,3.261 8.731,2.493c0.273,-1.939 1.048,-3.261 1.905,-4.011c-6.662,-0.757 -13.665,-3.331 -13.665,-14.827c0,-3.275 1.169,-5.953 3.088,-8.05c-0.308,-0.759 -1.338,-3.809 0.294,-7.939c0,0 2.519,-0.807 8.25,3.075c2.393,-0.665 4.959,-0.998 7.511,-1.01c2.548,0.012 5.114,0.344 7.511,1.01c5.727,-3.882 8.242,-3.075 8.242,-3.075c1.637,4.13 0.607,7.18 0.299,7.939c1.923,2.097 3.084,4.775 3.084,8.05c0,11.525 -7.014,14.061 -13.697,14.804c1.077,0.926 2.037,2.757 2.037,5.556c0,4.011 -0.037,7.246 -0.037,8.23c0,0.802 0.54,1.736 2.063,1.443c11.908,-3.978 20.496,-15.215 20.496,-28.464c0,-16.571 -13.433,-30.002 -30.002,-30.002z" clip-rule="evenodd"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-stack-overflow.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="64" height="64"><g><title>background</title><rect id="canvas_background" width="582" height="402" x="-1" y="-1" fill="none"/></g><g><title>Layer 1</title><polygon id="svg_1" fill="#002835" points="52.299 58.101 52.299 41.001 57.999 41.001 57.999 63.801 6.599 63.801 6.599 41.001 12.299 41.001 12.299 58.101"/><path id="svg_2" fill="#002835" d="m18.3,39.6l27.9,5.9l1.2,-5.6l-27.9,-5.9l-1.2,5.6zm3.7,-13.4l25.9,12.1l2.4,-5.2l-25.9,-12.1l-2.4,5.2zm7.2,-12.7l21.9,18.3l3.7,-4.4l-22,-18.3l-3.6,4.4zm14.1,-13.5l-4.6,3.4l17,22.9l4.6,-3.4l-17,-22.9zm-25.6,52.6l28.6,0l0,-5.7l-28.6,0l0,5.7z"/><path id="svg_4" fill="none" fill-opacity="null" stroke="null" stroke-opacity="null" stroke-width="null" d="m49.512436,11.544465c-0.099503,0 -0.39801,0 -0.995022,0c-0.298508,0 -1.515697,-0.271966 -2.089554,-0.796021c-0.831272,-0.75913 -0.914455,-0.883734 -1.094528,-1.19403c-0.111675,-0.192437 -0.099503,-0.298507 -0.099503,-0.597014c0,-0.099503 0,-0.199005 0,-0.497513c0,-0.199005 0,-0.597014 -0.099503,-0.895522l0,-0.199005"/><path id="svg_5" fill="none" fill-opacity="null" stroke="null" stroke-opacity="null" stroke-width="null" d="m42.845772,4.877798c-0.099503,-0.099503 1.065132,0.902537 1.990047,1.890547c1.062214,1.134675 3.151531,2.614952 3.582092,3.084577c0.242447,0.264442 0.208675,0.375701 0,0.298508c-0.384777,-0.142338 -0.796021,-0.298508 -1.094528,-0.597015l-0.796021,-0.497512l-0.199005,-0.199005"/><path id="svg_6" fill="none" fill-opacity="null" stroke="null" stroke-opacity="null" stroke-width="null" d="m43.741295,6.370336c-0.696518,-0.497512 -3.376286,-2.293804 -8.358212,-3.084577c-3.543255,-0.562415 -5.271688,-0.182637 -8.557213,0.199005c-0.895016,0.103964 -1.691542,0.199005 -2.38806,0.298507l-0.099503,0l-0.298508,0"/><line id="svg_10" x1="24.338" x2="31.204" y1="6.569" y2="40.201" fill="none" stroke="null" stroke-linecap="null" stroke-linejoin="null" stroke-opacity="null" stroke-width="null"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/logo-youtube.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="64" height="64"><g><title>background</title><rect id="canvas_background" width="66" height="66" x="-1" y="-1" fill="none"/></g><g><title>Layer 1</title><path id="svg_1" fill="#FFF" d="m41.272,31.81c-4.942,-2.641 -9.674,-5.069 -14.511,-7.604l0,15.165c5.09,-2.767 10.455,-5.301 14.532,-7.561l-0.021,0z"/><path id="svg_2" fill="#E8E0E0" d="m41.272,31.81c-4.942,-2.641 -14.511,-7.604 -14.511,-7.604l12.758,8.575c0.001,0 -2.324,1.289 1.753,-0.971z"/><path id="svg_3" fill="#002835" stroke="null" d="m27.962946,51.291228c-10.22448,-0.188469 -13.71664,-0.357991 -15.863133,-0.800743c-1.452245,-0.294171 -2.714243,-0.94733 -3.639576,-1.89466c-0.715166,-0.716979 -1.283912,-1.810896 -1.725163,-3.328619c-0.3785,-1.264437 -0.525916,-2.316472 -0.736083,-4.88623c-0.321725,-5.799655 -0.398421,-10.541292 0,-15.839361c0.328697,-2.925755 0.488066,-6.398966 2.671413,-8.425256c1.030914,-0.948327 2.230162,-1.558608 3.576825,-1.810896c2.103663,-0.399873 11.066144,-0.715982 20.344374,-0.715982c9.257313,0 18.239715,0.316109 20.34537,0.715982c1.682333,0.316109 3.26008,1.263439 4.186409,2.484997c1.992105,3.137159 2.026967,7.038165 2.229166,10.089565c0.083668,1.453903 0.083668,9.709636 0,11.163539c-0.314753,4.822409 -0.56775,6.528601 -1.282916,8.297615c-0.442247,1.116852 -0.819751,1.706192 -1.473162,2.359351a7.057032,7.065089 0 0 1 -3.745158,1.916599c-8.847935,0.666123 -16.361159,0.810715 -24.888365,0.6741zm13.549303,-19.37739c-4.922492,-2.633578 -9.635812,-5.075696 -14.453719,-7.603571l0,15.123379c5.069908,-2.759224 10.414726,-5.2871 14.474636,-7.540749l-0.020917,0.020941z"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/lua.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/lua.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/lua.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="937" height="937" version="1.1" viewBox="0 0 937 937"><title>Lua programming language logo</title><path fill="none" stroke="#002835" stroke-dasharray="39.852" stroke-width="10.597" d="m880.4 266.18a456.67 456.67 0 1 1 -158.18 -175.67"/><circle cx="473.5" cy="473.5" r="353.21" fill="#002835"/><circle cx="619.81" cy="327.2" r="103.45" fill="#fff"/><circle cx="826.72" cy="120.29" r="103.46" fill="#002835"/><g fill="#fff"><path d="m377.82 650.11v-26.067h-114.44v-205.68h-29.564v231.75h144.01"/><path d="m536.7 650.11v-166.58h-26.385v91.872c0 34.015-17.802 56.267-45.459 56.267-20.981 0-34.333-12.716-34.333-32.743v-115.4h-26.385v125.89c0 27.657 20.663 45.459 53.089 45.459 24.478 0 40.055-8.5832 55.632-30.518v25.75h23.842"/><path d="m730.5 649.47v-20.027c-2.861 0.63579-4.1326 0.63579-5.7221 0.63579-9.219 0-14.305-4.7684-14.305-13.034v-92.825c0-29.564-21.617-45.459-62.625-45.459-40.373 0-65.169 15.577-66.758 54.042h26.703c2.2253-20.345 14.305-29.564 39.101-29.564 23.842 0 37.194 8.9011 37.194 24.796v6.9937c0 11.126-6.6758 15.895-27.657 18.438-37.512 4.7684-43.234 6.04-53.406 10.173-19.392 7.9474-29.246 22.888-29.246 43.234 0 30.2 20.981 48.002 54.678 48.002 21.299 0 41.962-8.9011 56.585-24.478 2.861 12.716 14.305 21.935 27.339 21.935 5.4042 0 9.5369-0.63579 18.12-2.8611m-46.413-56.903c0 23.842-24.16 39.101-49.91 39.101-20.663 0-32.743-7.3116-32.743-25.432 0-17.484 11.762-25.114 40.055-29.246 27.975-3.8147 33.697-5.0863 42.598-9.219v24.796"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/module-logger.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="15" height="15" viewBox="0 0 15 15">
2 |   <path fill="#002835" fill-rule="evenodd"
3 |     d="M0 1.5A.5.5 0 0 1 .5 1h2a.5.5 0 0 1 0 1h-2a.5.5 0 0 1-.5-.5m4 0a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1h-10a.5.5 0 0 1-.5-.5m0 3a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7a.5.5 0 0 1-.5-.5m-4 3A.5.5 0 0 1 .5 7h2a.5.5 0 0 1 0 1h-2a.5.5 0 0 1-.5-.5m4 0a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1h-10a.5.5 0 0 1-.5-.5m0 3a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7a.5.5 0 0 1-.5-.5m-4 3a.5.5 0 0 1 .5-.5h2a.5.5 0 0 1 0 1h-2a.5.5 0 0 1-.5-.5m4 0a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1h-10a.5.5 0 0 1-.5-.5"
4 |     clip-rule="evenodd" />
5 | </svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/open-id.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Pro 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><g fill="#002835" stroke="none"><path d="M271.5 432l-68 32C88.5 453.7 0 392.5 0 318.2c0-71.5 82.5-131 191.7-144.3v43c-71.5 12.5-124 53-124 101.3 0 51 58.5 93.3 135.7 103v-340l68-33.2v384zM448 291l-131.3-28.5 36.8-20.7c-19.5-11.5-43.5-20-70-24.8v-43c46.2 5.5 87.7 19.5 120.3 39.3l35-19.8L448 291z"/></g></svg>
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/php.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/php.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/php.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg2" version="1.1" viewBox="0 0 128 128"><metadata id="metadata10"/><path id="path4" fill="#002835" fill-opacity="1" d="M64 33.039c-33.74 0-61.094 13.862-61.094 30.961s27.354 30.961 61.094 30.961 61.094-13.862 61.094-30.961-27.354-30.961-61.094-30.961zm-15.897 36.993c-1.458 1.364-3.077 1.927-4.86 2.507-1.783.581-4.052.461-6.811.461h-6.253l-1.733 10h-7.301l6.515-34h14.04c4.224 0 7.305 1.215 9.242 3.432 1.937 2.217 2.519 5.364 1.747 9.337-.319 1.637-.856 3.159-1.614 4.515-.759 1.357-1.75 2.624-2.972 3.748zm21.311 2.968l2.881-14.42c.328-1.688.208-2.942-.361-3.555-.57-.614-1.782-1.025-3.635-1.025h-5.79l-3.731 19h-7.244l6.515-33h7.244l-1.732 9h6.453c4.061 0 6.861.815 8.402 2.231s2.003 3.356 1.387 6.528l-3.031 15.241h-7.358zm40.259-11.178c-.318 1.637-.856 3.133-1.613 4.488-.758 1.357-1.748 2.598-2.971 3.722-1.458 1.364-3.078 1.927-4.86 2.507-1.782.581-4.053.461-6.812.461h-6.253l-1.732 10h-7.301l6.514-34h14.041c4.224 0 7.305 1.215 9.241 3.432 1.935 2.217 2.518 5.418 1.746 9.39zM95.919 54h-5.001l-2.727 14h4.442c2.942 0 5.136-.29 6.576-1.4 1.442-1.108 2.413-2.828 2.918-5.421.484-2.491.264-4.434-.66-5.458-.925-1.024-2.774-1.721-5.548-1.721zM38.934 54h-5.002l-2.727 14h4.441c2.943 0 5.136-.29 6.577-1.4 1.441-1.108 2.413-2.828 2.917-5.421.484-2.491.264-4.434-.66-5.458s-2.772-1.721-5.546-1.721z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/plugin-multi-tenancy.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="300" height="300" preserveAspectRatio="xMidYMid meet" version="1.0" viewBox="0 0 225 225"><g fill="#002835" stroke="none"><path d="M538 2239 c-17 -9 -18 -36 -18 -332 0 -238 3 -326 12 -335 9 -9 80 -12 260 -12 l248 0 0 -220 0 -220 -425 0 c-409 0 -425 -1 -435 -19 -6 -12 -10 -100 -10 -215 l0 -196 -73 0 c-43 0 -78 -5 -85 -12 -9 -9 -12 -96 -12 -329 0 -275 2 -320 16 -333 23 -24 465 -24 488 0 14 13 16 57 16 325 0 195 -4 318 -10 330 -10 17 -22 19 -130 19 l-120 0 0 175 0 175 390 0 390 0 0 -175 0 -175 -73 0 c-43 0 -78 -5 -85 -12 -17 -17 -17 -649 0 -666 17 -17 469 -17 486 0 17 17 17 649 0 666 -8 8 -52 12 -130 12 l-118 0 0 175 0 175 435 0 435 0 0 -175 0 -175 -120 0 c-108 0 -120 -2 -130 -19 -6 -12 -10 -135 -10 -330 0 -268 2 -312 16 -325 23 -24 465 -24 488 0 14 13 16 58 16 333 0 233 -3 320 -12 329 -7 7 -42 12 -85 12 l-73 0 0 198 c0 143 -3 203 -12 215 -12 15 -55 17 -478 19 l-465 3 -3 218 -2 217 293 0 c215 0 296 3 305 12 9 9 12 97 12 335 0 308 -1 323 -19 333 -27 14 -1149 13 -1173 -1z m1110 -336 l-3 -258 -520 0 -520 0 -3 258 -2 257 525 0 525 0 -2 -257z m-1218 -1553 l0 -260 -170 0 -170 0 0 260 0 260 170 0 170 0 0 -260z m870 0 l0 -260 -175 0 -175 0 0 260 0 260 175 0 175 0 0 -260z m860 0 l0 -260 -170 0 -170 0 0 260 0 260 170 0 170 0 0 -260z" transform="translate(0.000000,225.000000) scale(0.100000,-0.100000)"/></g></svg>
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/plugin-prometheus.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="1377.333" height="1365.333" preserveAspectRatio="xMidYMid meet" version="1.0" viewBox="0 0 1033 1024"><metadata>Created by potrace 1.15, written by Peter Selinger 2001-2017</metadata><g fill="#002835" stroke="none"><path d="M4730 10173 c-992 -74 -1925 -423 -2704 -1011 -271 -205 -634 -546 -825 -777 -425 -513 -726 -1042 -927 -1630 -122 -354 -199 -694 -245 -1071 -27 -226 -37 -739 -20 -973 63 -828 323 -1621 759 -2321 492 -788 1204 -1437 2032 -1851 563 -281 1093 -437 1747 -516 214 -26 873 -25 1088 0 948 113 1759 432 2500 982 216 160 342 270 580 509 893 895 1421 2111 1463 3368 22 654 -58 1230 -252 1813 -474 1425 -1545 2564 -2936 3125 -458 184 -946 300 -1460 345 -149 13 -662 18 -800 8z m360 -655 c-46 -98 -64 -193 -57 -317 8 -169 45 -291 212 -711 125 -314 171 -439 233 -630 76 -234 96 -346 137 -795 31 -336 41 -422 61 -540 21 -114 34 -130 34 -39 0 38 5 134 10 214 65 935 242 1606 514 1945 52 65 108 125 117 125 5 0 -1 -25 -11 -56 -35 -100 -50 -210 -50 -359 0 -348 107 -690 348 -1107 216 -375 330 -696 378 -1063 21 -164 25 -563 5 -680 -57 -350 -193 -668 -399 -928 -30 -38 -52 -71 -49 -74 3 -3 104 16 224 41 197 42 709 144 1223 246 107 21 197 37 198 35 14 -13 -92 -283 -175 -449 -127 -252 -325 -538 -512 -739 l-73 -77 -2371 0 -2372 0 -72 88 c-331 404 -519 716 -653 1084 -35 96 -35 97 -12 92 9 -2 85 -17 167 -35 83 -17 332 -71 555 -120 424 -95 792 -170 798 -164 2 2 -23 39 -55 82 -208 273 -339 566 -400 893 -28 147 -25 502 5 670 45 250 123 509 292 970 169 462 220 653 236 886 8 104 -9 258 -36 346 -10 32 -14 58 -9 58 5 0 26 -7 45 -15 266 -111 474 -631 513 -1283 4 -78 10 -145 13 -147 17 -17 142 224 206 395 126 337 191 691 212 1153 7 140 16 241 29 298 82 363 289 677 498 754 72 26 76 22 43 -47z m2390 -6843 l0 -425 -2390 0 -2390 0 0 425 0 425 2390 0 2390 0 0 -425z m-950 -884 c0 -27 -6 -82 -14 -123 -115 -600 -753 -1032 -1484 -1005 -290 10 -527 76 -763 210 -158 90 -309 222 -413 361 -117 157 -206 398 -206 558 l0 48 1440 0 1440 0 0 -49z" transform="translate(0.000000,1024.000000) scale(0.100000,-0.100000)"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/plugin-s3.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" width="300" height="300" preserveAspectRatio="xMidYMid meet" version="1.0" viewBox="0 0 225 225"><g fill="#002835" stroke="none"><path d="M1005 1860 c-141 -20 -252 -76 -360 -185 -88 -87 -143 -178 -169 -279 -8 -31 -17 -60 -20 -65 -3 -4 -31 -11 -63 -14 -129 -13 -285 -131 -347 -260 -81 -172 -46 -383 86 -523 61 -65 114 -98 201 -126 52 -17 98 -21 282 -25 121 -3 236 -1 255 4 45 12 63 52 36 82 -17 18 -35 20 -269 23 -249 3 -253 3 -309 30 -76 35 -151 107 -185 177 -25 50 -28 67 -28 156 0 121 18 167 95 249 75 79 150 111 262 111 l88 0 0 37 c0 110 54 238 138 330 99 107 214 164 351 175 102 7 179 -9 277 -57 193 -95 309 -305 291 -526 l-7 -71 68 24 c175 64 355 -3 432 -161 34 -72 39 -182 10 -258 -28 -75 -96 -150 -168 -185 l-57 -28 -337 -3 c-229 -2 -344 1 -358 8 -19 10 -20 20 -20 317 l0 307 36 -42 c37 -44 77 -55 102 -30 25 25 11 58 -64 148 -118 141 -137 141 -254 3 -82 -97 -88 -110 -70 -144 18 -33 63 -24 104 21 l36 40 0 -303 c0 -294 1 -304 23 -347 42 -83 48 -85 400 -88 336 -4 417 3 504 44 78 37 166 123 203 198 149 302 -74 647 -410 635 l-65 -3 -7 59 c-18 141 -74 251 -183 361 -60 60 -99 90 -155 117 -122 60 -255 83 -375 67z" transform="translate(0.000000,225.000000) scale(0.100000,-0.100000)"/></g></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/plugin.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-plug fa-w-12" data-icon="plug" data-prefix="fas" focusable="false" role="img" viewBox="0 0 384 512"><path fill="#002835" d="M256 144V32c0-17.673 14.327-32 32-32s32 14.327 32 32v112h-64zm112 16H16c-8.837 0-16 7.163-16 16v32c0 8.837 7.163 16 16 16h16v32c0 77.406 54.969 141.971 128 156.796V512h64v-99.204c73.031-14.825 128-79.39 128-156.796v-32h16c8.837 0 16-7.163 16-16v-32c0-8.837-7.163-16-16-16zm-240-16V32c0-17.673-14.327-32-32-32S64 14.327 64 32v112h64z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/probe.svg:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <!-- Svg Vector Icons : http://www.onlinewebfonts.com/icon -->
3 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
4 | <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
5 | <metadata> Svg Vector Icons : http://www.onlinewebfonts.com/icon </metadata>
6 | <g><g transform="translate(0.000000,511.000000) scale(0.100000,-0.100000)"><path d="M8602.6,3676.7c-721.4-35.3-735.9-37.4-783.7-85.2c-25-27-54.1-74.9-60.3-106c-12.5-49.9,6.2-79,158-239.1c95.6-99.8,232.8-241.1,307.7-311.8l137.2-128.9L6604.8,1049C5638.1,82.4,4839.8-709.7,4827.3-709.7s-492.7,474-1070.6,1051.9C3052,1049,2679.9,1406.6,2623.7,1433.6c-93.5,43.6-187.1,49.9-274.4,18.7C2272.4,1423.2,164.4-680.6,127-765.8c-39.5-91.5-35.3-187.1,10.4-286.9c45.7-97.7,195.4-247.4,278.6-278.6c74.8-29.1,203.7-29.1,278.6-2.1c31.2,12.5,447,409.5,920.9,883.5l862.7,862.7L3538.4-649.4c711-713,1087.2-1074.8,1143.4-1101.8c106-49.9,185-49.9,291,0c56.1,27,692.3,648.6,2026.9,1985.3c1068.6,1070.6,1952.1,1945.8,1964.5,1945.8c10.4,0,151.8-133,316-293.1c282.7-280.6,299.3-293.1,361.7-280.6c174.6,35.3,176.7,43.7,226.6,1068.5c39.5,802.5,39.5,904.3,12.5,958.4c-16.6,31.2-47.8,64.4-64.4,72.8C9764.7,3724.5,9417.5,3716.2,8602.6,3676.7z"/><path d="M8407.2,1061.5l-555.1-555.1v-1991.6v-1989.5h706.8h706.8v2396.9v2397L9114,1469l-149.7,149.7L8407.2,1061.5z"/><path d="M6785.6-560L6085-1260.6v-1108v-1106h706.8h706.8V-1666c0,995.8-2.1,1808.6-6.2,1808.6C7490.4,142.6,7172.3-173.3,6785.6-560z"/><path d="M2571.7-1869.7v-1604.9h706.8h706.8v900.1v898.1l-706.8,706.8l-706.8,706.8V-1869.7z"/><path d="M1594.7-1048.5C1158.1-1483,956.5-1668,894.1-1697.2l-89.4-37.4V-2616v-879.4h696.4c538.4,0,700.6,6.2,706.8,27c6.2,12.5,8.3,700.6,6.2,1525.9l-6.2,1501L1594.7-1048.5z"/><path d="M5492.6-1848.9c-245.3-241.1-349.2-303.5-550.9-340.9c-185-31.2-382.5,16.7-565.5,137.2l-58.2,37.4v-729.7v-729.7h706.8h706.8v925.1c0,509.3-2.1,925.1-4.2,925.1C5723.3-1624.4,5619.4-1726.2,5492.6-1848.9z"/></g></g>
7 | </svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/python.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/python.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/python.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg2" version="1.1" viewBox="0 0 128 128"><metadata id="metadata10"/><path id="path4" fill="#002835" fill-opacity="1" d="M49.33 62h29.159c8.117 0 14.511-6.868 14.511-15.019v-27.798c0-7.912-6.632-13.856-14.555-15.176-5.014-.835-10.195-1.215-15.187-1.191-4.99.023-9.612.448-13.805 1.191-12.355 2.181-14.453 6.751-14.453 15.176v10.817h29v4h-40.224000000000004c-8.484 0-15.914 5.108-18.237 14.811-2.681 11.12-2.8 17.919 0 29.53 2.075 8.642 7.03 14.659 15.515 14.659h9.946v-13.048c0-9.637 8.428-17.952 18.33-17.952zm-1.838-39.11c-3.026 0-5.478-2.479-5.478-5.545 0-3.079 2.451-5.581 5.478-5.581 3.015 0 5.479 2.502 5.479 5.581-.001 3.066-2.465 5.545-5.479 5.545zM122.281 48.811c-2.098-8.448-6.103-14.811-14.599-14.811h-10.682v12.981c0 10.05-8.794 18.019-18.511 18.019h-29.159c-7.988 0-14.33 7.326-14.33 15.326v27.8c0 7.91 6.745 12.564 14.462 14.834 9.242 2.717 17.994 3.208 29.051 0 7.349-2.129 14.487-6.411 14.487-14.834v-11.126h-29v-4h43.682c8.484 0 11.647-5.776 14.599-14.66 3.047-9.145 2.916-17.799 0-29.529zm-41.955 55.606c3.027 0 5.479 2.479 5.479 5.547 0 3.076-2.451 5.579-5.479 5.579-3.015 0-5.478-2.502-5.478-5.579 0-3.068 2.463-5.547 5.478-5.547z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/rocket.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-rocket fa-w-16" data-icon="rocket" data-prefix="fas" focusable="false" role="img" viewBox="0 0 512 512"><path fill="#002835" d="M505.05 19.1a15.89 15.89 0 0 0-12.2-12.2C460.65 0 435.46 0 410.36 0c-103.2 0-165.1 55.2-211.29 128H94.87A48 48 0 0 0 52 154.49l-49.42 98.8A24 24 0 0 0 24.07 288h103.77l-22.47 22.47a32 32 0 0 0 0 45.25l50.9 50.91a32 32 0 0 0 45.26 0L224 384.16V488a24 24 0 0 0 34.7 21.49l98.7-49.39a47.91 47.91 0 0 0 26.5-42.9V312.79c72.59-46.3 128-108.4 128-211.09.1-25.2.1-50.4-6.85-82.6zM384 168a40 40 0 1 1 40-40 40 40 0 0 1-40 40z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/ruby.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/logos/ruby.png


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/ruby.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" id="svg2" version="1.1" viewBox="0 0 128 128"><metadata id="metadata10"/><path id="path4" fill="#002835" fill-rule="evenodd" d="M35.971 111.33c27.466 3.75 54.444 7.433 81.958 11.188-9.374-15.606-18.507-30.813-27.713-46.144l-54.245 34.956zM125.681 24.947c-2.421 3.636-4.847 7.269-7.265 10.907-8.304 12.493-16.607 24.986-24.903 37.485-.462.696-1.061 1.248-.41 2.321 8.016 13.237 15.969 26.513 23.942 39.777 1.258 2.095 2.53 4.182 4.157 6.192 1.612-32.193 3.223-64.387 4.834-96.58l-.355-.102zM16.252 66.22c.375.355 1.311.562 1.747.347 7.689-3.779 15.427-7.474 22.948-11.564 2.453-1.333 4.339-3.723 6.452-5.661 6.997-6.417 13.983-12.847 20.966-19.278.427-.395.933-.777 1.188-1.275 2.508-4.902 4.973-9.829 7.525-14.898-3.043-1.144-5.928-2.263-8.849-3.281-.396-.138-1.02.136-1.449.375-6.761 3.777-13.649 7.353-20.195 11.472-3.275 2.061-5.943 5.098-8.843 7.743-4.674 4.266-9.342 8.542-13.948 12.882-1.222 1.152-2.336 2.468-3.288 3.854-3.15 4.587-6.206 9.24-9.402 14.025 1.786 1.847 3.41 3.613 5.148 5.259zM44.354 59.949c-3.825 16.159-7.627 32.227-11.556 48.823 18.423-11.871 36.421-23.468 54.3-34.987-14.228-4.605-28.41-9.196-42.744-13.836zM120.985 25.103c-15.566 2.601-30.76 5.139-46.15 7.71 5.242 12.751 10.379 25.246 15.662 38.096 10.221-15.359 20.24-30.41 30.488-45.806zM44.996 56.644c14.017 4.55 27.755 9.01 41.892 13.6-5.25-12.79-10.32-25.133-15.495-37.737-8.815 8.059-17.498 15.999-26.397 24.137zM16.831 75.643c-4.971 11.883-9.773 23.362-14.662 35.048 9.396-.278 18.504-.547 27.925-.825-4.423-11.412-8.759-22.6-13.263-34.223zM30.424 101.739l.346-.076c3.353-13.941 6.754-27.786 10.177-42.272-7.636 3.969-14.92 7.754-22.403 11.644 3.819 9.926 7.891 20.397 11.88 30.704zM115.351 22.842c-4.459-1.181-8.918-2.366-13.379-3.539-6.412-1.686-12.829-3.351-19.237-5.052-.801-.213-1.38-.352-1.851.613-2.265 4.64-4.6 9.245-6.901 13.868-.071.143-.056.328-.111.687 13.886-2.104 27.679-4.195 41.47-6.285l.009-.292zM89.482 12.288l36.343 10.054c-2.084-5.939-4.017-11.446-6.005-17.11l-30.285 6.715-.053.341zM33.505 114.007c-4.501-.519-9.122-.042-13.687.037-3.75.063-7.5.206-11.25.323-.386.012-.771.09-1.156.506 31.003 2.866 62.005 5.732 93.007 8.6l.063-.414c-9.938-1.357-19.877-2.714-29.815-4.07-12.384-1.691-24.747-3.551-37.162-4.982zM2.782 99.994c3.995-9.27 7.973-18.546 11.984-27.809.401-.929.37-1.56-.415-2.308-1.678-1.597-3.237-3.318-5.071-5.226-2.479 12.24-4.897 24.177-7.317 36.113l.271.127c.185-.297.411-.578.548-.897zM81.522 9.841c6.737-1.738 13.572-3.097 20.367-4.613.44-.099.87-.244 1.303-.368l-.067-.332c-9.571 1.287-19.141 2.575-29.194 3.928 2.741 1.197 4.853 2.091 7.591 1.385z" clip-rule="evenodd"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/scheduler.svg:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" standalone="no"?>
 2 | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
 3 |  "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
 4 | <svg version="1.0" xmlns="http://www.w3.org/2000/svg"
 5 |  width="512.000000pt" height="512.000000pt" viewBox="0 0 512.000000 512.000000"
 6 |  preserveAspectRatio="xMidYMid meet">
 7 | 
 8 | <g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)"
 9 | fill="#002835" stroke="none">
10 | <path d="M960 4560 l0 -79 -325 -3 -325 -3 -32 -33 -33 -32 0 -1770 0 -1770
11 | 33 -32 32 -33 1125 -3 1125 -2 0 120 0 120 -1040 0 -1040 0 0 1160 0 1160
12 | 1600 0 1600 0 0 -320 0 -320 120 0 120 0 -2 845 -3 845 -33 32 -32 33 -325 3
13 | -325 3 0 79 0 80 -120 0 -120 0 0 -80 0 -80 -880 0 -880 0 0 80 0 80 -120 0
14 | -120 0 0 -80z m0 -440 l0 -120 120 0 120 0 0 120 0 120 880 0 880 0 0 -120 0
15 | -120 120 0 120 0 0 120 0 120 240 0 240 0 0 -320 0 -320 -1600 0 -1600 0 0
16 | 320 0 320 240 0 240 0 0 -120z"/>
17 | <path d="M880 2640 l0 -400 400 0 400 0 0 400 0 400 -400 0 -400 0 0 -400z
18 | m560 0 l0 -160 -160 0 -160 0 0 160 0 160 160 0 160 0 0 -160z"/>
19 | <path d="M1920 2600 l0 -120 160 0 160 0 0 120 0 120 -160 0 -160 0 0 -120z"/>
20 | <path d="M2560 2600 l0 -120 160 0 160 0 0 120 0 120 -160 0 -160 0 0 -120z"/>
21 | <path d="M3675 2474 c-261 -39 -481 -148 -651 -325 -402 -419 -405 -1068 -7
22 | -1490 92 -97 179 -161 308 -224 464 -230 1023 -98 1336 314 71 94 155 267 186
23 | 386 23 89 26 119 26 265 0 146 -3 176 -26 265 -31 119 -115 292 -186 386 -199
24 | 261 -497 415 -826 424 -71 2 -143 1 -160 -1z m255 -245 c181 -29 325 -104 460
25 | -239 165 -165 250 -365 250 -590 0 -225 -85 -425 -250 -590 -165 -165 -365
26 | -250 -590 -250 -225 0 -425 85 -590 250 -105 105 -162 194 -204 320 -78 234
27 | -55 472 67 690 57 102 205 250 307 307 171 96 367 132 550 102z"/>
28 | <path d="M3680 1695 c0 -246 3 -311 14 -333 8 -15 100 -112 205 -217 l191
29 | -190 85 85 85 85 -170 170 -170 170 0 268 0 267 -120 0 -120 0 0 -305z"/>
30 | <path d="M880 1720 l0 -120 160 0 160 0 0 120 0 120 -160 0 -160 0 0 -120z"/>
31 | <path d="M1520 1720 l0 -120 160 0 160 0 0 120 0 120 -160 0 -160 0 0 -120z"/>
32 | <path d="M2160 1720 l0 -120 160 0 160 0 0 120 0 120 -160 0 -160 0 0 -120z"/>
33 | </g>
34 | </svg>
35 | 


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/search.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-search fa-w-16" data-icon="search" data-prefix="fas" focusable="false" role="img" viewBox="0 0 512 512"><path fill="#002835" d="M505 442.7L405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9 0 208 0S0 93.1 0 208s93.1 208 208 208c48.3 0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9 0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7 0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7 0 128 57.2 128 128 0 70.7-57.2 128-128 128z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/settings.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-cogs fa-w-20" data-icon="cogs" data-prefix="fas" focusable="false" role="img" viewBox="0 0 640 512"><path fill="#002835" d="M512.1 191l-8.2 14.3c-3 5.3-9.4 7.5-15.1 5.4-11.8-4.4-22.6-10.7-32.1-18.6-4.6-3.8-5.8-10.5-2.8-15.7l8.2-14.3c-6.9-8-12.3-17.3-15.9-27.4h-16.5c-6 0-11.2-4.3-12.2-10.3-2-12-2.1-24.6 0-37.1 1-6 6.2-10.4 12.2-10.4h16.5c3.6-10.1 9-19.4 15.9-27.4l-8.2-14.3c-3-5.2-1.9-11.9 2.8-15.7 9.5-7.9 20.4-14.2 32.1-18.6 5.7-2.1 12.1.1 15.1 5.4l8.2 14.3c10.5-1.9 21.2-1.9 31.7 0L552 6.3c3-5.3 9.4-7.5 15.1-5.4 11.8 4.4 22.6 10.7 32.1 18.6 4.6 3.8 5.8 10.5 2.8 15.7l-8.2 14.3c6.9 8 12.3 17.3 15.9 27.4h16.5c6 0 11.2 4.3 12.2 10.3 2 12 2.1 24.6 0 37.1-1 6-6.2 10.4-12.2 10.4h-16.5c-3.6 10.1-9 19.4-15.9 27.4l8.2 14.3c3 5.2 1.9 11.9-2.8 15.7-9.5 7.9-20.4 14.2-32.1 18.6-5.7 2.1-12.1-.1-15.1-5.4l-8.2-14.3c-10.4 1.9-21.2 1.9-31.7 0zm-10.5-58.8c38.5 29.6 82.4-14.3 52.8-52.8-38.5-29.7-82.4 14.3-52.8 52.8zM386.3 286.1l33.7 16.8c10.1 5.8 14.5 18.1 10.5 29.1-8.9 24.2-26.4 46.4-42.6 65.8-7.4 8.9-20.2 11.1-30.3 5.3l-29.1-16.8c-16 13.7-34.6 24.6-54.9 31.7v33.6c0 11.6-8.3 21.6-19.7 23.6-24.6 4.2-50.4 4.4-75.9 0-11.5-2-20-11.9-20-23.6V418c-20.3-7.2-38.9-18-54.9-31.7L74 403c-10 5.8-22.9 3.6-30.3-5.3-16.2-19.4-33.3-41.6-42.2-65.7-4-10.9.4-23.2 10.5-29.1l33.3-16.8c-3.9-20.9-3.9-42.4 0-63.4L12 205.8c-10.1-5.8-14.6-18.1-10.5-29 8.9-24.2 26-46.4 42.2-65.8 7.4-8.9 20.2-11.1 30.3-5.3l29.1 16.8c16-13.7 34.6-24.6 54.9-31.7V57.1c0-11.5 8.2-21.5 19.6-23.5 24.6-4.2 50.5-4.4 76-.1 11.5 2 20 11.9 20 23.6v33.6c20.3 7.2 38.9 18 54.9 31.7l29.1-16.8c10-5.8 22.9-3.6 30.3 5.3 16.2 19.4 33.2 41.6 42.1 65.8 4 10.9.1 23.2-10 29.1l-33.7 16.8c3.9 21 3.9 42.5 0 63.5zm-117.6 21.1c59.2-77-28.7-164.9-105.7-105.7-59.2 77 28.7 164.9 105.7 105.7zm243.4 182.7l-8.2 14.3c-3 5.3-9.4 7.5-15.1 5.4-11.8-4.4-22.6-10.7-32.1-18.6-4.6-3.8-5.8-10.5-2.8-15.7l8.2-14.3c-6.9-8-12.3-17.3-15.9-27.4h-16.5c-6 0-11.2-4.3-12.2-10.3-2-12-2.1-24.6 0-37.1 1-6 6.2-10.4 12.2-10.4h16.5c3.6-10.1 9-19.4 15.9-27.4l-8.2-14.3c-3-5.2-1.9-11.9 2.8-15.7 9.5-7.9 20.4-14.2 32.1-18.6 5.7-2.1 12.1.1 15.1 5.4l8.2 14.3c10.5-1.9 21.2-1.9 31.7 0l8.2-14.3c3-5.3 9.4-7.5 15.1-5.4 11.8 4.4 22.6 10.7 32.1 18.6 4.6 3.8 5.8 10.5 2.8 15.7l-8.2 14.3c6.9 8 12.3 17.3 15.9 27.4h16.5c6 0 11.2 4.3 12.2 10.3 2 12 2.1 24.6 0 37.1-1 6-6.2 10.4-12.2 10.4h-16.5c-3.6 10.1-9 19.4-15.9 27.4l8.2 14.3c3 5.2 1.9 11.9-2.8 15.7-9.5 7.9-20.4 14.2-32.1 18.6-5.7 2.1-12.1-.1-15.1-5.4l-8.2-14.3c-10.4 1.9-21.2 1.9-31.7 0zM501.6 431c38.5 29.6 82.4-14.3 52.8-52.8-38.5-29.6-82.4 14.3-52.8 52.8z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/tools.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" class="svg-inline--fa fa-tools fa-w-16" data-icon="tools" data-prefix="fas" focusable="false" role="img" viewBox="0 0 512 512"><path fill="#002835" d="M501.1 395.7L384 278.6c-23.1-23.1-57.6-27.6-85.4-13.9L192 158.1V96L64 0 0 64l96 128h62.1l106.6 106.6c-13.6 27.8-9.2 62.3 13.9 85.4l117.1 117.1c14.6 14.6 38.2 14.6 52.7 0l52.7-52.7c14.5-14.6 14.5-38.2 0-52.7zM331.7 225c28.3 0 54.9 11 74.9 31l19.4 19.4c15.8-6.9 30.8-16.5 43.8-29.5 37.1-37.1 49.7-89.3 37.9-136.7-2.2-9-13.5-12.1-20.1-5.5l-74.4 74.4-67.9-11.3L334 98.9l74.4-74.4c6.6-6.6 3.4-17.9-5.7-20.2-47.4-11.7-99.6.9-136.6 37.9-28.5 28.5-41.9 66.1-41.2 103.6l82.1 82.1c8.1-1.9 16.5-2.9 24.7-2.9zm-103.9 82l-56.7-56.7L18.7 402.8c-25 25-25 65.5 0 90.5s65.5 25 90.5 0l123.6-123.6c-7.6-19.9-9.9-41.6-5-62.7zM64 472c-13.2 0-24-10.8-24-24 0-13.3 10.7-24 24-24s24 10.7 24 24c0 13.2-10.7 24-24 24z"/></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/workflows.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" preserveAspectRatio="xMidYMid meet" viewBox="0 0 48 48" style="-ms-transform: rotate(360deg); -webkit-transform: rotate(360deg); transform: rotate(360deg);"><path fill="#002835" d="M7 31h10v10H7z"/><path fill="#002835" d="M35.3 19.3l-5.6-5.6c-.4-.4-.4-1 0-1.4l5.6-5.6c.4-.4 1-.4 1.4 0l5.6 5.6c.4.4.4 1 0 1.4l-5.6 5.6c-.4.4-1 .4-1.4 0z"/><circle fill="#002835" cx="12" cy="13" r="6"/><circle fill="#002835" cx="36" cy="36" r="6"/><g fill="#90A4AE"><path d="M11 24h2v5h-2z"/><path d="M12 21l-3 4h6z"/></g><g fill="#90A4AE"><path d="M20 12h5v2h-5z"/><path d="M28 13l-4-3v6z"/></g><g fill="#90A4AE"><path d="M35 21h2v5h-2z"/><path d="M36 29l3-4h-6z"/></g><rect x="0" y="0" width="48" height="48" fill="rgba(0, 0, 0, 0)" /></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/logos/write-code.svg:
--------------------------------------------------------------------------------
1 | <svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="code" class="svg-inline--fa fa-code fa-w-20" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path fill="#002835" d="M278.9 511.5l-61-17.7c-6.4-1.8-10-8.5-8.2-14.9L346.2 8.7c1.8-6.4 8.5-10 14.9-8.2l61 17.7c6.4 1.8 10 8.5 8.2 14.9L293.8 503.3c-1.9 6.4-8.5 10.1-14.9 8.2zm-114-112.2l43.5-46.4c4.6-4.9 4.3-12.7-.8-17.2L117 256l90.6-79.7c5.1-4.5 5.5-12.3.8-17.2l-43.5-46.4c-4.5-4.8-12.1-5.1-17-.5L3.8 247.2c-5.1 4.7-5.1 12.8 0 17.5l144.1 135.1c4.9 4.6 12.5 4.4 17-.5zm327.2.6l144.1-135.1c5.1-4.7 5.1-12.8 0-17.5L492.1 112.1c-4.8-4.5-12.4-4.3-17 .5L431.6 159c-4.6 4.9-4.3 12.7.8 17.2L523 256l-90.6 79.7c-5.1 4.5-5.5 12.3-.8 17.2l43.5 46.4c4.5 4.9 12.1 5.1 17 .6z"></path></svg>


--------------------------------------------------------------------------------
/src/.vuepress/public/og-image.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kuzzleio/documentation/581ea7eceff7bfbea53fcaeed3ddf9683037a8c5/src/.vuepress/public/og-image.png


--------------------------------------------------------------------------------
/src/.vuepress/sections.schema.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "title": "Sections Schema",
 3 |   "description": "Defines the format of the sections.json file",
 4 |   "type": "object",
 5 |   "additionalProperties": {
 6 |     "type": "object",
 7 |     "additionalProperties": false,
 8 |     "properties": {
 9 |       "kuzzleMajor": {
10 |         "type": "integer"
11 |       },
12 |       "section": {
13 |         "type": "string"
14 |       },
15 |       "subsection": {
16 |         "type": "string"
17 |       },
18 |       "name": {
19 |         "type": "string"
20 |       },
21 |       "version": {
22 |         "type": "integer"
23 |       },
24 |       "icon": {
25 |         "type": "string"
26 |       },
27 |       "deprecated": {
28 |         "type": "boolean"
29 |       },
30 |       "deprecatedBannerComponent": {
31 |         "type": "string"
32 |       },
33 |       "released": {
34 |         "type": "boolean"
35 |       },
36 |       "closedSources": {
37 |         "type": "boolean"
38 |       }
39 |     },
40 |     "required": ["name", "kuzzleMajor", "section", "released"]
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/Footer.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <footer class="md-footer">
 3 |     <ul class="md-footer-external md-typeset">
 4 |       <li class="md-footer-external__link">
 5 |         <a href="https://github.com/kuzzleio/" target="_blank">
 6 |           <font-awesome-icon icon="fa-brands fa-github" class="md-footer-external__link__img"/>
 7 |           <div class="md-footer-external__link__title">Github</div>
 8 |           <div class="md-footer-external__link__description">
 9 |             Contribute to Kuzzle projects
10 |           </div>
11 |         </a>
12 |       </li>
13 |       <li class="md-footer-external__link">
14 |         <a
15 |           href="https://stackoverflow.com/questions/ask?guided=false&tags=Kuzzle&title=[Kuzzle]"
16 |           target="_blank"
17 |         >
18 |           <font-awesome-icon icon="fa-brands fa-stack-overflow" class="md-footer-external__link__img"/>
19 |           <div class="md-footer-external__link__title">Stack Overflow</div>
20 |           <div class="md-footer-external__link__description">
21 |             Ask a question
22 |           </div>
23 |         </a>
24 |       </li>
25 |       <li class="md-footer-external__link">
26 |         <a href="http://join.discord.kuzzle.io" target="_blank">
27 |           <font-awesome-icon icon="fa-brands fa-discord" class="md-footer-external__link__img"/>
28 |           <div class="md-footer-external__link__title">Discord</div>
29 |           <div class="md-footer-external__link__description">
30 |             Chat with the community and Kuzzle developers
31 |           </div>
32 |         </a>
33 |       </li>
34 |       <li class="md-footer-external__link">
35 |         <a
36 |           href="https://www.youtube.com/channel/UCHcEzVQoH10YSyxc7jD3SMw"
37 |           target="_blank"
38 |           alt="youtube logo"
39 |         >
40 |           <font-awesome-icon icon="fa-brands fa-youtube" class="md-footer-external__link__img"/>
41 |           <div class="md-footer-external__link__title">Youtube</div>
42 |           <div class="md-footer-external__link__description">
43 |             Check out our tutorial videos
44 |           </div>
45 |         </a>
46 |       </li>
47 |     </ul>
48 |     <div class="md-footer-meta md-typeset">
49 |       <div class="md-footer-meta__inner md-grid">
50 |         <div class="md-footer-copyright">
51 |           <div class="md-footer-copyright__highlight">
52 |             &copy;{{ currentYearCopyright }} - Kuzzle.io
53 |           </div>
54 |           <a
55 |             href="https://github.com/kuzzleio/documentation/blob/master/LICENSE.md"
56 |             >Apache 2.0 License</a
57 |           >
58 |         </div>
59 | 
60 |         <div class="md-footer-social">
61 |           <a
62 |             href="https://kuzzle.io"
63 |             class="md-footer-social__link"
64 |             target="_blank"
65 |           >
66 |             <font-awesome-icon icon="fa-solid fa-globe" size="xs" />
67 |           </a>
68 |           <a
69 |             href="https://twitter.com/kuzzleio"
70 |             class="md-footer-social__link"
71 |             target="_blank"
72 |           >
73 |             <font-awesome-icon icon="fa-brands fa-x-twitter" size="xs" />
74 |           </a>
75 |           <a
76 |             href="https://www.linkedin.com/company/kuzzle/"
77 |             class="md-footer-social__link"
78 |             target="_blank"
79 |           >
80 |             <font-awesome-icon icon="fa-brands fa-linkedin-in" size="xs" />
81 |           </a>
82 |         </div>
83 |       </div>
84 |     </div>
85 |   </footer>
86 | </template>
87 | 
88 | <script>
89 | export default {
90 |   computed: {
91 |     currentYearCopyright() {
92 |       return new Date().getFullYear();
93 |     }
94 |   }
95 | };
96 | </script>
97 | 
98 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/Header.vue:
--------------------------------------------------------------------------------
  1 | <template>
  2 |   <div>
  3 |     <header class="md-header" data-md-component="header">
  4 |       <!-- Top-level navigation -->
  5 |       <nav class="md-header-nav">
  6 |         <!-- Link to home -->
  7 |         <div>
  8 |           <a href="/" class="md-header-nav__button md-logo">
  9 |             <img
 10 |               :src="$withBase('/logo-min.png')"
 11 |               alt="kuzzle logo mini"
 12 |               width="40"
 13 |               height="40"
 14 |             />
 15 |           </a>
 16 |         </div>
 17 | 
 18 |         <!-- Button to toggle drawer -->
 19 |         <div>
 20 |           <label
 21 |             class="md-header-nav__button drawer-icon"
 22 |             for="drawer"
 23 |             @click="$emit('openSidebar')"
 24 |           >
 25 |             <font-awesome-icon icon="fa-solid fa-bars" size="sm" />
 26 |           </label>
 27 |         </div>
 28 | 
 29 |         <!-- Header title -->
 30 |         <div data-md-component="title">
 31 |           <span>
 32 |             <MajorVersionSelector :kuzzle-major="kuzzleMajor" />
 33 |           </span>
 34 |         </div>
 35 | 
 36 |         <div class="md-header-nav__top-menu-container">
 37 |           <div class="screen-only">
 38 |             <div style="display: none">{{ debugInfo }}</div>
 39 |             <TopMenu :kuzzle-major="kuzzleMajor" v-if="kuzzleMajor === 2" />
 40 |             <TopMenuV1 :kuzzle-major="kuzzleMajor" v-else />
 41 |           </div>
 42 |         </div>
 43 | 
 44 |         <!-- Search interface -->
 45 |         <div class="md-header-nav__search-container">
 46 |           <SearchBox :options="searchboxOptions" />
 47 |         </div>
 48 | 
 49 |         <div class="divider"></div>
 50 |         <button class="btnCta"><a href="https://kuzzle.io" target="_blank">Discover Kuzzle</a></button>
 51 | 
 52 |         <!-- Repository containing source -->
 53 |         <!-- <div class="md-flex__cell md-flex__cell--shrink">
 54 |               <div class="md-header-nav__source">
 55 |                   {% include "partials/source.html" %}
 56 |               </div>
 57 |         </div>-->
 58 |       </nav>
 59 |     </header>
 60 |   </div>
 61 | </template>
 62 | 
 63 | <script>
 64 | import TopMenu from './TopMenu.vue';
 65 | import TopMenuV1 from './TopMenuV1.vue';
 66 | import MajorVersionSelector from '../components/MajorVersionSelector.vue';
 67 | 
 68 | export default {
 69 |   components: {
 70 |     TopMenu,
 71 |     TopMenuV1,
 72 |     MajorVersionSelector,
 73 |   },
 74 |   name: 'Header',
 75 |   props: {
 76 |     kuzzleMajor: {
 77 |       type: Number,
 78 |       default: 2,
 79 |     },
 80 |   },
 81 |   computed: {
 82 |     debugInfo() {
 83 |       return JSON.stringify(
 84 |         {
 85 |           kuzzleMajor: this.kuzzleMajor,
 86 |         },
 87 |         null,
 88 |         2
 89 |       );
 90 |     },
 91 |     searchboxOptions() {
 92 |       return {
 93 |         searchParameters: {
 94 |           facetFilters: [`version:${this.kuzzleMajor}`],
 95 |         },
 96 |       };
 97 |     },
 98 |   },
 99 | };
100 | </script>
101 | 
102 | <style lang="scss">
103 | .divider {
104 |   height: 30px;
105 |   width: 2px;
106 |   background-color: rgba(255, 255, 255, 0.2);
107 |   margin: 0 0.5rem;
108 | }
109 | </style>
110 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/NotFound.vue:
--------------------------------------------------------------------------------
  1 | <template>
  2 |   <div class="md-layout">
  3 |     <div
  4 |       class="overlay"
  5 |       :class="{ hidden: !sidebarOpen }"
  6 |       @click="closeSidebar"
  7 |     ></div>
  8 |     <Header ref="header" @openSidebar="openSidebar" />
  9 |     <div ref="container" class="md-container">
 10 |       <main class="md-main">
 11 |         <div class="md-main__inner md-grid" data-md-component="container">
 12 |           <!-- Main navigation -->
 13 |           <Sidebar
 14 |             ref="sidebar"
 15 |             :kuzzleMajor="kuzzleMajor"
 16 |             :sdkList="[]"
 17 |             :sidebarOpen="sidebarOpen"
 18 |             @closeSidebar="closeSidebar"
 19 |           />
 20 |           <div
 21 |             class="md-sidebar md-sidebar--primary"
 22 |             data-md-component="navigation"
 23 |             ref="sidebar"
 24 |           >
 25 |             <div
 26 |               v-if="!page$.frontmatter.nosidebar"
 27 |               class="md-sidebar__scrollwrap"
 28 |             >
 29 |               <div class="md-sidebar__inner"></div>
 30 |             </div>
 31 |           </div>
 32 | 
 33 |           <!-- Main container -->
 34 |           <div class="md-content">
 35 |             <article class="md-content__inner md-typeset">
 36 |               <h1>404 Page not found</h1>
 37 |               <p>
 38 |                 The page you are looking for doesn't exist or has been moved.<br />
 39 |                 Maybe you can try to do a search.<br />
 40 |                 Otherwise, you could go to the home page.
 41 |               </p>
 42 |               <div class="cta-wrapper">
 43 |                 <btnCta btnTextInside="Go to home" btnUrl="/" />
 44 |               </div>
 45 |               <p>
 46 |                 If you believe this is the result of an error, please
 47 |                 <a
 48 |                   href="https://github.com/kuzzleio/documentation/issues/new/choose"
 49 |                 >
 50 |                   let our team know.
 51 |                 </a>
 52 |                 We will be very grateful.
 53 |               </p>
 54 |             </article>
 55 |           </div>
 56 |         </div>
 57 |       </main>
 58 |       <Footer ref="footer" />
 59 |     </div>
 60 |   </div>
 61 | </template>
 62 | 
 63 | <script>
 64 | import { usePageData } from 'vuepress/client';
 65 | 
 66 | import { getCurrentVersion } from '../helpers';
 67 | import Header from './Header.vue';
 68 | import btnCta from '../components/Cta.vue';
 69 | import Footer from './Footer.vue';
 70 | import Sidebar from './Sidebar.vue';
 71 | 
 72 | export default {
 73 |   components: {
 74 |     Header,
 75 |     btnCta,
 76 |     Footer,
 77 |     Sidebar
 78 |   },
 79 |   data() {
 80 |     return {
 81 |       sidebarOpen: false
 82 |     };
 83 |   },
 84 |   computed: {
 85 |     kuzzleMajor() {
 86 |       return getCurrentVersion(this.page$);
 87 |     }
 88 |   },
 89 |   setup() {
 90 |     return { page$: usePageData() };
 91 |   },
 92 |   methods: {
 93 |     setContainerPadding() {
 94 |       const padding = this.$refs.header.$el.querySelector('header')
 95 |         .offsetHeight;
 96 |       if (padding === null || typeof padding === 'undefined') {
 97 |         return;
 98 |       }
 99 |       this.$refs.container.style = `padding-top: ${padding}px;`;
100 |     },
101 |     openSidebar() {
102 |       this.sidebarOpen = true;
103 |     },
104 |     closeSidebar() {
105 |       this.sidebarOpen = false;
106 |     }
107 |   },
108 |   mounted() {
109 |     this.setContainerPadding();
110 |   }
111 | };
112 | </script>
113 | 
114 | <style lang="scss">
115 | .cta-wrapper {
116 |   padding: 10px 0;
117 | }
118 | </style>
119 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/TOC.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <nav v-if="headers.length" class="md-nav md-nav--secondary">
 4 |       <label class="md-nav__title" for="toc">Table of contents</label>
 5 |       <ul class="md-nav__list" data-md-scrollfix>
 6 |         <li class="md-nav__item">
 7 |           <RouteLink to="" class="md-nav__link">{{ page$.title }}</RouteLink>
 8 |         </li>
 9 |         <li v-for="header of headers" class="md-nav__item">
10 |           <RouteLink :to="getPath(header)" :class="headerLinkClass(header)">{{ header.title }}</RouteLink>
11 |         </li>
12 |       </ul>
13 |     </nav>
14 |   </div>
15 | </template>
16 | 
17 | <script>
18 | import {
19 |   usePageData,
20 |   useSiteData,
21 | } from 'vuepress/client';
22 | 
23 | import { resolveHeaders } from '../util';
24 | 
25 | export default {
26 |   computed: {
27 |     headers() {
28 |       return resolveHeaders(this.page$)[0].children || [];
29 |     },
30 |     isLinkActive() {
31 |       return (link) => {
32 |         return link === this.$route.fullPath;
33 |       };
34 |     },
35 |     headerLinkClass() {
36 |       return (header) => {
37 |         return {
38 |           'md-nav__link': true,
39 |           'md-nav__link--active': this.isLinkActive(this.getPath(header)),
40 |         };
41 |       };
42 |     },
43 |   },
44 |   setup() {
45 |     return {
46 |       page$: usePageData(),
47 |       site$: useSiteData(),
48 |     };
49 |   },
50 |   methods: {
51 |     getPath(header) {
52 |       return `${header.path}`;
53 |     }
54 |   }
55 | };
56 | </script>
57 | 
58 | <style></style>
59 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/client.ts:
--------------------------------------------------------------------------------
 1 | import { defineClientConfig } from '@vuepress/client';
 2 | 
 3 | import Layout from './Layout.vue';
 4 | import NotFound from './NotFound.vue';
 5 | import './styles/main.scss';
 6 | 
 7 | export default defineClientConfig({
 8 |   layouts: {
 9 |     Layout,
10 |     NotFound,
11 |   },
12 | });
13 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/index.ts:
--------------------------------------------------------------------------------
1 | export * from './theme';
2 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/_config.scss:
--------------------------------------------------------------------------------
  1 | // ----------------------------------------------------------------------------
  2 | // Variables: typography
  3 | // ----------------------------------------------------------------------------
  4 | 
  5 | // Modular typographic scale
  6 | $ms-base: 1.6rem;
  7 | $ms-ratio: $major-third;
  8 | 
  9 | // ----------------------------------------------------------------------------
 10 | // Variables: breakpoints
 11 | // ----------------------------------------------------------------------------
 12 | 
 13 | // stylelint-disable unit-whitelist
 14 | 
 15 | // Device-specific breakpoints
 16 | $break-devices: (
 17 |   mobile: (
 18 |     portrait: px2em(220px) px2em(479px),
 19 |     landscape: px2em(480px) px2em(719px)
 20 |   ),
 21 |   tablet: (
 22 |     portrait: px2em(720px) px2em(959px),
 23 |     landscape: px2em(960px) px2em(1219px)
 24 |   ),
 25 |   screen: (
 26 |     small: px2em(1220px) px2em(1599px),
 27 |     medium: px2em(1600px) px2em(1999px),
 28 |     large: px2em(2000px)
 29 |   )
 30 | );
 31 | 
 32 | // stylelint-enable unit-whitelist
 33 | 
 34 | // ----------------------------------------------------------------------------
 35 | // Variables: base colors
 36 | // ----------------------------------------------------------------------------
 37 | 
 38 | // Primary and accent colors
 39 | $md-color-primary: $clr-indigo-500 !default;
 40 | $md-color-accent: $clr-indigo-a200 !default;
 41 | $md-color-pink: #e94e77;
 42 | $md-color-pink-light: rgba(233, 78, 119, 0.3);
 43 | $md-color-blue: #002835;
 44 | $md-color-blue-light: RGBA(0, 40, 53, 0.3);
 45 | 
 46 | // Shades of black
 47 | $md-color-black: hsla(0, 0%, 0%, 0.87) !default;
 48 | $md-color-black--light: hsla(0, 0%, 0%, 0.54) !default;
 49 | $md-color-black--lighter: hsla(0, 0%, 0%, 0.26) !default;
 50 | $md-color-black--lightest: hsla(0, 0%, 0%, 0.07) !default;
 51 | $md-color-black--transparent: hsla(0, 0%, 0%, 0) !default;
 52 | 
 53 | // Shades of white
 54 | $md-color-white: hsla(0, 0%, 100%, 1) !default;
 55 | $md-color-white--light: hsla(0, 0%, 100%, 0.7) !default;
 56 | $md-color-white--lighter: hsla(0, 0%, 100%, 0.3) !default;
 57 | $md-color-white--lightest: hsla(0, 0%, 100%, 0.12) !default;
 58 | $md-color-white--transparent: hsla(0, 0%, 100%, 0) !default;
 59 | 
 60 | // Custom properties
 61 | :root {
 62 |   // Text
 63 |   --vp-c-text: #{$md-color-black};
 64 |   --vp-c-text-muted: #{$md-color-black--light};
 65 |   --vp-c-text-subtle: #{$md-color-black--lighter};
 66 | 
 67 |   // Background
 68 |   --vp-c-bg: #{$md-color-white};
 69 |   --vp-c-bg-alt: #{$md-color-blue};
 70 |   --vp-c-bg-elv: #{$md-color-black--light};
 71 | 
 72 |   // Shadow
 73 |   --vp-c-shadow: #{$md-color-black--lighter};
 74 | 
 75 |   // Accent
 76 |   --vp-c-accent: #{$md-color-pink};
 77 |   --vp-c-accent-hover: #{$md-color-pink};
 78 |   --vp-c-accent-bg: #{$md-color-pink};
 79 |   --vp-c-accent-text: #{$md-color-black};
 80 |   --vp-c-accent-soft: #{$md-color-pink-light};
 81 | }
 82 | 
 83 | // ----------------------------------------------------------------------------
 84 | // Variables: sizing and spacing
 85 | // ----------------------------------------------------------------------------
 86 | 
 87 | // Icons
 88 | $md-icon-size: $ms-base * 1.5;
 89 | $md-icon-padding: $ms-base * 0.5;
 90 | $md-icon-margin: $ms-base * 0.25;
 91 | 
 92 | // Code blocks
 93 | $md-code-background: $md-color-blue;
 94 | $md-code-background-highlighted: #02171f;
 95 | $md-code-color: #c2c6cf;
 96 | 
 97 | // Keystrokes
 98 | $md-keyboard-background: #fcfcfc;
 99 | $md-keyboard-color: #555555;
100 | 
101 | $md-code-background-inline: $md-color-black--lightest;
102 | $md-code-color-inline: $md-color-black--light;
103 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/base/_icons.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Icon placeholders
 6 | %md-icon {
 7 |   font-family: 'Font Awesome 6 Free';
 8 |   font-style: normal;
 9 |   font-variant: normal;
10 |   font-weight: normal;
11 |   line-height: 1;
12 |   text-transform: none;
13 |   white-space: nowrap;
14 |   word-wrap: normal;
15 |   direction: ltr;
16 | 
17 |   // Icon rendered as button
18 |   &__button {
19 |     display: inline-block;
20 |     margin: $md-icon-margin;
21 |     padding: $md-icon-padding;
22 |     font-size: $md-icon-size;
23 |     cursor: pointer;
24 |   }
25 | }
26 | 
27 | // Representational classes
28 | .md-icon {
29 |   @extend %md-icon;
30 | 
31 |   // Build representational classes
32 |   @each $ligature,
33 |     $name
34 |       in (
35 |         '\F060': 'arrow-back',
36 |         '\F061': 'arrow-forward',
37 |         '\F0C9': 'menu',
38 |         '\F002': 'search'
39 |       )
40 |   {
41 |     &--#{$name}::before {
42 |       content: $ligature;
43 |     }
44 |   }
45 | 
46 |   // Adjust for RTL languages
47 |   [dir='rtl'] & {
48 |     // Flip ligatures for arrows
49 |     @each $ligature,
50 |       $name
51 |         in (
52 |           '\F061': 'arrow-back',
53 |           '\F060': 'arrow-forward'
54 |         )
55 |     {
56 |       &--#{$name}::before {
57 |         content: $ligature;
58 |       }
59 |     }
60 |   }
61 | }
62 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/base/_reset.scss:
--------------------------------------------------------------------------------
  1 | // ----------------------------------------------------------------------------
  2 | // Rules
  3 | // ----------------------------------------------------------------------------
  4 | 
  5 | // Enforce correct box model
  6 | html {
  7 |   box-sizing: border-box;
  8 | }
  9 | 
 10 | // All elements shall inherit the document default
 11 | *,
 12 | *::before,
 13 | *::after {
 14 |   box-sizing: inherit;
 15 | }
 16 | 
 17 | // Prevent adjustments of font size after orientation changes in IE and iOS
 18 | html {
 19 |   text-size-adjust: none;
 20 | }
 21 | 
 22 | // Remove margin in all browsers
 23 | body {
 24 |   margin: 0;
 25 | }
 26 | 
 27 | // Reset horizontal rules in FF
 28 | hr {
 29 |   overflow: visible;
 30 |   box-sizing: content-box;
 31 | }
 32 | 
 33 | // Remove gaps in underlined links in iOS >= 8 and Safari >= 8
 34 | a {
 35 |   -webkit-text-decoration-skip: objects;
 36 | }
 37 | 
 38 | // Reset tap outlines on iOS and Android
 39 | a,
 40 | button,
 41 | label,
 42 | input {
 43 |   -webkit-tap-highlight-color: transparent;
 44 | }
 45 | 
 46 | // Reset link styles
 47 | a {
 48 |   color: inherit;
 49 |   text-decoration: none;
 50 | }
 51 | 
 52 | // Normalize font-size in all browsers
 53 | small {
 54 |   font-size: 80%;
 55 | }
 56 | 
 57 | // Prevent subscript and superscript from affecting line-height
 58 | sub,
 59 | sup {
 60 |   position: relative;
 61 |   font-size: 80%;
 62 |   line-height: 0;
 63 |   vertical-align: baseline;
 64 | }
 65 | 
 66 | // Correct subscript offset
 67 | sub {
 68 |   bottom: -0.25em;
 69 | }
 70 | 
 71 | // Correct superscript offset
 72 | sup {
 73 |   top: -0.5em;
 74 | }
 75 | 
 76 | // Remove borders on images
 77 | img {
 78 |   border-style: none;
 79 | }
 80 | 
 81 | // Reset table styles
 82 | table {
 83 |   border-collapse: separate;
 84 |   border-spacing: 0;
 85 | }
 86 | 
 87 | // Reset table cell styles
 88 | td,
 89 | th {
 90 |   font-weight: normal;
 91 |   vertical-align: top;
 92 | }
 93 | 
 94 | // Reset (native) button styles
 95 | button {
 96 |   margin: 0;
 97 |   padding: 0;
 98 |   border: 0;
 99 |   outline-style: none;
100 |   background: transparent;
101 |   font-size: inherit;
102 | }
103 | 
104 | // Reset (native) input styles
105 | input {
106 |   border: 0;
107 |   outline: 0;
108 | }
109 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_alert.scss:
--------------------------------------------------------------------------------
 1 | .alert {
 2 |   border-radius: 4px;
 3 |   padding: 12px 16px;
 4 |   color: #002835;
 5 |   line-height: 1.6;
 6 |   position: relative;
 7 |   margin-top: 2rem;
 8 |   font-size: 16px;
 9 | 
10 |   display: flex;
11 |   align-items: center;
12 |   gap: 12px;
13 | 
14 |   &.deprecatedBanner {
15 |     vertical-align: middle;
16 |   }
17 | 
18 |   p {
19 |     margin-top: 0;
20 |     margin-bottom: 0;
21 |   }
22 | 
23 |   .content {
24 |     overflow: auto;
25 |     flex: 1;
26 | 
27 |     display: flex;
28 |     flex-direction: column;
29 |   }
30 | 
31 |   &.alert-success {
32 |     background: $clr-blue-100;
33 | 
34 |     .fa-circle-check {
35 |       color: $clr-blue-900;
36 |     }
37 |   }
38 | 
39 |   &.alert-info {
40 |     background: $clr-green-100;
41 | 
42 |     .fa-circle-info {
43 |       color: $clr-green-900;
44 |     }
45 |   }
46 | 
47 |   &.alert-warning {
48 |     background: $clr-orange-100;
49 | 
50 |     a {
51 |       color: #002835;
52 |       text-decoration: underline;
53 |     }
54 | 
55 |     .fa-triangle-exclamation {
56 |       color: $clr-brown-700;
57 |     }
58 |   }
59 | 
60 |   &.alert-message {
61 |     background: $clr-blue-50;
62 |     padding: 20px 20px;
63 | 
64 |     a {
65 |       color: #002835;
66 |       text-decoration: underline;
67 |     }
68 |   }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_badge.scss:
--------------------------------------------------------------------------------
 1 | .vp-badge {
 2 |     display: inline-block;
 3 |     vertical-align: top;
 4 |   
 5 |     height: 18px;
 6 |     padding: 0 6px;
 7 |     border-radius: 3px;
 8 |   
 9 |     background: $md-color-accent;
10 |     color: $md-color-white;
11 |   
12 |     font-size: 14px;
13 |     line-height: 18px;
14 |   
15 |     transition:
16 |       background 0.25s,
17 |       color 0.25s;
18 |   
19 |     & + & {
20 |       margin-inline-start: 5px;
21 |     }
22 |   
23 |     &.tip {
24 |       background: $clr-green-50;
25 |       color: $clr-green-900;
26 |     }
27 |   
28 |     &.warning,
29 |     &.warn {
30 |       background: $clr-yellow-100;
31 |       color: $clr-deep-orange-900;
32 |     }
33 |   
34 |     &.danger,
35 |     &.error {
36 |       background: $clr-red-50;
37 |       color: $clr-red-900;
38 |     }
39 |   
40 |     &.important {
41 |       background: $clr-purple-50;
42 |       color: $clr-purple-900;
43 |     }
44 |   
45 |     &.info {
46 |       background: $clr-blue-50;
47 |       color: $clr-blue-900;
48 |     }
49 |   
50 |     &.note {
51 |       background: $clr-grey-100;
52 |       color: $clr-grey-900;
53 |     }
54 |   
55 |     // update the vertical align for the badge in toc
56 |     .table-of-contents & {
57 |       vertical-align: middle;
58 |     }
59 |   }


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_docsearch.scss:
--------------------------------------------------------------------------------
 1 | @use "sass:color";
 2 | 
 3 | .DocSearch {
 4 |   // Common
 5 |   --docsearch-primary-color: #{$md-color-pink};
 6 |   --docsearch-text-color: #{$md-color-white};
 7 |   --docsearch-highlight-color: var(--docsearch-primary-color);
 8 |   --docsearch-icon-color: var(--docsearch-text-color);
 9 | 
10 |   // Modal
11 |   --docsearch-modal-background: #{$md-color-white};
12 | 
13 |   // Searchbox
14 |   --docsearch-searchbox-background: #{color.scale($md-color-blue, $lightness: -30%)};
15 |   --docsearch-searchbox-focus-background: #{$md-color-blue};
16 |   --docsearch-searchbox-shadow: inset 0 0 0 2px #{color.scale($md-color-blue, $saturation: -50%, $lightness: 30%)};
17 | 
18 |   // Key
19 |   --docsearch-key-gradient: linear-gradient(
20 |     -225deg,
21 |     #{md-color-black--light} 0%,
22 |     #{md-color-black} 100%
23 |   );
24 |   --docsearch-key-shadow: inset 0 -2px 0 0 #{$md-color-blue}, inset 0 0 1px 1px #{$md-color-blue}, 0 2px 2px 0 #{$md-color-black--lighter};
25 |   --docsearch-key-pressed-shadow: inset 0 0 1px 1px #{$md-color-blue}, 0 2px 2px 0 #{$md-color-black--lighter};
26 | }
27 | 
28 | .DocSearch {
29 |   font-size: 1.5rem;
30 | 
31 |   kbd {
32 |     font-size: 1.2rem;
33 |   }
34 | }
35 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_external-links.scss:
--------------------------------------------------------------------------------
 1 | .md-main {
 2 |   // External links in main content
 3 |   a {
 4 |     &[href*="://"],
 5 |     &[target=_blank] {
 6 |       &::after {
 7 |         content: '';
 8 | 
 9 |         display: inline-block;
10 |         flex-shrink: 0;
11 | 
12 |         width: 11px;
13 |         height: 11px;
14 |         margin-top: -2px;
15 |         margin-left: 4px;
16 |         margin-right: 2px;
17 | 
18 |         background: $clr-blue-grey-500;
19 | 
20 |         $external-link-mask-image: url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%20512%20512%22%3E%3C%21--%21Font%20Awesome%20Free%206.6.0%20by%20%40fontawesome%20-%20https%3A%2F%2Ffontawesome.com%20License%20-%20https%3A%2F%2Ffontawesome.com%2Flicense%2Ffree%20Copyright%202024%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M320%200c-17.7%200-32%2014.3-32%2032s14.3%2032%2032%2032l82.7%200L201.4%20265.4c-12.5%2012.5-12.5%2032.8%200%2045.3s32.8%2012.5%2045.3%200L448%20109.3l0%2082.7c0%2017.7%2014.3%2032%2032%2032s32-14.3%2032-32l0-160c0-17.7-14.3-32-32-32L320%200zM80%2032C35.8%2032%200%2067.8%200%20112L0%20432c0%2044.2%2035.8%2080%2080%2080l320%200c44.2%200%2080-35.8%2080-80l0-112c0-17.7-14.3-32-32-32s-32%2014.3-32%2032l0%20112c0%208.8-7.2%2016-16%2016L80%20448c-8.8%200-16-7.2-16-16l0-320c0-8.8%207.2-16%2016-16l112%200c17.7%200%2032-14.3%2032-32s-14.3-32-32-32L80%2032z%22%2F%3E%3C%2Fsvg%3E");
21 |         -webkit-mask-image: $external-link-mask-image;
22 |         mask-image: $external-link-mask-image;
23 |       }
24 |     }
25 |   }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_footnotes.scss:
--------------------------------------------------------------------------------
  1 | // ----------------------------------------------------------------------------
  2 | // Rules
  3 | // ----------------------------------------------------------------------------
  4 | 
  5 | // Scoped in typesetted content to match specificity of regular content
  6 | .md-typeset {
  7 |   // All footnote references
  8 |   [id^='fnref:'] {
  9 |     display: inline-block;
 10 | 
 11 |     // Targeted anchor
 12 |     &:target {
 13 |       margin-top: -(4.8rem + 1.2rem + 1.6rem);
 14 |       padding-top: (4.8rem + 1.2rem + 1.6rem);
 15 |       pointer-events: none;
 16 |     }
 17 |   }
 18 | 
 19 |   // All footnote back references
 20 |   [id^='fn:'] {
 21 |     // Add spacing to anchor for offset
 22 |     &::before {
 23 |       display: none;
 24 |       height: 0;
 25 |       content: '';
 26 |     }
 27 | 
 28 |     // Targeted anchor
 29 |     &:target::before {
 30 |       display: block;
 31 |       margin-top: -(4.8rem + 1.2rem + 1rem);
 32 |       padding-top: (4.8rem + 1.2rem + 1rem);
 33 |       pointer-events: none;
 34 |     }
 35 |   }
 36 | 
 37 |   // Footnotes extension
 38 |   .footnote {
 39 |     color: $md-color-black--light;
 40 |     font-size: ms(-1);
 41 | 
 42 |     // Remove additional spacing on footnotes
 43 |     ol {
 44 |       margin-left: 0;
 45 |     }
 46 | 
 47 |     // Footnote
 48 |     li {
 49 |       transition: color 0.25s;
 50 | 
 51 |       // Darken color for targeted footnote
 52 |       &:target {
 53 |         color: $md-color-black;
 54 |       }
 55 | 
 56 |       // Remove spacing on first element
 57 |       :first-child {
 58 |         margin-top: 0;
 59 |       }
 60 | 
 61 |       // Make back references visible on hover
 62 |       &:hover .footnote-backref,
 63 |       &:target .footnote-backref {
 64 |         transform: translateX(0);
 65 |         opacity: 1;
 66 |       }
 67 | 
 68 |       // Active or targeted back reference
 69 |       &:hover .footnote-backref:hover,
 70 |       &:target .footnote-backref {
 71 |         color: $md-color-accent;
 72 |       }
 73 |     }
 74 |   }
 75 | 
 76 |   // Footnote reference
 77 |   .footnote-ref {
 78 |     display: inline-block;
 79 |     pointer-events: initial;
 80 | 
 81 |     // Render a thin line before footnote
 82 |     &::before {
 83 |       display: inline;
 84 |       margin: 0 0.2em;
 85 |       border-left: 0.1rem solid $md-color-black--lighter;
 86 |       font-size: 1.25em;
 87 |       content: '';
 88 |       vertical-align: -0.5rem;
 89 |     }
 90 |   }
 91 | 
 92 |   // Footnote back reference
 93 |   .footnote-backref {
 94 |     @extend %md-icon;
 95 | 
 96 |     display: inline-block;
 97 |     transform: translateX(0.5rem);
 98 |     transition: transform 0.25s 0.125s, color 0.25s, opacity 0.125s 0.125s;
 99 |     color: $md-color-black--lighter;
100 |     // Hack: remove Unicode arrow for icon
101 |     font-size: 0;
102 |     opacity: 0;
103 |     vertical-align: text-bottom;
104 | 
105 |     // Adjust for RTL languages
106 |     [dir='rtl'] & {
107 |       transform: translateX(-0.5rem);
108 |     }
109 | 
110 |     // Back reference icon
111 |     &::before {
112 |       display: inline-block;
113 |       font-size: 1.6rem;
114 |       content: '\F100'; // angles-left
115 | 
116 |       // Adjust for RTL languages
117 |       [dir='rtl'] & {
118 |         transform: scaleX(-1);
119 |       }
120 |     }
121 |   }
122 | }
123 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_material-shadows.scss:
--------------------------------------------------------------------------------
  1 | //
  2 | // Name:           Material Shadows
  3 | // Description:    Mixins for Material Design Shadows.
  4 | // Version:        3.0.1
  5 | //
  6 | // Author:         Denis Malinochkin
  7 | // Git:            https://github.com/mrmlnc/material-shadows
  8 | //
  9 | // twitter:        @mrmlnc
 10 | //
 11 | // ------------------------------------
 12 | 
 13 | // Mixins
 14 | // ------------------------------------
 15 | 
 16 | @mixin z-depth-transition() {
 17 |   transition: box-shadow 0.28s cubic-bezier(0.4, 0, 0.2, 1);
 18 | }
 19 | 
 20 | @mixin z-depth-focus() {
 21 |   box-shadow: 0 0 8px rgba(0, 0, 0, 0.18), 0 8px 16px rgba(0, 0, 0, 0.36);
 22 | }
 23 | 
 24 | @mixin z-depth-2dp() {
 25 |   box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12),
 26 |     0 3px 1px -2px rgba(0, 0, 0, 0.2);
 27 | }
 28 | 
 29 | @mixin z-depth-3dp() {
 30 |   box-shadow: 0 3px 4px 0 rgba(0, 0, 0, 0.14), 0 1px 8px 0 rgba(0, 0, 0, 0.12),
 31 |     0 3px 3px -2px rgba(0, 0, 0, 0.4);
 32 | }
 33 | 
 34 | @mixin z-depth-4dp() {
 35 |   box-shadow: 0 4px 5px 0 rgba(0, 0, 0, 0.14), 0 1px 10px 0 rgba(0, 0, 0, 0.12),
 36 |     0 2px 4px -1px rgba(0, 0, 0, 0.4);
 37 | }
 38 | 
 39 | @mixin z-depth-6dp() {
 40 |   box-shadow: 0 6px 10px 0 rgba(0, 0, 0, 0.14), 0 1px 18px 0 rgba(0, 0, 0, 0.12),
 41 |     0 3px 5px -1px rgba(0, 0, 0, 0.4);
 42 | }
 43 | 
 44 | @mixin z-depth-8dp() {
 45 |   box-shadow: 0 8px 10px 1px rgba(0, 0, 0, 0.14),
 46 |     0 3px 14px 2px rgba(0, 0, 0, 0.12), 0 5px 5px -3px rgba(0, 0, 0, 0.4);
 47 | }
 48 | 
 49 | @mixin z-depth-16dp() {
 50 |   box-shadow: 0 16px 24px 2px rgba(0, 0, 0, 0.14),
 51 |     0 6px 30px 5px rgba(0, 0, 0, 0.12), 0 8px 10px -5px rgba(0, 0, 0, 0.4);
 52 | }
 53 | 
 54 | @mixin z-depth-24dp() {
 55 |   box-shadow: 0 9px 46px 8px rgba(0, 0, 0, 0.14),
 56 |     0 24px 38px 3px rgba(0, 0, 0, 0.12), 0 11px 15px -7px rgba(0, 0, 0, 0.4);
 57 | }
 58 | 
 59 | @mixin z-depth($dp: 2) {
 60 |   @if $dp == 2 {
 61 |     @include z-depth-2dp();
 62 |   } @else if $dp == 3 {
 63 |     @include z-depth-3dp();
 64 |   } @else if $dp == 4 {
 65 |     @include z-depth-4dp();
 66 |   } @else if $dp == 6 {
 67 |     @include z-depth-6dp();
 68 |   } @else if $dp == 8 {
 69 |     @include z-depth-8dp();
 70 |   } @else if $dp == 16 {
 71 |     @include z-depth-16dp();
 72 |   } @else if $dp == 24 {
 73 |     @include z-depth-24dp();
 74 |   }
 75 | }
 76 | 
 77 | // Class generator
 78 | // ------------------------------------
 79 | 
 80 | @mixin z-depth-classes($transition: false, $focus: false) {
 81 |   @if $transition == true {
 82 |     &-transition {
 83 |       @include z-depth-transition();
 84 |     }
 85 |   }
 86 | 
 87 |   @if $focus == true {
 88 |     &-focus {
 89 |       @include z-depth-focus();
 90 |     }
 91 |   }
 92 | 
 93 |   // The available values for the shadow depth
 94 |   @each $depth in 2, 3, 4, 6, 8, 16, 24 {
 95 |     &-#{$depth}dp {
 96 |       @include z-depth($depth);
 97 |     }
 98 |   }
 99 | }
100 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_menuDropdown.scss:
--------------------------------------------------------------------------------
 1 | .MenuDropdown {
 2 |   &-title {
 3 |     cursor: pointer;
 4 | 
 5 |     .fa-caret-down {
 6 |       margin-left: 4px;
 7 |     }
 8 |   }
 9 | 
10 |   &.active:after {
11 |     content: '';
12 |     width: 100%;
13 |     transition: width 0.3s;
14 |     height: 1px;
15 |     display: block;
16 |     background-color: white;
17 |   }
18 | 
19 |   &-list {
20 |     display: none;
21 |     padding: 1.5em 1em 1em 1em;
22 |     position: fixed;
23 |     background-color: #002835;
24 |     color: white;
25 |     list-style: none;
26 |     border-bottom-left-radius: 4px;
27 |     border-bottom-right-radius: 4px;
28 |     margin-top: 1px;
29 | 
30 |     &.visible {
31 |       display: block;
32 |     }
33 |   }
34 | 
35 |   &-list-item {
36 |     line-height: 2.2em;
37 |     font-size: 0.9em;
38 |   }
39 | 
40 |   &-list-item-link {
41 |     &:hover,
42 |     &.active {
43 |       padding-bottom: 2px;
44 |       border-bottom: 1px solid rgba(255, 255, 255, 0.8);
45 |     }
46 |   }
47 | }
48 | 
49 | @include break-to-device(tablet) {
50 |   .MenuDropdown {
51 |     &-title {
52 |       cursor: default;
53 | 
54 |       svg {
55 |         display: none;
56 |       }
57 |     }
58 | 
59 |     &.active:after,
60 |     &:hover:after {
61 |       width: 0%;
62 |     }
63 | 
64 |     &-list {
65 |       display: block;
66 |       position: relative;
67 |       top: 0;
68 |       padding-top: 0.5em;
69 |     }
70 |   }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_permalinks.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Permalinks extension
 8 |   .headerlink {
 9 |     display: inline-block;
10 |     margin-left: 1rem;
11 |     transform: translate(0, 0.5rem);
12 |     transition: transform 0.25s 0.25s, color 0.25s, opacity 0.125s 0.25s;
13 |     opacity: 0;
14 | 
15 |     // Adjust for RTL languages
16 |     [dir='rtl'] & {
17 |       margin-right: 1rem;
18 |       margin-left: initial;
19 |     }
20 | 
21 |     // Higher specificity for color due to palettes integration
22 |     html body & {
23 |       color: $md-color-black--lighter;
24 |     }
25 | 
26 |     // Hide for print
27 |     @media print {
28 |       display: none;
29 |     }
30 |   }
31 | 
32 |   // Correct anchor offset for link blurring
33 |   @each $level,
34 |     $delta
35 |       in (
36 |         h1: 4rem,
37 |         h2: 3.8rem,
38 |         h3: 0.9rem,
39 |         h4: 0.9rem,
40 |         h5: 1.1rem,
41 |         h6: 1.1rem
42 |       )
43 |   {
44 |     #{$level}[id] {
45 |       // Scroll 48px from header, 12px from sidebar offset
46 |       scroll-margin-top: (4.8rem + 1.2rem + $delta);
47 | 
48 |       // Make permalink visible on hover
49 |       &:hover .headerlink,
50 |       &:target .headerlink,
51 |       & .headerlink:focus {
52 |         transform: translate(0, 0);
53 |         opacity: 1;
54 |       }
55 | 
56 |       // Active or targeted permalink
57 |       &:hover .headerlink:hover,
58 |       &:target .headerlink,
59 |       & .headerlink:focus {
60 |         color: $md-color-accent;
61 |       }
62 |     }
63 |   }
64 | 
65 |   .heading-anchor-link {
66 |     opacity: 0.2;
67 |     color: $md-color-pink;
68 | 
69 |     &:hover {
70 |       opacity: 1;
71 |       color: $md-color-pink;
72 |     }
73 |   }
74 | 
75 | }
76 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_ribbon.scss:
--------------------------------------------------------------------------------
 1 | .ribbon {
 2 |   position: absolute;
 3 |   right: -5px;
 4 |   top: -5px;
 5 |   z-index: 1;
 6 |   overflow: hidden;
 7 |   width: 75px;
 8 |   height: 75px;
 9 |   text-align: right;
10 | }
11 | .ribbon span {
12 |   font-size: 10px;
13 |   font-weight: bold;
14 |   color: #fff;
15 |   text-transform: uppercase;
16 |   text-align: center;
17 |   line-height: 20px;
18 |   transform: rotate(45deg);
19 |   -webkit-transform: rotate(45deg);
20 |   width: 100px;
21 |   display: block;
22 |   background: #79a70a;
23 |   background: linear-gradient(#e94e77 0%, #e94e77 100%);
24 |   box-shadow: 0 3px 10px -5px rgba(0, 0, 0, 1);
25 |   position: absolute;
26 |   top: 19px;
27 |   right: -21px;
28 | }
29 | .ribbon span::before {
30 |   content: '';
31 |   position: absolute;
32 |   left: 0px;
33 |   top: 100%;
34 |   z-index: -1;
35 |   border-left: 3px solid #e94e77;
36 |   border-right: 3px solid transparent;
37 |   border-bottom: 3px solid transparent;
38 |   border-top: 3px solid #e94e77;
39 | }
40 | .ribbon span::after {
41 |   content: '';
42 |   position: absolute;
43 |   right: 0px;
44 |   top: 100%;
45 |   z-index: -1;
46 |   border-left: 3px solid transparent;
47 |   border-right: 3px solid #e94e77;
48 |   border-bottom: 3px solid transparent;
49 |   border-top: 3px solid #e94e77;
50 | }
51 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_sdk-selector.scss:
--------------------------------------------------------------------------------
  1 | .api {
  2 |   padding: 6px !important;
  3 |   margin: 20px;
  4 |   border-radius: 4px;
  5 |   border: 2px solid $clr-indigo;
  6 |   background-color: $clr-indigo;
  7 |   color: white;
  8 |   text-align: center;
  9 |   transition: background-color 0.1s linear;
 10 | }
 11 | .api:hover {
 12 |   opacity: 0.8;
 13 | }
 14 | .disabled {
 15 |   pointer-events: none;
 16 |   opacity: 0.3;
 17 | }
 18 | .selector {
 19 |   font-size: 15px;
 20 |   cursor: pointer;
 21 | 
 22 |   &-selectedItem {
 23 |     border-bottom: 1px solid rgba(233, 78, 119, 0.3);
 24 |     padding: 10px 10px 5px;
 25 | 
 26 |     &-icon {
 27 |       position: relative;
 28 |       top: 4px;
 29 |       width: 22px;
 30 |       height: 22px;
 31 |       margin-right: 8px;
 32 |     }
 33 |     i {
 34 |       color: #55595c;
 35 |     }
 36 |   }
 37 | }
 38 | .selector-list {
 39 |   position: absolute;
 40 |   width: 80%;
 41 |   background-color: white;
 42 |   box-shadow: 0 2px 5px 0 rgba(0, 0, 0, 0.16), 0 2px 10px 0 rgba(0, 0, 0, 0.12);
 43 |   padding: 0;
 44 |   margin-top: 0;
 45 |   transform-origin: 50% 0;
 46 |   transition: transform 0.1s linear, opacity 0.1s linear;
 47 | 
 48 |   @include break-to-device(tablet) {
 49 |     height: 250px;
 50 |     overflow-y: scroll;
 51 |   }
 52 | 
 53 |   &-opened {
 54 |     transform: scaleY(1);
 55 |     opacity: 1;
 56 |   }
 57 |   &-closed {
 58 |     transform: scaleY(0);
 59 |     opacity: 0;
 60 |   }
 61 |   &-item {
 62 |     width: 100%;
 63 |     list-style-type: none;
 64 |     &-link {
 65 |       display: block;
 66 |       height: 100%;
 67 |       padding: 12px;
 68 |     }
 69 |     &-icon {
 70 |       position: relative;
 71 |       top: 4px;
 72 |       width: 22px;
 73 |       height: 22px;
 74 |       margin-right: 8px;
 75 |     }
 76 |     &:hover {
 77 |       background-color: #ddd;
 78 |     }
 79 |   }
 80 | }
 81 | 
 82 | .selector-majorVersion {
 83 |   .selector-selectedItem {
 84 |     border: none;
 85 |     padding: 0;
 86 |     font-size: 1.7rem;
 87 |     text-align: center;
 88 | 
 89 |     .selector-selectedItem-name {
 90 |       font-size: 22px;
 91 |       position: relative;
 92 |       border-radius: 0.2rem;
 93 |       line-height: 3rem;
 94 | 
 95 |       @include break-from-device(screen) {
 96 |         font-size: 22px;
 97 |       }
 98 | 
 99 |       &:hover {
100 |         background-color: $md-color-white--lightest;
101 |       }
102 | 
103 |       &-wrapper {
104 |         border-bottom: 1px solid #6c7a79;
105 |       }
106 |     }
107 | 
108 |     .fa-caret-down {
109 |       color: white;
110 |       margin-left: 6px;
111 |     }
112 |   }
113 | 
114 |   .selector-list {
115 |     position: fixed;
116 |     width: 135px;
117 |     height: auto;
118 |     text-align: center;
119 |     z-index: 10;
120 | 
121 |     .selector-list-item-link {
122 |       color: $clr-indigo;
123 |     }
124 |   }
125 | }
126 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/_tiles.scss:
--------------------------------------------------------------------------------
 1 | .Tiles {
 2 |   display: grid;
 3 |   grid-template-columns: repeat(auto-fill, minmax(170px, 1fr));
 4 |   grid-gap: 2rem;
 5 | 
 6 |   &-item {
 7 |     padding: 15px 5px 5px 5px;
 8 |     border-radius: 0.2rem;
 9 |     box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12),
10 |       0 3px 1px -2px rgba(0, 0, 0, 0.2);
11 |     background-image: linear-gradient(to top, #f5f5fa, #fff);
12 |     text-align: center;
13 |     position: relative;
14 | 
15 |     display: flex;
16 |     flex-direction: column;
17 | 
18 |     justify-content: center;
19 |     align-items: center;
20 | 
21 |     width: 100%;
22 |     height: 100%;
23 | 
24 |     &.min {
25 |       width: 11%;
26 |       height: 11%;
27 |     }
28 | 
29 |     &.medium {
30 |       width: 180px;
31 |       height: 130px;
32 |     }
33 |   }
34 | 
35 |   &-item:last-of-type {
36 |     margin-right: 0;
37 |   }
38 | 
39 |   &-item-logo {
40 |     width: 70%;
41 |     height: 70%;
42 |     position: relative;
43 |     margin: 0;
44 |   }
45 | 
46 |   &-item-name {
47 |     color: $md-color-blue;
48 |     margin-top: 0.5rem;
49 |   }
50 | 
51 |   &-item:hover {
52 |     top: -2px;
53 |     left: -1px;
54 | 
55 |     &.min {
56 |       top: 0px;
57 |       left: 0px;
58 |     }
59 | 
60 |     .Languages-item-name {
61 |       color: $md-color-pink;
62 |     }
63 |   }
64 | }
65 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_function.scss:
--------------------------------------------------------------------------------
 1 | @function ms-function(
 2 |   $v: 0,
 3 |   $base: false,
 4 |   $ratio: false,
 5 |   $thread: false,
 6 |   $settings: $modularscale
 7 | ) {
 8 |   // Parse settings
 9 |   $ms-settings: ms-settings($base, $ratio, $thread, $settings);
10 |   $base: nth($ms-settings, 1);
11 |   $ratio: nth($ms-settings, 2);
12 | 
13 |   // Render target values from settings.
14 |   @if unit($ratio) != '' {
15 |     $ratio: ms-target($ratio, $base);
16 |   }
17 | 
18 |   // Fast calc if not multi stranded
19 |   @if (length($base) == 1) {
20 |     @return ms-round-px(ms-pow($ratio, $v) * $base);
21 |   }
22 | 
23 |   // Create new base array
24 |   $ms-bases: nth($base, 1);
25 | 
26 |   // Normalize base values
27 |   @for $i from 2 through length($base) {
28 |     // initial base value
29 |     $ms-base: nth($base, $i);
30 |     // If the base is bigger than the main base
31 |     @if ($ms-base > nth($base, 1)) {
32 |       // divide the value until it aligns with main base.
33 |       @while ($ms-base > nth($base, 1)) {
34 |         $ms-base: $ms-base / $ratio;
35 |       }
36 |       $ms-base: $ms-base * $ratio;
37 |     }
38 |     // If the base is smaller than the main base.
39 |     @else if ($ms-base < nth($base,1)) {
40 |       // pump up the value until it aligns with main base.
41 |       @while $ms-base < nth($base, 1) {
42 |         $ms-base: $ms-base * $ratio;
43 |       }
44 |     }
45 |     // Push into new array
46 |     $ms-bases: append($ms-bases, $ms-base);
47 |   }
48 | 
49 |   // Sort array from smallest to largest.
50 |   $ms-bases: ms-sort($ms-bases);
51 | 
52 |   // Find step to use in calculation
53 |   $vtep: floor($v / length($ms-bases));
54 |   // Find base to use in calculation
55 |   $ms-base: round(($v / length($ms-bases) - $vtep) * length($ms-bases)) + 1;
56 | 
57 |   @return ms-round-px(ms-pow($ratio, $vtep) * nth($ms-bases, $ms-base));
58 | }
59 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_pow.scss:
--------------------------------------------------------------------------------
 1 | // Sass does not have native pow() support so this needs to be added.
 2 | // Compass and other libs implement this more extensively.
 3 | // In order to keep this simple, use those when they are avalible.
 4 | // Issue for pow() support in Sass: https://github.com/sass/sass/issues/684
 5 | 
 6 | @function ms-pow($b, $e) {
 7 |   // Return 1 if exponent is 0
 8 |   @if $e == 0 {
 9 |     @return 1;
10 |   }
11 | 
12 |   // If pow() exists (compass or mathsass) use that.
13 |   @if function-exists('pow') {
14 |     @return pow($b, $e);
15 |   }
16 | 
17 |   // This does not support non-integer exponents,
18 |   // Check and return an error if a non-integer exponent is passed.
19 |   @if (floor($e) != $e) {
20 |     @error 'Non-integer values are not supported in modularscale by default. Try using mathsass in your project to add non-integer scale support. https://github.com/terkel/mathsass';
21 |   }
22 | 
23 |   // Seed the return.
24 |   $ms-return: $b;
25 | 
26 |   // Multiply or divide by the specified number of times.
27 |   @if $e > 0 {
28 |     @for $i from 1 to $e {
29 |       $ms-return: $ms-return * $b;
30 |     }
31 |   }
32 |   @if $e < 0 {
33 |     @for $i from $e through 0 {
34 |       $ms-return: calc($ms-return / $b);
35 |     }
36 |   }
37 |   @return $ms-return;
38 | }
39 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_respond.scss:
--------------------------------------------------------------------------------
 1 | // Generate calc() function
 2 | // based on Mike Riethmuller's Precise control over responsive typography
 3 | // http://madebymike.com.au/writing/precise-control-responsive-typography/
 4 | @function ms-fluid($val1: 1em, $val2: 1em, $break1: 0, $break2: 0) {
 5 |   $diff: ms-unitless($val2) - ms-unitless($val1);
 6 | 
 7 |   // v1 + (v2 - v1) * ( (100vw - b1) / b2 - b1 )
 8 |   @return calc(
 9 |     #{$val1} + #{ms-unitless($val2) - ms-unitless($val1)} *
10 |       ((100vw - #{$break1}) / #{ms-unitless($break2) - ms-unitless($break1)})
11 |   );
12 | }
13 | 
14 | // Main responsive mixin
15 | @mixin ms-respond($prop, $val, $map: $modularscale, $ms-important: false) {
16 |   $base: $ms-base;
17 |   $ratio: $ms-ratio;
18 | 
19 |   $first-write: true;
20 |   $last-break: null;
21 | 
22 |   $important: '';
23 | 
24 |   @if $ms-important == true {
25 |     $important: ' !important';
26 |   }
27 | 
28 |   // loop through all settings with a breakpoint type value
29 |   @each $v, $s in $map {
30 |     @if type-of($v) == number {
31 |       @if unit($v) != '' {
32 |         // Write out the first value without a media query.
33 |         @if $first-write {
34 |           #{$prop}: ms-function($val, $thread: $v, $settings: $map)
35 |             #{$important};
36 | 
37 |           // Not the first write anymore, reset to false to move on.
38 |           $first-write: false;
39 |           $last-break: $v;
40 |         }
41 | 
42 |         // Write intermediate breakpoints.
43 |         @else {
44 |           @media (min-width: $last-break) and (max-width: $v) {
45 |             $val1: ms-function($val, $thread: $last-break, $settings: $map);
46 |             $val2: ms-function($val, $thread: $v, $settings: $map);
47 |             #{$prop}: ms-fluid($val1, $val2, $last-break, $v) #{$important};
48 |           }
49 |           $last-break: $v;
50 |         }
51 |       }
52 |     }
53 |   }
54 | 
55 |   // Write the last breakpoint.
56 |   @if $last-break {
57 |     @media (min-width: $last-break) {
58 |       #{$prop}: ms-function($val, $thread: $last-break, $settings: $map) #{$important};
59 |     }
60 |   }
61 | }
62 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_round-px.scss:
--------------------------------------------------------------------------------
 1 | // No reason to have decimal pixel values,
 2 | // normalize them to whole numbers.
 3 | 
 4 | @function ms-round-px($r) {
 5 |   @if unit($r) == 'px' {
 6 |     @return round($r);
 7 |   }
 8 |   @return $r;
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_settings.scss:
--------------------------------------------------------------------------------
 1 | // Parse settings starting with defaults.
 2 | // Settings should cascade down like you would expect in CSS.
 3 | // More specific overrides previous settings.
 4 | 
 5 | @function ms-settings($b: false, $r: false, $t: false, $m: $modularscale) {
 6 |   $base: $ms-base;
 7 |   $ratio: $ms-ratio;
 8 |   $thread: map-get($m, $t);
 9 | 
10 |   // Override with user settings
11 |   @if map-get($m, base) {
12 |     $base: map-get($m, base);
13 |   }
14 |   @if map-get($m, ratio) {
15 |     $ratio: map-get($m, ratio);
16 |   }
17 | 
18 |   // Override with thread settings
19 |   @if $thread {
20 |     @if map-get($thread, base) {
21 |       $base: map-get($thread, base);
22 |     }
23 |     @if map-get($thread, ratio) {
24 |       $ratio: map-get($thread, ratio);
25 |     }
26 |   }
27 | 
28 |   // Override with inline settings
29 |   @if $b {
30 |     $base: $b;
31 |   }
32 |   @if $r {
33 |     $ratio: $r;
34 |   }
35 | 
36 |   @return $base $ratio;
37 | }
38 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_sort.scss:
--------------------------------------------------------------------------------
 1 | // Basic list sorting
 2 | // Would like to replace with http://sassmeister.com/gist/30e4863bd03ce0e1617c
 3 | // Unfortunately libsass has a bug with passing arguments into the min() funciton.
 4 | 
 5 | @function ms-sort($l) {
 6 |   // loop until the list is confirmed to be sorted
 7 |   $sorted: false;
 8 |   @while $sorted == false {
 9 |     // Start with the assumption that the lists are sorted.
10 |     $sorted: true;
11 | 
12 |     // Loop through the list, checking each value with the one next to it.
13 |     // Swap the values if they need to be swapped.
14 |     // Not super fast but simple and modular scale doesn't lean hard on sorting.
15 |     @for $i from 2 through length($l) {
16 |       $n1: nth($l, $i - 1);
17 |       $n2: nth($l, $i);
18 | 
19 |       // If the first value is greater than the 2nd, swap them.
20 |       @if $n1 > $n2 {
21 |         $l: set-nth($l, $i, $n1);
22 |         $l: set-nth($l, $i - 1, $n2);
23 | 
24 |         // The list isn't sorted and needs to be looped through again.
25 |         $sorted: false;
26 |       }
27 |     }
28 |   }
29 | 
30 |   // Return the sorted list.
31 |   @return $l;
32 | }
33 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_strip-units.scss:
--------------------------------------------------------------------------------
1 | // Stripping units is not a best practice
2 | // This function should not be used elsewhere
3 | // It is used here because calc() doesn't do unit logic
4 | // AND target ratios use units as a hack to get a number.
5 | @function ms-unitless($val) {
6 |   @return ($val / ($val - $val + 1));
7 | }
8 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_sugar.scss:
--------------------------------------------------------------------------------
 1 | // To attempt to avoid conflicts with other libraries
 2 | // all funcitons are namespaced with `ms-`.
 3 | // However, to increase usability, a shorthand function is included here.
 4 | 
 5 | @function ms(
 6 |   $v: 0,
 7 |   $base: false,
 8 |   $ratio: false,
 9 |   $thread: false,
10 |   $settings: $modularscale
11 | ) {
12 |   @return ms-function($v, $base, $ratio, $thread, $settings);
13 | }
14 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_target.scss:
--------------------------------------------------------------------------------
 1 | // Convert number string to number
 2 | @function ms-to-num($n) {
 3 |   $l: str-length($n);
 4 |   $r: 0;
 5 |   $m: str-index($n, '.');
 6 |   @if $m == null {
 7 |     $m: $l + 1;
 8 |   }
 9 |   // Loop through digits and convert to numbers
10 |   @for $i from 1 through $l {
11 |     $v: str-slice($n, $i, $i);
12 |     @if $v == '1' {
13 |       $v: 1;
14 |     }
15 |     @else if $v == '2' {
16 |       $v: 2;
17 |     }
18 |     @else if $v == '3' {
19 |       $v: 3;
20 |     }
21 |     @else if $v == '4' {
22 |       $v: 4;
23 |     }
24 |     @else if $v == '5' {
25 |       $v: 5;
26 |     }
27 |     @else if $v == '6' {
28 |       $v: 6;
29 |     }
30 |     @else if $v == '7' {
31 |       $v: 7;
32 |     }
33 |     @else if $v == '8' {
34 |       $v: 8;
35 |     }
36 |     @else if $v == '9' {
37 |       $v: 9;
38 |     }
39 |     @else if $v == '0' {
40 |       $v: 0;
41 |     } @else {
42 |       $v: null;
43 |     }
44 |     @if $v != null {
45 |       $m: $m - 1;
46 |       $r: $r + ms-pow(10, $m - 1) * $v;
47 |     } @else {
48 |       $l: $l - 1;
49 |     }
50 |   }
51 |   @return $r;
52 | }
53 | 
54 | // Find a ratio based on a target value
55 | @function ms-target($t, $b) {
56 |   // Convert to string
57 |   $t: $t + '';
58 |   // Remove base units to calulate ratio
59 |   $b: ms-unitless(nth($b, 1));
60 |   // Find where 'at' is in the string
61 |   $at: str-index($t, 'at');
62 | 
63 |   // Slice the value and target out
64 |   // and convert strings to numbers
65 |   $v: ms-to-num(str-slice($t, 0, $at - 1));
66 |   $t: ms-to-num(str-slice($t, $at + 2));
67 | 
68 |   // Solve the modular scale function for the ratio.
69 |   @return ms-pow(($v/$b), (1 / $t));
70 | }
71 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/modularscale/_vars.scss:
--------------------------------------------------------------------------------
 1 | // Ratios
 2 | $double-octave: 4;
 3 | $pi: 3.14159265359;
 4 | $major-twelfth: 3;
 5 | $major-eleventh: 2.666666667;
 6 | $major-tenth: 2.5;
 7 | $octave: 2;
 8 | $major-seventh: 1.875;
 9 | $minor-seventh: 1.777777778;
10 | $major-sixth: 1.666666667;
11 | $phi: 1.618034;
12 | $golden: $phi;
13 | $minor-sixth: 1.6;
14 | $fifth: 1.5;
15 | $augmented-fourth: 1.41421;
16 | $fourth: 1.333333333;
17 | $major-third: 1.25;
18 | $minor-third: 1.2;
19 | $major-second: 1.125;
20 | $minor-second: 1.066666667;
21 | 
22 | // Base config
23 | $ms-base: 1em !default;
24 | $ms-ratio: $fifth !default;
25 | $modularscale: () !default;
26 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_arithmatex.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // MathJax integration - add padding to omit vertical scrollbar
 8 |   .MJXc-display {
 9 |     margin: 0.75em 0;
10 |     padding: 0.75em 0;
11 |     overflow: auto;
12 |     -webkit-overflow-scrolling: touch;
13 |   }
14 | 
15 |   // Stretch top-level containers
16 |   > p > .MJXc-display {
17 |     // [mobile -]: Stretch to whole width
18 |     @include break-to-device(mobile) {
19 |       margin: 0.75em -1.6rem;
20 |       padding: 0.25em 1.6rem;
21 |     }
22 |   }
23 | 
24 |   // Remove outline on tab index
25 |   .MathJax_CHTML {
26 |     outline: 0;
27 |   }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_critic.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Deletions, additions and comments
 8 |   del.critic,
 9 |   ins.critic,
10 |   .critic.comment {
11 |     margin: 0 0.25em;
12 |     padding: 0.0625em 0;
13 |     border-radius: 0.2rem;
14 |     box-decoration-break: clone;
15 |   }
16 | 
17 |   // Deletion
18 |   del.critic {
19 |     background-color: $codehilite-diff-deleted; // TODO: dependent on order of inclusion
20 |     box-shadow: +0.25em 0 0 $codehilite-diff-deleted,
21 |       -0.25em 0 0 $codehilite-diff-deleted;
22 |   }
23 | 
24 |   // Addition
25 |   ins.critic {
26 |     background-color: $codehilite-diff-inserted; // TODO: dependent on order of inclusion
27 |     box-shadow: +0.25em 0 0 $codehilite-diff-inserted,
28 |       -0.25em 0 0 $codehilite-diff-inserted;
29 |   }
30 | 
31 |   // Comment
32 |   .critic.comment {
33 |     background-color: $md-code-background; // TODO: rename, centralize somehow
34 |     color: $md-code-color;
35 |     box-shadow: +0.25em 0 0 $md-code-background, -0.25em 0 0 $md-code-background;
36 | 
37 |     // Icon
38 |     &::before {
39 |       @extend %md-icon;
40 | 
41 |       padding-right: 0.125em;
42 |       color: $md-color-black--lighter;
43 |       content: '\F075'; // comment
44 |       vertical-align: -0.125em;
45 |     }
46 |   }
47 | 
48 |   // Block
49 |   .critic.block {
50 |     display: block;
51 |     margin: 1em 0;
52 |     padding-right: 1.6rem;
53 |     padding-left: 1.6rem;
54 |     box-shadow: none;
55 | 
56 |     // Decrease spacing on first element
57 |     :first-child {
58 |       margin-top: 0.5em;
59 |     }
60 | 
61 |     // Decrease spacing on last element
62 |     :last-child {
63 |       margin-bottom: 0.5em;
64 |     }
65 |   }
66 | }
67 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_details.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Details extension
 8 |   details {
 9 |     @extend .admonition;
10 | 
11 |     display: block;
12 |     padding-top: 0;
13 | 
14 |     // Rotate title icon
15 |     &[open] > summary::after {
16 |       transform: rotate(180deg);
17 |     }
18 | 
19 |     // Remove bottom spacing
20 |     &:not([open]) {
21 |       padding-bottom: 0;
22 | 
23 |       // Remove bottom border if block is closed
24 |       > summary {
25 |         border-bottom: none;
26 |       }
27 |     }
28 | 
29 |     // Increase spacing to the right - scoped here for higher specificity
30 |     summary {
31 |       padding-right: 4rem;
32 | 
33 |       // Adjust for RTL languages
34 |       [dir='rtl'] & {
35 |         padding-left: 4rem;
36 |       }
37 |     }
38 | 
39 |     // Manually hide and show, if browser doesn't support details
40 |     .no-details &:not([open]) {
41 |       // Hide all nested tags ...
42 |       > * {
43 |         display: none;
44 |       }
45 | 
46 |       // ... but show title
47 |       summary {
48 |         display: block;
49 |       }
50 |     }
51 |   }
52 | 
53 |   // Title
54 |   summary {
55 |     @extend .admonition-title;
56 | 
57 |     // Hack: set to block, so Firefox doesn't render marker
58 |     display: block;
59 |     outline: none;
60 |     cursor: pointer;
61 | 
62 |     // Remove default details marker
63 |     &::-webkit-details-marker {
64 |       display: none;
65 |     }
66 | 
67 |     // Icon
68 |     &::after {
69 |       @extend %md-icon;
70 | 
71 |       position: absolute;
72 |       top: 1rem;
73 |       right: 1.5rem;
74 |       color: $md-color-black--lighter;
75 |       font-size: 1.5rem;
76 |       content: '\F107'; // angle-down
77 | 
78 |       // Adjust for RTL languages
79 |       [dir='rtl'] & {
80 |         right: initial;
81 |         left: 1.2rem;
82 |       }
83 |     }
84 |   }
85 | }
86 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_emoji.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Correct alignment of emojis
 8 |   .emojione {
 9 |     width: 2rem;
10 |     vertical-align: text-top;
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_inlinehilite.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Qualified class selector to distinguish inline code from code blocks
 8 |   code.codehilite {
 9 |     $correct: calc(1 / 0.85);
10 | 
11 |     margin: 0 0.25em * $correct;
12 |     padding: 0.0625em * $correct 0;
13 |   }
14 | }
15 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/extensions/pymdown/_tasklist.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Scoped in typesetted content to match specificity of regular content
 6 | .md-typeset {
 7 |   // Remove list icon on task items
 8 |   .task-list-item {
 9 |     position: relative;
10 |     list-style-type: none;
11 | 
12 |     // Make checkbox items align with normal list items, but position
13 |     // everything in ems for correct layout at smaller font sizes
14 |     [type='checkbox'] {
15 |       position: absolute;
16 |       top: 0.45em;
17 |       left: -2em;
18 | 
19 |       // Adjust for RTL languages
20 |       [dir='rtl'] & {
21 |         right: -2em;
22 |         left: initial;
23 |       }
24 |     }
25 |   }
26 | 
27 |   // Wrapper for list controls, in case custom checkboxes are enabled
28 |   .task-list-control {
29 |     // Checkbox icon in unchecked state
30 |     .task-list-indicator::before {
31 |       @extend %md-icon;
32 | 
33 |       position: absolute;
34 |       top: 0.15em;
35 |       left: -1.25em;
36 |       color: $md-color-black--lighter;
37 |       font-size: 1.25em;
38 |       content: '\F0C8'; // square
39 |       vertical-align: -0.25em;
40 | 
41 |       // Adjust for RTL languages
42 |       [dir='rtl'] & {
43 |         right: -1.25em;
44 |         left: initial;
45 |       }
46 |     }
47 | 
48 |     // Checkbox icon in checked state
49 |     [type='checkbox']:checked + .task-list-indicator::before {
50 |       content: '\F14A'; // square-check
51 |     }
52 | 
53 |     // Hide original checkbox behind icon
54 |     [type='checkbox'] {
55 |       opacity: 0;
56 |       z-index: -1;
57 |     }
58 |   }
59 | }
60 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/helpers/_px2em.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Helpers
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | ///
 6 | /// Convert font size in px to em.
 7 | ///
 8 | /// @group  helpers
 9 | /// @access public
10 | /// @param  {Number} $size Font size in px
11 | /// @param  {Number} $base Base font size
12 | /// @return {Number}       Font size in em
13 | ///
14 | @function px2em($size, $base: 16px) {
15 |   @if unit($size) == px {
16 |     @if unit($base) == px {
17 |       @return calc($size / $base) * 1em;
18 |     } @else {
19 |       @error "Invalid base: #{$base} - unit must be 'px'";
20 |     }
21 |   } @else {
22 |     @error "Invalid size: #{$size} - unit must be 'px'";
23 |   }
24 | }
25 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/layout/_content.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Content container
 6 | $content-margin: 26rem;
 7 | 
 8 | .md-content {
 9 |   // [tablet landscape +]: Add space for table of contents
10 |   @include break-from-device(tablet landscape) {
11 |     margin-right: $content-margin;
12 | 
13 |     // Adjust for RTL languages
14 |     [dir='rtl'] & {
15 |       margin-right: initial;
16 |       margin-left: $content-margin;
17 |     }
18 |   }
19 | 
20 |   // [screen +]: Add space for table of contents
21 |   @include break-from-device(screen) {
22 |     margin-left: $content-margin;
23 | 
24 |     // Adjust for RTL languages
25 |     [dir='rtl'] & {
26 |       margin-right: $content-margin;
27 |     }
28 |   }
29 | 
30 |   // Define spacing
31 |   &__inner {
32 |     margin: 0 1.6rem 2.4rem;
33 |     padding-top: 1.2rem;
34 | 
35 |     // [screen +]: Increase horizontal spacing
36 |     @include break-from-device(screen) {
37 |       margin-right: 0;
38 |       margin-left: 0;
39 |     }
40 | 
41 |     // Hack: add pseudo element for spacing, as the overflow of the content
42 |     // container may not be hidden due to an imminent offset error on targets
43 |     &::before {
44 |       display: block;
45 |       height: 0.8rem;
46 |       content: '';
47 |     }
48 | 
49 |     // Hack: remove bottom spacing of last element, due to margin collapse
50 |     > :last-child {
51 |       margin-bottom: 0;
52 |     }
53 |   }
54 | 
55 |   // Icons
56 |   &__icon {
57 |     @extend %md-icon__button;
58 | 
59 |     position: relative;
60 |     margin: 0.8rem 0;
61 |     padding: 0;
62 |     float: right;
63 | 
64 |     // Override default link color for icons
65 |     .md-typeset & {
66 |       color: $md-color-black--lighter;
67 |     }
68 | 
69 |     // Hide for print
70 |     @media print {
71 |       display: none;
72 |     }
73 |   }
74 | }
75 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/layout/_hero.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Rules
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | // Hero teaser
 6 | .md-hero {
 7 |   transition: background 0.25s;
 8 |   background-color: $md-color-primary;
 9 |   color: $md-color-white;
10 |   font-size: ms(1);
11 |   overflow: hidden;
12 | 
13 |   // Inner wrapper
14 |   &__inner {
15 |     margin-top: 2rem;
16 |     padding: 1.6rem 1.6rem 0.8rem;
17 |     transition: transform 0.4s cubic-bezier(0.1, 0.7, 0.1, 1), opacity 0.25s;
18 |     transition-delay: 0.1s;
19 | 
20 |     // [tablet -]: Compensate for missing tabs
21 |     @include break-to-device(tablet) {
22 |       margin-top: 4.8rem;
23 |       margin-bottom: 2.4rem;
24 |     }
25 | 
26 |     // Fade-out tabs background upon scrolling
27 |     [data-md-state='hidden'] & {
28 |       pointer-events: none;
29 |       transform: translateY(1.25rem);
30 |       transition: transform 0s 0.4s, opacity 0.1s 0s;
31 |       opacity: 0;
32 |     }
33 | 
34 |     // Adjust bottom spacing if there are no tabs
35 |     .md-hero--expand & {
36 |       margin-bottom: 2.4rem;
37 |     }
38 |   }
39 | }
40 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/layout/_icontable.scss:
--------------------------------------------------------------------------------
 1 | .IconTable {
 2 |   width: 100%;
 3 |   padding: 1em;
 4 | 
 5 |   &-item {
 6 |     display: inline-block;
 7 |     width: 50%;
 8 |     height: 6em;
 9 |     border-left: 1px solid #e1e4e5;
10 |     border-bottom: 1px solid #e1e4e5;
11 |     padding: 1em;
12 |     background-color: #eee;
13 | 
14 |     &:nth-child(-n + 2) {
15 |       border-top: 1px solid #e1e4e5;
16 |     }
17 | 
18 |     &:nth-child(even) {
19 |       border-right: 1px solid #e1e4e5;
20 |     }
21 | 
22 |     &:nth-child(4n),
23 |     &:nth-child(4n-1) {
24 |       background-color: white;
25 |     }
26 |   }
27 | 
28 |   &-item-icon {
29 |     display: table-cell;
30 |     vertical-align: middle;
31 |     width: 60px;
32 |     height: 60px;
33 | 
34 |     img {
35 |       width: 100%;
36 |     }
37 |   }
38 | 
39 |   &-item-text {
40 |     display: table-cell;
41 |     vertical-align: middle;
42 |     padding-left: 1em;
43 |     overflow: hidden;
44 |     width: calc(100% - 5em);
45 |     height: calc(100% - 2em);
46 |   }
47 | }
48 | 
49 | @media (max-width: 720px) {
50 |   .IconTable-item {
51 |     background-color: white;
52 |     display: block;
53 |     width: 100%;
54 |     border-right: 1px solid #e1e4e5;
55 | 
56 |     &:nth-child(odd) {
57 |       background-color: #eee;
58 |     }
59 |   }
60 | }


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/layout/_tabs.scss:
--------------------------------------------------------------------------------
 1 | // ----------------------------------------------------------------------------
 2 | // Element-tabs styles override
 3 | // ----------------------------------------------------------------------------
 4 | 
 5 | .el-tabs--border-card {
 6 |   .el-tabs__header {
 7 |     .el-tabs__item.is-active,
 8 |     .el-tabs__item:not(.is-disabled):hover {
 9 |       color: $md-color-blue;
10 |     }
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/layout/_versions.scss:
--------------------------------------------------------------------------------
 1 | .since {
 2 |   font-size: 1.3rem;
 3 |   opacity: 0.7;
 4 |   display: inline;
 5 | }
 6 | 
 7 | .deprecated {
 8 |   font-size: 1.3rem;
 9 |   color: #FFFFFF !important;
10 |   background-color: #E94E77;
11 |   display: inline;
12 |   padding: 0.2em 0.2em 0.2em 0.2em !important;
13 | }
14 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/libs/_copy-code.scss:
--------------------------------------------------------------------------------
1 | .vp-copy-code-button {
2 |   color: white;
3 | 
4 |   &:after {
5 |     box-sizing: content-box;
6 |   }
7 | }
8 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/libs/_fontawesome.scss:
--------------------------------------------------------------------------------
1 | $fa-font-path: "@fortawesome/fontawesome-free/webfonts";
2 | 
3 | @import "@fortawesome/fontawesome-free/scss/fontawesome";
4 | @import "@fortawesome/fontawesome-free/scss/solid";
5 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/libs/_google-fonts.scss:
--------------------------------------------------------------------------------
1 | @import url('https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,100..700;1,100..700&family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap');


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/libs/_monokai.scss:
--------------------------------------------------------------------------------
 1 | .hljs {
 2 |   display: block;
 3 |   overflow-x: auto;
 4 |   padding: 0.5em;
 5 |   background: #272822;
 6 |   color: #ddd;
 7 | }
 8 | .hljs-tag,
 9 | .hljs-keyword,
10 | .hljs-selector-tag,
11 | .hljs-literal,
12 | .hljs-strong,
13 | .hljs-name {
14 |   color: #f92672;
15 | }
16 | .hljs-code {
17 |   color: #66d9ef;
18 | }
19 | .hljs-class .hljs-title {
20 |   color: white;
21 | }
22 | .hljs-attribute,
23 | .hljs-symbol,
24 | .hljs-regexp,
25 | .hljs-link {
26 |   color: #bf79db;
27 | }
28 | .hljs-string,
29 | .hljs-bullet,
30 | .hljs-subst,
31 | .hljs-title,
32 | .hljs-section,
33 | .hljs-emphasis,
34 | .hljs-type,
35 | .hljs-built_in,
36 | .hljs-builtin-name,
37 | .hljs-selector-attr,
38 | .hljs-selector-pseudo,
39 | .hljs-addition,
40 | .hljs-variable,
41 | .hljs-template-tag,
42 | .hljs-template-variable {
43 |   color: #a6e22e;
44 | }
45 | .hljs-comment,
46 | .hljs-quote,
47 | .hljs-deletion,
48 | .hljs-meta {
49 |   color: #75715e;
50 | }
51 | .hljs-keyword,
52 | .hljs-selector-tag,
53 | .hljs-literal,
54 | .hljs-doctag,
55 | .hljs-title,
56 | .hljs-section,
57 | .hljs-type,
58 | .hljs-selector-id {
59 |   font-weight: bold;
60 | }
61 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/styles/main.scss:
--------------------------------------------------------------------------------
 1 | ////
 2 | /// Copyright (c) 2016-2018 Martin Donath <martin.donath@squidfunk.com>
 3 | ///
 4 | 
 5 | // ----------------------------------------------------------------------------
 6 | // Dependencies
 7 | // ----------------------------------------------------------------------------
 8 | 
 9 | // Modularscale
10 | @import 'extensions/modularscale/vars';
11 | @import 'extensions/modularscale/settings';
12 | @import 'extensions/modularscale/pow';
13 | @import 'extensions/modularscale/strip-units';
14 | @import 'extensions/modularscale/sort';
15 | @import 'extensions/modularscale/round-px';
16 | @import 'extensions/modularscale/target';
17 | @import 'extensions/modularscale/function';
18 | @import 'extensions/modularscale/respond';
19 | @import 'extensions/modularscale/sugar';
20 | 
21 | @import 'extensions/material-color';
22 | @import 'extensions/material-shadows';
23 | 
24 | // ----------------------------------------------------------------------------
25 | // Local imports
26 | // ----------------------------------------------------------------------------
27 | 
28 | @import 'helpers/break';
29 | @import 'helpers/px2em';
30 | 
31 | @import 'config';
32 | 
33 | @import 'base/reset';
34 | @import 'base/icons';
35 | @import 'base/typeset';
36 | 
37 | @import 'layout/base';
38 | @import 'layout/content';
39 | @import 'layout/header';
40 | @import 'layout/hero';
41 | @import 'layout/footer';
42 | @import 'layout/nav';
43 | @import 'layout/sidebar';
44 | @import 'layout/source';
45 | @import 'layout/tabs';
46 | @import 'layout/topMenu';
47 | @import 'layout/versions';
48 | @import 'layout/icontable';
49 | 
50 | @import 'extensions/admonition';
51 | @import 'extensions/badge';
52 | @import 'extensions/codehilite';
53 | @import 'extensions/docsearch';
54 | @import 'extensions/external-links';
55 | @import 'extensions/footnotes';
56 | @import 'extensions/permalinks';
57 | @import 'extensions/select2';
58 | @import 'extensions/alert';
59 | @import 'extensions/tiles';
60 | @import 'extensions/ribbon';
61 | @import 'extensions/sdk-selector';
62 | @import 'extensions/menuDropdown';
63 | 
64 | @import 'extensions/pymdown/arithmatex';
65 | @import 'extensions/pymdown/critic';
66 | @import 'extensions/pymdown/details';
67 | @import 'extensions/pymdown/emoji';
68 | @import 'extensions/pymdown/inlinehilite';
69 | @import 'extensions/pymdown/tasklist';
70 | 
71 | @import 'libs/copy-code';
72 | @import 'libs/fontawesome';
73 | @import 'libs/google-fonts';
74 | @import 'libs/monokai';
75 | @import 'libs/select2';
76 | 
77 | body,
78 | input {
79 |   font-family: 'Roboto', 'Helvetica Neue', Helvetica, Arial, sans-serif;
80 | }
81 | 
82 | code,
83 | kbd,
84 | pre {
85 |   font-family: 'Roboto Mono', 'Courier New', Courier, monospace;
86 | }
87 | 


--------------------------------------------------------------------------------
/src/.vuepress/theme/theme.ts:
--------------------------------------------------------------------------------
 1 | import { getDirname, path } from '@vuepress/utils';
 2 | 
 3 | const __dirname = getDirname(import.meta.url);
 4 | 
 5 | export const kuzdocTheme = () =>
 6 | ({
 7 |   name: '@kuzzleio/vuepress-theme-kuzdoc',
 8 |   clientConfigFile: path.resolve(__dirname, './client.ts'),
 9 | });
10 | 


--------------------------------------------------------------------------------
/src/.vuepress/util.ts:
--------------------------------------------------------------------------------
  1 | import { get, endsWith } from 'lodash-es';
  2 | import path from 'path';
  3 | 
  4 | export function setItemLocalStorage(key: string, item: string | object) {
  5 |   const storeItem = typeof item === 'object' ? JSON.stringify(item) : item;
  6 |   localStorage.setItem(key, storeItem);
  7 | }
  8 | 
  9 | function getPageDir(page) {
 10 |   if (endsWith(page.path, '/')) {
 11 |     return page.path;
 12 |   } else {
 13 |     return path.dirname(page.path);
 14 |   }
 15 | }
 16 | 
 17 | function getParentPath(node) {
 18 |   return path.normalize(`${getPageDir(node)}../`);
 19 | }
 20 | 
 21 | function sortPagesByOrderAndTitle(p1, p2) {
 22 |   const o1 = +get(p1, 'meta.frontmatter.order', NaN);
 23 |   const o2 = +get(p2, 'meta.frontmatter.order', NaN);
 24 | 
 25 |   if (isNaN(o1) && !isNaN(o2)) {
 26 |     return 1;
 27 |   }
 28 |   if (isNaN(o2) && !isNaN(o1)) {
 29 |     return -1;
 30 |   }
 31 |   if (isNaN(o1) || o1 === o2) {
 32 |     return p1.meta.frontmatter.title < p2.meta.frontmatter.title ? -1 : 1;
 33 |   }
 34 | 
 35 |   return o1 < o2 ? -1 : 1;
 36 | }
 37 | 
 38 | function groupHeaders(headers) {
 39 |   // group h3s under h2
 40 |   headers = headers.map(h => Object.assign({}, h));
 41 |   let lastH2;
 42 |   headers.forEach(h => {
 43 |     if (h.level === 2) {
 44 |       lastH2 = h;
 45 |     } else if (lastH2) {
 46 |       (lastH2.children || (lastH2.children = [])).push(h);
 47 |     }
 48 |   });
 49 |   return headers.filter(h => h.level === 2);
 50 | }
 51 | 
 52 | export const getPageChildren = (page, pages, fullDetpth = false) => {
 53 |   const pathRE = new RegExp(`^${getPageDir(page)}[a-zA-z_0-9\-]+/?${fullDetpth ? '' : '$'}`);
 54 | 
 55 |   return pages
 56 |     .filter(p => p.path.match(pathRE) && p.path !== page.path)
 57 |     .sort(sortPagesByOrderAndTitle);
 58 | };
 59 | 
 60 | export const findRootNode = (node, nodes) => {
 61 |   if (node.frontmatter.type === 'root' || node.path === '/') {
 62 |     return node;
 63 |   }
 64 |   const parent = getParentNode(node, nodes);
 65 |   if (!parent) {
 66 |     return node;
 67 |   }
 68 | 
 69 |   return findRootNode(parent, nodes);
 70 | };
 71 | 
 72 | export const getFirstValidChild = (node, nodes) => {
 73 |   const children = getPageChildren(node, nodes, true);
 74 | 
 75 |   if (!children.length) {
 76 |     return node;
 77 |   }
 78 | 
 79 |   return getFirstValidChild(children[0], nodes);
 80 | };
 81 | 
 82 | export const getNodeByPath = (path, nodes) => {
 83 |   return nodes.find(p => p.path === path);
 84 | };
 85 | 
 86 | export const getParentNode = (node, nodes) => {
 87 |   return getNodeByPath(getParentPath(node), nodes);
 88 | };
 89 | 
 90 | export const resolveHeaders = page => {
 91 |   const headers = groupHeaders(page.headers || []);
 92 |   return [
 93 |     {
 94 |       type: 'group',
 95 |       collapsable: false,
 96 |       title: page.title,
 97 |       children: headers.map(h => ({
 98 |         type: 'auto',
 99 |         title: h.title,
100 |         basePath: page.path,
101 |         path: page.path + '#' + h.slug,
102 |         children: h.children || []
103 |       }))
104 |     }
105 |   ];
106 | };
107 | 


--------------------------------------------------------------------------------
/src/core/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | code: false
3 | type: root
4 | order: 0
5 | title: Core
6 | description: Kuzzle Core Documentation
7 | ---
8 | 
9 | <Redirect to="/core/2" />


--------------------------------------------------------------------------------
/src/how-to/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Kuzzle How to guides and tutorials 
 6 | meta:
 7 |   - name: description
 8 |     content: Here you can find all the Kuzzle how-to divided into different categories
 9 |   - name: keywords
10 |     content: Kuzzle, how to, official, guides, tutorials, monitor iot data, iot backend, keep warm data, massive data import, sync to other db, replicate to postgres, iot
11 | ---
12 | 
13 | <Redirect to="/v2" />
14 | 


--------------------------------------------------------------------------------
/src/how-to/v1.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: How to
 6 | ---
 7 | 
 8 | # Kuzzle How to
 9 | Here you can find all the Kuzzle how-to divided into different categories
10 | 
11 | <HowToIndex :kuzzle-major="1" />
12 | 
13 | 


--------------------------------------------------------------------------------
/src/how-to/v2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Kuzzle How to guides and tutorials 
 6 | meta:
 7 |   - name: description
 8 |     content: Here you can find all the Kuzzle how-to divided into different categories
 9 |   - name: keywords
10 |     content: Kuzzle, how to, official, guides, tutorials, monitor iot data, iot backend, keep warm data, massive data import, sync to other db, replicate to postgres, iot
11 | ---
12 | 
13 | # Kuzzle How to
14 | Here you can find all the Kuzzle how-to divided into different categories
15 | 
16 | <HowToIndex :kuzzle-major="2" />
17 | 
18 | 


--------------------------------------------------------------------------------
/src/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: page
 4 | order: 0
 5 | title: Kuzzle documentation
 6 | meta:
 7 |   - name: description
 8 |     content: Kuzzle V2 official documentation
 9 |   - name: keywords
10 |     content: Kuzzle, documentation, kuzzle documentation V2, kuzzle V2, what is kuzzle, kuzzle v2 guide, kuzzle v2 tutorial
11 | ---
12 | 
13 | <Redirect to="/core/2/guides/introduction/what-is-kuzzle/" reload />
14 | 


--------------------------------------------------------------------------------
/src/modules/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Official Kuzzle Modules
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of officially released kuzzle modules
 9 |   - name: keywords
10 |     content: Kuzzle, modules, official
11 | ---
12 | 
13 | <Redirect to="/v2" />
14 | 


--------------------------------------------------------------------------------
/src/modules/v2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Official Kuzzle Modules
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of officially released kuzzle modules
 9 |   - name: keywords
10 |     content: Kuzzle, modules, official
11 | ---
12 | 
13 | # Official Modules
14 | 
15 | Below you’ll find the ones we officially released.
16 | 
17 | <ModulesIndex :kuzzle-major="2" />
18 | 


--------------------------------------------------------------------------------
/src/official-plugins/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Official Kuzzle Plugins
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of officially released kuzzle plugins
 9 |   - name: keywords
10 |     content: Kuzzle, plugins, official
11 | ---
12 | 
13 | <Redirect to="/v2" />
14 | 


--------------------------------------------------------------------------------
/src/official-plugins/v1.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Official Plugins
 6 | ---
 7 | 
 8 | # Official Plugins
 9 | 
10 | Below you’ll find the ones we officially released.
11 | 
12 | <PluginsIndex :kuzzle-major="1" />
13 | 


--------------------------------------------------------------------------------
/src/official-plugins/v2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Kuzzle Official Plugins
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of officially released kuzzle plugins
 9 |   - name: keywords
10 |     content: Kuzzle, plugins, official
11 | ---
12 | 
13 | # Official Plugins
14 | 
15 | Below you’ll find the ones we officially released.
16 | 
17 | <PluginsIndex :kuzzle-major="2" />
18 | 


--------------------------------------------------------------------------------
/src/sdk/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Kuzzle official SDKs references
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of the officially supported SDK
 9 |   - name: keywords
10 |     content: Kuzzle, sdk, official, JS, Javascript, Golang, C#, Dart, Dart Null Safety, Jvm, Java
11 | ---
12 | 
13 | <Redirect to="/v2" />
14 | 


--------------------------------------------------------------------------------
/src/sdk/v1.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: SDKs
 6 | ---
 7 | 
 8 | # SDKs Reference
 9 | 
10 | Below you’ll find a list of the officially supported SDK,
11 | (we’re working on extending the support to many more).
12 | 
13 | <br>
14 | 
15 | <SDKIndex :kuzzle-major="1" />


--------------------------------------------------------------------------------
/src/sdk/v2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: root
 4 | order: 3
 5 | title: Kuzzle official SDKs references
 6 | meta:
 7 |   - name: description
 8 |     content: You can find here a list of the officially supported SDK
 9 |   - name: keywords
10 |     content: Kuzzle, sdk, official, JS, Javascript, Golang, C#, Dart, Dart Null Safety, Jvm, Java
11 | ---
12 | 
13 | # SDKs Reference
14 | 
15 | Below you’ll find a list of the officially supported SDK,
16 | (we’re working on extending the support to many more).
17 | 
18 | <br>
19 | 
20 | <SDKIndex :kuzzle-major="2"/>


--------------------------------------------------------------------------------
/src/v1.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: page
 4 | order: 0
 5 | title: Kuzzle Documentation
 6 | description: Kuzzle Documentation
 7 | ---
 8 | 
 9 | <HomeV1 :kuzzleMajor="1"/>
10 | 


--------------------------------------------------------------------------------
/src/v2.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | code: false
 3 | type: page
 4 | order: 0
 5 | title: What is kuzzle | Introduction
 6 | meta:
 7 |   - name: description
 8 |     content: Kuzzle V2 official documentation
 9 |   - name: keywords
10 |     content: Kuzzle, documentation, kuzzle documentation V2, kuzzle V2, what is kuzzle, kuzzle v2 guide, kuzzle v2 tutorial
11 | ---
12 | 
13 | <Redirect to="/core/2/guides/introduction/what-is-kuzzle/" reload />
14 | 


--------------------------------------------------------------------------------