@fett/synology-api 0.0.1-beta.0 → 0.0.1-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +25 -1
  2. package/bin/syno +6 -0
  3. package/lib/cjs/index.js +728 -0
  4. package/lib/esm/cli/apis.js +53 -0
  5. package/lib/esm/cli/config.js +130 -0
  6. package/lib/esm/cli/helper.js +19 -0
  7. package/lib/esm/cli/index.js +30 -0
  8. package/lib/esm/constants.js +5 -0
  9. package/{dist → lib/esm}/core.js +28 -40
  10. package/lib/esm/errorcodes.js +97 -0
  11. package/lib/esm/helpers.js +81 -0
  12. package/lib/esm/index.js +5 -0
  13. package/lib/esm/modules/Api/Auth.js +43 -0
  14. package/lib/esm/modules/Api/Info.js +26 -0
  15. package/lib/esm/modules/Api/index.js +2 -0
  16. package/lib/esm/modules/AudioStation/Song.js +18 -0
  17. package/lib/esm/modules/AudioStation/index.js +7 -0
  18. package/{dist/modules/AudioStation.js → lib/esm/modules/FileStation/Info.js} +5 -11
  19. package/lib/esm/modules/FileStation/List.js +32 -0
  20. package/lib/esm/modules/FileStation/index.js +14 -0
  21. package/lib/esm/modules/index.js +46 -0
  22. package/lib/esm/types/apiInfo.js +42 -0
  23. package/lib/esm/types/index.js +2 -0
  24. package/lib/esm/types/request.js +2 -0
  25. package/lib/esm/utils.js +20 -0
  26. package/lib/types/cli/apis.d.ts +6 -0
  27. package/lib/types/cli/config.d.ts +13 -0
  28. package/lib/types/cli/helper.d.ts +4 -0
  29. package/lib/types/cli/index.d.ts +1 -0
  30. package/lib/types/constants.d.ts +5 -0
  31. package/{dist → lib/types}/core.d.ts +2 -2
  32. package/lib/types/errorcodes.d.ts +94 -0
  33. package/lib/types/helpers.d.ts +19 -0
  34. package/lib/types/index.d.ts +5 -0
  35. package/lib/types/modules/Api/Auth.d.ts +4 -0
  36. package/lib/types/modules/Api/Info.d.ts +3 -0
  37. package/lib/types/modules/Api/index.d.ts +2 -0
  38. package/lib/types/modules/AudioStation/Song.d.ts +22 -0
  39. package/lib/types/modules/AudioStation/index.d.ts +7 -0
  40. package/lib/types/modules/FileStation/Info.d.ts +11 -0
  41. package/lib/types/modules/FileStation/List.d.ts +59 -0
  42. package/lib/types/modules/FileStation/index.d.ts +13 -0
  43. package/lib/types/modules/index.d.ts +16 -0
  44. package/lib/types/types/apiInfo.d.ts +39 -0
  45. package/lib/types/types/index.d.ts +2 -0
  46. package/lib/types/types/request.d.ts +8 -0
  47. package/lib/types/utils.d.ts +5 -0
  48. package/package.json +42 -13
  49. package/dist/constants.d.ts +0 -2
  50. package/dist/constants.js +0 -2
  51. package/dist/index.d.ts +0 -2
  52. package/dist/index.js +0 -2
  53. package/dist/modules/AudioStation.d.ts +0 -7
  54. package/dist/modules/index.d.ts +0 -5
  55. package/dist/modules/index.js +0 -15
  56. package/dist/types/API.js +0 -1
  57. package/dist/types/AudioStation.Song.d.ts +0 -17
  58. package/dist/types/AudioStation.Song.js +0 -1
  59. package/dist/types/FileStation.js +0 -0
  60. package/dist/types/index.d.ts +0 -0
  61. package/dist/types/index.js +0 -0
  62. package/dist/utils.d.ts +0 -2
  63. package/dist/utils.js +0 -11
  64. /package/{dist/types/API.d.ts → lib/esm/modules/FileStation/File.js} +0 -0
  65. /package/{dist/types/FileStation.d.ts → lib/types/modules/FileStation/File.d.ts} +0 -0
package/README.md CHANGED
@@ -1,2 +1,26 @@
1
- # synology-api
1
+ # Synology Api
2
+
2
3
  nodejs synology api wrapper
4
+
5
+ ## Usage
6
+
7
+ ```js
8
+ import SynologyApi from '@fett/synology-api';
9
+
10
+ // Create a new instance
11
+ const synologyApi = new SynologyApi(
12
+ server: "https:192.168.1.1:5001",
13
+ username: "admin",
14
+ password: "password",
15
+ );
16
+
17
+ // you can now use the api by calling the methods
18
+ const info = await synologyApi.FileStation.getInfo();
19
+
20
+ ```
21
+
22
+ ## API
23
+
24
+ ### FileStation
25
+
26
+ ### AudioStation
package/bin/syno ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env node
2
+ const { loadCli } = require("../lib/cjs/index");
3
+
4
+ (async () => {
5
+ await loadCli();
6
+ })();