swcombine.js 0.0.1 → 0.0.3

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 (29) hide show
  1. package/{README → README.md} +98 -97
  2. package/dist/index.cjs.js +664 -9
  3. package/dist/index.d.ts +497 -5
  4. package/dist/index.esm.js +664 -9
  5. package/package.json +5 -6
  6. package/dist/index.d.mts +0 -33
  7. package/dist/index.d.ts.map +0 -1
  8. package/dist/permissions.d.ts +0 -289
  9. package/dist/permissions.d.ts.map +0 -1
  10. package/dist/resources/ApiResource.d.ts +0 -7
  11. package/dist/resources/ApiResource.d.ts.map +0 -1
  12. package/dist/resources/Resource.d.ts +0 -6
  13. package/dist/resources/Resource.d.ts.map +0 -1
  14. package/dist/resources/index.d.ts +0 -3
  15. package/dist/resources/index.d.ts.map +0 -1
  16. package/dist/responses/SwcApiResponse.d.ts +0 -8
  17. package/dist/responses/SwcApiResponse.d.ts.map +0 -1
  18. package/dist/responses/api/getPermissionsResponse.d.ts +0 -17
  19. package/dist/responses/api/getPermissionsResponse.d.ts.map +0 -1
  20. package/dist/responses/api/index.d.ts +0 -2
  21. package/dist/responses/api/index.d.ts.map +0 -1
  22. package/dist/responses/index.d.ts +0 -3
  23. package/dist/responses/index.d.ts.map +0 -1
  24. package/dist/types/Permission.d.ts +0 -7
  25. package/dist/types/Permission.d.ts.map +0 -1
  26. package/dist/types/SwcTimestamp.d.ts +0 -34
  27. package/dist/types/SwcTimestamp.d.ts.map +0 -1
  28. package/dist/types/index.d.ts +0 -3
  29. package/dist/types/index.d.ts.map +0 -1
package/{README → README.md} RENAMED
@@ -1,97 +1,98 @@
1
- # Star Wars Combine Web Services 2.0 JS/TS SDK
2
-
3
- Typescript and Javascript SDK for the Star Wars Combine 2.0 Web Services.
4
- The SDK is currently a WIP. Status is as follows:
5
-
6
- ## API SDK Status
7
-
8
- - :x: = Not yet implemented
9
- - :construction: = Partially implemented
10
- - :heavy_check_mark: = Implemented
11
- - :white_check_mark: = Implemented and covered by tests
12
-
13
- | Endpoint | Status | Availability | OAuth scope required (if applicable) |
14
- | ------------------------------------------ | ------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
15
- | **<h3>OAuth</h3>** | :x: | Public | |
16
- | Get token using server flow (node.js only) | :x: | Public | |
17
- | Get token using client flow (browser only) | :x: | Public | |
18
- | Get granted permissions | :x: | OAuth :lock: | |
19
- | **<h3>Permissions</h3>** | :x: | | |
20
- | List permissions | :heavy_check_mark: | Public | |
21
- | **<h3>Rate Limits</h3>** | :x: | | |
22
- | List rate limits | :x: | Public | |
23
- | **<h3>Time</h3>** | :white_check_mark: | | |
24
- | Get current SWC time | :white_check_mark: | Public/on device | |
25
- | Convert between SWC and Unix time | :white_check_mark: | Public/on device | |
26
- | Convert between SWC time and Date objects | :white_check_mark: | Public/on device | |
27
- | **<h3>Character</h3>** | :x: | | |
28
- | Get character info | :x: | OAuth :lock: | character_read |
29
- | Get character's credits | :x: | OAuth :lock: | character_credits |
30
- | Get character's creditlog | :x: | OAuth :lock: | character_credits |
31
- | Get UID by handle(handlecheck) | :x: | Public | |
32
- | List received messages | :x: | OAuth :lock: | messages_read |
33
- | List sent messages | :x: | OAuth :lock: | messages_read |
34
- | Send message from character | :x: | OAuth :lock: | messages_send |
35
- | Get message by id | :x: | OAUth :lock: | messages_read |
36
- | Delete message by id | :x: | OAuth :lock: | messages_delete |
37
- | Get character's skills | :x: | OAuth :lock: | character_skills |
38
- | List character's privileges | :x: | OAuth :lock: | character_privileges |
39
- | Check if character has privilege | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that can view the privileges of others. |
40
- | Grant privilege to a character | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that has the ability to grant privileges to others. |
41
- | Revoke privilege from character | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that can grant/revoke privileges of others. |
42
- | **<h3>Datacard</h3>** | :x: | | |
43
- | List datacards | :x: | OAuth :lock: | faction_datacards_read |
44
- | Get datacard | :x: | OAuth :lock: | faction_datacards_read |
45
- | Assign datacard | :x: | OAuth :lock: | faction_datacards_write |
46
- | Delete datacard assignment | :x: | OAuth :lock: | faction_datacards_write |
47
- | **<h3>Events</h3>** | :x: | | |
48
- | List events for character | :x: | OAuth :lock: | character_events |
49
- | Get event by uid | :x: | OAuth :lock: | character_events |
50
- | **<h3>Factions</h3>** | :x: | | |
51
- | List factions | :x: | Public | |
52
- | Get faction by uid | :x: | Public | |
53
- | Get faction credits | :x: | OAuth :lock: | faction_credits_read |
54
- | Get faction's creditlog | :x: | OAuth :lock: | faction_credits_read |
55
- | Send faction credits | :x: | OAuth :lock: | faction_credits_write |
56
- | List faction's budgets | :x: | OAuth :lock: | faction_budgets_read |
57
- | Get faction budget by uid | :x: | OAuth :lock: | faction_budgets_read |
58
- | List faction members | :x: | OAuth :lock: | faction_members |
59
- | Update faction member's infofields | :x: | OAuth :lock: | faction_members, and must be logged in as someone that can update infofields |
60
- | List faction's stock holders | :x: | OAuth :lock: | faction_stocks |
61
- | **<h3>Galaxy</h3>** | :x: | | |
62
- | List sectors | :x: | Public | |
63
- | Get sector by uid | :x: | Public | |
64
- | List systems | :x: | Public | |
65
- | Get system by uid | :x: | Public | |
66
- | List planets | :x: | Public | |
67
- | Get planet by uid | :x: | Public | |
68
- | List stations | :x: | Public | |
69
- | Get station by uid | :x: | Public | |
70
- | List cities | :x: | Public | |
71
- | Get city by uid | :x: | Public | |
72
- | **<h3>Inventory</h3>** | :x: | | |
73
- | List inventories | :x: | OAuth :lock: | [personal/faction]\_inv_overview |
74
- | List entities in inventory | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_read |
75
- | Get one entity in inventory | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_read |
76
- | Modify entity info | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_assign |
77
- | Rename entity | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_rename |
78
- | Makeover entity | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_makeover |
79
- | Apply tag to entity | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_tags_write |
80
- | Remove tag from entity | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_tags_write |
81
- | Clear all tags from entity | :x: | OAuth :lock: | [personal/faction]\_inv\_[inventory]\_tags_write |
82
- | **<h3>Location</h3>** | :x: | | |
83
- | Get location for specified entity | :x: | OAuth :lock: | character_location |
84
- | **<h3>Market</h3>** | :x: | |
85
- | List all public market vendors | :x: | Public |
86
- | Get vendor info | :x: | Public |
87
- | **<h3>News</h3>** | :x: | | |
88
- | List GNS news | :x: | Public | |
89
- | Get one GNS Item | :x: | Public | |
90
- | List Sim news | :x: | Public | |
91
- | Get one Sim news item | :x: | Public | |
92
- | **<h3>Types</h3>** | :x: | | |
93
- | List classes of type | :x: | Public | |
94
- | List entities of type | :x: | Public | |
95
- | List entities by class and type | :x: | Public | |
96
- | Get type for existing entity | :x: | Public | |
97
- | List all entity types | :x: | Public | |
1
+ # Star Wars Combine Web Services 2.0 JS/TS SDK
2
+
3
+ Typescript and Javascript SDK for the Star Wars Combine 2.0 Web Services.
4
+ The SDK is currently a WIP. Status is as follows:
5
+
6
+ ## API SDK Status
7
+
8
+ - :x: = Not yet implemented
9
+ - :construction: = Partially implemented
10
+ - :heavy_check_mark: = Implemented
11
+ - :white_check_mark: = Implemented and covered by tests
12
+
13
+ | Endpoint | Status | Availability | OAuth scope required (if applicable) |
14
+ |--------------------------------------------|--------------------|------------------|------------------------------------------------------------------------------------------------------------|
15
+ | **<h3>OAuth</h3>** | :x: | Public | |
16
+ | Get token using server flow (node.js only) | :x: | Public | |
17
+ | Get token using client flow (browser only) | :x: | Public | |
18
+ | Get granted permissions | :x: | OAuth :lock: | |
19
+ | **<h3>Permissions</h3>** | :x: | | |
20
+ | List permissions | :heavy_check_mark: | Public | |
21
+ | **<h3>Rate Limits</h3>** | :x: | | |
22
+ | List rate limits | :x: | Public | |
23
+ | **<h3>Time</h3>** | :white_check_mark: | | |
24
+ | Get current SWC time | :white_check_mark: | Public/on device | |
25
+ | Convert between SWC and Unix time | :white_check_mark: | Public/on device | |
26
+ | Convert between SWC time and Date objects | :white_check_mark: | Public/on device | |
27
+ | **<h3>Character</h3>** | :x: | | |
28
+ | Get character info | :x: | OAuth :lock: | character_read |
29
+ | Get character's credits | :x: | OAuth :lock: | character_credits |
30
+ | Get character's creditlog | :x: | OAuth :lock: | character_credits |
31
+ | Get UID by handle(handlecheck) | :x: | Public | |
32
+ | List received messages | :x: | OAuth :lock: | messages_read |
33
+ | List sent messages | :x: | OAuth :lock: | messages_read |
34
+ | Send message from character | :x: | OAuth :lock: | messages_send |
35
+ | Get message by id | :x: | OAUth :lock: | messages_read |
36
+ | Delete message by id | :x: | OAuth :lock: | messages_delete |
37
+ | Get character's skills | :x: | OAuth :lock: | character_skills |
38
+ | List character's privileges | :x: | OAuth :lock: | character_privileges |
39
+ | Check if character has privilege | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that can view the privileges of others. |
40
+ | Grant privilege to a character | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that has the ability to grant privileges to others. |
41
+ | Revoke privilege from character | :x: | OAuth :lock: | character_privileges, and must be logged in as someone that can grant/revoke privileges of others. |
42
+ | **<h3>Datacard</h3>** | :x: | | |
43
+ | List datacards | :x: | OAuth :lock: | faction_datacards_read |
44
+ | Get datacard | :x: | OAuth :lock: | faction_datacards_read |
45
+ | Assign datacard | :x: | OAuth :lock: | faction_datacards_write |
46
+ | Delete datacard assignment | :x: | OAuth :lock: | faction_datacards_write |
47
+ | **<h3>Events</h3>** | :x: | | |
48
+ | List events for character | :x: | OAuth :lock: | character_events |
49
+ | Get event by uid | :x: | OAuth :lock: | character_events |
50
+ | **<h3>Factions</h3>** | :x: | | |
51
+ | List factions | :x: | Public | |
52
+ | Get faction by uid | :x: | Public | |
53
+ | Get faction credits | :x: | OAuth :lock: | faction_credits_read |
54
+ | Get faction's creditlog | :x: | OAuth :lock: | faction_credits_read |
55
+ | Send faction credits | :x: | OAuth :lock: | faction_credits_write |
56
+ | List faction's budgets | :x: | OAuth :lock: | faction_budgets_read |
57
+ | Get faction budget by uid | :x: | OAuth :lock: | faction_budgets_read |
58
+ | List faction members | :x: | OAuth :lock: | faction_members |
59
+ | Update faction member's infofields | :x: | OAuth :lock: | faction_members, and must be logged in as someone that can update infofields |
60
+ | List faction's stock holders | :x: | OAuth :lock: | faction_stocks |
61
+ | **<h3>Galaxy</h3>** | :x: | | |
62
+ | List sectors | :x: | Public | |
63
+ | Get sector by uid | :x: | Public | |
64
+ | List systems | :x: | Public | |
65
+ | Get system by uid | :x: | Public | |
66
+ | List planets | :x: | Public | |
67
+ | Get planet by uid | :x: | Public | |
68
+ | List stations | :x: | Public | |
69
+ | Get station by uid | :x: | Public | |
70
+ | List cities | :x: | Public | |
71
+ | Get city by uid | :x: | Public | |
72
+ | **<h3>Inventory</h3>** | :x: | | |
73
+ | List inventories | :x: | OAuth :lock: | [personal/faction]_inv_overview |
74
+ | List entities in inventory | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_read |
75
+ | Get one entity in inventory | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_read |
76
+ | Modify entity info | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_assign |
77
+ | Rename entity | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_rename |
78
+ | Makeover entity | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_makeover |
79
+ | Apply tag to entity | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_tags_write |
80
+ | Remove tag from entity | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_tags_write |
81
+ | Clear all tags from entity | :x: | OAuth :lock: | [personal/faction]\_inv_[inventory]_tags_write |
82
+ | **<h3>Location</h3>** | :x: | | |
83
+ | Get location for specified entity | :x: | OAuth :lock: | character_location |
84
+ | **<h3>Market</h3>** | :x: | |
85
+ | List all public market vendors | :x: | Public |
86
+ | Get vendor info | :x: | Public |
87
+ | **<h3>News</h3>** | :x: | | |
88
+ | List GNS news | :x: | Public | |
89
+ | Get one GNS Item | :x: | Public | |
90
+ | List Sim news | :x: | Public | |
91
+ | Get one Sim news item | :x: | Public | |
92
+ | **<h3>Types</h3>** | :x: | | |
93
+ | List classes of type | :x: | Public | |
94
+ | List entities of type | :x: | Public | |
95
+ | List entities by class and type | :x: | Public | |
96
+ | Get type for existing entity | :x: | Public | |
97
+ | List all entity types | :x: | Public | |
98
+