[
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = LF\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false"
},
{
"path": ".eslintignore",
"content": "**/node_modules\n**/public\n**/build\n**/dist\n**/config\n**/scripts\n**/docs\n**/playground\n"
},
{
"path": ".eslintrc",
"content": "{\n \"root\": true,\n \"extends\": [\"react-app\", \"airbnb\"],\n \"parser\": \"babel-eslint\",\n \"plugins\": [\n \"babel\",\n \"react\",\n \"jsx-a11y\",\n \"import\",\n \"react-hooks\"\n ],\n \"env\": {\n \"browser\": true,\n \"es6\": true,\n \"commonjs\": true,\n \"node\": true\n },\n \"parserOptions\": {\n \"ecmaFeatures\": {\n \"jsx\": true\n },\n \"ecmaVersion\": 12,\n \"sourceType\": \"module\"\n },\n \"globals\": {\n \"strapi\": true\n },\n \"overrides\": [\n {\n \"files\": [\n \"**/*.cy.*\",\n \"./cypress/**/*.*\"\n ],\n \"extends\": [\n \"plugin:cypress/recommended\"\n ],\n \"parserOptions\": {\n \"project\": \"./tsconfig.cypress.json\"\n }\n }\n ],\n \"rules\": {\n \"import/no-unresolved\": [2, {\n \"ignore\": [\n \"@strapi/strapi/admin\",\n \"@strapi/icons/symbols\",\n \"@strapi/admin/strapi-admin\"\n ]\n }],\n\n \"template-curly-spacing\" : \"off\",\n\n \"indent\" : \"off\",\n\n \"react/jsx-fragments\": \"off\",\n\n \"react/jsx-props-no-spreading\": \"off\",\n\n \"react-hooks/rules-of-hooks\": \"error\",\n\n \"react-hooks/exhaustive-deps\": \"off\",\n\n \"react/no-unused-prop-types\": \"warn\",\n\n \"react/jsx-no-target-blank\": \"error\",\n\n \"no-invalid-this\": \"off\",\n\n \"babel/no-invalid-this\": \"error\",\n\n \"arrow-spacing\": \"warn\",\n\n \"implicit-arrow-linebreak\": \"warn\",\n\n \"react/no-unused-state\": \"warn\",\n\n \"react/boolean-prop-naming\": \"off\",\n\n \"react/destructuring-assignment\": [\"warn\", \"always\", { \"ignoreClassFields\": true }],\n\n \"react/no-access-state-in-setstate\": \"warn\",\n\n \"operator-linebreak\": \"warn\",\n\n \"no-useless-constructor\": \"warn\",\n\n \"react/no-danger\": \"off\",\n\n \"react/jsx-indent-props\": \"warn\",\n\n \"react/jsx-curly-brace-presence\": \"warn\",\n\n \"react/jsx-key\": \"error\",\n\n \"react/jsx-boolean-value\": \"warn\",\n\n \"react/jsx-closing-tag-location\": \"warn\",\n\n \"import/extensions\": \"error\",\n\n \"newline-per-chained-call\": \"warn\",\n\n \"prefer-arrow-callback\": \"warn\",\n\n \"block-spacing\": \"warn\",\n\n \"one-var-declaration-per-line\": \"warn\",\n\n \"prefer-const\": \"warn\",\n\n \"import/first\": \"off\",\n\n \"react/jsx-max-props-per-line\": 1,\n\n \"react/jsx-first-prop-new-line\": \"warn\",\n\n \"react/jsx-equals-spacing\": \"warn\",\n\n \"react/jsx-indent\": \"warn\",\n\n \"react/jsx-closing-bracket-location\": \"off\",\n\n \"import/no-mutable-exports\": \"error\",\n\n \"import/no-extraneous-dependencies\": \"off\",\n\n \"object-shorthand\": [\"off\", \"never\"],\n\n \"object-curly-newline\": \"off\",\n\n \"arrow-body-style\": \"off\",\n\n \"comma-dangle\": [\"warn\", \"always-multiline\"],\n\n \"import/prefer-default-export\": \"off\",\n\n \"no-cond-assign\": \"warn\",\n\n \"no-confusing-arrow\": \"off\",\n\n \"no-console\": \"off\",\n\n \"no-constant-condition\": \"warn\",\n\n \"no-control-regex\": \"warn\",\n\n \"no-continue\": \"warn\",\n\n \"react/forbid-prop-types\": \"warn\",\n\n \"no-debugger\": \"warn\",\n\n \"no-dupe-args\": \"error\",\n\n \"no-dupe-keys\": \"error\",\n\n \"no-duplicate-case\": \"error\",\n\n \"no-empty\": \"warn\",\n\n \"no-empty-character-class\": \"error\",\n\n \"no-ex-assign\": \"error\",\n\n \"no-extra-boolean-cast\": \"warn\",\n\n \"no-extra-semi\": \"warn\",\n\n \"no-func-assign\": \"error\",\n\n \"no-inner-declarations\": \"error\",\n\n \"no-invalid-regexp\": \"error\",\n\n \"no-mixed-operators\": \"off\",\n\n \"no-irregular-whitespace\": \"error\",\n\n \"no-negated-in-lhs\": \"error\",\n\n \"no-obj-calls\": \"error\",\n\n \"no-regex-spaces\": \"warn\",\n\n \"no-sparse-arrays\": \"error\",\n\n \"no-unreachable\": \"warn\",\n\n \"use-isnan\": \"error\",\n\n \"valid-jsdoc\": \"warn\",\n\n \"valid-typeof\": \"error\",\n\n \"array-callback-return\": \"off\",\n\n \"block-scoped-var\": \"off\",\n\n \"prefer-destructuring\": \"warn\",\n\n \"complexity\": \"off\",\n\n \"consistent-return\": \"off\",\n\n \"curly\": \"warn\",\n\n \"default-case\": \"warn\",\n\n \"dot-notation\": \"off\",\n\n \"eqeqeq\": \"warn\",\n\n \"guard-for-in\": \"off\",\n\n \"no-alert\": \"warn\",\n\n \"no-caller\": \"error\",\n\n \"no-div-regex\": \"off\",\n\n \"no-else-return\": \"off\",\n\n \"no-eq-null\": \"error\",\n\n \"no-eval\": \"error\",\n\n \"no-extend-native\": \"error\",\n\n \"no-extra-bind\": \"error\",\n\n \"no-fallthrough\": \"error\",\n\n \"no-floating-decimal\": \"error\",\n\n \"no-implied-eval\": \"error\",\n\n \"no-iterator\": \"error\",\n\n \"no-labels\": \"off\",\n\n \"no-lone-blocks\": \"warn\",\n\n \"no-loop-func\": \"error\",\n\n \"no-multi-spaces\": \"warn\",\n\n \"no-multi-str\": \"error\",\n\n \"no-native-reassign\": \"error\",\n\n \"no-new\": \"warn\",\n\n \"no-new-func\": \"error\",\n\n \"no-new-wrappers\": \"error\",\n\n \"no-octal\": \"error\",\n\n \"no-octal-escape\": \"error\",\n\n \"no-param-reassign\": \"off\",\n\n \"no-process-env\": \"off\",\n\n \"no-proto\": \"error\",\n\n \"no-redeclare\": \"error\",\n\n \"no-return-assign\": \"off\",\n\n \"arrow-parens\": [\"warn\", \"always\", { \"requireForBlockBody\": false }],\n\n \"no-script-url\": \"error\",\n\n \"no-self-compare\": \"error\",\n\n \"no-sequences\": \"error\",\n\n \"no-throw-literal\": \"error\",\n\n \"no-unused-expressions\": \"warn\",\n\n \"no-void\": \"error\",\n\n \"no-with\": \"error\",\n\n \"radix\": \"off\",\n\n \"vars-on-top\": \"off\",\n\n \"wrap-iife\": \"error\",\n\n \"yoda\": \"warn\",\n\n \"strict\": \"off\",\n\n \"no-catch-shadow\": \"error\",\n\n \"no-delete-var\": \"error\",\n\n \"no-label-var\": \"error\",\n\n \"no-shadow\": \"warn\",\n\n \"no-shadow-restricted-names\": \"error\",\n\n \"no-undef\": \"error\",\n\n \"no-undef-init\": \"error\",\n\n \"no-multi-assign\": \"warn\",\n\n \"no-undefined\": \"error\",\n\n \"no-unused-vars\": [\"warn\", { \"args\": \"none\", \"ignoreRestSiblings\": true }],\n\n \"no-use-before-define\": [\n \"error\",\n { \"functions\": false, \"classes\": true, \"variables\": true }\n ],\n\n \"no-restricted-properties\": \"warn\",\n\n \"no-restricted-syntax\": \"warn\",\n\n \"brace-style\": \"off\",\n\n \"camelcase\": \"warn\",\n\n \"comma-spacing\": [\"warn\", { \"before\": false, \"after\": true }],\n\n \"comma-style\": [\"warn\", \"last\"],\n\n \"consistent-this\": [\"off\", \"_this\"],\n\n \"eol-last\": \"warn\",\n\n \"func-names\": \"off\",\n\n \"func-style\": [\"warn\", \"declaration\", { \"allowArrowFunctions\": true }],\n\n \"key-spacing\": [\"warn\", { \"beforeColon\": false, \"afterColon\": true }],\n\n \"max-nested-callbacks\": [\"warn\", 5],\n\n \"new-cap\": [\"warn\", { \"newIsCap\": true, \"capIsNew\": false }],\n\n \"new-parens\": \"warn\",\n\n \"newline-after-var\": \"off\",\n\n \"no-array-constructor\": \"off\",\n\n \"no-inline-comments\": \"off\",\n\n \"no-lonely-if\": \"warn\",\n\n \"no-mixed-spaces-and-tabs\": \"warn\",\n\n \"no-multiple-empty-lines\": [\"warn\", { \"max\": 2 }],\n\n \"no-nested-ternary\": \"warn\",\n\n \"no-new-object\": \"off\",\n\n \"no-spaced-func\": \"warn\",\n\n \"no-ternary\": \"off\",\n\n \"no-trailing-spaces\": \"warn\",\n\n \"no-underscore-dangle\": \"off\",\n\n \"no-extra-parens\": \"off\",\n\n \"padding-line-between-statements\": \"off\",\n\n \"one-var\": [\"warn\", \"never\"],\n\n \"operator-assignment\": [\"off\", \"never\"],\n\n \"class-methods-use-this\": \"off\",\n\n \"padded-blocks\": [\"off\", \"never\"],\n\n \"lines-between-class-members\": [\"warn\", \"always\"],\n\n \"quote-props\": [\"warn\", \"as-needed\"],\n\n \"quotes\": [\"off\", \"single\"],\n\n \"semi\": [\"warn\", \"always\"],\n\n \"semi-spacing\": [\"warn\", { \"before\": false, \"after\": true }],\n\n \"sort-vars\": \"off\",\n\n \"keyword-spacing\": [\"warn\", { \"before\": true, \"after\": true }],\n\n \"space-before-blocks\": [\"warn\", \"always\"],\n\n \"function-paren-newline\": \"off\",\n\n \"space-before-function-paren\": [\"warn\", { \"anonymous\": \"never\", \"named\": \"never\" }],\n\n \"object-curly-spacing\": [\"warn\", \"always\"],\n\n \"array-bracket-spacing\": [\"warn\", \"never\"],\n\n \"computed-property-spacing\": [\"warn\", \"never\"],\n\n \"space-in-parens\": [\"warn\", \"never\"],\n\n \"space-infix-ops\": \"warn\",\n\n \"space-unary-ops\": [\"warn\", { \"words\": true, \"nonwords\": false }],\n\n \"spaced-comment\": [\"warn\", \"always\"],\n\n \"wrap-regex\": \"off\",\n\n \"no-var\": \"error\",\n\n \"generator-star-spacing\": [\"error\", \"before\"],\n\n \"max-depth\": [\"warn\", 4],\n\n \"max-len\": [\"off\", 80, 2],\n\n \"max-params\": [\"off\", 99],\n\n \"max-statements\": \"off\",\n\n \"no-bitwise\": \"off\",\n\n \"no-plusplus\": \"off\",\n\n \"react/display-name\": \"off\",\n\n \"react/jsx-tag-spacing\": \"warn\",\n\n \"jsx-quotes\": [\"warn\", \"prefer-double\"],\n\n \"react/jsx-no-undef\": \"error\",\n\n \"react/jsx-sort-props\": \"off\",\n\n \"react/jsx-uses-react\": \"error\",\n\n \"react/prefer-stateless-function\": \"warn\",\n\n \"react/jsx-uses-vars\": \"error\",\n\n \"react/jsx-no-bind\": \"error\",\n\n \"react/no-did-mount-set-state\": \"warn\",\n\n \"react/no-will-update-set-state\": \"warn\",\n\n \"react/no-did-update-set-state\": \"warn\",\n\n \"react/no-multi-comp\": \"off\",\n\n \"react/no-unknown-property\": \"warn\",\n\n \"react/prop-types\": \"off\",\n\n \"react/react-in-jsx-scope\": \"error\",\n\n \"react/self-closing-comp\": \"warn\",\n\n \"react/jsx-wrap-multilines\": \"warn\",\n\n \"react/no-array-index-key\": \"warn\",\n\n \"react/no-unescaped-entities\": \"warn\",\n\n \"react/sort-comp\": \"off\",\n\n \"jsx-a11y/no-static-element-interactions\": \"off\",\n\n \"jsx-a11y/click-events-have-key-events\": \"off\",\n\n \"jsx-a11y/no-noninteractive-element-interactions\": \"off\",\n\n \"react/jsx-one-expression-per-line\": \"off\",\n\n \"jsx-a11y/anchor-is-valid\": \"off\",\n\n \"jsx-a11y/alt-text\": \"warn\",\n\n \"jsx-a11y/label-has-for\": [\n \"warn\",\n {\n \"required\": {\n \"some\": [\"nesting\", \"id\"]\n }\n }\n ],\n\n \"jsx-a11y/img-redundant-alt\": \"warn\",\n\n \"jsx-a11y/no-autofocus\": \"off\",\n\n \"jsx-a11y/iframe-has-title\": \"warn\",\n\n \"jsx-a11y/anchor-has-content\": \"off\",\n\n \"jsx-a11y/label-has-associated-control\": \"warn\",\n\n \"jsx-a11y/mouse-events-have-key-events\": \"off\",\n\n \"jsx-a11y/interactive-supports-focus\": \"off\",\n\n \"jsx-a11y/no-distracting-elements\": \"warn\",\n\n \"jsx-a11y/heading-has-content\": \"warn\",\n\n \"jsx-a11y/html-has-lang\": \"warn\",\n\n \"jsx-a11y/href-no-hash\": \"off\",\n\n \"react/jsx-filename-extension\": \"off\",\n\n \"jsx-a11y/no-noninteractive-tabindex\": \"warn\",\n\n \"jsx-a11y/media-has-caption\": \"off\"\n }\n}\n"
},
{
"path": ".gitattributes",
"content": "# From https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes\n\n# Handle line endings automatically for files detected as text\n# and leave all files detected as binary untouched.\n* text=auto\n\n#\n# The above will handle all files NOT found below\n#\n\n#\n## These files are text and should be normalized (Convert crlf => lf)\n#\n\n# source code\n*.php text\n*.css text\n*.sass text\n*.scss text\n*.less text\n*.styl text\n*.js text eol=lf\n*.coffee text\n*.json text\n*.htm text\n*.html text\n*.xml text\n*.svg text\n*.txt text\n*.ini text\n*.inc text\n*.pl text\n*.rb text\n*.py text\n*.scm text\n*.sql text\n*.sh text\n*.bat text\n\n# templates\n*.ejs text\n*.hbt text\n*.jade text\n*.haml text\n*.hbs text\n*.dot text\n*.tmpl text\n*.phtml text\n\n# git config\n.gitattributes text\n.gitignore text\n.gitconfig text\n\n# code analysis config\n.jshintrc text\n.jscsrc text\n.jshintignore text\n.csslintrc text\n\n# misc config\n*.yaml text\n*.yml text\n.editorconfig text\n\n# build config\n*.npmignore text\n*.bowerrc text\n\n# Heroku\nProcfile text\n.slugignore text\n\n# Documentation\n*.md text\nLICENSE text\nAUTHORS text\n\n\n#\n## These files are binary and should be left untouched\n#\n\n# (binary is a macro for -text -diff)\n*.png binary\n*.jpg binary\n*.jpeg binary\n*.gif binary\n*.ico binary\n*.mov binary\n*.mp4 binary\n*.mp3 binary\n*.flv binary\n*.fla binary\n*.swf binary\n*.gz binary\n*.zip binary\n*.7z binary\n*.ttf binary\n*.eot binary\n*.woff binary\n*.pyc binary\n*.pdf binary\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: π Bug Report\nabout: Create a report to help improve this plugin\n---\n\n\n\n## Bug report\n\n### Describe the bug\n\nA clear and concise description of what the bug is.\n\n### Steps to reproduce the behavior\n\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n### Expected behavior\n\nA clear and concise description of what you expected to happen.\n\n### Screenshots\n\nIf applicable, add screenshots to help explain your problem.\n\n### Code snippets\n\nIf applicable, add code samples to help explain your problem.\n\n### System\n\n- Node.js version: \n- NPM version:\n- Strapi version:\n- Plugin version:\n- Database:\n- Operating system:\n\n### Additional context\n\nAdd any other context about the problem here.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"content": "---\nname: π Feature Request\nabout: Suggest an idea to help make this plugin even better!\n---\n\n\n\n## Feature request\n\n### Summary\n\nQuick summary what's this feature request about.\n\n### Why is it needed?\n\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n### Suggested solution(s)\n\nA clear and concise description of what you want to happen.\n\n### Related issue(s)/PR(s)\n\nLet us know if this is related to any issue/pull request.\n"
},
{
"path": ".github/PULL_REQUEST_TEMPLATE.md",
"content": "\n\n### What does it do?\n\nDescribe the technical changes you did.\n\n### Why is it needed?\n\nDescribe the issue you are solving.\n\n### How to test it?\n\nProvide information about the environment and the path to verify the behaviour.\n\n### Related issue(s)/PR(s)\n\nLet us know if this is related to any issue/pull request\n"
},
{
"path": ".github/workflows/deploy-docs.yml",
"content": "name: Deploy Docs\n\non:\n workflow_dispatch:\n release:\n types: [published]\n\njobs:\n deploy:\n name: Deploy\n runs-on: ubuntu-latest\n environment:\n name: docs.pluginpal.io\n url: https://docs.pluginpal.io/config-sync\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n - name: Set up Docker\n uses: actions/setup-node@v4\n with:\n node-version: '14'\n\n - name: Build a Docker image\n run: |\n cd docs\n docker build \\\n -t docs-config-sync:latest .\n docker save -o ../docs-config-sync-latest.tar docs-config-sync:latest\n\n - name: Transfer the Docker image to the Dokku server\n uses: appleboy/scp-action@v0.1.3\n with:\n host: ${{ secrets.SSH_HOST }}\n username: ${{ secrets.SSH_CI_USERNAME }}\n password: ${{ secrets.SSH_CI_PASSWORD }}\n source: docs-config-sync-latest.tar\n target: /var/lib/dokku/data/storage/docs/docker-images\n\n - name: Deploy the Dokku app based on the Docker image\n uses: appleboy/ssh-action@v0.1.10\n with:\n host: ${{ secrets.SSH_HOST }}\n username: ${{ secrets.SSH_CI_USERNAME }}\n password: ${{ secrets.SSH_CI_PASSWORD }}\n script_stop: true\n script: |\n sudo docker load -i /var/lib/dokku/data/storage/docs/docker-images/docs-config-sync-latest.tar\n DOCS_CONFIG_SYNC_LATEST_IMAGE=$(sudo docker images --format \"{{.ID}}\" docs-config-sync:latest)\n sudo docker tag docs-config-sync:latest docs-config-sync:$DOCS_CONFIG_SYNC_LATEST_IMAGE\n dokku git:from-image docs-config-sync docs-config-sync:$DOCS_CONFIG_SYNC_LATEST_IMAGE\n sudo docker system prune --all --force\n"
},
{
"path": ".github/workflows/publish.yml",
"content": "name: Publish to NPM\npermissions:\n id-token: write\n contents: write\non:\n release:\n types: [published]\njobs:\n publish:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n - name: Setup Node.js\n uses: actions/setup-node@v4\n with:\n always-auth: true\n node-version: 24\n cache: 'yarn'\n registry-url: 'https://registry.npmjs.org/'\n - name: Install dependencies\n run: yarn install --frozen-lockfile --ignore-engines\n - name: Build the plugin\n run: yarn build\n - name: Get the release tag version\n id: get_version\n run: echo \"VERSION=${GITHUB_REF/refs\\/tags\\//}\" >> $GITHUB_OUTPUT\n - name: Extract pre-release tag if any\n id: extract_tag\n run: |\n VERSION=\"${{ steps.get_version.outputs.VERSION }}\"\n if [[ $VERSION == *-* ]]; then\n # Extract everything between hyphen and last period (or end of string)\n PRETAG=$(echo $VERSION | sed -E 's/.*-([^.]+).*/\\1/')\n echo \"IS_PRERELEASE=true\" >> $GITHUB_OUTPUT\n echo \"NPM_TAG=$PRETAG\" >> $GITHUB_OUTPUT\n else\n echo \"IS_PRERELEASE=false\" >> $GITHUB_OUTPUT\n echo \"NPM_TAG=latest\" >> $GITHUB_OUTPUT\n fi\n - name: Get source branch\n id: get_branch\n run: |\n RELEASE_COMMIT=$(git rev-list -n 1 ${{ steps.get_version.outputs.VERSION }})\n SOURCE_BRANCH=$(git branch -r --contains $RELEASE_COMMIT | grep -v HEAD | head -n 1 | sed 's/.*origin\\///')\n echo \"SOURCE_BRANCH=$SOURCE_BRANCH\" >> $GITHUB_OUTPUT\n - name: Set package version\n run: yarn version --new-version \"${{ steps.get_version.outputs.VERSION }}\" --no-git-tag-version\n - name: Publish package\n run: npm publish --provenance --access public --tag ${{ steps.extract_tag.outputs.NPM_TAG }}\n - name: Push version bump\n uses: stefanzweifel/git-auto-commit-action@v4\n with:\n commit_message: 'chore: Bump version to ${{ steps.get_version.outputs.VERSION }}'\n file_pattern: 'package.json'\n branch: master\n"
},
{
"path": ".github/workflows/tests.yml",
"content": "name: Tests\n\non:\n push:\n branches:\n - master\n pull_request:\n branches:\n - master\n - develop\n - beta\n\njobs:\n lint:\n name: 'lint'\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node: [20, 22]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node }}\n cache: 'yarn'\n - name: Install dependencies\n run: yarn --frozen-lockfile\n - name: Run eslint\n run: yarn run eslint\n test:\n name: 'test'\n needs: [lint]\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node: [20, 22]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node }}\n cache: 'yarn'\n - name: Install dependencies plugin\n run: yarn --no-lockfile --unsafe-perm\n - name: Push the package to yalc\n run: yarn build\n - name: Add yalc package to the playground\n run: yarn playground:yalc-add\n - name: Install dependencies playground\n run: cd playground && yarn install --unsafe-perm\n - name: Build playground\n run: yarn playground:build\n # - name: Run unit tests\n # run: yarn test:unit\n - name: Run integration tests\n run: yarn run -s test:integration\n - name: Run end-to-end tests\n uses: cypress-io/github-action@v6\n with:\n start: yarn playground:start\n - uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: cypress-screenshots\n path: cypress/screenshots\n if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`\n - uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: cypress-videos\n path: cypress/videos\n if-no-files-found: ignore # 'warn' or 'error' are also available, defaults to `warn`\n - name: Upload coverage to Codecov\n uses: codecov/codecov-action@v4\n with:\n token: ${{ secrets.CODECOV }}\n flags: unit\n verbose: true\n fail_ci_if_error: true\n"
},
{
"path": ".gitignore",
"content": "# Don't check auto-generated stuff into git\ncoverage\nnode_modules\nstats.json\npackage-lock.json\nfiles\n\n# Cruft\n.DS_Store\nnpm-debug.log\n.idea\n\n# Production build\nbuild\ndist\nbundle\n\n# Cypress\ncypress/screenshots/\ncypress/videos/\ncypress/downloads/\n"
},
{
"path": "CODE_OF_CONDUCT.md",
"content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\n[@boazpoolman](https://twitter.com/boazpoolman) on twitter.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing\n\nWe want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.\n\n## Development Workflow\n\nThis plugin provides a local development instance of Strapi to develop it's features. We call this instance `playground` and it can be found in the playground folder in the root of the project. For that reason it is not needed to have your own Strapi instance running to work on this plugin. Just clone the repo and you're ready to go!\n\n#### 1. Fork the [repository](https://github.com/pluginpal/strapi-plugin-config-sync)\n\n[Go to the repository](https://github.com/pluginpal/strapi-plugin-config-sync) and fork it to your own GitHub account.\n\n#### 2. Clone the forked repository\n\n```bash\ngit clone git@github.com:YOUR_USERNAME/strapi-plugin-config-sync.git\n```\n\n#### 3. Install the dependencies\n\nGo to the folder and install the dependencies\n\n```bash\ncd strapi-plugin-config-sync && yarn install\n```\n\n#### 4. Install the playground dependencies\n\nRun this in the root of the repository\n\n```bash\nyarn playground:install\n```\n\n#### 5. Run the compiler of the plugin \n\nWe use `yalc` to publish the package to a local registry. Run the following command o watch for changes and push to `yalc` every time a change is made:\n\n```bash\nyarn develop\n```\n\n#### 6. Start the playground instance\n\nLeave the watcher running, open up a new terminal window and browse back to the root of the plugin repo. Run the following command:\n\n```bash\nyarn playground:develop\n```\n\nThis will start the playground instance that will have the plugin installed from the `yalc` registry. Browse to http://localhost:1337 and create a test admin user to log in to the playground.\n\n#### 7. Start your contribution!\n\nYou can now start working on your contribution. If you had trouble setting up this testing environment please feel free to report an issue on Github.\n\n### Commit message convention\n\nWe follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:\n\n- `fix`: bug fixes, e.g. fix crash due to deprecated method.\n- `feat`: new features, e.g. add new method to the module.\n- `refactor`: code refactor, e.g. migrate from class components to hooks.\n- `docs`: changes into documentation, e.g. add usage example for the module..\n- `test`: adding or updating tests, eg add integration tests using detox.\n- `chore`: tooling changes, e.g. change CI config.\n\n### Linting and tests\n\n[ESLint](https://eslint.org/)\n\nWe use [ESLint](https://eslint.org/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.\n\n### Scripts\n\nThe `package.json` file contains various scripts for common tasks:\n\n- `yarn eslint`: lint files with ESLint.\n- `yarn eslint:fix`: auto-fix ESLint issues.\n- `yarn test:integration`: run integration tests with Jest.\n\n### Sending a pull request\n\nWhen you're sending a pull request:\n\n- Prefer small pull requests focused on one change.\n- Verify that linters and tests are passing.\n- Review the documentation to make sure it looks good.\n- Follow the pull request template when opening a pull request.\n- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.\n"
},
{
"path": "LICENSE.md",
"content": "\n\nCopyright (c) 2021 Boaz Poolman.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the βSoftwareβ), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED βAS ISβ, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
{
"path": "README.md",
"content": "\n
Strapi config-sync plugin \n\t\n
This plugin is a multi-purpose tool to manage your Strapi database records through JSON files. Mostly used to version controlconfig data for automated deployment, automated tests and data sharing for collaboration purposes.
\n\n
Read the documentation \n\t\n
\n \n \n \n \n \n \n \n \n
\n
\n \n {formatMessage({ id: 'config-sync.Buttons.Import' })}\n \n )}\n onSubmit={(force) => dispatch(importAllConfig(partialDiff, force, toggleNotification, formatMessage, post, get))}\n />\n \n {formatMessage({ id: 'config-sync.Buttons.Export' })}\n \n )}\n onSubmit={(force) => dispatch(exportAllConfig(partialDiff, toggleNotification, formatMessage, post, get))}\n />\n {!isEmpty(partialDiff) && (\n {Object.keys(partialDiff).length} {Object.keys(partialDiff).length === 1 ? \"config change\" : \"config changes\"} \n )}\n dispatch(downloadZip(toggleNotification, formatMessage, post, get))}>{formatMessage({ id: 'config-sync.Buttons.DownloadConfig' })} \n \n );\n};\n\nconst ActionButtonsStyling = styled.div`\n padding: 10px 0 20px 0;\n display: flex;\n align-items: center;\n\n > button {\n margin-right: 10px;\n }\n > button:last-of-type {\n margin-left: auto;\n }\n`;\n\nexport default ActionButtons;\n"
},
{
"path": "admin/src/components/ConfigDiff/index.jsx",
"content": "import React from 'react';\nimport RDV, { DiffMethod } from 'react-diff-viewer-continued';\nimport { useIntl } from 'react-intl';\n\n/**\n * An issue with the diff-viewer library causes a difference in the way the library is exported.\n * Depending on whether the library is loaded through the browser or through the server, the default export may or may not be present.\n * This causes issues with SSR and the way the library is imported.\n *\n * Below a workaround to fix this issue.\n *\n * @see https://github.com/Aeolun/react-diff-viewer-continued/issues/43\n */\nlet ReactDiffViewer;\nif (typeof RDV.default !== 'undefined') {\n ReactDiffViewer = RDV.default;\n} else {\n ReactDiffViewer = RDV;\n}\n\nimport {\n Modal,\n Grid,\n Typography,\n} from '@strapi/design-system';\n\nconst ConfigDiff = ({ oldValue, newValue, configName, trigger }) => {\n const { formatMessage } = useIntl();\n\n return (\n \n \n {trigger}\n \n \n \n \n {formatMessage({ id: 'config-sync.ConfigDiff.Title' })} {configName}\n \n \n \n \n \n {formatMessage({ id: 'config-sync.ConfigDiff.SyncDirectory' })} \n \n \n {formatMessage({ id: 'config-sync.ConfigDiff.Database' })} \n \n \n \n \n \n \n \n );\n};\n\nexport default ConfigDiff;\n"
},
{
"path": "admin/src/components/ConfigList/ConfigListRow/index.jsx",
"content": "import React from 'react';\nimport { Tr, Td, Checkbox, Typography } from '@strapi/design-system';\n\nconst CustomRow = ({ row, checked, updateValue, ...props }) => {\n const { configName, configType, state, onClick } = row;\n\n const stateStyle = (stateStr) => {\n const style = {\n display: 'inline-flex',\n padding: '0 10px',\n borderRadius: '12px',\n height: '24px',\n alignItems: 'center',\n fontWeight: '500',\n };\n\n if (stateStr === 'Only in DB') {\n style.backgroundColor = '#cbf2d7';\n style.color = '#1b522b';\n }\n\n if (stateStr === 'Only in sync dir') {\n style.backgroundColor = '#f0cac7';\n style.color = '#3d302f';\n }\n\n if (stateStr === 'Different') {\n style.backgroundColor = '#e8e6b7';\n style.color = '#4a4934';\n }\n\n return style;\n };\n\n return (\n {\n if (e.target.type !== 'checkbox') {\n onClick(configType, configName);\n }\n }}\n style={{ cursor: 'pointer' }}\n >\n \n \n props.onClick(e)}>\n {configName} \n \n props.onClick(e)}>\n {configType} \n \n props.onClick(e)}>\n {state} \n \n \n );\n};\n\nexport default CustomRow;\n"
},
{
"path": "admin/src/components/ConfigList/index.jsx",
"content": "import React, { useState, useEffect } from 'react';\nimport { useIntl } from 'react-intl';\nimport { isEmpty } from 'lodash';\nimport { useDispatch } from 'react-redux';\n\nimport {\n Table,\n Thead,\n Tbody,\n Tr,\n Th,\n Typography,\n Checkbox,\n Loader,\n} from '@strapi/design-system';\n\nimport ConfigDiff from '../ConfigDiff';\nimport FirstExport from '../FirstExport';\nimport NoChanges from '../NoChanges';\nimport ConfigListRow from './ConfigListRow';\nimport { setConfigPartialDiffInState } from '../../state/actions/Config';\n\n\nconst ConfigList = ({ diff, isLoading }) => {\n const [originalConfig, setOriginalConfig] = useState({});\n const [newConfig, setNewConfig] = useState({});\n const [cName, setCname] = useState('');\n const [rows, setRows] = useState([]);\n const [checkedItems, setCheckedItems] = useState([]);\n const dispatch = useDispatch();\n const { formatMessage } = useIntl();\n\n const getConfigState = (configName) => {\n if (\n diff.fileConfig[configName]\n && diff.databaseConfig[configName]\n ) {\n return formatMessage({ id: 'config-sync.ConfigList.Different' });\n } else if (\n diff.fileConfig[configName]\n && !diff.databaseConfig[configName]\n ) {\n return formatMessage({ id: 'config-sync.ConfigList.OnlyDir' });\n } else if (\n !diff.fileConfig[configName]\n && diff.databaseConfig[configName]\n ) {\n return formatMessage({ id: 'config-sync.ConfigList.OnlyDB' });\n }\n };\n\n useEffect(() => {\n if (isEmpty(diff.diff)) {\n setRows([]);\n return;\n }\n\n const formattedRows = [];\n const newCheckedItems = [];\n Object.keys(diff.diff).map((name) => {\n const type = name.split('.')[0]; // Grab the first part of the filename.\n const formattedName = name.split(/\\.(.+)/)[1]; // Grab the rest of the filename minus the file extension.\n\n newCheckedItems.push(true);\n\n formattedRows.push({\n configName: formattedName,\n configType: type,\n state: getConfigState(name),\n onClick: (configType, configName) => {\n setOriginalConfig(diff.fileConfig[`${configType}.${configName}`]);\n setNewConfig(diff.databaseConfig[`${configType}.${configName}`]);\n setCname(`${configType}.${configName}`);\n },\n });\n });\n setCheckedItems(newCheckedItems);\n\n setRows(formattedRows);\n }, [diff]);\n\n useEffect(() => {\n const newPartialDiff = [];\n checkedItems.map((item, index) => {\n if (item && rows[index]) newPartialDiff.push(`${rows[index].configType}.${rows[index].configName}`);\n });\n dispatch(setConfigPartialDiffInState(newPartialDiff));\n }, [checkedItems]);\n\n if (isLoading) {\n return (\n \n {formatMessage({ id: 'config-sync.ConfigList.Loading' })} \n
\n );\n }\n\n if (!isLoading && !isEmpty(diff.message)) {\n return \n
\n \n \n \n setCheckedItems(checkedItems.map(() => value))}\n />\n \n \n {formatMessage({ id: 'config-sync.ConfigList.ConfigName' })} \n \n \n {formatMessage({ id: 'config-sync.ConfigList.ConfigType' })} \n \n \n {formatMessage({ id: 'config-sync.ConfigList.State' })} \n \n \n \n \n {rows.map((row, index) => (\n {\n checkedItems[index] = !checkedItems[index];\n setCheckedItems([...checkedItems]);\n }}\n />\n )}\n />\n ))}\n \n
\n
\n \n {trigger}\n \n \n {formatMessage({ id: \"config-sync.popUpWarning.Confirmation\" })} \n \n \n \n \n {formatMessage({ id: `config-sync.popUpWarning.warning.${type}_1` })} \n \n \n {(soft && type === 'import') && (\n \n \n \n setForce(value)}\n value={force}\n name=\"force\"\n >\n {formatMessage({ id: 'config-sync.popUpWarning.force' })}\n \n \n \n \n )}\n \n \n \n \n {formatMessage({ id: 'config-sync.popUpWarning.button.cancel' })}\n \n \n \n {\n onSubmit(force);\n }}\n >\n {formatMessage({ id: `config-sync.popUpWarning.button.${type}` })}\n \n \n \n \n \n );\n};\n\nexport default ConfirmModal;\n"
},
{
"path": "admin/src/components/FirstExport/index.jsx",
"content": "import React from 'react';\nimport { useIntl } from 'react-intl';\nimport { useDispatch } from 'react-redux';\nimport { getFetchClient, useNotification } from '@strapi/strapi/admin';\nimport { Button, EmptyStateLayout } from '@strapi/design-system';\nimport { EmptyDocuments } from '@strapi/icons/symbols';\n\n\nimport { exportAllConfig } from '../../state/actions/Config';\nimport ConfirmModal from '../ConfirmModal';\n\nconst FirstExport = () => {\n const { post, get } = getFetchClient();\n const { toggleNotification } = useNotification();\n const dispatch = useDispatch();\n const { formatMessage } = useIntl();\n\n return (\n \n dispatch(exportAllConfig([], toggleNotification, formatMessage, post, get))}\n trigger={(\n {formatMessage({ id: 'config-sync.FirstExport.Button' })} \n )}\n />\n )}\n icon={
\n );\n};\n\nexport default FirstExport;\n"
},
{
"path": "admin/src/components/Header/index.jsx",
"content": "/*\n *\n * HeaderComponent\n *\n */\n\nimport React, { memo } from 'react';\nimport { useIntl } from 'react-intl';\n\nimport { Layouts } from '@strapi/admin/strapi-admin';\nimport { Box } from '@strapi/design-system';\n\nconst HeaderComponent = () => {\n const { formatMessage } = useIntl();\n\n return (\n \n \n );\n};\n\nexport default memo(HeaderComponent);\n"
},
{
"path": "admin/src/components/NoChanges/index.jsx",
"content": "import React from 'react';\nimport { EmptyStateLayout } from '@strapi/design-system';\nimport { useIntl } from 'react-intl';\nimport { EmptyDocuments } from '@strapi/icons/symbols';\n\nconst NoChanges = () => {\n const { formatMessage } = useIntl();\n return (\n \n \n \n \n \n );\n};\n\nexport default App;\n"
},
{
"path": "admin/src/containers/ConfigPage/index.jsx",
"content": "import React, { useEffect } from 'react';\nimport { useDispatch, useSelector } from 'react-redux';\nimport { Map } from 'immutable';\nimport {\n Box,\n Alert,\n Typography,\n} from '@strapi/design-system';\nimport { useNotification } from '@strapi/strapi/admin';\nimport { getFetchClient, Layouts } from '@strapi/admin/strapi-admin';\nimport { useIntl } from 'react-intl';\n\nimport { getAllConfigDiff, getAppEnv } from '../../state/actions/Config';\nimport ConfigList from '../../components/ConfigList';\nimport ActionButtons from '../../components/ActionButtons';\n\nconst ConfigPage = () => {\n const { toggleNotification } = useNotification();\n const { get } = getFetchClient();\n const { formatMessage } = useIntl();\n\n const dispatch = useDispatch();\n const isLoading = useSelector((state) => state.getIn(['config', 'isLoading'], Map({})));\n const configDiff = useSelector((state) => state.getIn(['config', 'configDiff'], Map({})));\n const appEnv = useSelector((state) => state.getIn(['config', 'appEnv', 'env']));\n\n useEffect(() => {\n dispatch(getAllConfigDiff(toggleNotification, formatMessage, get));\n dispatch(getAppEnv(toggleNotification, formatMessage, get));\n }, []);\n\n return (\n \n {appEnv === 'production' && (\n \n \n {formatMessage({ id: 'config-sync.envWarning.production.heading' })} \n \n )}\n \n );\n};\n\nexport default ConfigPage;\n"
},
{
"path": "admin/src/containers/Initializer/index.jsx",
"content": "/**\n *\n * Initializer\n *\n */\n\nimport { useEffect, useRef } from 'react';\nimport PropTypes from 'prop-types';\nimport pluginId from '../../helpers/pluginId';\n\nconst Initializer = ({ updatePlugin }) => {\n const ref = useRef();\n ref.current = updatePlugin;\n\n useEffect(() => {\n ref.current(pluginId, 'isReady', true);\n }, []);\n\n return null;\n};\n\nInitializer.propTypes = {\n updatePlugin: PropTypes.func.isRequired,\n};\n\nexport default Initializer;\n"
},
{
"path": "admin/src/helpers/blob.js",
"content": "export function b64toBlob(dataURI, type) {\n const byteString = atob(dataURI);\n const ab = new ArrayBuffer(byteString.length);\n const ia = new Uint8Array(ab);\n for (let i = 0; i < byteString.length; i++) {\n ia[i] = byteString.charCodeAt(i);\n }\n return new Blob([ab], { type });\n}\n"
},
{
"path": "admin/src/helpers/configureStore.js",
"content": "import { createStore, applyMiddleware, compose } from 'redux';\nimport { thunk } from 'redux-thunk';\nimport { Map } from 'immutable';\n\nimport rootReducer from '../state/reducers';\nimport { __DEBUG__ } from '../config/constants';\n\nconst configureStore = () => {\n const initialStoreState = Map();\n\n const enhancers = [];\n const middlewares = [\n thunk,\n ];\n\n let devtools;\n\n if (__DEBUG__) {\n devtools = (\n typeof window !== 'undefined'\n && typeof window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ === 'function'\n && window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({ actionsBlacklist: [] })\n );\n\n if (devtools) {\n console.info('[setup] β Enabling Redux DevTools Extension');\n }\n }\n\n const composedEnhancers = devtools || compose;\n const storeEnhancers = composedEnhancers(\n applyMiddleware(...middlewares),\n ...enhancers,\n );\n\n const store = createStore(\n rootReducer,\n initialStoreState,\n storeEnhancers,\n );\n\n return store;\n};\n\nexport default configureStore;\n\nexport const store = configureStore();\n"
},
{
"path": "admin/src/helpers/getTrad.js",
"content": "import pluginId from './pluginId';\n\nconst getTrad = (id) => `${pluginId}.${id}`;\n\nexport default getTrad;\n"
},
{
"path": "admin/src/helpers/pluginId.js",
"content": "import pluginPkg from '../../../package.json';\n\nconst pluginId = pluginPkg.name.replace(\n /^strapi-plugin-/i,\n '',\n);\n\nexport default pluginId;\n"
},
{
"path": "admin/src/helpers/prefixPluginTranslations.js",
"content": "const prefixPluginTranslations = (trad, pluginId) => {\n if (!pluginId) {\n throw new TypeError(\"pluginId can't be empty\");\n }\n return Object.keys(trad).reduce((acc, current) => {\n acc[`${pluginId}.${current}`] = trad[current];\n return acc;\n }, {});\n};\n\nexport { prefixPluginTranslations };\n"
},
{
"path": "admin/src/index.cy.jsx",
"content": "// yarn deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n"
},
{
"path": "docs/babel.config.js",
"content": "module.exports = {\n presets: [require.resolve('@docusaurus/core/lib/babel/preset')],\n};\n"
},
{
"path": "docs/blog/2019-05-28-first-blog-post.md",
"content": "---\nslug: first-blog-post\ntitle: First Blog Post\nauthors: [slorber, yangshun]\ntags: [hola, docusaurus]\n---\n\nLorem ipsum dolor sit amet...\n\n\n\n...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n"
},
{
"path": "docs/blog/2019-05-29-long-blog-post.md",
"content": "---\nslug: long-blog-post\ntitle: Long Blog Post\nauthors: yangshun\ntags: [hello, docusaurus]\n---\n\nThis is the summary of a very long blog post,\n\nUse a `` comment to limit blog post size in the list view.\n\n\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet\n"
},
{
"path": "docs/blog/2021-08-01-mdx-blog-post.mdx",
"content": "---\nslug: mdx-blog-post\ntitle: MDX Blog Post\nauthors: [slorber]\ntags: [docusaurus]\n---\n\nBlog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).\n\n:::tip\n\nUse the power of React to create interactive blog posts.\n\n:::\n\n{/* truncate */}\n\nFor example, use JSX to create an interactive button:\n\n```js\n alert('button clicked!')}>Click me! \n```\n\n alert('button clicked!')}>Click me! \n"
},
{
"path": "docs/blog/2021-08-26-welcome/index.md",
"content": "---\nslug: welcome\ntitle: Welcome\nauthors: [slorber, yangshun]\ntags: [facebook, hello, docusaurus]\n---\n\n[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).\n\nHere are a few tips you might find useful.\n\n\n\nSimply add Markdown files (or folders) to the `blog` directory.\n\nRegular blog authors can be added to `authors.yml`.\n\nThe blog post date can be extracted from filenames, such as:\n\n- `2019-05-30-welcome.md`\n- `2019-05-30-welcome/index.md`\n\nA blog post folder can be convenient to co-locate blog post images:\n\n\n\nThe blog supports tags as well!\n\n**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.\n"
},
{
"path": "docs/blog/authors.yml",
"content": "yangshun:\n name: Yangshun Tay\n title: Front End Engineer @ Facebook\n url: https://github.com/yangshun\n image_url: https://github.com/yangshun.png\n page: true\n socials:\n x: yangshunz\n github: yangshun\n\nslorber:\n name: SΓ©bastien Lorber\n title: Docusaurus maintainer\n url: https://sebastienlorber.com\n image_url: https://github.com/slorber.png\n page:\n # customize the url of the author page at /blog/authors/\n permalink: '/all-sebastien-lorber-articles'\n socials:\n x: sebastienlorber\n linkedin: sebastienlorber\n github: slorber\n newsletter: https://thisweekinreact.com\n"
},
{
"path": "docs/blog/tags.yml",
"content": "facebook:\n label: Facebook\n permalink: /facebook\n description: Facebook tag description\n\nhello:\n label: Hello\n permalink: /hello\n description: Hello tag description\n\ndocusaurus:\n label: Docusaurus\n permalink: /docusaurus\n description: Docusaurus tag description\n\nhola:\n label: Hola\n permalink: /hola\n description: Hola tag description\n"
},
{
"path": "docs/docs/api/plugin-config-types.md",
"content": "---\nsidebar_label: 'Plugin config types'\ndisplayed_sidebar: configSyncSidebar\nslug: /api/plugin-config-types\n---\n\n# Plugin config types\n\nWhen you're writing a plugin, which registers a content type, you might want to consider that content type as a config type as defined in the Config Sync specification.\n\n## Register a config type programatically\n\nYou can register a config type by adding some code to the register function of your plugin.\n\n```md title=\"register.js\"\n// Register the config type when using the config-sync plugin.\nif (strapi.plugin('config-sync')) {\n if (!strapi.plugin('config-sync').pluginTypes) {\n strapi.plugin('config-sync').pluginTypes = [];\n }\n\n strapi.plugin('config-sync').pluginTypes.push({\n configName: 'url-pattern',\n queryString: 'plugin::webtools.url-pattern',\n uid: 'code',\n });\n}\n```\n\nIf you want to read more about what the different values of a config type actually mean please read the in depth [custom types](/config-types#custom-types) docs\n"
},
{
"path": "docs/docs/configuration/custom-types.md",
"content": "---\nsidebar_label: 'Custom types'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/custom-types\n---\n\n# Custom types\n\nWith this setting you can register your own custom config types. This is an array which expects objects with at least the `configName`, `queryString` and `uid` properties. Read more about registering custom types in the [Custom config types](/config-types#custom-types) documentation.\n\n| Name | Details |\n| ---- | ------- |\n| Key | `customTypes` |\n| Required | false |\n| Type | array |\n| Default | `[]` |\n"
},
{
"path": "docs/docs/configuration/excluded-config.md",
"content": "---\nsidebar_label: 'Excluded config'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/excluded-config\n---\n\n# Excluded config\n\nSpecify the names of configs you want to exclude from the syncing process. By default the API tokens for users-permissions, which are stored in core_store, are excluded. This setting expects the config names to comply with the naming convention.\n\n| Name | Details |\n| ---- | ------- |\n| Key | `excludedConfig` |\n| Required | false |\n| Type | array |\n| Default | `['core-store.plugin_users-permissions_grant', 'core-store.plugin_upload_metrics', 'core-store.strapi_content_types_schema', 'core-store.ee_information',]` |\n"
},
{
"path": "docs/docs/configuration/excluded-types.md",
"content": "---\nsidebar_label: 'Excluded types'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/excluded-types\n---\n\n# Excluded types\n\nThis setting will exclude all the config from a given type from the syncing process. The config types are specified by the `configName` of the type.\n\nFor example:\n\n```\nexcludedTypes: ['admin-role']\n```\n\n| Name | Details |\n| ---- | ------- |\n| Key | `excludedTypes` |\n| Required | false |\n| Type | array |\n| Default | `[]` |\n"
},
{
"path": "docs/docs/configuration/import-on-bootstrap.md",
"content": "---\nsidebar_label: 'Import on bootstrap'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/import-on-bootstrap\n---\n\n# Import on bootstrap\n\nAllows you to let the config be imported automaticly when strapi is bootstrapping (on `strapi start`). \n\n:::danger\nThis setting can't be used locally and should be handled very carefully as it can unintendedly overwrite the changes in your database. **PLEASE USE WITH CARE**.\n:::\n\n| Name | Details |\n| ---- | ------- |\n| Key | `importOnBootstrap` |\n| Required | false |\n| Type | bool |\n| Default | `false` |\n"
},
{
"path": "docs/docs/configuration/introduction.md",
"content": "---\nsidebar_label: 'Introduction'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration\n---\n\n# π§ Configuration\nThe settings of the plugin can be overridden in the `config/plugins.js` file. \nIn the example below you can see how, and also what the default settings are.\n\n```md title=\"config/plugins.js\"\nmodule.exports = ({ env }) => ({\n // ...\n 'config-sync': {\n enabled: true,\n config: {\n syncDir: \"config/sync/\",\n minify: false,\n soft: false,\n importOnBootstrap: false,\n customTypes: [],\n excludedTypes: [],\n excludedConfig: [\n \"core-store.plugin_users-permissions_grant\",\n \"core-store.plugin_upload_metrics\",\n \"core-store.strapi_content_types_schema\",\n \"core-store.ee_information\",\n ],\n },\n },\n});\n```\n"
},
{
"path": "docs/docs/configuration/minify.md",
"content": "---\nsidebar_label: 'Minify'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/minify\n---\n\n# Minify\n\nWhen enabled all the exported JSON files will be minified.\n\n| Name | Details |\n| ---- | ------- |\n| Key | `minify` |\n| Required | false |\n| Type | bool |\n| Default | `false` |\n"
},
{
"path": "docs/docs/configuration/soft.md",
"content": "---\nsidebar_label: 'Soft'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/soft\n---\n\n# Soft\n\nWhen enabled the import action will be limited to only create new entries. Entries to be deleted, or updated will be skipped from the import process and will remain in it's original state.\n\n| Name | Details |\n| ---- | ------- |\n| Key | `soft` |\n| Required | false |\n| Type | bool |\n| Default | `false` |\n"
},
{
"path": "docs/docs/configuration/sync-dir.md",
"content": "---\nsidebar_label: 'Sync dir'\ndisplayed_sidebar: configSyncSidebar\nslug: /configuration/sync-dir\n---\n\n# Sync dir\n\nThe path for reading and writing the sync files.\n\n| Name | Details |\n| ---- | ------- |\n| Key | `syncDir` |\n| Required | true |\n| Type | string |\n| Default | `config/sync/` |\n"
},
{
"path": "docs/docs/getting-started/admin-gui.md",
"content": "---\nsidebar_label: 'Admin GUI'\ndisplayed_sidebar: configSyncSidebar\nslug: /admin-gui\n---\n\n# π₯οΈ Admin panel (GUI)\nThis plugin ships with a React app which can be accessed from the settings page in Strapi admin panel. On this page you can pretty much do the same as you can from the CLI. You can import, export and see the difference between the config as found in the sync directory, and the config as found in the database.\n\n**Pro tip:**\nBy clicking on one of the items in the diff table you can see the exact difference between sync dir and database in a git-style diff viewer.\n\n\n"
},
{
"path": "docs/docs/getting-started/cli.md",
"content": "---\nsidebar_label: 'CLI'\ndisplayed_sidebar: configSyncSidebar\nslug: /cli\n---\n\n# π Command line interface (CLI)\n\nAdd the `config-sync` command as a script to the `package.json` of your Strapi project:\n\n```\n\"scripts\": {\n // ...\n \"cs\": \"config-sync\"\n},\n```\n\nYou can now run all the `config-sync` commands like this:\n\n\n \n ```\n yarn cs --help\n ```\n \n \n ```\n npm run cs -- --help\n ```\n \n \n\n## β¬οΈ Import β¬οΈ Export\n\n> _Command:_ `import` _Alias:_ `i`\n> \n> _Command:_ `export` _Alias:_ `e`\n\nThese commands are used to sync the config in your Strapi project. \n\n_Example:_\n\n\n \n ```\n yarn cs import\n yarn cs export\n ```\n \n \n ```\n npm run cs import\n npm run cs export\n ```\n \n \n\n:::info\nWhen you're using `npm` to run these commands, please note that you need an extra `--` to forward the flags to the script.\nMore information about this topic can be found on the NPM documentation .\n\nExample:\n```\nnpm run cs import -- --yes\n```\n:::\n\n### Flag: `-y`, `--yes`\n\nUse this flag to skip the confirm prompt and go straight to syncing the config.\n\n```bash\n[command] --yes\n```\n\n### Flag: `-t`, `--type`\n\nUse this flag to specify the type of config you want to sync.\n\n```bash\n[command] --type user-role\n```\n\n### Flag: `-p`, `--partial`\n\nUse this flag to sync a specific set of configs by giving the CLI a comma-separated string of config names.\n\n```bash\n[command] --partial user-role.public,i18n-locale.en\n```\n\n### Flag: `-f`, `--force`\n\nIf you're using the soft setting to gracefully import config, you can use this flag to ignore the setting for the current command and forcefully import all changes anyway.\n\n```bash\n[command] --force\n```\n\n## βοΈ Diff\n\n> _Command:_ `diff` | _Alias:_ `d`\n\nThis command is used to see the difference between the config as found in the sync directory, and the config as found in the database.\n\n_Example:_\n\n\n \n ```\n yarn cs diff\n ```\n \n \n ```\n npm run cs diff\n ```\n \n \n\n### Argument: ``\n\nAdd a single config name as the argument of the `diff` command to see the difference of that single file in a git-style diff viewer.\n\n_Example:_\n\n\n \n ```\n yarn cs diff user-role.public\n ```\n \n \n ```\n npm run cs diff user-role.public\n ```\n \n \n"
},
{
"path": "docs/docs/getting-started/config-types.md",
"content": "---\nsidebar_label: 'Config Types'\ndisplayed_sidebar: configSyncSidebar\nslug: /config-types\n---\n\n# π Config types\n\nBy default the plugin will track 4 (official) types. \n\nTo track your own custom types you can register them by setting some plugin config.\n\n## Default types\n\nThese 4 types are by default registered in the sync process. \n\n### Admin role\n\n> Config name: `admin-role` | UID: `code` | Query string: `admin::role`\n\n### User role\n\n> Config name: `user-role` | UID: `type` | Query string: `plugin::users-permissions.role`\n\n### Core store\n\n> Config name: `core-store` | UID: `key` | Query string: `strapi::core-store`\n\n### I18n locale\n\n> Config name: `i18n-locale` | UID: `code` | Query string: `plugin::i18n.locale`\n\n## Custom types\n\nYour custom types can be registered through the `customTypes` plugin config. This is a setting that can be set in the `config/plugins.js` file in your project.\n\n_Read more about the `config/plugins.js` file [here](/configuration)._\n\nYou can register a type by giving the `customTypes` array an object which contains at least the following 3 properties:\n\n```\ncustomTypes: [{\n configName: 'webhook',\n queryString: 'webhook',\n uid: 'name',\n}],\n```\n\n_The example above will register the Strapi webhook type._\n\n### Config name\n\nThe name of the config type. This value will be used as the first part of the filename for all config of this type. It should be unique from the other types and is preferably written in kebab-case.\n\n##### Key: `configName`\n\n> `required:` YES | `type:` string\n\n### Query string\n\nThis is the query string of the type. Each type in Strapi has its own query string you can use to programatically preform CRUD actions on the entries of the type. Often for custom types in Strapi the format is something like `api::custom-api.custom-type`.\n\n##### Key: `queryString`\n\n> `required:` YES | `type:` string\n\n### UID\n\nThe UID represents a field on the registered type. The value of this field will act as a unique identifier to identify the entries across environments. Therefore it should be unique and preferably un-editable after initial creation.\n\nMind that you can not use an auto-incremental value like the `id` as auto-increment does not play nice when you try to match entries across different databases.\n\nIf you do not have a single unique value, you can also pass in an array of keys for a combined uid key. This is for example the case for all content types which use i18n features (An example config would be `uid: ['productId', 'locale']`).\n\n##### Key: `uid`\n\n> `required:` YES | `type:` string | string[]\n\n### Relations\n\nThe relations array specifies the relations you want to include in the sync process.\nThis feature is used to sync the relations between `roles` and `permissions`. See https://github.com/boazpoolman/strapi-plugin-config-sync/blob/master/server/config/types.js#L16.\n\nExample:\n```\n{\n configName: 'admin-role',\n queryString: 'admin::role',\n uid: 'code',\n relations: [{\n queryString: 'admin::permission',\n relationName: 'permissions',\n parentName: 'role',\n relationSortFields: ['action', 'subject'],\n }],\n},\n```\n\n##### Key: `relations`\n\n> `required:` NO | `type:` array\n\n### Components\n\nThis property can accept an array of component names from the type. Strapi Components can be included in the export/import process. With \".\" nested components can also be included in the process.\n```\ncustomTypes: [{\n configName: 'webhook',\n queryString: 'webhook',\n uid: 'name',\n components: ['ParentComponentA', 'ParentComponentA.ChildComponent', 'ParentComponentB']\n}],\n```\n\n##### Key: `components`\n\n> `required:` NO | `type:` array\n\n### JSON fields\n\nThis property can accept an array of field names from the type. It is meant to specify the JSON fields on the type so the plugin can better format the field values when calculating the config difference.\n\n##### Key: `jsonFields`\n\n> `required:` NO | `type:` array\n"
},
{
"path": "docs/docs/getting-started/installation.md",
"content": "---\nsidebar_label: 'Installation'\ndisplayed_sidebar: configSyncSidebar\nslug: /\n---\n\n# β³ Installation\n\n:::prerequisites\nComplete installation requirements are the exact same as for Strapi itself and can be found in the Strapi documentation.\n\n**Supported Strapi versions:**\n\nStrapi v5 use `strapi-plugin-config-sync@^3`\n\nStrapi v4 use `strapi-plugin-config-sync@^1`\n\n:::\n\nInstall the plugin in your Strapi project.\n\n\n \n ```\n yarn add strapi-plugin-config-sync\n ```\n \n \n ```\n npm install strapi-plugin-config-sync --save\n ```\n \n \n \nAdd the export path to the `watchIgnoreFiles` list in the `config/admin.js` file.\nThis way your app won't reload when you export the config in development.\n\n```md title=\"config/admin.js\"\nmodule.exports = ({ env }) => ({\n // ...\n watchIgnoreFiles: [\n '**/config/sync/**',\n ],\n});\n```\n\nAfter successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:\n\n\n \n ```\n yarn build\n yarn develop\n ```\n \n \n ```\n npm run build\n npm run develop\n ```\n \n \n\nThe **Config Sync** plugin should now appear in the **Settings** section of your Strapi app.\n\nTo start tracking your config changes you have to make the first export. This will dump all your configuration data to the `/config/sync` directory. You can export either through [the CLI](/cli) or [Strapi admin panel](/admin-gui)\n\nEnjoy π\n"
},
{
"path": "docs/docs/getting-started/motivation.md",
"content": "---\nsidebar_label: 'Motivation'\ndisplayed_sidebar: configSyncSidebar\nslug: /motivation\n---\n\n# π‘ Motivation\n\nIn Strapi we come across what I would call config types. These are models of which the records are stored in our database, just like content types. Though the big difference here is that your code often relies on the database records of these types. \n\nHaving said that, it makes sense that these records can be exported, added to git, and be migrated across environments. This way we can make sure we have all the data our code relies on, on each environment.\n\nExamples of these types are:\n\n- Admin roles _(admin::role)_\n- User roles _(plugin::users-permissions.role)_\n- Admin settings _(strapi::core-store)_\n- I18n locale _(plugin::i18n.locale)_\n\nThis plugin gives you the tools to sync this data. You can export the data as JSON files on one env, and import them on every other env. By writing this data as JSON files you can easily track them in your version control system (git).\n\n_With great power comes great responsibility - Uncle Ben_\n"
},
{
"path": "docs/docs/getting-started/naming-convention.md",
"content": "---\nsidebar_label: 'Naming convention'\ndisplayed_sidebar: configSyncSidebar\nslug: /naming-convention\n---\n\n# π Naming convention\nAll the config files written in the sync directory have the same naming convention. It goes as follows:\n\n\t[config-type].[identifier].json\n\n- `config-type` - Corresponds to the `configName` of the config type.\n- `identifier` - Corresponds to the value of the `uid` field of the config type.\n"
},
{
"path": "docs/docs/getting-started/workflow.md",
"content": "---\nsidebar_label: 'Workflow'\ndisplayed_sidebar: configSyncSidebar\nslug: /workflow\n---\n\n# β¨οΈ Usage / Workflow\nThis plugin works best when you use `git` for the version control of your Strapi project.\n\n_The following workflows are assuming you're using `git`._\n\n### Intro\nAll database records tracked with this plugin will be exported to JSON files. Once exported each change to the file or the record will be tracked. Meaning you can now do one of two things:\n\n- Change the file(s), and run an import. You have now imported from filesystem -> database.\n- Change the record(s), and run an export. You have now exported from database -> filesystem. \n\n### Local development\nWhen building a new feature locally for your Strapi project you'd use the following workflow:\n\n- Build the feature.\n- Export the config.\n- Commit and push the files to git.\n\n### Deployment\nWhen deploying the newly created feature - to either a server, or a co-worker's machine - you'd use the following workflow:\n\n- Pull the latest file changes to the environment.\n- (Re)start your Strapi instance.\n- Import the config.\n\n## Production deployment\nThe production deployment will be the same as a regular deployment. You just have to be careful before running the import. Ideally making sure the are no open changes before you pull the new code to the environment.\n"
},
{
"path": "docs/docs/upgrading/generic-update.md",
"content": "---\nsidebar_label: 'Generic update'\ndisplayed_sidebar: configSyncSidebar\nslug: /upgrading/generic-update\n---\n\n# Updating Config Sync\n\nWe are always working to make Config Sync better by fixing bugs and introducing new features. These changes will be released as minor or patch versions as defined in the Semantic Versioning specification.\n\n## Bump a minor/patch version\n\nWhen you're updating Config Sync you'll have to follow these steps:\n\n1. Make sure there are no config changes before starting. Either export or import all staged changes.\n2. Update the version of the `strapi-plugin-config-sync` package in your `package.json` using your package manager of choice (yarn/npm/pnpm)\n3. After you've bumped the version make sure to export any new changes that are now shown. It is possible that new configs are introduced, or old ones are updated/removed.\n4. You're now ready to push these changes an commit them to your source control!\n"
},
{
"path": "docs/docusaurus.config.ts",
"content": "import {themes as prismThemes} from 'prism-react-renderer';\nimport type {Config} from '@docusaurus/types';\nimport type * as Preset from '@docusaurus/preset-classic';\n\nconst config: Config = {\n title: 'Strapi Config Sync',\n tagline: \"Documentation for the config-sync plugin for Strapi\",\n favicon: 'img/favicon.jpg',\n\n plugins: [\n 'docusaurus-plugin-sass',\n ],\n\n // Set the production url of your site here\n url: 'https://docs.pluginpal.io',\n // Set the // pathname under which your site is served\n // For GitHub pages deployment, it is often '//'\n baseUrl: '/config-sync/',\n\n // GitHub pages deployment config.\n // If you aren't using GitHub pages, you don't need these.\n organizationName: 'pluginpal', // Usually your GitHub org/user name.\n\n onBrokenLinks: 'throw',\n onBrokenMarkdownLinks: 'warn',\n\n // Even if you don't use internationalization, you can use this field to set\n // useful metadata like html lang. For example, if your site is Chinese, you\n // may want to replace \"en\" with \"zh-Hans\".\n i18n: {\n defaultLocale: 'en',\n locales: ['en'],\n },\n\n // themes: ['@docusaurus/theme-live-codeblock', '@docusaurus/theme-mermaid'],\n\n presets: [\n [\n 'classic',\n {\n docs: {\n routeBasePath: '/',\n sidebarPath: './sidebars.ts',\n // Please change this to your repo.\n // Remove this to remove the \"edit this page\" links.\n editUrl:\n 'https://github.com/pluginpal/strapi-plugin-config-sync/tree/master/docs',\n admonitions: {\n keywords: [\n // Admonitions defaults\n 'note',\n 'tip',\n 'info',\n 'caution',\n 'danger',\n\n // Admonitions custom\n 'callout',\n 'prerequisites',\n 'strapi',\n 'warning',\n ],\n },\n },\n blog: false,\n sitemap: {\n lastmod: 'date',\n changefreq: 'weekly',\n priority: 0.6,\n // ignorePatterns: ['/tags/**'],\n filename: 'sitemap.xml',\n createSitemapItems: async (params) => {\n const {defaultCreateSitemapItems, ...rest} = params;\n const items = await defaultCreateSitemapItems(rest);\n return items;\n },\n },\n theme: {\n customCss: './src/scss/__index.scss',\n },\n } satisfies Preset.Options,\n ],\n ],\n\n themeConfig: {\n // Replace with your project's social card\n // image: 'img/docusaurus-social-card.jpg',\n navbar: {\n title: 'Strapi Config Sync',\n logo: {\n alt: 'Config Sync logo',\n src: 'img/logo.png',\n },\n items: [\n {\n href: 'https://github.com/pluginpal/strapi-plugin-config-sync',\n label: 'GitHub',\n position: 'right',\n },\n ],\n },\n footer: {\n style: 'dark',\n links: [\n {\n title: 'Community',\n items: [\n {\n label: 'Discord',\n href: 'https://discord.com/invite/strapi',\n },\n {\n label: 'Forum',\n href: 'https://forum.strapi.io/',\n },\n ],\n },\n {\n title: 'More',\n items: [\n {\n label: 'Website',\n href: 'https://www.pluginpal.io',\n },\n {\n label: 'GitHub',\n href: 'https://github.com/pluginpal',\n },\n ],\n },\n ],\n },\n\n algolia: {\n appId: 'ADLP623G89',\n apiKey: '8f91ceaf54e8e8db14479fd79a420a8c',\n indexName: 'pluginpal',\n },\n\n prism: {\n theme: prismThemes.github,\n darkTheme: prismThemes.dracula,\n },\n } satisfies Preset.ThemeConfig,\n};\n\nexport default config;\n"
},
{
"path": "docs/package.json",
"content": "{\n \"name\": \"pluginpal-docs\",\n \"version\": \"0.0.0\",\n \"private\": true,\n \"scripts\": {\n \"docusaurus\": \"docusaurus\",\n \"start\": \"docusaurus start\",\n \"build\": \"docusaurus build\",\n \"swizzle\": \"docusaurus swizzle\",\n \"deploy\": \"docusaurus deploy\",\n \"clear\": \"docusaurus clear\",\n \"serve\": \"docusaurus serve\",\n \"write-translations\": \"docusaurus write-translations\",\n \"write-heading-ids\": \"docusaurus write-heading-ids\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"@docusaurus/core\": \"^3.9.2\",\n \"@docusaurus/plugin-sitemap\": \"^3.9.2\",\n \"@docusaurus/preset-classic\": \"^3.9.2\",\n \"@docusaurus/theme-live-codeblock\": \"^3.9.2\",\n \"@docusaurus/theme-mermaid\": \"^3.9.2\",\n \"@docusaurus/theme-search-algolia\": \"^3.9.2\",\n \"@mdx-js/react\": \"^3.0.0\",\n \"classnames\": \"^2.5.1\",\n \"clsx\": \"^2.0.0\",\n \"docusaurus-plugin-sass\": \"^0.2.5\",\n \"prism-react-renderer\": \"^2.3.0\",\n \"react\": \"^18.0.0\",\n \"react-dom\": \"^18.0.0\",\n \"sass\": \"^1.78.0\"\n },\n \"devDependencies\": {\n \"@docusaurus/module-type-aliases\": \"^3.9.2\",\n \"@docusaurus/tsconfig\": \"^3.9.2\",\n \"@docusaurus/types\": \"^3.9.2\",\n \"typescript\": \"~5.5.2\"\n },\n \"browserslist\": {\n \"production\": [\n \">0.5%\",\n \"not dead\",\n \"not op_mini all\"\n ],\n \"development\": [\n \"last 3 chrome version\",\n \"last 3 firefox version\",\n \"last 5 safari version\"\n ]\n },\n \"engines\": {\n \"node\": \">=18.0\"\n }\n}\n"
},
{
"path": "docs/sidebars.ts",
"content": "/**\n - create an ordered group of docs\n - render a sidebar for each doc of that group\n - provide next/previous navigation\n\n The sidebars can be generated from the filesystem, or explicitly defined here.\n\n Create as many sidebars as you want.\n */\n\n// @ts-check\n\n/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */\nconst sidebars = {\n // By default, Docusaurus generates a sidebar from the docs folder structure\n // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],\n\n // But you can create a sidebar manually\n configSyncSidebar: [\n {\n type: \"category\",\n collapsed: false,\n label: \"π Getting Started\",\n items: [\n \"getting-started/installation\",\n \"getting-started/motivation\",\n \"getting-started/cli\",\n \"getting-started/admin-gui\",\n \"getting-started/config-types\",\n \"getting-started/workflow\",\n \"getting-started/naming-convention\",\n // \"dev-docs/usage-information\",\n ],\n },\n {\n type: \"category\",\n collapsed: false,\n label: \"βοΈ Configuration\",\n items: [\n \"configuration/introduction\",\n \"configuration/sync-dir\",\n \"configuration/minify\",\n \"configuration/import-on-bootstrap\",\n \"configuration/custom-types\",\n \"configuration/soft\",\n \"configuration/excluded-types\",\n \"configuration/excluded-config\",\n ],\n },\n {\n type: \"category\",\n collapsed: false,\n label: \"π¦ API\",\n items: [\n \"api/plugin-config-types\",\n ],\n },\n {\n type: \"category\",\n collapsed: false,\n label: \"β»οΈ Upgrading\",\n items: [\n \"upgrading/generic-update\",\n ],\n },\n ],\n};\n\nmodule.exports = sidebars;\n"
},
{
"path": "docs/src/components/ApiCall.js",
"content": "import React from 'react'\nimport clsx from 'clsx'\n\nexport default function ApiCall({\n children,\n noSideBySide = false,\n}) {\n return (\n \n {children}\n \n );\n}\n"
},
{
"path": "docs/src/components/Badge.js",
"content": "import React from 'react';\nimport clsx from 'clsx';\n\nexport default function Badge({\n children,\n className,\n link = '',\n noLink = false,\n variant = '',\n ...rest\n}) {\n const variantNormalized = variant.toLowerCase().replace(/\\W/g, '');\n\n return (\n \n {(noLink || !link) ? (\n <>\n {variant}\n \n ) : (\n \n {variant}\n \n )}\n {children}\n \n );\n}\n\nexport function AlphaBadge(props) {\n return (\n \n {children}\n {decorative && (\n \n {decorative}\n \n )}\n \n );\n}\n"
},
{
"path": "docs/src/components/Button/button.module.scss",
"content": "/** Component: Button */\n\n@import '../../scss/_mixins.scss';\n\n.button {\n --strapi-button-background-color: var(--strapi-primary-600);\n --strapi-button-border-color: var(--strapi-primary-600);\n --strapi-button-border-radius: 4px;\n --strapi-button-box-shadow: 0 0 0 transparent;\n --strapi-button-color: #fff;\n --strapi-button-font-size: 12px;\n --strapi-button-font-weight: 600;\n --strapi-button-line-height: 16px;\n --strapi-button-position: relative;\n --strapi-button-py: 7px;\n --strapi-button-px: 15px;\n --strapi-button-transition-property: color, background, border-color, box-shadow;\n\n --strapi-button-hover-background-color: var(--strapi-primary-700);\n --strapi-button-hover-border-color: var(--strapi-primary-700);\n --strapi-button-hover-box-shadow: 0px 9px 10px rgba(44, 56, 148, 0.2475);\n --strapi-button-hover-color: #fff;\n\n --ifm-button-color: var(--strapi-button-color);\n --ifm-button-background-color: var(--strapi-button-background-color);\n --ifm-button-border-color: var(--strapi-button-border-color);\n --ifm-button-border-radius: var(--strapi-button-border-radius);\n --ifm-button-font-weight: var(--strapi-button-font-weight);\n --ifm-button-padding-horizontal: var(--strapi-button-px);\n --ifm-button-padding-vertical: var(--strapi-button-py);\n --ifm-button-size-multiplier: 1;\n\n --ifm-color-primary-darker: var(--strapi-primary-200);\n\n --ifm-link-hover-color: var(--strapi-button-color);\n --ifm-link-hover-decoration: none;\n\n position: var(--strapi-button-position);\n font-size: var(--strapi-button-font-size);\n line-height: var(--strapi-button-line-height);\n box-shadow: var(--strapi-button-box-shadow);\n transition-property: var(--strapi-button-transition-property);\n\n &__decorative {\n position: absolute;\n font-size: 32px;\n line-height: 32px;\n bottom: -16px;\n right: -8px;\n }\n\n &:not(:disabled),\n &:not([aria-disabled=\"true\"]) {\n &:focus, &:hover {\n --strapi-button-box-shadow: var(--strapi-button-hover-box-shadow);\n --strapi-button-background-color: var(--strapi-button-hover-background-color);\n --strapi-button-border-color: var(--strapi-button-hover-border-color);\n --strapi-button-color: var(--strapi-button-hover-color);\n }\n }\n\n /** Sizes */\n &--huge {\n --strapi-button-border-radius: 6px;\n --strapi-button-font-size: 15px;\n --strapi-button-line-height: 23px;\n --strapi-button-py: 11px;\n --strapi-button-px: 71px;\n }\n\n /** Variants */\n &--secondary {\n --strapi-button-background-color: #f0f0ff;\n --strapi-button-border-color: #d9d8ff;\n --strapi-button-color: var(--strapi-primary-600);\n\n --strapi-button-hover-background-color: var(--strapi-neutral-0);\n --strapi-button-hover-border-color: #d9d8ff;\n --strapi-button-hover-box-shadow: none;\n --strapi-button-hover-color: var(--strapi-primary-600);\n }\n}\n\n/** Dark mode */\n@include dark {\n .button {\n /** Dark mode Variants */\n &--secondary {\n --strapi-button-background-color: var(--strapi-neutral-100);\n --strapi-button-border-color: var(--strapi-neutral-200);\n\n --strapi-button-hover-background-color: var(--strapi-neutral-0);\n --strapi-button-hover-border-color: var(--strapi-neutral-200);\n }\n }\n}\n"
},
{
"path": "docs/src/components/Card/Card.jsx",
"content": "import React from 'react';\nimport clsx from 'clsx';\nimport Link from '@docusaurus/Link';\nimport styles from './card.module.scss';\nimport IconArrow from '@site/static/img/assets/icons/arrow-right.svg';\n\nexport function CardTitle({\n as,\n children,\n className,\n withArrow,\n ...rest\n}) {\n const TitleElement = (as || 'h3');\n\n return (\n \n {children}\n {withArrow && (\n \n \n )}\n \n );\n}\n\nexport function CardDescription({\n as,\n className,\n ...rest\n}) {\n const DescriptionElement = (as || 'div');\n\n return (\n \n \n \n {emoji ? emoji : 'ποΈ'} {title}\n \n \n {description}\n
\n \n \n );\n}\n"
},
{
"path": "docs/src/components/CustomDocCardsWrapper.js",
"content": "import React from 'react';\n\nexport default function CustomDocCardsWrapper({ children }) {\n return (\n \n {children}\n
\n );\n}\n"
},
{
"path": "docs/src/components/FeaturesList/FeaturesList.jsx",
"content": "import clsx from 'clsx';\nimport React from 'react';\nimport styles from './features-list.module.scss';\nimport { LinkWithArrow } from '../LinkWithArrow/LinkWithArrow';\n\nexport function FeatureListItem({\n children,\n className,\n href,\n icon: Icon,\n iconColor,\n label,\n to,\n ...rest\n}) {\n const ContentElement = ((href || to) ? LinkWithArrow : 'span');\n const IconElement = ((href || to) ? 'a' : 'span');\n\n return (\n \n {Icon && (\n \n \n {children || label}\n \n \n );\n}\n\nexport function FeaturesList({\n className,\n id,\n icon,\n iconColor,\n items,\n ...rest\n}) {\n const defaultId = `featureListItem${Math.random()}`;\n\n return (\n \n {items?.map((featureListItem, featureListItemIndex) => {\n return (\n >;\n description: JSX.Element;\n};\n\nconst FeatureList: FeatureItem[] = [\n {\n title: 'Easy to Use',\n Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,\n description: (\n <>\n Docusaurus was designed from the ground up to be easily installed and\n used to get your website up and running quickly.\n \n ),\n },\n {\n title: 'Focus on What Matters',\n Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,\n description: (\n <>\n Docusaurus lets you focus on your docs, and we'll do the chores. Go\n ahead and move your docs into the docs directory.\n \n ),\n },\n {\n title: 'Powered by React',\n Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,\n description: (\n <>\n Extend or customize your website layout by reusing React. Docusaurus can\n be extended while reusing the same header and footer.\n \n ),\n },\n];\n\nfunction Feature({title, Svg, description}: FeatureItem) {\n return (\n \n
\n
\n
\n
{title} \n
{description}
\n
\n
\n \n
\n {FeatureList.map((props, idx) => (\n
\n
\n );\n}\n"
},
{
"path": "docs/src/components/HomepageFeatures/styles.module.css",
"content": ".features {\n display: flex;\n align-items: center;\n padding: 2rem 0;\n width: 100%;\n}\n\n.featureSvg {\n height: 200px;\n width: 200px;\n}\n"
},
{
"path": "docs/src/components/LinkWithArrow/LinkWithArrow.jsx",
"content": "import clsx from 'clsx';\nimport React from 'react';\nimport Link from '@docusaurus/Link';\nimport IconArrow from '@site/static/img/assets/icons/arrow-right.svg';\nimport styles from './link-with-arrow.module.scss';\n\nexport function LinkWithArrow({\n apart = false,\n children,\n className,\n href,\n to,\n ...rest\n}) {\n const LinkElement = (to ? Link : 'a');\n\n return (\n \n \n {children}\n \n \n
{title}
\n
{children}
\n
\n
{title}
\n
{children}
\n
\n
\n { emoji } { title }\n
\n { children }\n
\n {shouldRenderHeading && (\n \n {icon && (\n \n {icon}{' '}\n \n )}\n {title}\n
\n )}\n {children}\n \n );\n}\n"
},
{
"path": "docs/src/theme/MDXComponents.js",
"content": "import React from 'react';\n// Import the original mapper\nimport MDXComponents from '@theme-original/MDXComponents';\n/** Import built-in Docusaurus components at the global level\n * so we don't have to re-import them in every file\n */\n\nimport Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n// Import custom components, globally as well\nimport Request from '../components/Request';\nimport Response from '../components/Response';\nimport ApiCall from '../components/ApiCall';\nimport SubtleCallout from '../components/SubtleCallout';\nimport CustomDocCard from '../components/CustomDocCard';\nimport CustomDocCardsWrapper from '../components/CustomDocCardsWrapper';\n\nexport default {\n // Re-use the default mapping\n ...MDXComponents,\n\n /**\n * Components below are imported within the global scope,\n * meaning you don't have to insert the typical 'import SomeStuff from '/path/to/stuff' line\n * at the top of a Markdown file before being able to use these components\n * β see https://docusaurus.io/docs/next/markdown-features/react#mdx-component-scope\n */\n Request,\n Response,\n ApiCall,\n Tabs,\n TabItem,\n SubtleCallout,\n CustomDocCard,\n CustomDocCardsWrapper,\n};\n"
},
{
"path": "docs/static/.nojekyll",
"content": ""
},
{
"path": "docs/tsconfig.json",
"content": "{\n // This file is not used in compilation. It is here just for a nice editor experience.\n \"extends\": \"@docusaurus/tsconfig\",\n \"compilerOptions\": {\n \"baseUrl\": \".\"\n }\n}\n"
},
{
"path": "jest.config.js",
"content": "module.exports = {\n name: 'Unit test',\n testMatch: ['**/__tests__/?(*.)+(spec|test).js'],\n transform: {},\n coverageDirectory: \"./coverage/\",\n collectCoverage: true,\n};\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"strapi-plugin-config-sync\",\n \"version\": \"3.2.0\",\n \"description\": \"Migrate your config data across environments using the CLI or Strapi admin panel.\",\n \"strapi\": {\n \"displayName\": \"Config Sync\",\n \"name\": \"config-sync\",\n \"icon\": \"sync\",\n \"description\": \"Migrate your config data across environments using the CLI or Strapi admin panel.\",\n \"required\": false,\n \"kind\": \"plugin\"\n },\n \"bin\": {\n \"config-sync\": \"./bin/config-sync\"\n },\n \"exports\": {\n \"./strapi-admin\": {\n \"source\": \"./admin/src/index.js\",\n \"import\": \"./dist/admin/index.mjs\",\n \"require\": \"./dist/admin/index.js\",\n \"default\": \"./dist/admin/index.js\"\n },\n \"./strapi-server\": {\n \"source\": \"./server/index.js\",\n \"import\": \"./dist/server/index.mjs\",\n \"require\": \"./dist/server/index.js\",\n \"default\": \"./dist/server/index.js\"\n },\n \"./cli\": {\n \"source\": \"./server/cli.js\",\n \"import\": \"./dist/cli/index.mjs\",\n \"require\": \"./dist/cli/index.js\",\n \"default\": \"./dist/cli/index.js\"\n },\n \"./package.json\": \"./package.json\"\n },\n \"scripts\": {\n \"develop\": \"strapi-plugin watch:link\",\n \"watch\": \"strapi-plugin watch\",\n \"build\": \"strapi-plugin build && yalc push --publish\",\n \"eslint\": \"eslint --max-warnings=0 './**/*.{js,jsx}'\",\n \"eslint:fix\": \"eslint --fix './**/*.{js,jsx}'\",\n \"test:unit\": \"jest --verbose\",\n \"test:integration\": \"cd playground && node_modules/.bin/jest --verbose --forceExit --detectOpenHandles\",\n \"test:e2e\": \"cypress open\",\n \"playground:install\": \"yarn playground:yalc-add-link && cd playground && yarn install\",\n \"playground:yalc-add\": \"cd playground && yalc add strapi-plugin-config-sync\",\n \"playground:yalc-add-link\": \"cd playground && yalc add --link strapi-plugin-config-sync\",\n \"playground:build\": \"cd playground && yarn build\",\n \"playground:develop\": \"cd playground && yarn develop\",\n \"playground:start\": \"cd playground && yarn start\"\n },\n \"dependencies\": {\n \"adm-zip\": \"^0.5.16\",\n \"chalk\": \"^5.6.2\",\n \"cli-table\": \"^0.3.6\",\n \"commander\": \"^14.0.3\",\n \"file-saver\": \"^2.0.5\",\n \"git-diff\": \"^2.0.6\",\n \"immutable\": \"^4.0.0\",\n \"inquirer\": \"^13.3.0\",\n \"lodash\": \"^4.17.23\",\n \"react-diff-viewer-continued\": \"4.0.6\",\n \"react-intl\": \"^6\",\n \"react-query\": \"^3.39.3\",\n \"react-redux\": \"^9.2.0\",\n \"redux\": \"^5.0.1\",\n \"redux-immutable\": \"^4.0.0\",\n \"redux-thunk\": \"^3.1.0\"\n },\n \"author\": {\n \"name\": \"Boaz Poolman\",\n \"email\": \"boaz@pluginpal.io\",\n \"url\": \"https://github.com/boazpoolman\"\n },\n \"maintainers\": [\n {\n \"name\": \"Boaz Poolman\",\n \"email\": \"boaz@pluginpal.io\",\n \"url\": \"https://github.com/boazpoolman\"\n }\n ],\n \"files\": [\n \"dist\",\n \"bin\"\n ],\n \"peerDependencies\": {\n \"@strapi/admin\": \"^5.0.0\",\n \"@strapi/design-system\": \"^2.0.0\",\n \"@strapi/icons\": \"^2.0.0\",\n \"@strapi/strapi\": \"^5.0.0\",\n \"@strapi/typescript-utils\": \"^5.0.0\",\n \"@strapi/utils\": \"^5.0.0\",\n \"react\": \"^17.0.0 || ^18.0.0\",\n \"react-dom\": \"^17.0.0 || ^18.0.0\",\n \"react-router-dom\": \"^6.0.0\",\n \"styled-components\": \"^6.0.0\"\n },\n \"devDependencies\": {\n \"@strapi/admin\": \"^5.0.0\",\n \"@strapi/design-system\": \"^2.0.0\",\n \"@strapi/icons\": \"^2.0.0\",\n \"@strapi/sdk-plugin\": \"^6.0.0\",\n \"@strapi/strapi\": \"^5.0.0\",\n \"@strapi/typescript-utils\": \"^5.0.0\",\n \"@strapi/utils\": \"^5.0.0\",\n \"babel-eslint\": \"9.0.0\",\n \"cypress\": \"^15\",\n \"cypress-terminal-report\": \"^7\",\n \"eslint\": \"^7.32.0\",\n \"eslint-config-airbnb\": \"^18.2.1\",\n \"eslint-config-react-app\": \"^3.0.7\",\n \"eslint-import-resolver-webpack\": \"^0.11.0\",\n \"eslint-loader\": \"^4.0.2\",\n \"eslint-plugin-babel\": \"^5.3.0\",\n \"eslint-plugin-cypress\": \"^3.2.0\",\n \"eslint-plugin-flowtype\": \"2.50.1\",\n \"eslint-plugin-import\": \"^2.22.1\",\n \"eslint-plugin-jsx-a11y\": \"^6.4.1\",\n \"eslint-plugin-react\": \"^7.21.5\",\n \"eslint-plugin-react-hooks\": \"^2.3.0\",\n \"jest\": \"^29.7.0\",\n \"jest-cli\": \"^29.3.1\",\n \"jest-styled-components\": \"^7.0.2\",\n \"nodemon\": \"^3.1.7\",\n \"react\": \"^17.0.0\",\n \"styled-components\": \"^5.2.3\",\n \"yalc\": \"^1.0.0-pre.53\"\n },\n \"bugs\": {\n \"url\": \"https://github.com/pluginpal/strapi-plugin-config-sync/issues\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git://github.com/pluginpal/strapi-plugin-config-sync.git\"\n },\n \"homepage\": \"https://www.pluginpal.io/plugin/config-sync\",\n \"engines\": {\n \"node\": \">=20.0.0 <=24.x.x\",\n \"npm\": \">=6.0.0\"\n },\n \"license\": \"MIT\",\n \"publishConfig\": {\n \"registry\": \"https://registry.npmjs.org/\",\n \"access\": \"public\",\n \"provenance\": true\n }\n}\n"
},
{
"path": "packup.config.ts",
"content": "// eslint-disable-next-line import/no-extraneous-dependencies\nimport { defineConfig } from '@strapi/pack-up';\n\nexport default defineConfig({\n bundles: [\n {\n source: './admin/src/index.js',\n import: './dist/admin/index.mjs',\n require: './dist/admin/index.js',\n runtime: 'web',\n },\n {\n source: './server/index.js',\n import: './dist/server/index.mjs',\n require: './dist/server/index.js',\n runtime: 'node',\n },\n {\n source: './server/cli.js',\n import: './dist/cli/index.mjs',\n require: './dist/cli/index.js',\n runtime: 'node',\n },\n ],\n dist: './dist',\n exports: {},\n});\n"
},
{
"path": "playground/.editorconfig",
"content": "root = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[{package.json,*.yml}]\nindent_style = space\nindent_size = 2\n\n[*.md]\ntrim_trailing_whitespace = false\n"
},
{
"path": "playground/.eslintignore",
"content": ".cache\nbuild\n**/node_modules/**\n"
},
{
"path": "playground/.eslintrc",
"content": "{\n \"parser\": \"babel-eslint\",\n \"extends\": \"eslint:recommended\",\n \"env\": {\n \"commonjs\": true,\n \"es6\": true,\n \"node\": true,\n \"browser\": false\n },\n \"parserOptions\": {\n \"ecmaFeatures\": {\n \"experimentalObjectRestSpread\": true,\n \"jsx\": false\n },\n \"sourceType\": \"module\"\n },\n \"globals\": {\n \"strapi\": true\n },\n \"rules\": {\n \"indent\": [\"error\", 2, { \"SwitchCase\": 1 }],\n \"linebreak-style\": [\"error\", \"unix\"],\n \"no-console\": 0,\n \"quotes\": [\"error\", \"single\"],\n \"semi\": [\"error\", \"always\"]\n }\n}\n"
},
{
"path": "playground/.gitignore",
"content": "############################\n# OS X\n############################\n\n.DS_Store\n.AppleDouble\n.LSOverride\nIcon\n.Spotlight-V100\n.Trashes\n._*\n\n\n############################\n# Linux\n############################\n\n*~\n\n\n############################\n# Windows\n############################\n\nThumbs.db\nehthumbs.db\nDesktop.ini\n$RECYCLE.BIN/\n*.cab\n*.msi\n*.msm\n*.msp\n\n\n############################\n# Packages\n############################\n\n*.7z\n*.csv\n*.dat\n*.dmg\n*.gz\n*.iso\n*.jar\n*.rar\n*.tar\n*.zip\n*.com\n*.class\n*.dll\n*.exe\n*.o\n*.seed\n*.so\n*.swo\n*.swp\n*.swn\n*.swm\n*.out\n*.pid\n\n\n############################\n# Logs and databases\n############################\n\n.tmp\n*.log\n*.sql\n*.sqlite\n*.sqlite3\n\n\n############################\n# Misc.\n############################\n\n*#\nssl\n.idea\nnbproject\npublic/uploads/*\n!public/uploads/.gitkeep\n\n############################\n# Node.js\n############################\n\nlib-cov\nlcov.info\npids\nlogs\nresults\nnode_modules\n.node_history\nyarn.lock\n\n############################\n# Tests\n############################\n\ntestApp\ncoverage\n/config/sync\n\n############################\n# Strapi\n############################\n\nlicense.txt\nexports\n.strapi\ndist\nbuild\n.strapi-updater.json\n.strapi-cloud.json\n\n# yalc\n.yalc\nyalc.lock\n"
},
{
"path": "playground/README.md",
"content": "# π Getting started with Strapi\n\nStrapi comes with a full featured [Command Line Interface](https://docs.strapi.io/dev-docs/cli) (CLI) which lets you scaffold and manage your project in seconds.\n\n### `develop`\n\nStart your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-develop)\n\n```\nnpm run develop\n# or\nyarn develop\n```\n\n### `start`\n\nStart your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-start)\n\n```\nnpm run start\n# or\nyarn start\n```\n\n### `build`\n\nBuild your admin panel. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-build)\n\n```\nnpm run build\n# or\nyarn build\n```\n\n## βοΈ Deployment\n\nStrapi gives you many possible deployment options for your project including [Strapi Cloud](https://cloud.strapi.io). Browse the [deployment section of the documentation](https://docs.strapi.io/dev-docs/deployment) to find the best solution for your use case.\n\n## π Learn more\n\n- [Resource center](https://strapi.io/resource-center) - Strapi resource center.\n- [Strapi documentation](https://docs.strapi.io) - Official Strapi documentation.\n- [Strapi tutorials](https://strapi.io/tutorials) - List of tutorials made by the core team and the community.\n- [Strapi blog](https://strapi.io/blog) - Official Strapi blog containing articles made by the Strapi team and the community.\n- [Changelog](https://strapi.io/changelog) - Find out about the Strapi product updates, new features and general improvements.\n\nFeel free to check out the [Strapi GitHub repository](https://github.com/strapi/strapi). Your feedback and contributions are welcome!\n\n## β¨ Community\n\n- [Discord](https://discord.strapi.io) - Come chat with the Strapi community including the core team.\n- [Forum](https://forum.strapi.io/) - Place to discuss, ask questions and find answers, show your Strapi project and get feedback or just talk with other Community members.\n- [Awesome Strapi](https://github.com/strapi/awesome-strapi) - A curated list of awesome things related to Strapi.\n\n---\n\nπ€« Psst! [Strapi is hiring](https://strapi.io/careers). \n"
},
{
"path": "playground/__tests__/cli.test.js",
"content": "'use strict';\n\nconst util = require('util');\nconst exec = util.promisify(require('child_process').exec);\n\njest.setTimeout(20000);\n\ndescribe('Test the config-sync CLI', () => {\n afterAll(async () => {\n // Remove the generated files and the DB.\n await exec('rm -rf config/sync');\n await exec('rm -rf .tmp');\n });\n\n test('Export', async () => {\n const { stdout: exportOutput } = await exec('yarn cs export -y');\n expect(exportOutput).toContain('Finished export');\n const { stdout: diffOutput } = await exec('yarn cs diff');\n expect(diffOutput).toContain('No differences between DB and sync directory');\n });\n\n test('Import (delete)', async () => {\n // Remove a file to trigger a delete.\n await exec('mv config/sync/admin-role.strapi-editor.json .tmp');\n const { stdout: importOutput } = await exec('yarn cs import -y');\n expect(importOutput).toContain('Finished import');\n const { stdout: diffOutput } = await exec('yarn cs diff');\n expect(diffOutput).toContain('No differences between DB and sync directory');\n });\n test('Import (update)', async () => {\n // Update a core-store file.\n await exec('sed -i \\'s/\"description\":\"\",/\"description\":\"test\",/g\\' config/sync/core-store.plugin_content_manager_configuration_content_types##plugin##users-permissions.user.json');\n // Update a file that has relations.\n await exec('sed -i \\'s/{\"action\":\"plugin::users-permissions.auth.register\"},//g\\' config/sync/user-role.public.json');\n const { stdout: importOutput } = await exec('yarn cs import -y');\n expect(importOutput).toContain('Finished import');\n const { stdout: diffOutput } = await exec('yarn cs diff');\n expect(diffOutput).toContain('No differences between DB and sync directory');\n });\n test('Import (create)', async () => {\n // Add a file to trigger a creation.\n await exec('mv .tmp/admin-role.strapi-editor.json config/sync/');\n const { stdout: importOutput } = await exec('yarn cs import -y');\n expect(importOutput).toContain('Finished import');\n const { stdout: diffOutput } = await exec('yarn cs diff');\n expect(diffOutput).toContain('No differences between DB and sync directory');\n });\n\n test('Non-empty diff returns 1', async () => {\n await exec('rm -rf config/sync/admin-role.strapi-editor.json');\n // Work around Jest not supporting custom error matching.\n // https://github.com/facebook/jest/issues/8140\n let error;\n try {\n await exec('yarn cs diff');\n } catch (e) {\n error = e;\n }\n expect(error).toHaveProperty('code', 1);\n });\n\n test('Import build project', async () => {\n // First we make sure the dist folder is deleted.\n await exec('mv dist .tmp');\n\n await exec('yarn cs import -y');\n\n const { stdout: buildOutput } = await exec('ls dist');\n expect(buildOutput).toContain('config');\n expect(buildOutput).toContain('src');\n expect(buildOutput).toContain('tsconfig.tsbuildinfo');\n\n // We restore the dist folder.\n await exec('rm -rf dist');\n await exec('mv .tmp/dist ./dist');\n\n });\n test('Import project already built', async () => {\n\n\n // First we make sure the dist folder exists by doing an import.\n await exec('yarn cs import -y');\n\n const { stdout: lsDist } = await exec('ls dist');\n expect(lsDist).toContain('config');\n expect(lsDist).toContain('src');\n expect(lsDist).toContain('tsconfig.tsbuildinfo');\n\n // We remove on file from the dist folder\n await exec('mv dist/tsconfig.tsbuildinfo .tmp');\n\n // The new import should not rebuild the project.\n await exec('yarn cs import -y');\n\n const { stdout: buildOutput } = await exec('ls dist');\n expect(buildOutput).toContain('config');\n expect(buildOutput).toContain('src');\n expect(buildOutput).not.toContain('tsconfig.tsbuildinfo');\n\n // We restore the tsconfig.tsbuildinfo file.\n await exec('mv .tmp/tsconfig.tsbuildinfo dist/tsconfig.tsbuildinfo');\n\n });\n});\n"
},
{
"path": "playground/__tests__/helpers.js",
"content": "const fs = require('fs');\nconst { createStrapi, compileStrapi } = require('@strapi/strapi');\n\nlet instance;\n\nasync function setupStrapi() {\n if (!instance) {\n const appContext = await compileStrapi();\n await createStrapi(appContext).load();\n instance = strapi;\n\n await instance.server.mount();\n }\n return instance;\n}\n\nasync function cleanupStrapi() {\n const dbSettings = strapi.config.get('database.connection');\n\n // close server to release the db-file.\n await strapi.server.httpServer.close();\n\n // close the connection to the database before deletion.\n await strapi.db.connection.destroy();\n\n // delete test database after all tests have completed.\n if (dbSettings && dbSettings.connection && dbSettings.connection.filename) {\n const tmpDbFile = dbSettings.connection.filename;\n if (fs.existsSync(tmpDbFile)) {\n fs.unlinkSync(tmpDbFile);\n }\n }\n}\n\nmodule.exports = { setupStrapi, cleanupStrapi };\n"
},
{
"path": "playground/__tests__/import-on-boostrap.test.js",
"content": "const util = require('util');\nconst exec = util.promisify(require('child_process').exec);\n\nconst { setupStrapi, cleanupStrapi } = require('./helpers');\n\njest.setTimeout(20000);\n\nafterEach(async () => {\n // Disable importOnBootstrap\n await exec('sed -i \"s/importOnBootstrap: true/importOnBootstrap: false/g\" config/plugins.ts');\n\n await cleanupStrapi();\n await exec('rm -rf config/sync');\n});\n\ndescribe('Test the importOnBootstrap feature', () => {\n test('Without a database', async () => {\n // Do the initial export and remove the database.\n await exec('yarn cs export -y');\n await exec('rm -rf .tmp');\n\n // Manually change the plugins.ts to enable importOnBoostrap.\n await exec('sed -i \"s/importOnBootstrap: false/importOnBootstrap: true/g\" config/plugins.ts');\n\n // Start up Strapi to initiate the importOnBootstrap function.\n await setupStrapi();\n\n expect(strapi).toBeDefined();\n });\n\n test('With a database', async () => {\n // Delete any existing database and do an export.\n await exec('rm -rf .tmp');\n await exec('yarn cs export -y');\n\n // Manually change the plugins.ts to enable importOnBoostrap.\n await exec('sed -i \"s/importOnBootstrap: false/importOnBootstrap: true/g\" config/plugins.ts');\n\n // Remove a config file to make sure the importOnBoostrap\n // function actually attempts to import.\n await exec('rm -rf config/sync/admin-role.strapi-editor.json');\n\n // Start up Strapi to initiate the importOnBootstrap function.\n await setupStrapi();\n\n expect(strapi).toBeDefined();\n });\n});\n"
},
{
"path": "playground/config/admin.ts",
"content": "export default ({ env }) => ({\n auth: {\n secret: env('ADMIN_JWT_SECRET'),\n },\n apiToken: {\n salt: env('API_TOKEN_SALT'),\n },\n rateLimit: {\n enabled: false,\n },\n transfer: {\n token: {\n salt: env('TRANSFER_TOKEN_SALT'),\n },\n },\n flags: {\n nps: env.bool('FLAG_NPS', true),\n promoteEE: env.bool('FLAG_PROMOTE_EE', true),\n },\n watchIgnoreFiles: [\n '**/config/sync/**',\n '!**/.yalc/**/server/**',\n ],\n});\n"
},
{
"path": "playground/config/api.ts",
"content": "export default {\n rest: {\n defaultLimit: 25,\n maxLimit: 100,\n withCount: true,\n },\n};\n"
},
{
"path": "playground/config/database.ts",
"content": "import path from 'path';\n\nexport default ({ env }) => {\n\n return {\n connection: {\n client: 'sqlite',\n connection: {\n filename: path.join(__dirname, '..', '..', env('DATABASE_FILENAME', '.tmp/data.db')),\n },\n useNullAsDefault: true,\n },\n };\n\n};\n"
},
{
"path": "playground/config/middlewares.ts",
"content": "export default [\n 'strapi::logger',\n 'strapi::errors',\n 'strapi::security',\n 'strapi::cors',\n 'strapi::poweredBy',\n 'strapi::query',\n 'strapi::body',\n 'strapi::session',\n 'strapi::favicon',\n 'strapi::public',\n];\n"
},
{
"path": "playground/config/plugins.ts",
"content": "export default () => ({\n 'config-sync': {\n enabled: true,\n config: {\n importOnBootstrap: false,\n minify: true,\n },\n },\n});\n"
},
{
"path": "playground/config/server.ts",
"content": "export default ({ env }) => ({\n host: env('HOST', '0.0.0.0'),\n port: env.int('PORT', 1337),\n app: {\n keys: env.array('APP_KEYS'),\n },\n webhooks: {\n populateRelations: env.bool('WEBHOOKS_POPULATE_RELATIONS', false),\n },\n});\n"
},
{
"path": "playground/database/migrations/.gitkeep",
"content": ""
},
{
"path": "playground/jest.config.js",
"content": "module.exports = {\n name: 'Integration test',\n testMatch: ['**/__tests__/?(*.)+(spec|test).js'],\n transform: {},\n coverageDirectory: '../coverage/',\n collectCoverage: true,\n};\n"
},
{
"path": "playground/package.json",
"content": "{\n \"name\": \"strapi-5-beta\",\n \"private\": true,\n \"version\": \"0.1.0\",\n \"description\": \"A Strapi application\",\n \"scripts\": {\n \"develop\": \"strapi develop\",\n \"start\": \"strapi start\",\n \"build\": \"strapi build\",\n \"strapi\": \"strapi\",\n \"cs\": \"config-sync\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^24.0.7\",\n \"@types/react\": \"^19.1.8\",\n \"@types/react-dom\": \"^19.1.6\",\n \"jest\": \"^29.7.0\",\n \"jest-cli\": \"^29.7.0\",\n \"supertest\": \"^6.3.3\",\n \"typescript\": \"^5.8.3\",\n \"yalc\": \"^1.0.0-pre.53\"\n },\n \"dependencies\": {\n \"@strapi/plugin-cloud\": \"5.37.1\",\n \"@strapi/plugin-users-permissions\": \"5.37.1\",\n \"@strapi/strapi\": \"5.37.1\",\n \"better-sqlite3\": \"11.3.0\",\n \"react\": \"^18.0.0\",\n \"react-dom\": \"^18.0.0\",\n \"react-router-dom\": \"^6.0.0\",\n \"strapi-plugin-config-sync\": \"link:.yalc/strapi-plugin-config-sync\",\n \"styled-components\": \"^6.0.0\"\n },\n \"author\": {\n \"name\": \"A Strapi developer\"\n },\n \"strapi\": {\n \"uuid\": \"edadddbd-0f25-4da7-833b-d4cd7dcae2fc\"\n },\n \"engines\": {\n \"node\": \">=20.0.0 <=24.x.x\",\n \"npm\": \">=6.0.0\"\n },\n \"license\": \"MIT\"\n}\n"
},
{
"path": "playground/public/robots.txt",
"content": "# To prevent search engines from seeing the site altogether, uncomment the next two lines:\n# User-Agent: *\n# Disallow: /\n"
},
{
"path": "playground/public/uploads/.gitkeep",
"content": ""
},
{
"path": "playground/src/admin/app.example.tsx",
"content": "import type { StrapiApp } from '@strapi/strapi/admin';\n\nexport default {\n config: {\n locales: [\n // 'ar',\n // 'fr',\n // 'cs',\n // 'de',\n // 'dk',\n // 'es',\n // 'he',\n // 'id',\n // 'it',\n // 'ja',\n // 'ko',\n // 'ms',\n // 'nl',\n // 'no',\n // 'pl',\n // 'pt-BR',\n // 'pt',\n // 'ru',\n // 'sk',\n // 'sv',\n // 'th',\n // 'tr',\n // 'uk',\n // 'vi',\n // 'zh-Hans',\n // 'zh',\n ],\n },\n bootstrap(app: StrapiApp) {\n console.log(app);\n },\n};\n"
},
{
"path": "playground/src/admin/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"target\": \"ESNext\",\n \"module\": \"ESNext\",\n \"moduleResolution\": \"Bundler\",\n \"useDefineForClassFields\": true,\n \"lib\": [\"DOM\", \"DOM.Iterable\", \"ESNext\"],\n \"allowJs\": false,\n \"skipLibCheck\": true,\n \"esModuleInterop\": true,\n \"allowSyntheticDefaultImports\": true,\n \"strict\": true,\n \"forceConsistentCasingInFileNames\": true,\n \"resolveJsonModule\": true,\n \"noEmit\": true,\n \"jsx\": \"react-jsx\"\n },\n \"include\": [\"../plugins/**/admin/src/**/*\", \"./\"],\n \"exclude\": [\"node_modules/\", \"build/\", \"dist/\", \"**/*.test.ts\"]\n}\n"
},
{
"path": "playground/src/admin/webpack.config.example.ts",
"content": "import { mergeConfig, type UserConfig } from 'vite';\n\nexport default (config: UserConfig) => {\n // Important: always return the modified config\n return mergeConfig(config, {\n resolve: {\n alias: {\n '@': '/src',\n },\n },\n });\n};\n"
},
{
"path": "playground/src/api/.gitkeep",
"content": ""
},
{
"path": "playground/src/api/home/content-types/home/schema.json",
"content": "{\n \"kind\": \"singleType\",\n \"collectionName\": \"homes\",\n \"info\": {\n \"singularName\": \"home\",\n \"pluralName\": \"homes\",\n \"displayName\": \"Home\",\n \"description\": \"\"\n },\n \"options\": {\n \"draftAndPublish\": false\n },\n \"pluginOptions\": {},\n \"attributes\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"slug\": {\n \"type\": \"uid\",\n \"targetField\": \"title\"\n }\n }\n}\n"
},
{
"path": "playground/src/api/home/controllers/home.ts",
"content": "/**\n * home controller\n */\n\nimport { factories } from '@strapi/strapi';\n\nexport default factories.createCoreController('api::home.home');\n"
},
{
"path": "playground/src/api/home/routes/home.ts",
"content": "\n/**\n * home router\n */\n\nimport { factories } from '@strapi/strapi';\n\nexport default factories.createCoreRouter('api::home.home');\n"
},
{
"path": "playground/src/api/home/services/home.ts",
"content": "/**\n * home service\n */\n\nimport { factories } from '@strapi/strapi';\n\nexport default factories.createCoreService('api::home.home');\n"
},
{
"path": "playground/src/api/page/content-types/page/schema.json",
"content": "{\n \"kind\": \"collectionType\",\n \"collectionName\": \"pages\",\n \"info\": {\n \"singularName\": \"page\",\n \"pluralName\": \"pages\",\n \"displayName\": \"Page\"\n },\n \"options\": {\n \"draftAndPublish\": false\n },\n \"pluginOptions\": {},\n \"attributes\": {\n \"title\": {\n \"type\": \"string\",\n \"required\": true\n }\n }\n}\n"
},
{
"path": "playground/src/api/page/controllers/page.ts",
"content": "/**\n * page controller\n */\n\nimport { factories } from '@strapi/strapi';\n\nexport default factories.createCoreController('api::page.page');\n"
},
{
"path": "playground/src/api/page/routes/page.ts",
"content": "/**\n * page router\n */\n\nimport { factories } from '@strapi/strapi';\n\nexport default factories.createCoreRouter('api::page.page');\n"
},
{
"path": "playground/src/api/page/services/page.ts",
"content": "/**\n * page service\n */\n\nimport { factories } from '@strapi/strapi';\n\nmodule.exports = factories.createCoreService('api::page.page');\n"
},
{
"path": "playground/src/extensions/.gitkeep",
"content": ""
},
{
"path": "playground/src/index.ts",
"content": "// import type { Core } from '@strapi/strapi';\n\nexport default {\n /**\n * An asynchronous register function that runs before\n * your application is initialized.\n *\n * This gives you an opportunity to extend code.\n */\n register(/* { strapi }: { strapi: Core.Strapi } */) {},\n\n /**\n * An asynchronous bootstrap function that runs before\n * your application gets started.\n *\n * This gives you an opportunity to set up your data model,\n * run jobs, or perform some special logic.\n */\n bootstrap(/* { strapi }: { strapi: Core.Strapi } */) {},\n};\n"
},
{
"path": "playground/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"module\": \"CommonJS\",\n \"moduleResolution\": \"Node\",\n \"lib\": [\"ES2020\"],\n \"target\": \"ES2019\",\n \"strict\": false,\n \"skipLibCheck\": true,\n \"forceConsistentCasingInFileNames\": true,\n \"incremental\": true,\n \"esModuleInterop\": true,\n \"resolveJsonModule\": true,\n \"noEmitOnError\": true,\n \"noImplicitThis\": true,\n \"outDir\": \"dist\",\n \"rootDir\": \".\",\n },\n \"include\": [\n // Include root files\n \"./\",\n // Include all ts files\n \"./**/*.ts\",\n // Include all js files\n \"./**/*.js\",\n // Force the JSON files in the src folder to be included\n \"src/**/*.json\"\n ],\n\n \"exclude\": [\n \"node_modules/\",\n \"build/\",\n \"dist/\",\n \".cache/\",\n \".tmp/\",\n\n // Do not include admin files in the server compilation\n \"src/admin/\",\n // Do not include test files\n \"**/*.test.*\",\n // Do not include plugins in the server compilation\n \"src/plugins/**\"\n ]\n}\n"
},
{
"path": "playground/types/generated/components.d.ts",
"content": "/*\n * The app doesn't have any components yet.\n */\n"
},
{
"path": "playground/types/generated/contentTypes.d.ts",
"content": "import type { Schema, Struct } from '@strapi/strapi';\n\nexport interface AdminApiToken extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_api_tokens';\n info: {\n description: '';\n displayName: 'Api Token';\n name: 'Api Token';\n pluralName: 'api-tokens';\n singularName: 'api-token';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n accessKey: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n description: Schema.Attribute.String &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }> &\n Schema.Attribute.DefaultTo<''>;\n encryptedKey: Schema.Attribute.Text &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n expiresAt: Schema.Attribute.DateTime;\n lastUsedAt: Schema.Attribute.DateTime;\n lifespan: Schema.Attribute.BigInteger;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'admin::api-token'> &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n permissions: Schema.Attribute.Relation<\n 'oneToMany',\n 'admin::api-token-permission'\n >;\n publishedAt: Schema.Attribute.DateTime;\n type: Schema.Attribute.Enumeration<['read-only', 'full-access', 'custom']> &\n Schema.Attribute.Required &\n Schema.Attribute.DefaultTo<'read-only'>;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminApiTokenPermission extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_api_token_permissions';\n info: {\n description: '';\n displayName: 'API Token Permission';\n name: 'API Token Permission';\n pluralName: 'api-token-permissions';\n singularName: 'api-token-permission';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n action: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'admin::api-token-permission'\n > &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n token: Schema.Attribute.Relation<'manyToOne', 'admin::api-token'>;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminPermission extends Struct.CollectionTypeSchema {\n collectionName: 'admin_permissions';\n info: {\n description: '';\n displayName: 'Permission';\n name: 'Permission';\n pluralName: 'permissions';\n singularName: 'permission';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n action: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n actionParameters: Schema.Attribute.JSON & Schema.Attribute.DefaultTo<{}>;\n conditions: Schema.Attribute.JSON & Schema.Attribute.DefaultTo<[]>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'admin::permission'> &\n Schema.Attribute.Private;\n properties: Schema.Attribute.JSON & Schema.Attribute.DefaultTo<{}>;\n publishedAt: Schema.Attribute.DateTime;\n role: Schema.Attribute.Relation<'manyToOne', 'admin::role'>;\n subject: Schema.Attribute.String &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminRole extends Struct.CollectionTypeSchema {\n collectionName: 'admin_roles';\n info: {\n description: '';\n displayName: 'Role';\n name: 'Role';\n pluralName: 'roles';\n singularName: 'role';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n code: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n description: Schema.Attribute.String;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'admin::role'> &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n permissions: Schema.Attribute.Relation<'oneToMany', 'admin::permission'>;\n publishedAt: Schema.Attribute.DateTime;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n users: Schema.Attribute.Relation<'manyToMany', 'admin::user'>;\n };\n}\n\nexport interface AdminSession extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_sessions';\n info: {\n description: 'Session Manager storage';\n displayName: 'Session';\n name: 'Session';\n pluralName: 'sessions';\n singularName: 'session';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n i18n: {\n localized: false;\n };\n };\n attributes: {\n absoluteExpiresAt: Schema.Attribute.DateTime & Schema.Attribute.Private;\n childId: Schema.Attribute.String & Schema.Attribute.Private;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n deviceId: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Private;\n expiresAt: Schema.Attribute.DateTime &\n Schema.Attribute.Required &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'admin::session'> &\n Schema.Attribute.Private;\n origin: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n sessionId: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Private &\n Schema.Attribute.Unique;\n status: Schema.Attribute.String & Schema.Attribute.Private;\n type: Schema.Attribute.String & Schema.Attribute.Private;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n userId: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminTransferToken extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_transfer_tokens';\n info: {\n description: '';\n displayName: 'Transfer Token';\n name: 'Transfer Token';\n pluralName: 'transfer-tokens';\n singularName: 'transfer-token';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n accessKey: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n description: Schema.Attribute.String &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }> &\n Schema.Attribute.DefaultTo<''>;\n expiresAt: Schema.Attribute.DateTime;\n lastUsedAt: Schema.Attribute.DateTime;\n lifespan: Schema.Attribute.BigInteger;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'admin::transfer-token'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n permissions: Schema.Attribute.Relation<\n 'oneToMany',\n 'admin::transfer-token-permission'\n >;\n publishedAt: Schema.Attribute.DateTime;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminTransferTokenPermission\n extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_transfer_token_permissions';\n info: {\n description: '';\n displayName: 'Transfer Token Permission';\n name: 'Transfer Token Permission';\n pluralName: 'transfer-token-permissions';\n singularName: 'transfer-token-permission';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n action: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'admin::transfer-token-permission'\n > &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n token: Schema.Attribute.Relation<'manyToOne', 'admin::transfer-token'>;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface AdminUser extends Struct.CollectionTypeSchema {\n collectionName: 'admin_users';\n info: {\n description: '';\n displayName: 'User';\n name: 'User';\n pluralName: 'users';\n singularName: 'user';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n blocked: Schema.Attribute.Boolean &\n Schema.Attribute.Private &\n Schema.Attribute.DefaultTo;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n email: Schema.Attribute.Email &\n Schema.Attribute.Required &\n Schema.Attribute.Private &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 6;\n }>;\n firstname: Schema.Attribute.String &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n isActive: Schema.Attribute.Boolean &\n Schema.Attribute.Private &\n Schema.Attribute.DefaultTo;\n lastname: Schema.Attribute.String &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'admin::user'> &\n Schema.Attribute.Private;\n password: Schema.Attribute.Password &\n Schema.Attribute.Private &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 6;\n }>;\n preferedLanguage: Schema.Attribute.String;\n publishedAt: Schema.Attribute.DateTime;\n registrationToken: Schema.Attribute.String & Schema.Attribute.Private;\n resetPasswordToken: Schema.Attribute.String & Schema.Attribute.Private;\n roles: Schema.Attribute.Relation<'manyToMany', 'admin::role'> &\n Schema.Attribute.Private;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n username: Schema.Attribute.String;\n };\n}\n\nexport interface ApiHomeHome extends Struct.SingleTypeSchema {\n collectionName: 'homes';\n info: {\n description: '';\n displayName: 'Home';\n pluralName: 'homes';\n singularName: 'home';\n };\n options: {\n draftAndPublish: false;\n };\n attributes: {\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'api::home.home'> &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n slug: Schema.Attribute.UID<'title'>;\n title: Schema.Attribute.String;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface ApiPagePage extends Struct.CollectionTypeSchema {\n collectionName: 'pages';\n info: {\n displayName: 'Page';\n pluralName: 'pages';\n singularName: 'page';\n };\n options: {\n draftAndPublish: false;\n };\n attributes: {\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<'oneToMany', 'api::page.page'> &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n title: Schema.Attribute.String & Schema.Attribute.Required;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginContentReleasesRelease\n extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_releases';\n info: {\n displayName: 'Release';\n pluralName: 'releases';\n singularName: 'release';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n actions: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::content-releases.release-action'\n >;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::content-releases.release'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String & Schema.Attribute.Required;\n publishedAt: Schema.Attribute.DateTime;\n releasedAt: Schema.Attribute.DateTime;\n scheduledAt: Schema.Attribute.DateTime;\n status: Schema.Attribute.Enumeration<\n ['ready', 'blocked', 'failed', 'done', 'empty']\n > &\n Schema.Attribute.Required;\n timezone: Schema.Attribute.String;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginContentReleasesReleaseAction\n extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_release_actions';\n info: {\n displayName: 'Release Action';\n pluralName: 'release-actions';\n singularName: 'release-action';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n contentType: Schema.Attribute.String & Schema.Attribute.Required;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n entryDocumentId: Schema.Attribute.String;\n isEntryValid: Schema.Attribute.Boolean;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::content-releases.release-action'\n > &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n release: Schema.Attribute.Relation<\n 'manyToOne',\n 'plugin::content-releases.release'\n >;\n type: Schema.Attribute.Enumeration<['publish', 'unpublish']> &\n Schema.Attribute.Required;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginI18NLocale extends Struct.CollectionTypeSchema {\n collectionName: 'i18n_locale';\n info: {\n collectionName: 'locales';\n description: '';\n displayName: 'Locale';\n pluralName: 'locales';\n singularName: 'locale';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n code: Schema.Attribute.String & Schema.Attribute.Unique;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::i18n.locale'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.SetMinMax<\n {\n max: 50;\n min: 1;\n },\n number\n >;\n publishedAt: Schema.Attribute.DateTime;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginReviewWorkflowsWorkflow\n extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_workflows';\n info: {\n description: '';\n displayName: 'Workflow';\n name: 'Workflow';\n pluralName: 'workflows';\n singularName: 'workflow';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n contentTypes: Schema.Attribute.JSON &\n Schema.Attribute.Required &\n Schema.Attribute.DefaultTo<'[]'>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::review-workflows.workflow'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique;\n publishedAt: Schema.Attribute.DateTime;\n stageRequiredToPublish: Schema.Attribute.Relation<\n 'oneToOne',\n 'plugin::review-workflows.workflow-stage'\n >;\n stages: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::review-workflows.workflow-stage'\n >;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginReviewWorkflowsWorkflowStage\n extends Struct.CollectionTypeSchema {\n collectionName: 'strapi_workflows_stages';\n info: {\n description: '';\n displayName: 'Stages';\n name: 'Workflow Stage';\n pluralName: 'workflow-stages';\n singularName: 'workflow-stage';\n };\n options: {\n draftAndPublish: false;\n version: '1.1.0';\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n color: Schema.Attribute.String & Schema.Attribute.DefaultTo<'#4945FF'>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::review-workflows.workflow-stage'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String;\n permissions: Schema.Attribute.Relation<'manyToMany', 'admin::permission'>;\n publishedAt: Schema.Attribute.DateTime;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n workflow: Schema.Attribute.Relation<\n 'manyToOne',\n 'plugin::review-workflows.workflow'\n >;\n };\n}\n\nexport interface PluginUploadFile extends Struct.CollectionTypeSchema {\n collectionName: 'files';\n info: {\n description: '';\n displayName: 'File';\n pluralName: 'files';\n singularName: 'file';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n alternativeText: Schema.Attribute.Text;\n caption: Schema.Attribute.Text;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n ext: Schema.Attribute.String;\n focalPoint: Schema.Attribute.JSON;\n folder: Schema.Attribute.Relation<'manyToOne', 'plugin::upload.folder'> &\n Schema.Attribute.Private;\n folderPath: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Private &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n formats: Schema.Attribute.JSON;\n hash: Schema.Attribute.String & Schema.Attribute.Required;\n height: Schema.Attribute.Integer;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::upload.file'\n > &\n Schema.Attribute.Private;\n mime: Schema.Attribute.String & Schema.Attribute.Required;\n name: Schema.Attribute.String & Schema.Attribute.Required;\n previewUrl: Schema.Attribute.Text;\n provider: Schema.Attribute.String & Schema.Attribute.Required;\n provider_metadata: Schema.Attribute.JSON;\n publishedAt: Schema.Attribute.DateTime;\n related: Schema.Attribute.Relation<'morphToMany'>;\n size: Schema.Attribute.Decimal & Schema.Attribute.Required;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n url: Schema.Attribute.Text & Schema.Attribute.Required;\n width: Schema.Attribute.Integer;\n };\n}\n\nexport interface PluginUploadFolder extends Struct.CollectionTypeSchema {\n collectionName: 'upload_folders';\n info: {\n displayName: 'Folder';\n pluralName: 'folders';\n singularName: 'folder';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n children: Schema.Attribute.Relation<'oneToMany', 'plugin::upload.folder'>;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n files: Schema.Attribute.Relation<'oneToMany', 'plugin::upload.file'>;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::upload.folder'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n parent: Schema.Attribute.Relation<'manyToOne', 'plugin::upload.folder'>;\n path: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 1;\n }>;\n pathId: Schema.Attribute.Integer &\n Schema.Attribute.Required &\n Schema.Attribute.Unique;\n publishedAt: Schema.Attribute.DateTime;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginUsersPermissionsPermission\n extends Struct.CollectionTypeSchema {\n collectionName: 'up_permissions';\n info: {\n description: '';\n displayName: 'Permission';\n name: 'permission';\n pluralName: 'permissions';\n singularName: 'permission';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n action: Schema.Attribute.String & Schema.Attribute.Required;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::users-permissions.permission'\n > &\n Schema.Attribute.Private;\n publishedAt: Schema.Attribute.DateTime;\n role: Schema.Attribute.Relation<\n 'manyToOne',\n 'plugin::users-permissions.role'\n >;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n };\n}\n\nexport interface PluginUsersPermissionsRole\n extends Struct.CollectionTypeSchema {\n collectionName: 'up_roles';\n info: {\n description: '';\n displayName: 'Role';\n name: 'role';\n pluralName: 'roles';\n singularName: 'role';\n };\n options: {\n draftAndPublish: false;\n };\n pluginOptions: {\n 'content-manager': {\n visible: false;\n };\n 'content-type-builder': {\n visible: false;\n };\n };\n attributes: {\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n description: Schema.Attribute.String;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::users-permissions.role'\n > &\n Schema.Attribute.Private;\n name: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 3;\n }>;\n permissions: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::users-permissions.permission'\n >;\n publishedAt: Schema.Attribute.DateTime;\n type: Schema.Attribute.String & Schema.Attribute.Unique;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n users: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::users-permissions.user'\n >;\n };\n}\n\nexport interface PluginUsersPermissionsUser\n extends Struct.CollectionTypeSchema {\n collectionName: 'up_users';\n info: {\n description: '';\n displayName: 'User';\n name: 'user';\n pluralName: 'users';\n singularName: 'user';\n };\n options: {\n draftAndPublish: false;\n timestamps: true;\n };\n attributes: {\n blocked: Schema.Attribute.Boolean & Schema.Attribute.DefaultTo;\n confirmationToken: Schema.Attribute.String & Schema.Attribute.Private;\n confirmed: Schema.Attribute.Boolean & Schema.Attribute.DefaultTo;\n createdAt: Schema.Attribute.DateTime;\n createdBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n email: Schema.Attribute.Email &\n Schema.Attribute.Required &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 6;\n }>;\n locale: Schema.Attribute.String & Schema.Attribute.Private;\n localizations: Schema.Attribute.Relation<\n 'oneToMany',\n 'plugin::users-permissions.user'\n > &\n Schema.Attribute.Private;\n password: Schema.Attribute.Password &\n Schema.Attribute.Private &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 6;\n }>;\n provider: Schema.Attribute.String;\n publishedAt: Schema.Attribute.DateTime;\n resetPasswordToken: Schema.Attribute.String & Schema.Attribute.Private;\n role: Schema.Attribute.Relation<\n 'manyToOne',\n 'plugin::users-permissions.role'\n >;\n updatedAt: Schema.Attribute.DateTime;\n updatedBy: Schema.Attribute.Relation<'oneToOne', 'admin::user'> &\n Schema.Attribute.Private;\n username: Schema.Attribute.String &\n Schema.Attribute.Required &\n Schema.Attribute.Unique &\n Schema.Attribute.SetMinMaxLength<{\n minLength: 3;\n }>;\n };\n}\n\ndeclare module '@strapi/strapi' {\n export module Public {\n export interface ContentTypeSchemas {\n 'admin::api-token': AdminApiToken;\n 'admin::api-token-permission': AdminApiTokenPermission;\n 'admin::permission': AdminPermission;\n 'admin::role': AdminRole;\n 'admin::session': AdminSession;\n 'admin::transfer-token': AdminTransferToken;\n 'admin::transfer-token-permission': AdminTransferTokenPermission;\n 'admin::user': AdminUser;\n 'api::home.home': ApiHomeHome;\n 'api::page.page': ApiPagePage;\n 'plugin::content-releases.release': PluginContentReleasesRelease;\n 'plugin::content-releases.release-action': PluginContentReleasesReleaseAction;\n 'plugin::i18n.locale': PluginI18NLocale;\n 'plugin::review-workflows.workflow': PluginReviewWorkflowsWorkflow;\n 'plugin::review-workflows.workflow-stage': PluginReviewWorkflowsWorkflowStage;\n 'plugin::upload.file': PluginUploadFile;\n 'plugin::upload.folder': PluginUploadFolder;\n 'plugin::users-permissions.permission': PluginUsersPermissionsPermission;\n 'plugin::users-permissions.role': PluginUsersPermissionsRole;\n 'plugin::users-permissions.user': PluginUsersPermissionsUser;\n }\n }\n}\n"
},
{
"path": "server/bootstrap.js",
"content": "'use strict';\n\nimport fs from 'fs';\n\nimport ConfigType from './config/type';\nimport defaultTypes from './config/types';\nimport { logMessage } from './utils';\n\n/**\n * An asynchronous bootstrap function that runs before\n * your application gets started.\n *\n * This gives you an opportunity to set up your data model,\n * run jobs, or perform some special logic.\n *\n * See more details here: https://strapi.io/documentation/v3.x/concepts/configurations.html#bootstrap\n */\n\nexport default async () => {\n // Register config types.\n const registerTypes = () => {\n const types = {};\n\n // The default types provided by the plugin.\n defaultTypes(strapi).map((type) => {\n if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {\n types[type.configName] = new ConfigType(type);\n }\n });\n\n // The types provided by other plugins.\n strapi.plugin('config-sync').pluginTypes.map((type) => {\n if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {\n types[type.configName] = new ConfigType(type);\n }\n });\n\n // The custom types provided by the user.\n strapi.config.get('plugin::config-sync.customTypes').map((type) => {\n if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {\n types[type.configName] = new ConfigType(type);\n }\n });\n\n return types;\n };\n strapi.plugin('config-sync').types = registerTypes();\n\n // Import on bootstrap.\n if (strapi.config.get('plugin::config-sync.importOnBootstrap')) {\n if (strapi.server.app.env === 'development') {\n strapi.log.warn(logMessage(`You can't use the 'importOnBootstrap' setting in the development env.`));\n } else if (process.env.CONFIG_SYNC_CLI === 'true') {\n strapi.log.warn(logMessage(`The 'importOnBootstrap' setting was ignored because Strapi was started from the config-sync CLI itself.`));\n } else if (fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n await strapi.plugin('config-sync').service('main').importAllConfig();\n }\n }\n\n // Register permission actions.\n const actions = [\n {\n section: 'plugins',\n displayName: 'Access the plugin settings',\n uid: 'settings.read',\n pluginName: 'config-sync',\n },\n {\n section: 'plugins',\n displayName: 'Menu link to plugin settings',\n uid: 'menu-link',\n pluginName: 'config-sync',\n },\n ];\n await strapi.admin.services.permission.actionProvider.registerMany(actions);\n};\n"
},
{
"path": "server/cli.js",
"content": "#!/usr/bin/env node\n\nimport fs from 'fs';\nimport { Command } from 'commander';\nimport Table from 'cli-table';\nimport chalk from 'chalk';\nimport inquirer from 'inquirer';\nimport isEmpty from 'lodash/isEmpty';\nimport { createStrapi, compileStrapi } from '@strapi/strapi';\nimport gitDiff from 'git-diff';\nimport tsUtils from '@strapi/typescript-utils';\n\nimport warnings from './warnings';\nimport packageJSON from '../package.json';\n\nconst program = new Command();\n\nconst getStrapiApp = async () => {\n process.env.CONFIG_SYNC_CLI = 'true';\n\n const appDir = process.cwd();\n const isTSProject = await tsUtils.isUsingTypeScript(appDir);\n const outDir = await tsUtils.resolveOutDir(appDir);\n const alreadyCompiled = await fs.existsSync(outDir);\n\n let appContext;\n if (!isTSProject || !alreadyCompiled) {\n appContext = await compileStrapi();\n } else {\n const distDir = isTSProject ? outDir : appDir;\n appContext = { appDir, distDir };\n }\n\n const app = await createStrapi(appContext).load();\n return app;\n};\n\nconst initTable = (head) => {\n return new Table({\n head: [chalk.green('Name'), chalk.green(head || 'State')],\n colWidths: [65, 20],\n chars: { top: 'β',\n 'top-mid': 'β€',\n 'top-left': 'β',\n 'top-right': 'β',\n bottom: 'β',\n 'bottom-mid': 'β§',\n 'bottom-left': 'β',\n 'bottom-right': 'β',\n left: 'β',\n 'left-mid': 'β',\n mid: 'β',\n 'mid-mid': 'βΌ',\n right: 'β',\n 'right-mid': 'β’',\n middle: 'β',\n },\n });\n};\n\nconst getConfigState = (diff, configName, syncType) => {\n if (\n diff.fileConfig[configName]\n && diff.databaseConfig[configName]\n ) {\n return chalk.yellow(syncType ? 'Update' : 'Different');\n } else if (\n diff.fileConfig[configName]\n && !diff.databaseConfig[configName]\n ) {\n if (syncType === 'import') {\n return chalk.green('Create');\n } else if (syncType === 'export') {\n return chalk.red('Delete');\n } else {\n return chalk.red('Only in sync dir');\n }\n } else if (\n !diff.fileConfig[configName]\n && diff.databaseConfig[configName]\n ) {\n if (syncType === 'import') {\n return chalk.red('Delete');\n } else if (syncType === 'export') {\n return chalk.green('Create');\n } else {\n return chalk.green('Only in DB');\n }\n }\n};\n\nconst handleAction = async (syncType, skipConfirm, configType, partials, force) => {\n const app = await getStrapiApp();\n const hasSyncDir = fs.existsSync(app.config.get('plugin::config-sync.syncDir'));\n\n // No import with empty sync dir.\n if (!hasSyncDir && syncType === 'import') {\n console.log(`${chalk.yellow.bold('[warning]')} You can't import an empty sync directory. Please export before continuing.`);\n process.exit(0);\n }\n\n const diff = await app.plugin('config-sync').service('main').getFormattedDiff();\n\n // No changes.\n if (isEmpty(diff.diff)) {\n console.log(`${chalk.cyan.bold('[notice]')} There are no changes to ${syncType}.`);\n process.exit(0);\n }\n\n // Init table.\n const table = initTable('Action');\n const configNames = partials && partials.split(',');\n const partialDiff = {};\n\n // Fill partialDiff with arguments.\n if (configNames) {\n configNames.map((name) => {\n if (diff.diff[name]) partialDiff[name] = diff.diff[name];\n });\n }\n if (configType) {\n Object.keys(diff.diff).map((name) => {\n if (configType === name.split('.')[0]) {\n partialDiff[name] = diff.diff[name];\n }\n });\n }\n\n // No changes for partial diff.\n if ((partials || configType) && isEmpty(partialDiff)) {\n console.log(`${chalk.cyan.bold('[notice]')} There are no changes for the specified config.`);\n process.exit(0);\n }\n\n const finalDiff = (partials || configType) && partialDiff ? partialDiff : diff.diff;\n\n // Add diff to table.\n Object.keys(finalDiff).map((configName) => {\n table.push([configName, getConfigState(diff, configName, syncType)]);\n });\n\n // Print table.\n if (hasSyncDir) {\n console.log(table.toString(), '\\n');\n }\n\n // Prompt to confirm.\n let answer = {};\n if (!skipConfirm) {\n answer = await inquirer.prompt([{\n type: 'confirm',\n name: 'confirm',\n message: `Are you sure you want to ${syncType} the config changes?`,\n }]);\n console.log('');\n }\n\n // Preform the action.\n if (skipConfirm || answer.confirm) {\n if (syncType === 'import') {\n const onSuccess = (name) => console.log(`${chalk.cyan.bold('[notice]')} Imported ${name}`);\n try {\n await Promise.all(Object.keys(finalDiff).map(async (name) => {\n let warning;\n if (\n getConfigState(diff, name, syncType) === chalk.red('Delete')\n && warnings.delete[name]\n ) warning = warnings.delete[name];\n\n await app.plugin('config-sync').service('main').importSingleConfig(name, onSuccess, force);\n if (warning) console.log(`${chalk.yellow.bold('[warning]')} ${warning}`);\n }));\n console.log(`${chalk.green.bold('[success]')} Finished import`);\n } catch (e) {\n console.log(`${chalk.red.bold('[error]')} ${e}`);\n }\n }\n if (syncType === 'export') {\n const onSuccess = (name) => console.log(`${chalk.cyan.bold('[notice]')} Exported ${name}`);\n\n try {\n await Promise.all(Object.keys(finalDiff).map(async (name) => {\n await app.plugin('config-sync').service('main').exportSingleConfig(name, onSuccess);\n }));\n console.log(`${chalk.green.bold('[success]')} Finished export`);\n } catch (e) {\n console.log(`${chalk.red.bold('[error]')} ${e}`);\n }\n }\n }\n\n process.exit(0);\n};\n\n// Initial program setup\nprogram.storeOptionsAsProperties(false).allowUnknownOption(true);\n\nprogram.helpOption('-h, --help', 'Display help for command');\nprogram.addHelpCommand('help [command]', 'Display help for command');\n\n// `$ config-sync version` (--version synonym)\nprogram.version(packageJSON.version, '-v, --version', 'Output the version number');\nprogram\n .command('version')\n .description('Output your version of the config-sync plugin')\n .action(() => {\n process.stdout.write(`${packageJSON.version}\\n`);\n process.exit(0);\n });\n\n// `$ config-sync import`\nprogram\n .command('import')\n .alias('i')\n .option('-t, --type ', 'The type of config')\n .option('-p, --partial ', 'A comma separated string of configs')\n .option('-y, --yes', 'Skip the confirm prompt')\n .option('-f, --force', 'Ignore the soft setting')\n .description('Import the config')\n .action(async ({ yes, type, partial, force }) => {\n return handleAction('import', yes, type, partial, force);\n });\n\n// `$ config-sync export`\nprogram\n .command('export')\n .alias('e')\n .option('-t, --type ', 'The type of config')\n .option('-p, --partial ', 'A comma separated string of configs')\n .option('-y, --yes', 'Skip the confirm prompt')\n .description('Export the config')\n .action(async ({ yes, type, partial }) => {\n return handleAction('export', yes, type, partial);\n });\n\n// `$ config-sync diff`\nprogram\n .command('diff')\n .alias('d')\n .description('The config diff')\n .action(async (options, { args }) => {\n const single = args[0];\n const app = await getStrapiApp();\n const diff = await app.plugin('config-sync').service('main').getFormattedDiff();\n\n // No changes.\n if (isEmpty(diff.diff)) {\n console.log(`${chalk.cyan.bold('[notice]')} No differences between DB and sync directory.`);\n process.exit(0);\n }\n\n // Single config diff.\n if (single) {\n // No changes.\n if (!diff.fileConfig[single] && !diff.databaseConfig[single]) {\n console.log(`${chalk.cyan.bold('[notice]')} No differences between DB and sync directory for ${single}.`);\n process.exit(0);\n }\n\n // Git diff.\n console.log(gitDiff(\n JSON.stringify(diff.fileConfig[single], null, 2),\n JSON.stringify(diff.databaseConfig[single], null, 2),\n { color: true },\n ));\n\n process.exit(1);\n }\n\n // Init table.\n const table = initTable();\n\n // Add diff to table.\n Object.keys(diff.diff).map((configName) => {\n table.push([configName, getConfigState(diff, configName)]);\n });\n\n // Print table.\n console.log(table.toString());\n\n process.exit(1);\n });\n\nprogram.parseAsync(process.argv);\n"
},
{
"path": "server/config/type.js",
"content": "import isEmpty from 'lodash/isEmpty';\nimport { logMessage, sanitizeConfig, dynamicSort, noLimit, getCombinedUid, getCombinedUidWhereFilter, getUidParamsFromName } from '../utils';\nimport { difference, same } from '../utils/getArrayDiff';\nimport queryFallBack from '../utils/queryFallBack';\n\nconst ConfigType = class ConfigType {\n constructor({ queryString, configName, uid, jsonFields, relations, components }) {\n if (!configName) {\n strapi.log.error(logMessage('A config type was registered without a config name.'));\n process.exit(0);\n }\n if (!queryString) {\n strapi.log.error(logMessage(`No query string found for the '${configName}' config type.`));\n process.exit(0);\n }\n // uid could be a single key or an array for a combined uid. So the type of uid is either string or string[]\n if (typeof uid === \"string\") {\n this.uidKeys = [uid];\n } else if (Array.isArray(uid)) {\n this.uidKeys = uid.sort();\n } else {\n strapi.log.error(logMessage(`Wrong uid config for the '${configName}' config type.`));\n process.exit(0);\n }\n this.queryString = queryString;\n this.configPrefix = configName;\n this.jsonFields = jsonFields || [];\n this.relations = relations || [];\n this.components = components || null;\n }\n\n /**\n * Import a single role-permissions config file into the db.\n *\n * @param {string} configName - The name of the config file.\n * @param {string} configContent - The JSON content of the config file.\n * @param {boolean} force - Ignore the soft setting.\n * @returns {void}\n */\n importSingle = async (configName, configContent, force) => {\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${this.configPrefix}.${configName}`.startsWith(option)));\n if (shouldExclude) return;\n\n const softImport = strapi.config.get('plugin::config-sync.soft');\n const queryAPI = strapi.query(this.queryString);\n const uidParams = getUidParamsFromName(this.uidKeys, configName);\n const combinedUidWhereFilter = getCombinedUidWhereFilter(this.uidKeys, uidParams);\n let existingConfig = await queryAPI\n .findOne({\n where: combinedUidWhereFilter,\n populate: this.relations.map(({ relationName }) => relationName),\n });\n\n // Config exists in DB but no configfile content --> delete config from DB\n if (existingConfig && configContent === null) {\n // Don't preform action when soft setting is true.\n if (softImport && !force) return false;\n\n // Exit when trying to delete the super-admin role.\n if (this.configPrefix === 'admin-role' && configName === 'strapi-super-admin') {\n return false;\n }\n\n await Promise.all(this.relations.map(async ({ queryString, parentName }) => {\n const relations = await noLimit(strapi.query(queryString), {\n where: {\n [parentName]: existingConfig.id,\n },\n });\n\n await Promise.all(relations.map(async (relation) => {\n await queryFallBack.delete(queryString, { where: {\n id: relation.id,\n }});\n }));\n }));\n\n await queryFallBack.delete(this.queryString, { where: {\n id: existingConfig.id,\n }});\n\n return;\n }\n\n // Config does not exist in DB --> create config in DB\n if (!existingConfig) {\n // Format JSON fields.\n const query = { ...configContent };\n this.jsonFields.map((field) => query[field] = JSON.stringify(configContent[field]));\n\n // Create entity.\n this.relations.map(({ relationName }) => delete query[relationName]);\n const newEntity = await queryFallBack.create(this.queryString, {\n data: query,\n });\n\n // Create relation entities.\n await Promise.all(this.relations.map(async ({ queryString, relationName, parentName }) => {\n await Promise.all(configContent[relationName].map(async (relationEntity) => {\n const relationQuery = { ...relationEntity, [parentName]: newEntity };\n await queryFallBack.create(queryString, {\n data: relationQuery,\n });\n }));\n }));\n } else { // Config does exist in DB --> update config in DB\n // Don't preform action when soft setting is true.\n if (softImport && !force) return false;\n\n // Format JSON fields.\n configContent = sanitizeConfig({\n config: configContent,\n configName,\n });\n const query = { ...configContent };\n this.jsonFields.map((field) => query[field] = JSON.stringify(configContent[field]));\n\n // Update entity.\n this.relations.map(({ relationName }) => delete query[relationName]);\n const entity = await queryFallBack.update(this.queryString, { where: combinedUidWhereFilter, data: query });\n\n // Delete/create relations.\n await Promise.all(this.relations.map(async ({ queryString, relationName, parentName, relationSortFields }) => {\n const relationQueryApi = strapi.query(queryString);\n existingConfig = sanitizeConfig({ config: existingConfig, configName, relation: relationName, relationSortFields });\n configContent = sanitizeConfig({ config: configContent, configName, relation: relationName, relationSortFields });\n\n const configToAdd = difference(configContent[relationName], existingConfig[relationName], relationSortFields);\n const configToDelete = difference(existingConfig[relationName], configContent[relationName], relationSortFields);\n const configToUpdate = same(configContent[relationName], existingConfig[relationName], relationSortFields);\n\n await Promise.all(configToDelete.map(async (config) => {\n const whereClause = {};\n relationSortFields.map((sortField) => {\n whereClause[sortField] = config[sortField];\n });\n await relationQueryApi.delete({\n where: {\n ...whereClause,\n [parentName]: entity.id,\n },\n });\n }));\n\n await Promise.all(configToAdd.map(async (config) => {\n await queryFallBack.create(queryString, {\n data: { ...config, [parentName]: entity.id },\n });\n }));\n\n await Promise.all(configToUpdate.map(async (config, index) => {\n const whereClause = {};\n relationSortFields.map((sortField) => {\n whereClause[sortField] = config[sortField];\n });\n\n await relationQueryApi.update({\n where: {\n ...whereClause,\n [parentName]: entity.id,\n },\n data: { ...config, [parentName]: entity.id },\n });\n }));\n }));\n }\n }\n\n /**\n * Export a single core-store config to a file.\n *\n * @param {string} configName - The name of the config file.\n * @returns {void}\n */\n exportSingle = async (configName) => {\n const formattedDiff = await strapi.plugin('config-sync').service('main').getFormattedDiff(this.configPrefix);\n\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));\n if (shouldExclude) return;\n\n const currentConfig = formattedDiff.databaseConfig[configName];\n\n if (\n !currentConfig\n && formattedDiff.fileConfig[configName]\n ) {\n await strapi.plugin('config-sync').service('main').deleteConfigFile(configName);\n } else {\n const combinedUid = getCombinedUid(this.uidKeys, currentConfig);\n await strapi.plugin('config-sync').service('main').writeConfigFile(this.configPrefix, combinedUid, currentConfig);\n }\n }\n\n\n /**\n * Zip config files\n *\n * @param {string} configName - The name of the zip archive.\n * @returns {void}\n */\n zipConfig = async () => {\n return strapi.plugin('config-sync').service('main').zipConfigFiles();\n }\n\n /**\n * Get all role-permissions config from the db.\n *\n * @returns {object} Object with key value pairs of configs.\n */\n getAllFromDatabase = async () => {\n const AllConfig = await noLimit(strapi.query(this.queryString), {\n populate: this.components,\n });\n const configs = {};\n\n await Promise.all(Object.entries(AllConfig).map(async ([configName, config]) => {\n const combinedUid = getCombinedUid(this.uidKeys, config);\n const combinedUidWhereFilter = getCombinedUidWhereFilter(this.uidKeys, config);\n\n if (!combinedUid) {\n strapi.log.warn(logMessage(`Missing data for entity with id ${config.id} of type ${this.configPrefix}`));\n return;\n }\n\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${this.configPrefix}.${combinedUid}`.startsWith(option)));\n if (shouldExclude) return;\n\n const formattedConfig = { ...sanitizeConfig({ config, configName }) };\n await Promise.all(this.relations.map(async ({ queryString, relationName, relationSortFields, parentName }) => {\n const relations = await noLimit(strapi.query(queryString), {\n where: { [parentName]: combinedUidWhereFilter },\n });\n\n relations.map((relation) => sanitizeConfig({ config: relation, configName: relationName }));\n relationSortFields.map((sortField) => {\n relations.sort(dynamicSort(sortField));\n });\n formattedConfig[relationName] = relations;\n }));\n\n this.jsonFields.map((field) => formattedConfig[field] = JSON.parse(config[field]));\n configs[`${this.configPrefix}.${combinedUid}`] = formattedConfig;\n }));\n\n\n return configs;\n }\n\n /**\n * Import all core-store config files into the db.\n *\n * @returns {void}\n */\n importAll = async () => {\n // The main.importAllConfig service will loop the core-store.importSingle service.\n await strapi.plugin('config-sync').service('main').importAllConfig(this.configPrefix);\n }\n\n /**\n * Export all core-store config to files.\n *\n * @returns {void}\n */\n exportAll = async () => {\n // The main.importAllConfig service will loop the core-store.importSingle service.\n await strapi.plugin('config-sync').service('main').exportAllConfig(this.configPrefix);\n }\n};\n\nexport default ConfigType;\n"
},
{
"path": "server/config/types.js",
"content": "'use strict';\n\nconst types = (strapi) => {\n // Initiate Strapi 'core-store' and 'admin-role' types.\n const typesArray = [\n {\n configName: 'core-store',\n queryString: 'strapi::core-store',\n uid: 'key',\n jsonFields: ['value'],\n },\n {\n configName: 'admin-role',\n queryString: 'admin::role',\n uid: 'code',\n relations: [{\n queryString: 'admin::permission',\n relationName: 'permissions',\n parentName: 'role',\n relationSortFields: ['action', 'subject'],\n }],\n },\n ];\n\n // Register plugin users-permissions 'role' type.\n if (strapi.plugin('users-permissions')) {\n typesArray.push({\n configName: 'user-role',\n queryString: 'plugin::users-permissions.role',\n uid: 'type',\n relations: [{\n queryString: 'plugin::users-permissions.permission',\n relationName: 'permissions',\n parentName: 'role',\n relationSortFields: ['action'],\n }],\n });\n }\n\n // Register plugin i18n 'locale' type.\n if (strapi.plugin('i18n')) {\n typesArray.push({\n configName: 'i18n-locale',\n queryString: 'plugin::i18n.locale',\n uid: 'code',\n });\n }\n\n return typesArray;\n};\n\nexport default types;\n"
},
{
"path": "server/config.js",
"content": "'use strict';\n\nexport default {\n default: {\n syncDir: \"config/sync/\",\n minify: false,\n soft: false,\n importOnBootstrap: false,\n customTypes: [],\n excludedTypes: [],\n excludedConfig: [\n \"core-store.plugin_users-permissions_grant\",\n \"core-store.plugin_upload_metrics\",\n \"core-store.plugin_upload_api-folder\",\n \"core-store.strapi_content_types_schema\",\n \"core-store.ee_information\",\n ],\n },\n validator() {},\n};\n"
},
{
"path": "server/controllers/config.js",
"content": "'use strict';\n\nimport fs from 'fs';\nimport isEmpty from 'lodash/isEmpty';\n\n/**\n * Main controllers for config import/export.\n */\n\nexport default {\n /**\n * Export all config, from db to filesystem.\n *\n * @param {object} ctx - Request context object.\n * @returns {void}\n */\n exportAll: async (ctx) => {\n if (isEmpty(ctx.request.body)) {\n await strapi.plugin('config-sync').service('main').exportAllConfig();\n } else {\n await Promise.all(ctx.request.body.map(async (configName) => {\n await strapi.plugin('config-sync').service('main').exportSingleConfig(configName);\n }));\n }\n\n\n ctx.send({\n message: `Config was successfully exported to ${strapi.config.get('plugin::config-sync.syncDir')}.`,\n });\n },\n\n /**\n * Import all config, from filesystem to db.\n *\n * @param {object} ctx - Request context object.\n * @returns {void}\n */\n importAll: async (ctx) => {\n // Check for existance of the config file sync dir.\n if (!fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n ctx.send({\n message: 'No config files were found.',\n });\n\n return;\n }\n\n if (!ctx.request.body.config) {\n ctx.send({\n message: 'No config was specified for the import endpoint.',\n });\n\n return;\n }\n\n await Promise.all(ctx.request.body.config.map(async (configName) => {\n await strapi.plugin('config-sync').service('main').importSingleConfig(configName, null, ctx.request.body.force);\n }));\n\n ctx.send({\n message: 'Config was successfully imported.',\n });\n },\n\n /**\n * Get config diff between filesystem & db.\n *\n * @param {object} ctx - Request context object.\n * @returns {object} formattedDiff - The formatted diff object.\n * @returns {object} formattedDiff.fileConfig - The config as found in the filesystem.\n * @returns {object} formattedDiff.databaseConfig - The config as found in the database.\n * @returns {object} formattedDiff.diff - The diff between the file config and databse config.\n */\n getDiff: async (ctx) => {\n // Check for existance of the config file sync dir.\n if (!fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n ctx.send({\n message: 'No config files were found.',\n });\n\n return;\n }\n\n return strapi.plugin('config-sync').service('main').getFormattedDiff();\n },\n\n zipConfig: async (ctx) => {\n // Check for existance of the config file sync dir.\n if (!fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n ctx.send({\n message: 'No config files were found.',\n });\n\n return;\n }\n\n return strapi.plugin('config-sync').service('main').zipConfigFiles();\n },\n\n /**\n * Get the current Strapi env.\n * @returns {string} The current Strapi environment.\n */\n getAppEnv: async () => {\n return {\n env: strapi.server.app.env,\n config: strapi.config.get('plugin::config-sync'),\n };\n },\n};\n"
},
{
"path": "server/controllers/index.js",
"content": "'use strict';\n\nimport config from './config';\n\nexport default {\n config: config,\n};\n"
},
{
"path": "server/index.js",
"content": "'use strict';\n\nimport register from './register';\nimport bootstrap from './bootstrap';\nimport services from './services';\nimport routes from './routes';\nimport config from './config';\nimport controllers from './controllers';\n\nexport default {\n register,\n bootstrap,\n routes,\n config,\n controllers,\n services,\n};\n"
},
{
"path": "server/register.js",
"content": "'use strict';\n\nexport default async ({ strapi }) => {\n // Instantiate the pluginTypes array.\n if (!strapi.plugin('config-sync').pluginTypes) {\n strapi.plugin('config-sync').pluginTypes = [];\n }\n};\n"
},
{
"path": "server/routes/admin.js",
"content": "'use strict';\n\nexport default {\n type: 'admin',\n routes: [\n {\n method: \"POST\",\n path: \"/export\",\n handler: \"config.exportAll\",\n config: {\n policies: [],\n },\n },\n {\n method: \"POST\",\n path: \"/import\",\n handler: \"config.importAll\",\n config: {\n policies: [],\n },\n },\n {\n method: \"GET\",\n path: \"/diff\",\n handler: \"config.getDiff\",\n config: {\n policies: [],\n },\n },\n {\n method: \"GET\",\n path: \"/zip\",\n handler: \"config.zipConfig\",\n config: {\n policies: [],\n },\n },\n {\n method: \"GET\",\n path: \"/app-env\",\n handler: \"config.getAppEnv\",\n config: {\n policies: [],\n },\n },\n ],\n};\n"
},
{
"path": "server/routes/index.js",
"content": "'use strict';\n\nimport adminRoutes from './admin';\n\nexport default {\n admin: adminRoutes,\n};\n"
},
{
"path": "server/services/index.js",
"content": "'use strict';\n\nimport main from './main';\n\nexport default {\n main,\n};\n"
},
{
"path": "server/services/main.js",
"content": "'use strict';\n\nimport isEmpty from 'lodash/isEmpty';\nimport fs from 'fs';\nimport util from 'util';\nimport AdmZip from 'adm-zip';\n\nimport difference from '../utils/getObjectDiff';\nimport { logMessage } from '../utils';\n\n/**\n * Main services for config import/export.\n */\n\nexport default () => ({\n /**\n * Write a single config file.\n *\n * @param {string} configType - The type of the config.\n * @param {string} configName - The name of the config file.\n * @param {string} fileContents - The JSON content of the config file.\n * @returns {void}\n */\n writeConfigFile: async (configType, configName, fileContents) => {\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${configType}.${configName}`.startsWith(option)));\n if (shouldExclude) return;\n\n // Replace reserved characters in filenames.\n configName = configName.replace(/:/g, \"#\").replace(/\\//g, \"$\");\n\n // Check if the JSON content should be minified.\n const json = !strapi.config.get('plugin::config-sync').minify\n ? JSON.stringify(fileContents, null, 2)\n : JSON.stringify(fileContents);\n\n if (!fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n fs.mkdirSync(strapi.config.get('plugin::config-sync.syncDir'), { recursive: true });\n }\n\n const writeFile = util.promisify(fs.writeFile);\n await writeFile(`${strapi.config.get('plugin::config-sync.syncDir')}${configType}.${configName}.json`, json)\n .then(() => {\n // @TODO:\n // Add logging for successfull config export.\n })\n .catch(() => {\n // @TODO:\n // Add logging for failed config export.\n });\n },\n\n /**\n * Delete config file.\n *\n * @param {string} configName - The name of the config file.\n * @returns {void}\n */\n deleteConfigFile: async (configName) => {\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));\n if (shouldExclude) return;\n\n // Replace reserved characters in filenames.\n configName = configName.replace(/:/g, \"#\").replace(/\\//g, \"$\");\n\n fs.unlinkSync(`${strapi.config.get('plugin::config-sync.syncDir')}${configName}.json`);\n },\n\n /**\n * Zip config files.\n *\n * @param {string} configName - The name of the config file.\n * @returns {void}\n */\n zipConfigFiles: async () => {\n const fileName = `config-sync-${new Date().toJSON()}.zip`;\n\n const zip = new AdmZip();\n zip.addLocalFolder(strapi.config.get('plugin::config-sync.syncDir'));\n const base64Data = zip.toBuffer().toString('base64');\n\n return { base64Data, name: fileName, message: 'Success' };\n },\n\n /**\n * Read from a config file.\n *\n * @param {string} configType - The type of config.\n * @param {string} configName - The name of the config file.\n * @returns {object} The JSON content of the config file.\n */\n readConfigFile: async (configType, configName) => {\n // Replace reserved characters in filenames.\n configName = configName.replace(/:/g, \"#\").replace(/\\//g, \"$\");\n\n const readFile = util.promisify(fs.readFile);\n return readFile(`${strapi.config.get('plugin::config-sync.syncDir')}${configType}.${configName}.json`)\n .then((data) => {\n return JSON.parse(data);\n })\n .catch(() => {\n return null;\n });\n },\n\n\n /**\n * Get all the config JSON from the filesystem.\n *\n * @param {string} configType - Type of config to gather. Leave empty to get all config.\n * @returns {object} Object with key value pairs of configs.\n */\n getAllConfigFromFiles: async (configType = null) => {\n if (!fs.existsSync(strapi.config.get('plugin::config-sync.syncDir'))) {\n return {};\n }\n\n const configFiles = fs.readdirSync(strapi.config.get('plugin::config-sync.syncDir'));\n\n const getConfigs = async () => {\n const fileConfigs = {};\n\n await Promise.all(configFiles.map(async (file) => {\n const type = file.split('.')[0]; // Grab the first part of the filename.\n const name = file.split(/\\.(.+)/)[1].split('.').slice(0, -1).join('.'); // Grab the rest of the filename minus the file extension.\n\n // Put back reserved characters from filenames.\n const formattedName = name.replace(/#/g, \":\").replace(/\\$/g, \"/\");\n\n if (\n configType && configType !== type\n || !strapi.plugin('config-sync').types[type]\n || !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${type}.${name}`.startsWith(option)))\n ) {\n return;\n }\n\n const fileContents = await strapi.plugin('config-sync').service('main').readConfigFile(type, name);\n\n if (!fileContents) {\n strapi.log.warn(logMessage(`An empty config file '${file}' was found in the sync directory`));\n return;\n }\n\n fileConfigs[`${type}.${formattedName}`] = fileContents;\n }));\n\n return fileConfigs;\n };\n\n return getConfigs();\n },\n\n /**\n * Get all the config JSON from the database.\n *\n * @param {string} configType - Type of config to gather. Leave empty to get all config.\n * @returns {object} Object with key value pairs of configs.\n */\n getAllConfigFromDatabase: async (configType = null) => {\n const getConfigs = async () => {\n let databaseConfigs = {};\n\n await Promise.all(Object.entries(strapi.plugin('config-sync').types).map(async ([name, type]) => {\n if (configType && configType !== name) {\n return;\n }\n\n const config = await type.getAllFromDatabase();\n databaseConfigs = Object.assign(config, databaseConfigs);\n }));\n\n return databaseConfigs;\n };\n\n return getConfigs();\n },\n\n /**\n * Import all config files into the db.\n *\n * @param {string} configType - Type of config to impor. Leave empty to import all config.\n * @param {object} onSuccess - Success callback to run on each single successfull import.\n * @returns {void}\n */\n importAllConfig: async (configType = null, onSuccess) => {\n const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles();\n const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase();\n\n const diff = difference(databaseConfig, fileConfig);\n\n await Promise.all(Object.keys(diff).map(async (file) => {\n const type = file.split('.')[0]; // Grab the first part of the filename.\n const name = file.split(/\\.(.+)/)[1]; // Grab the rest of the filename.\n\n if (configType && configType !== type) {\n return;\n }\n\n await strapi.plugin('config-sync').service('main').importSingleConfig(`${type}.${name}`, onSuccess);\n }));\n },\n\n /**\n * Export all config files.\n *\n * @param {string} configType - Type of config to export. Leave empty to export all config.\n * @param {object} onSuccess - Success callback to run on each single successfull import.\n * @returns {void}\n */\n exportAllConfig: async (configType = null, onSuccess) => {\n const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles();\n const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase();\n\n const diff = difference(databaseConfig, fileConfig);\n\n await Promise.all(Object.keys(diff).map(async (file) => {\n const type = file.split('.')[0]; // Grab the first part of the filename.\n const name = file.split(/\\.(.+)/)[1]; // Grab the rest of the filename.\n\n if (configType && configType !== type) {\n return;\n }\n\n await strapi.plugin('config-sync').service('main').exportSingleConfig(`${type}.${name}`, onSuccess);\n }));\n },\n\n /**\n * Import a single config file into the db.\n *\n * @param {string} configName - The name of the config file.\n * @param {object} onSuccess - Success callback to run on each single successfull import.\n * @param {boolean} force - Ignore the soft setting.\n * @returns {void}\n */\n importSingleConfig: async (configName, onSuccess, force) => {\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));\n if (shouldExclude) return;\n\n const type = configName.split('.')[0]; // Grab the first part of the filename.\n const name = configName.split(/\\.(.+)/)[1]; // Grab the rest of the filename.\n const fileContents = await strapi.plugin('config-sync').service('main').readConfigFile(type, name);\n\n try {\n const importState = await strapi.plugin('config-sync').types[type].importSingle(name, fileContents, force);\n if (onSuccess && importState !== false) onSuccess(`${type}.${name}`);\n } catch (e) {\n throw new Error(`Error when trying to import ${type}.${name}. ${e}`);\n }\n },\n\n /**\n * Export a single config file.\n *\n * @param {string} configName - The name of the config file.\n * @param {object} onSuccess - Success callback to run on each single successfull import.\n *\n * @returns {void}\n */\n exportSingleConfig: async (configName, onSuccess) => {\n // Check if the config should be excluded.\n const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));\n if (shouldExclude) return;\n\n const type = configName.split('.')[0]; // Grab the first part of the filename.\n const name = configName.split(/\\.(.+)/)[1]; // Grab the rest of the filename.\n\n try {\n await strapi.plugin('config-sync').types[type].exportSingle(configName);\n if (onSuccess) onSuccess(`${type}.${name}`);\n } catch (e) {\n throw new Error(`Error when trying to export ${type}.${name}. ${e}`);\n }\n },\n\n /**\n * Get the formatted diff.\n *\n * @param {string} configType - Type of config to get the diff of. Leave empty to get the diff of all config.\n *\n * @returns {object} - the formatted diff.\n */\n getFormattedDiff: async (configType = null) => {\n const formattedDiff = {\n fileConfig: {},\n databaseConfig: {},\n diff: {},\n };\n\n const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles(configType);\n const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase(configType);\n\n const diff = difference(databaseConfig, fileConfig);\n\n formattedDiff.diff = diff;\n\n Object.keys(diff).map((changedConfigName) => {\n formattedDiff.fileConfig[changedConfigName] = fileConfig[changedConfigName];\n formattedDiff.databaseConfig[changedConfigName] = databaseConfig[changedConfigName];\n });\n\n return formattedDiff;\n },\n});\n"
},
{
"path": "server/utils/getArrayDiff.js",
"content": "export const difference = (arrayOne, arrayTwo, compareKeys) => {\n return arrayOne.filter(({\n [compareKeys[0]]: id1,\n [compareKeys[1]]: id2,\n }) => {\n return !arrayTwo.some(({\n [compareKeys[0]]: id3,\n [compareKeys[1]]: id4,\n }) => id1 === id3 && id2 === id4);\n });\n};\n\nexport const same = (arrayOne, arrayTwo, compareKeys) => {\n return arrayOne.filter(({\n [compareKeys[0]]: id1,\n [compareKeys[1]]: id2,\n ...restOne\n }) => {\n return !arrayTwo.some(({\n [compareKeys[0]]: id3,\n [compareKeys[1]]: id4,\n ...restTwo\n }) => id1 === id3\n && id2 === id4\n && JSON.stringify(restOne) === JSON.stringify(restTwo));\n });\n};\n"
},
{
"path": "server/utils/getObjectDiff.js",
"content": "'use strict';\n\nimport transform from 'lodash/transform';\nimport isEqual from 'lodash/isEqual';\nimport isArray from 'lodash/isArray';\nimport isObject from 'lodash/isObject';\n\n/**\n * Find difference between two objects\n * @param {object} origObj - Source object to compare newObj against\n * @param {object} newObj - New object with potential changes\n * @return {object} differences\n */\nconst difference = (origObj, newObj) => {\n let arrayIndexCounter = 0;\n\n const newObjChange = transform(newObj, (result, value, key) => {\n if (!isEqual(value, origObj[key])) {\n const resultKey = isArray(origObj) ? arrayIndexCounter++ : key;\n result[resultKey] = (isObject(value) && isObject(origObj[key])) ? difference(value, origObj[key]) : value;\n }\n });\n const origObjChange = transform(origObj, (result, value, key) => {\n if (!isEqual(value, newObj[key])) {\n const resultKey = isArray(newObj) ? arrayIndexCounter++ : key;\n result[resultKey] = (isObject(value) && isObject(newObj[key])) ? difference(value, newObj[key]) : value;\n }\n });\n\n return Object.assign(newObjChange, origObjChange);\n};\n\nexport default difference;\n"
},
{
"path": "server/utils/index.js",
"content": "'use strict';\n\nconst COMBINED_UID_JOINSTR = '.combine-uid.';\n\nconst escapeUid = (uid) => typeof uid === \"string\" ? uid.replace(/\\.combine-uid\\./g, '.combine-uid-escape.') : uid;\nconst unEscapeUid = (uid) => typeof uid === \"string\" ? uid.replace(/\\.combine-uid-escape\\./g, '.combine-uid.') : uid;\nexport const getCombinedUid = (uidKeys, params) => uidKeys.map((uidKey) => escapeUid(params[uidKey])).join(COMBINED_UID_JOINSTR);\nexport const getCombinedUidWhereFilter = (uidKeys, params) => uidKeys.reduce(((akku, uidKey) => ({ ...akku, [uidKey]: params[uidKey] })), {});\nexport const getUidParamsFromName = (uidKeys, configName) => configName.split(COMBINED_UID_JOINSTR).map(unEscapeUid).reduce((akku, param, i) => ({ ...akku, [uidKeys[i]]: param }), {});\n\nexport const getCoreStore = () => {\n return strapi.store({ type: 'plugin', name: 'config-sync' });\n};\n\nexport const getService = (name) => {\n return strapi.plugin('config-sync').service(name);\n};\n\nexport const logMessage = (msg = '') => `[strapi-plugin-config-sync]: ${msg}`;\n\nconst sortByKeys = (unordered) => {\n return Object.keys(unordered).sort().reduce((obj, key) => {\n obj[key] = unordered[key];\n return obj;\n },\n {},\n );\n};\n\nexport const dynamicSort = (property) => {\n let sortOrder = 1;\n\n if (property[0] === \"-\") {\n sortOrder = -1;\n property = property.substr(1);\n }\n\n return (a, b) => {\n if (sortOrder === -1) {\n if (b[property]) {\n return b[property].localeCompare(a[property]);\n }\n } else if (a[property]) {\n return a[property].localeCompare(b[property]);\n }\n };\n};\n\nexport const sanitizeConfig = ({\n config,\n relation,\n relationSortFields,\n configName,\n}) => {\n delete config._id;\n delete config.id;\n delete config.updatedAt;\n delete config.createdAt;\n delete config.publishedAt;\n\n if (relation) {\n const formattedRelations = [];\n\n config[relation].map((relationEntity) => {\n delete relationEntity._id;\n delete relationEntity.id;\n delete relationEntity.updatedAt;\n delete config.publishedAt;\n delete relationEntity.createdAt;\n relationEntity = sortByKeys(relationEntity);\n\n formattedRelations.push(relationEntity);\n });\n\n if (relationSortFields) {\n relationSortFields.map((sortField) => {\n formattedRelations.sort(dynamicSort(sortField));\n });\n }\n\n config[relation] = formattedRelations;\n }\n\n // We recursively sanitize the config to remove environment specific data.\n // Except for the plugin_content_manager_configuration.\n // This is because that stores the \"edit the view\" data which includes only configuration, not content.\n if (configName && !configName.startsWith('plugin_content_manager_configuration_')) {\n const recursiveSanitizeConfig = (recursivedSanitizedConfig) => {\n delete recursivedSanitizedConfig._id;\n delete recursivedSanitizedConfig.id;\n delete recursivedSanitizedConfig.updatedAt;\n delete recursivedSanitizedConfig.createdAt;\n\n Object.keys(recursivedSanitizedConfig).map((key, index) => {\n if (recursivedSanitizedConfig[key] && typeof recursivedSanitizedConfig[key] === \"object\") {\n recursiveSanitizeConfig(recursivedSanitizedConfig[key]);\n }\n });\n };\n\n recursiveSanitizeConfig(config);\n }\n\n return config;\n};\n\nexport const noLimit = async (query, parameters, limit = 100) => {\n let entries = [];\n const amountOfEntries = await query.count(parameters);\n\n for (let i = 0; i < (amountOfEntries / limit); i++) {\n /* eslint-disable-next-line */\n const chunk = await query.findMany({\n ...parameters,\n limit: limit,\n offset: (i * limit),\n orderBy: 'id',\n });\n entries = [...chunk, ...entries];\n }\n\n return entries;\n};\n"
},
{
"path": "server/utils/queryFallBack.js",
"content": "const queryFallBack = {\n create: async (queryString, options) => {\n try {\n const newEntity = await strapi.documents(queryString).create(options);\n\n return newEntity;\n } catch (e) {\n return strapi.query(queryString).create(options);\n }\n },\n update: async (queryString, options) => {\n try {\n const entity = await strapi.query(queryString).findOne(options);\n const updatedEntity = await strapi.documents(queryString).update({\n documentId: entity.documentId,\n ...options,\n });\n\n return updatedEntity;\n } catch (e) {\n return strapi.query(queryString).update(options);\n }\n },\n delete: async (queryString, options) => {\n try {\n const entity = await strapi.query(queryString).findOne(options);\n await strapi.documents(queryString).delete({\n documentId: entity.documentId,\n });\n } catch (e) {\n await strapi.query(queryString).delete(options);\n }\n },\n};\n\nexport default queryFallBack;\n"
},
{
"path": "server/warnings.js",
"content": "'use strict';\n\nexport default {\n delete: {\n 'user-role.public': \"You've just deleted a default role from the users-permissions plugin.\",\n 'user-role.authenticated': \"You've just deleted a default role from the users-permissions plugin.\",\n 'admin-role.strapi-super-admin': \"You've just deleted one of the default admin roles from Strapi.\",\n 'admin-role.strapi-author': \"You've just deleted one of the default admin roles from Strapi.\",\n 'admin-role.strapi-editor': \"You've just deleted one of the default admin roles from Strapi.\",\n },\n};\n"
}
] ![\"NPM](\"https://img.shields.io/npm/v/strapi-plugin-config-sync/latest.svg\")
\n ![\"Monthly](\"https://img.shields.io/npm/dm/strapi-plugin-config-sync\")
\n ![\"CI](\"https://img.shields.io/github/actions/workflow/status/boazpoolman/strapi-plugin-config-sync/tests.yml?branch=master\")
\n ![\"codecov.io\"](\"https://codecov.io/gh/boazpoolman/strapi-plugin-config-sync/coverage.svg?branch=master\")
\n