Add paperless-ngx to latest

[BenAhrdt]

Please add my adapter ioBroker.paperless-ngx to latest.

This pull request was created by https://www.iobroker.dev c0726ff.

[mcm1957]

RE-CHECK!

[mcm1957]

Thanks for spending your time and providing a new adapter for ioBroker.

Your adapter will get a manual review as soon as possible. Please stand by - this might last one or two weeks. Feel free to continue your work and create new releases. You do NOT need to close or update this PR in case of new releases.

In the meantime please check any feedback issues logged by automatic adapter checker and try to fix them.

You will find the results of the review and eventually issues / suggestings as a comment to this PR. So please keep this PR watched.

If you have any urgent questions feel free to ask.

reminder 17.8.2024

[mcm1957]

First of all - THANK YOU for the time and effort you spend to maintain this adapter.

I would like to give some feedback based on my personal oppinion. @Apollon77 might have additional suggestions or even a different oppinion to one or the other statement. Please feel free to contact him if you cannot follow my suggestions or want to discuss some special aspects.

• Readme.md is very short

  The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter, add links the the manufacturer site (if applicable) and add a description of the configuration of the adapter. If you provide an external documentation - which should be located at doc/xx directory - please add links to at least the english documentation.

• Please add unique adapter icon

  Please add a unique adapter icon and use it in README.md.

• invalid characters should be filtered from object ids

  Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

• Add timeout to axios calls

  All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

• adapt testing to supported node releases

  Tests for node 18 are mandatory.
  Tests for node 20 are mandatory as this is the recommended node version.
  Tests for node 22 are mandatory unless you already know incompatibilities which cannot be fixed immidiatly. In this case please create a issue stating the problem and fix as soon as possible.

  So the recommended testmatrix is [18.x, 20.x, 22.x] depending on engines requirments setting at package.json

  Tests must be performed at all supported platforms (linux, windows, mac) unless special hardware or software restrictions prohibit this.

Thanks for reading and evaluating this suggestions.
McM1957

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

[mcm1957]

reminder 15.9.2024

[mcm1957]

Do you need an help?
Or did you fix the issues noted and teh adapter is ready for a review?

reminder 28.9.2024

[mcm1957]

Do you need an help?
Or did you fix the issues noted and the adapter is ready for a review?
Please indicate

reminder 15.10.2024

[mcm1957]

Review done at 2.11.2024

• errors reported by adapter checker

  Please fix Issue reported by adapter checker.
  Information in respect to our responsive UI initiative can be found here: https://github.com/iobroker-community-adapters/responsive-design-initiative#
  If you need additional help for jsonCOnfig adjustments please contact @simatec

• Readme.md is very short

  The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter, add links the the manufacturer site (if applicable) and add a description of the configuration of the adapter. If you provide an external documentation - which should be located at doc/xx directory - please add links to at least the english documentation.

• invalid characters should be filtered from object ids

  Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

I still do not see any filtering of illegal characters. As elementName and startDirectory are no constants fixed within soure, the must be filter. The same applies to other external data used to create ids. Please advice whre this processing is done if it is already implemented.

• Add timeout to axios calls

  All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

  This looks like still missing too.

In general I do not see much improvments til Sommer. Please let me know if you do not have time / interest to fix the open issues within the next time. If you need any help, please let us know.

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

[mcm1957]

reminder 16.11.2024

[BenAhrdt]

Ich habe die Spezifakationen und die Readme ergänzt und eine neue Version erzeugt: (1.0.4)
Sollte damit alles soweit in Ordnung sein?

[BenAhrdt]

@ioBroker-Bot recreate

[github-actions]

Automated adapter checker

ioBroker.paperless-ngx

-

👍 No errors found

• 👀 [W401] Cannot find "paperless-ngx" in latest repository

Add comment "RE-CHECK!" to start check anew

[mcm1957]

RE-REVIEW WORKSHEET ONLY _ please ignore for now

• errors reported by adapter checker

  Please fix Issue reported by adapter checker.
  Information in respect to our responsive UI initiative can be found here: https://github.com/iobroker-community-adapters/responsive-design-initiative#
  If you need additional help for jsonCOnfig adjustments please contact @simatec

• Readme.md is very short

  The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter, add links the the manufacturer site (if applicable) and add a description of the configuration of the adapter. If you provide an external documentation - which should be located at doc/xx directory - please add links to at least the english documentation.

• invalid characters should be filtered from object ids

  Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

I still do not see any filtering of illegal characters. As elementName and startDirectory are no constants fixed within soure, the must be filter. The same applies to other external data used to create ids. Please advice whre this processing is done if it is already implemented.

• Add timeout to axios calls

  All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

  This looks like still missing too.

[mcm1957]

@BenAhrdt

The following issues reported at last review (2.11.2024) are still open / not clearified. Please fix or indicate how they are solved anyway:

• invalid characters should be filtered from object ids

  Some characters are not allowed to be used as part of an object id. If an object id is not hardcoded or even depending on user input you should ensure that such an object id does not contain an invalid character. Iobroker provides the constant adapter.FORBIDDEN_CHARS, i.e. by using the following snippet:

function name2id(pName) {
    return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

I'm not sure where the ids of the directory structure are coming from. Please ensure, that no illegal characters are possible there (i.e. german Umlaute etc.)

I still do not see any filtering of illegal characters. As elementName and startDirectory are no constants fixed within soure, the must be filter. The same applies to other external data used to create ids. Please advice where this processing is done if it is already implemented.

• Add timeout to axios calls

  All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

  This looks like still missing too.

• Please add a link to paperless-ngx home page at README.md

  A link to the manufacturer / original home should be present at README.md. But I do not consider this blocking, so please add whenever you have time to do.

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

reminder 31.12.2024

[BenAhrdt]

function name2id(pName) {
return (pName || '').replace(adapter.FORBIDDEN_CHARS, '_');
}

i think i solved the issues.

[mcm1957]

reminder 27.12.2024