swcombine-sdk 2.0.1 → 2.2.0
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.
- package/README.md +39 -1
- package/dist/cjs/resources/CharacterResource.js +62 -4
- package/dist/cjs/resources/CharacterResource.js.map +1 -1
- package/dist/cjs/resources/NewsResource.js +171 -8
- package/dist/cjs/resources/NewsResource.js.map +1 -1
- package/dist/cjs/resources/TypesResource.js +26 -2
- package/dist/cjs/resources/TypesResource.js.map +1 -1
- package/dist/esm/resources/CharacterResource.js +62 -4
- package/dist/esm/resources/CharacterResource.js.map +1 -1
- package/dist/esm/resources/NewsResource.js +171 -8
- package/dist/esm/resources/NewsResource.js.map +1 -1
- package/dist/esm/resources/TypesResource.js +26 -2
- package/dist/esm/resources/TypesResource.js.map +1 -1
- package/dist/types/resources/CharacterResource.d.ts +38 -4
- package/dist/types/resources/CharacterResource.d.ts.map +1 -1
- package/dist/types/resources/NewsResource.d.ts +27 -5
- package/dist/types/resources/NewsResource.d.ts.map +1 -1
- package/dist/types/resources/TypesResource.d.ts +26 -2
- package/dist/types/resources/TypesResource.d.ts.map +1 -1
- package/dist/types/types/index.d.ts +166 -12
- package/dist/types/types/index.d.ts.map +1 -1
- package/package.json +3 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CharacterResource.js","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"CharacterResource.js","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAoBjD,gGAAgG;AAEhG,yEAAyE;AAEzE;;;;GAIG;AACH,MAAM,OAAO,yBAA0B,SAAQ,YAAY;IACjD,6BAA6B,CAAC,SAAiB;QACrD,MAAM,eAAe,GAAG,SAAS;aAC9B,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;aAClC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE7C,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,QAAQ,CAChB,0EAA0E,EAC1E;gBACE,IAAI,EAAE,YAAY;aACnB,CACF,CAAC;QACJ,CAAC;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,QAAQ,CAChB,6EAA6E,EAC7E;gBACE,IAAI,EAAE,YAAY;aACnB,CACF,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvF,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,IAAI,QAAQ,CAChB,uCAAuC,eAAe,uFAAuF,EAC7I;gBACE,IAAI,EAAE,YAAY;aACnB,CACF,CAAC;QACJ,CAAC;QAED,OAAO,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,IAAI,CAAC,OAA4B;QACrC,MAAM,MAAM,GAA2B;YACrC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC;QACF,4EAA4E;QAC5E,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI;YACvB,CAAC,CAAC,cAAc,OAAO,CAAC,GAAG,aAAa,OAAO,CAAC,IAAI,EAAE;YACtD,CAAC,CAAC,cAAc,OAAO,CAAC,GAAG,WAAW,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,IAAI,EACJ,EAAE,MAAM,EAAE,CACX,CAAC;QACF,4EAA4E;QAC5E,OAAO,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,GAAG,CAAC,OAA0B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,aAAa,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAA6B;QACxC,OAAO,IAAI,CAAC,OAAO,CAAO,QAAQ,EAAE,cAAc,OAAO,CAAC,GAAG,aAAa,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,MAAM,CAAC,OAA6B;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAExE,OAAO,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,WAAW,EAAE;YACxE,SAAS;YACT,aAAa,EAAE,OAAO,CAAC,aAAa;SACrC,CAAC,CAAC;IACL,CAAC;CACF;AAsCD;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IACvD;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,OAAkC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAkB,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAClF,CAAC;CACF;AAoCD;;;;GAIG;AACH,MAAM,OAAO,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,IAAI,CAAC,OAAgE;QACzE,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,cAAc,OAAO,CAAC,GAAG,aAAa,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,OAKT;QACC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAClB,cAAc,OAAO,CAAC,GAAG,eAAe,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,SAAS,EAAE,EACrF,EAAE,MAAM,EAAE,CACX,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,OAMZ;QACC,MAAM,IAAI,GAA2B,EAAE,CAAC;QACxC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,6CAA6C;YAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QACD,gFAAgF;QAEhF,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CACnB,cAAc,OAAO,CAAC,GAAG,eAAe,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,SAAS,EAAE,EACrF,IAAI,EACJ,EAAE,MAAM,EAAE,CACX,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,OAAmC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAS,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,OAKd;QACC,MAAM,IAAI,GAA4B;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAU,MAAM,EAAE,cAAc,OAAO,CAAC,GAAG,UAAU,EAAE,IAAI,CAAC,CAAC;IAClF,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,YAAY;IAC1D;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,CAAC,OAAqC;QAC9C,MAAM,MAAM,GAA2B;YACrC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC;QACF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA2D,cAAc,OAAO,CAAC,GAAG,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAClJ,sFAAsF;QACtF,kEAAkE;QAClE,OAAO,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC;IACpC,CAAC;CACF;AAqBD;;;;GAIG;AACH,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IAC5D;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuC;QAChD,OAAO,IAAI,CAAC,OAAO,CAA+B,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,cAAc,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,OAAuC;QACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC;IACvD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IAQjD,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE;QACN,OAAO,IAAI,CAAC,OAAO,CAAc,KAAK,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,OAA4B;QACpC,OAAO,IAAI,CAAC,OAAO,CAAY,KAAK,EAAE,cAAc,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,OAAoC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAkB,KAAK,EAAE,0BAA0B,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CAAC,OAA4C;QAC9D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACtE,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,6DAA6D;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CACF"}
|
|
@@ -2,6 +2,145 @@
|
|
|
2
2
|
* News resource for accessing news feeds
|
|
3
3
|
*/
|
|
4
4
|
import { BaseResource } from './BaseResource.js';
|
|
5
|
+
function normalizeNewsListAttributes(attributes) {
|
|
6
|
+
if (!attributes || typeof attributes !== 'object') {
|
|
7
|
+
return {};
|
|
8
|
+
}
|
|
9
|
+
const raw = attributes;
|
|
10
|
+
const normalized = {};
|
|
11
|
+
const maybeNumber = (value) => {
|
|
12
|
+
if (typeof value === 'number' && Number.isFinite(value)) {
|
|
13
|
+
return value;
|
|
14
|
+
}
|
|
15
|
+
if (typeof value === 'string') {
|
|
16
|
+
const parsed = Number(value);
|
|
17
|
+
if (Number.isFinite(parsed)) {
|
|
18
|
+
return parsed;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
return undefined;
|
|
22
|
+
};
|
|
23
|
+
const start = maybeNumber(raw.start);
|
|
24
|
+
const total = maybeNumber(raw.total);
|
|
25
|
+
const count = maybeNumber(raw.count);
|
|
26
|
+
if (start !== undefined)
|
|
27
|
+
normalized.start = start;
|
|
28
|
+
if (total !== undefined)
|
|
29
|
+
normalized.total = total;
|
|
30
|
+
if (count !== undefined)
|
|
31
|
+
normalized.count = count;
|
|
32
|
+
return { ...raw, ...normalized };
|
|
33
|
+
}
|
|
34
|
+
function normalizeNewsId(id) {
|
|
35
|
+
if (typeof id === 'number' && Number.isFinite(id)) {
|
|
36
|
+
return id;
|
|
37
|
+
}
|
|
38
|
+
if (typeof id === 'string') {
|
|
39
|
+
const parsed = Number(id);
|
|
40
|
+
return Number.isFinite(parsed) ? parsed : 0;
|
|
41
|
+
}
|
|
42
|
+
return 0;
|
|
43
|
+
}
|
|
44
|
+
function normalizeNewsListItem(item) {
|
|
45
|
+
const raw = item && typeof item === 'object' ? item : {};
|
|
46
|
+
const rawAttributes = raw.attributes && typeof raw.attributes === 'object' ? raw.attributes : {};
|
|
47
|
+
const value = typeof raw.value === 'string'
|
|
48
|
+
? raw.value
|
|
49
|
+
: typeof rawAttributes.title === 'string'
|
|
50
|
+
? rawAttributes.title
|
|
51
|
+
: '';
|
|
52
|
+
const normalized = {
|
|
53
|
+
...raw,
|
|
54
|
+
value,
|
|
55
|
+
attributes: {
|
|
56
|
+
...rawAttributes,
|
|
57
|
+
id: normalizeNewsId(rawAttributes.id),
|
|
58
|
+
href: typeof rawAttributes.href === 'string' ? rawAttributes.href : '',
|
|
59
|
+
title: typeof rawAttributes.title === 'string' ? rawAttributes.title : value,
|
|
60
|
+
},
|
|
61
|
+
};
|
|
62
|
+
return normalized;
|
|
63
|
+
}
|
|
64
|
+
function normalizeNewsListResponse(response) {
|
|
65
|
+
const items = (response.newsitem || []).map(normalizeNewsListItem);
|
|
66
|
+
const list = Object.assign(items, {
|
|
67
|
+
attributes: normalizeNewsListAttributes(response.attributes),
|
|
68
|
+
});
|
|
69
|
+
return list;
|
|
70
|
+
}
|
|
71
|
+
function normalizeNewsReference(reference) {
|
|
72
|
+
if (typeof reference === 'string') {
|
|
73
|
+
return { value: reference };
|
|
74
|
+
}
|
|
75
|
+
if (reference && typeof reference === 'object') {
|
|
76
|
+
const raw = reference;
|
|
77
|
+
const normalized = {
|
|
78
|
+
...raw,
|
|
79
|
+
value: typeof raw.value === 'string' ? raw.value : '',
|
|
80
|
+
};
|
|
81
|
+
if (raw.attributes && typeof raw.attributes === 'object') {
|
|
82
|
+
const attrs = raw.attributes;
|
|
83
|
+
normalized.attributes = {
|
|
84
|
+
uid: typeof attrs.uid === 'string' ? attrs.uid : undefined,
|
|
85
|
+
href: typeof attrs.href === 'string' ? attrs.href : undefined,
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
return normalized;
|
|
89
|
+
}
|
|
90
|
+
return { value: '' };
|
|
91
|
+
}
|
|
92
|
+
function normalizeNewsPostedTimestamp(posted) {
|
|
93
|
+
if (!posted || typeof posted !== 'object') {
|
|
94
|
+
return undefined;
|
|
95
|
+
}
|
|
96
|
+
const raw = posted;
|
|
97
|
+
const normalized = {};
|
|
98
|
+
if (typeof raw.years === 'number')
|
|
99
|
+
normalized.years = raw.years;
|
|
100
|
+
if (typeof raw.days === 'number')
|
|
101
|
+
normalized.days = raw.days;
|
|
102
|
+
if (typeof raw.hours === 'number')
|
|
103
|
+
normalized.hours = raw.hours;
|
|
104
|
+
if (typeof raw.mins === 'number')
|
|
105
|
+
normalized.mins = raw.mins;
|
|
106
|
+
if (typeof raw.secs === 'number')
|
|
107
|
+
normalized.secs = raw.secs;
|
|
108
|
+
if (typeof raw.timestamp === 'number')
|
|
109
|
+
normalized.timestamp = raw.timestamp;
|
|
110
|
+
return Object.keys(normalized).length > 0 ? normalized : undefined;
|
|
111
|
+
}
|
|
112
|
+
function normalizeNewsItem(item) {
|
|
113
|
+
const raw = item && typeof item === 'object' ? item : {};
|
|
114
|
+
const normalized = {
|
|
115
|
+
...raw,
|
|
116
|
+
url: typeof raw.url === 'string' ? raw.url : '',
|
|
117
|
+
title: typeof raw.title === 'string' ? raw.title : '',
|
|
118
|
+
id: normalizeNewsId(raw.id),
|
|
119
|
+
author: normalizeNewsReference(raw.author),
|
|
120
|
+
faction: normalizeNewsReference(raw.faction),
|
|
121
|
+
};
|
|
122
|
+
if (typeof raw.logo === 'string')
|
|
123
|
+
normalized.logo = raw.logo;
|
|
124
|
+
if (typeof raw.hacked === 'number')
|
|
125
|
+
normalized.hacked = raw.hacked;
|
|
126
|
+
if (typeof raw.location === 'string')
|
|
127
|
+
normalized.location = raw.location;
|
|
128
|
+
if (typeof raw.body === 'string')
|
|
129
|
+
normalized.body = raw.body;
|
|
130
|
+
if (typeof raw.category === 'string')
|
|
131
|
+
normalized.category = raw.category;
|
|
132
|
+
const posted = normalizeNewsPostedTimestamp(raw.posted);
|
|
133
|
+
if (posted) {
|
|
134
|
+
normalized.posted = posted;
|
|
135
|
+
}
|
|
136
|
+
return normalized;
|
|
137
|
+
}
|
|
138
|
+
function normalizeNewsGetResponse(response) {
|
|
139
|
+
if (Array.isArray(response)) {
|
|
140
|
+
return normalizeNewsItem(response[0]);
|
|
141
|
+
}
|
|
142
|
+
return normalizeNewsItem(response);
|
|
143
|
+
}
|
|
5
144
|
/**
|
|
6
145
|
* Galactic News Service (GNS) resource
|
|
7
146
|
*
|
|
@@ -10,6 +149,9 @@ import { BaseResource } from './BaseResource.js';
|
|
|
10
149
|
export class GNSResource extends BaseResource {
|
|
11
150
|
/**
|
|
12
151
|
* List GNS news items (paginated with optional filtering)
|
|
152
|
+
* Returns headline metadata entries (`attributes.id`, `attributes.href`, `attributes.title`, `value`).
|
|
153
|
+
* The returned array also includes pagination metadata at `result.attributes`
|
|
154
|
+
* (`start`, `total`, `count`) from the API response.
|
|
13
155
|
* @requires_auth No
|
|
14
156
|
* @param options - Optional category, pagination, and filtering parameters
|
|
15
157
|
* @param options.category - News category: 'auto', 'economy', 'military', 'political', 'social'
|
|
@@ -23,6 +165,8 @@ export class GNSResource extends BaseResource {
|
|
|
23
165
|
* const moreNews = await client.news.gns.list({ start_index: 51, item_count: 50 });
|
|
24
166
|
* const searchNews = await client.news.gns.list({ search: 'battle', author: 'John Doe' });
|
|
25
167
|
* const factionNews = await client.news.gns.list({ faction: 'Empire', faction_type: 'government' });
|
|
168
|
+
* console.log(news[0].attributes.title);
|
|
169
|
+
* console.log(news.attributes.start, news.attributes.total, news.attributes.count);
|
|
26
170
|
*/
|
|
27
171
|
async list(options) {
|
|
28
172
|
const path = options?.category ? `/news/gns/${options.category}` : '/news/gns';
|
|
@@ -49,14 +193,21 @@ export class GNSResource extends BaseResource {
|
|
|
49
193
|
params.faction_type = options.faction_type;
|
|
50
194
|
}
|
|
51
195
|
const response = await this.http.get(path, { params });
|
|
52
|
-
//
|
|
53
|
-
return response
|
|
196
|
+
// Preserve array behavior while exposing `attributes.start/total/count`.
|
|
197
|
+
return normalizeNewsListResponse(response);
|
|
54
198
|
}
|
|
55
199
|
/**
|
|
56
|
-
* Get specific GNS news item
|
|
200
|
+
* Get a specific GNS news item by numeric ID.
|
|
201
|
+
* Author and faction are normalized to object references with `value`.
|
|
202
|
+
* If the API returns an array, the SDK returns the first normalized item.
|
|
203
|
+
* @example
|
|
204
|
+
* const post = await client.news.gns.get({ id: 49108 });
|
|
205
|
+
* console.log(post.author.value);
|
|
206
|
+
* console.log(post.faction.value);
|
|
57
207
|
*/
|
|
58
208
|
async get(options) {
|
|
59
|
-
|
|
209
|
+
const response = await this.request('GET', `/news/gns/${options.id}`);
|
|
210
|
+
return normalizeNewsGetResponse(response);
|
|
60
211
|
}
|
|
61
212
|
}
|
|
62
213
|
/**
|
|
@@ -67,6 +218,9 @@ export class GNSResource extends BaseResource {
|
|
|
67
218
|
export class SimNewsResource extends BaseResource {
|
|
68
219
|
/**
|
|
69
220
|
* List Sim News items (paginated with optional filtering)
|
|
221
|
+
* Returns headline metadata entries (`attributes.id`, `attributes.href`, `attributes.title`, `value`).
|
|
222
|
+
* The returned array also includes pagination metadata at `result.attributes`
|
|
223
|
+
* (`start`, `total`, `count`) from the API response.
|
|
70
224
|
* @requires_auth No
|
|
71
225
|
* @param options - Optional category, pagination, and filtering parameters
|
|
72
226
|
* @param options.category - News category: 'player', 'technical', 'community'
|
|
@@ -77,6 +231,8 @@ export class SimNewsResource extends BaseResource {
|
|
|
77
231
|
* const playerNews = await client.news.simNews.list({ category: 'player' });
|
|
78
232
|
* const moreNews = await client.news.simNews.list({ start_index: 51, item_count: 50 });
|
|
79
233
|
* const searchNews = await client.news.simNews.list({ search: 'update', author: 'Admin' });
|
|
234
|
+
* console.log(news[0].attributes.title);
|
|
235
|
+
* console.log(news.attributes.start, news.attributes.total, news.attributes.count);
|
|
80
236
|
*/
|
|
81
237
|
async list(options) {
|
|
82
238
|
const path = options?.category ? `/news/simnews/${options.category}` : '/news/simnews';
|
|
@@ -97,14 +253,21 @@ export class SimNewsResource extends BaseResource {
|
|
|
97
253
|
params.author = options.author;
|
|
98
254
|
}
|
|
99
255
|
const response = await this.http.get(path, { params });
|
|
100
|
-
//
|
|
101
|
-
return response
|
|
256
|
+
// Preserve array behavior while exposing `attributes.start/total/count`.
|
|
257
|
+
return normalizeNewsListResponse(response);
|
|
102
258
|
}
|
|
103
259
|
/**
|
|
104
|
-
* Get specific Sim News item
|
|
260
|
+
* Get a specific Sim News item by numeric ID.
|
|
261
|
+
* Author and faction are normalized to object references with `value`.
|
|
262
|
+
* If the API returns an array, the SDK returns the first normalized item.
|
|
263
|
+
* @example
|
|
264
|
+
* const post = await client.news.simNews.get({ id: 49108 });
|
|
265
|
+
* console.log(post.author.value);
|
|
266
|
+
* console.log(post.faction.value);
|
|
105
267
|
*/
|
|
106
268
|
async get(options) {
|
|
107
|
-
|
|
269
|
+
const response = await this.request('GET', `/news/simnews/${options.id}`);
|
|
270
|
+
return normalizeNewsGetResponse(response);
|
|
108
271
|
}
|
|
109
272
|
}
|
|
110
273
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"NewsResource.js","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"NewsResource.js","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAcjD,SAAS,2BAA2B,CAAC,UAAmB;IACtD,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,GAAG,GAAG,UAAqC,CAAC;IAClD,MAAM,UAAU,GAAuB,EAAE,CAAC;IAE1C,MAAM,WAAW,GAAG,CAAC,KAAc,EAAsB,EAAE;QACzD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7B,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAErC,IAAI,KAAK,KAAK,SAAS;QAAE,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;IAClD,IAAI,KAAK,KAAK,SAAS;QAAE,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;IAClD,IAAI,KAAK,KAAK,SAAS;QAAE,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;IAElD,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,eAAe,CAAC,EAAW;IAClC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QAC1B,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAa;IAC1C,MAAM,GAAG,GAAG,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAE,IAAgC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,MAAM,aAAa,GACjB,GAAG,CAAC,UAAU,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAE,GAAG,CAAC,UAAsC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE1G,MAAM,KAAK,GACT,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAC3B,CAAC,CAAC,GAAG,CAAC,KAAK;QACX,CAAC,CAAC,OAAO,aAAa,CAAC,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,aAAa,CAAC,KAAK;YACrB,CAAC,CAAC,EAAE,CAAC;IAEX,MAAM,UAAU,GAAiB;QAC/B,GAAG,GAAG;QACN,KAAK;QACL,UAAU,EAAE;YACV,GAAG,aAAa;YAChB,EAAE,EAAE,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;YACrC,IAAI,EAAE,OAAO,aAAa,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YACtE,KAAK,EAAE,OAAO,aAAa,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;SAC7E;KACF,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,yBAAyB,CAAC,QAAwD;IACzF,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;QAChC,UAAU,EAAE,2BAA2B,CAAC,QAAQ,CAAC,UAAU,CAAC;KAC7D,CAAC,CAAC;IACH,OAAO,IAAwB,CAAC;AAClC,CAAC;AAED,SAAS,sBAAsB,CAAC,SAAkB;IAChD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,SAAoC,CAAC;QACjD,MAAM,UAAU,GAAkB;YAChC,GAAG,GAAG;YACN,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;SACtD,CAAC;QAEF,IAAI,GAAG,CAAC,UAAU,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YACzD,MAAM,KAAK,GAAG,GAAG,CAAC,UAAqC,CAAC;YACxD,UAAU,CAAC,UAAU,GAAG;gBACtB,GAAG,EAAE,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;gBAC1D,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;aAC9D,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;AACvB,CAAC;AAED,SAAS,4BAA4B,CAAC,MAAe;IACnD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,GAAG,GAAG,MAAiC,CAAC;IAC9C,MAAM,UAAU,GAAwB,EAAE,CAAC;IAE3C,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAAE,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChE,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAAE,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChE,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ;QAAE,UAAU,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAE5E,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACrE,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAa;IACtC,MAAM,GAAG,GAAG,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAE,IAAgC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEtF,MAAM,UAAU,GAAa;QAC3B,GAAG,GAAG;QACN,GAAG,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QAC/C,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACrD,EAAE,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,EAAE,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC;QAC1C,OAAO,EAAE,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC;KAC7C,CAAC;IAEF,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ;QAAE,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IACnE,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAAE,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACzE,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAAE,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAEzE,MAAM,MAAM,GAAG,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAiB;IACjD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,IAAI,CAAC,OAAwB;QACjC,MAAM,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAE/E,MAAM,MAAM,GAAgB;YAC1B,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC;YACtC,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,EAAE;SACtC,CAAC;QAEF,IAAI,OAAO,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QACD,IAAI,OAAO,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,EAAE,OAAO,EAAE,CAAC;YACrB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACnC,CAAC;QACD,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,MAAM,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC7C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiD,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACvG,yEAAyE;QACzE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,OAA2B;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,aAAa,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/E,OAAO,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,eAAgB,SAAQ,YAAY;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,IAAI,CAAC,OAA4B;QACrC,MAAM,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,iBAAiB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC;QAEvF,MAAM,MAAM,GAAgB;YAC1B,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC;YACtC,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,EAAE;SACtC,CAAC;QAEF,IAAI,OAAO,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QACD,IAAI,OAAO,EAAE,QAAQ,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACjC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiD,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACvG,yEAAyE;QACzE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,OAA2B;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU,KAAK,EAAE,iBAAiB,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QACnF,OAAO,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,YAAY;IAI5C,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;CACF"}
|
|
@@ -68,8 +68,32 @@ export class TypesEntitiesResource extends BaseResource {
|
|
|
68
68
|
return response.items;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
71
|
+
* Returns normalized pagination metadata and items for any `TypesEntityType`.
|
|
72
|
+
*
|
|
73
|
+
* @param options - Entity list options. `start_index` defaults to `1`, `item_count` defaults to `50`,
|
|
74
|
+
* and `class` is optional for class-filtered results.
|
|
75
|
+
* @returns `TypesEntitiesListMetaResponse` with pagination `attributes` and normalized `items`.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* const response = await client.types.entities.listRaw({
|
|
79
|
+
* entityType: 'vehicles',
|
|
80
|
+
* start_index: 1,
|
|
81
|
+
* item_count: 50,
|
|
82
|
+
* });
|
|
83
|
+
* console.log(response.attributes?.total);
|
|
84
|
+
* console.log(response.items[0]?.attributes.uid);
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* const response = await client.types.entities.listRaw({
|
|
88
|
+
* entityType: 'ships',
|
|
89
|
+
* class: 'fighter',
|
|
90
|
+
* start_index: 1,
|
|
91
|
+
* item_count: 25,
|
|
92
|
+
* });
|
|
93
|
+
*
|
|
94
|
+
* for (const item of response.items) {
|
|
95
|
+
* console.log(item.attributes.uid, item.value);
|
|
96
|
+
* }
|
|
73
97
|
*/
|
|
74
98
|
async listRaw(options) {
|
|
75
99
|
const entityPath = getTypesEntityPathSegment(options.entityType);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TypesResource.js","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAajD,SAAS,yBAAyB,CAAC,UAA2B;IAC5D,sGAAsG;IACtG,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;QACpC,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAcD;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAmC;QAEnC,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,kBAAkB,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EACjE,EAAE,MAAM,EAAE,CACX,CAAC;QACF,yFAAyF;QACzF,iGAAiG;QACjG,sDAAsD;QACtD,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAwC,CAAC;QAC3F,IAAI,cAAc,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,OAAO,cAAc,CAAC,KAAsB,CAAC;QAC/C,CAAC;QACD,+CAA+C;QAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,GAAG,KAAK,YAAY,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,GAAG,CAAkB,CAAC;YACxC,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"TypesResource.js","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAajD,SAAS,yBAAyB,CAAC,UAA2B;IAC5D,sGAAsG;IACtG,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;QACpC,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAcD;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAmC;QAEnC,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClC,kBAAkB,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EACjE,EAAE,MAAM,EAAE,CACX,CAAC;QACF,yFAAyF;QACzF,iGAAiG;QACjG,sDAAsD;QACtD,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAwC,CAAC;QAC3F,IAAI,cAAc,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,OAAO,cAAc,CAAC,KAAsB,CAAC;QAC/C,CAAC;QACD,+CAA+C;QAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,GAAG,KAAK,YAAY,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,GAAG,CAAkB,CAAC;YACxC,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,OAAO,CACX,OAAoC;QAEpC,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK;YACxB,CAAC,CAAC,UAAU,UAAU,UAAU,OAAO,CAAC,KAAK,GAAG;YAChD,CAAC,CAAC,UAAU,UAAU,GAAG,CAAC;QAE5B,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,CAAC;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA0B,IAAI,EAAE;YAClE,MAAM;SACP,CAAC,CAAiC,CAAC;QAEpC,OAAO;YACL,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;SACnE,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC;QAEjC,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAA+B,KAAK,EAAE,UAAU,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAClG,CAAC;IAEO,yBAAyB,CAC/B,QAAsC,EACtC,UAA2B;QAE3B,kDAAkD;QAClD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,QAAqC,CAAC;YAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO,aAAa,CAAC,QAAQ,CAAC;YAChC,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,UAAU,KAAK,UAAU,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAI,QAAoC,CAAC,WAAW,CAAC;YACvE,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,OAAO,YAAqC,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,sDAAsD;QACtD,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;YAC/B,MAAM,aAAa,GAAI,QAAoC,CAAC,YAAY,CAAC;YACzE,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACjC,OAAO,aAAsC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,2DAA2D;QAC3D,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;YACpC,MAAM,kBAAkB,GAAI,QAAoC,CAAC,oBAAoB,CAAC,CAAC;YACvF,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBACtC,OAAO,kBAA2C,CAAC;YACrD,CAAC;QACH,CAAC;QAED,oDAAoD;QACpD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,YAAY,GAAI,QAAoC,CAAC,WAAW,CAAC;YACvE,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,OAAO,YAAqC,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,mDAAmD;QACnD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAI,QAAoC,CAAC,UAAU,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/B,OAAO,WAAoC,CAAC;YAC9C,CAAC;QACH,CAAC;QAED,mDAAmD;QACnD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAI,QAAoC,CAAC,UAAU,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/B,OAAO,WAAoC,CAAC;YAC9C,CAAC;QACH,CAAC;QAED,iDAAiD;QACjD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAI,QAAoC,CAAC,IAAI,CAAC;YAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAkC,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;YAC/B,MAAM,aAAa,GAAI,QAAoC,CAAC,YAAY,CAAC;YACzE,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACjC,OAAO,aAAsC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,kDAAkD;QAClD,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAI,QAAoC,CAAC,SAAS,CAAC;YACnE,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9B,OAAO,UAAmC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,gDAAgD;QAChD,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAI,QAAoC,CAAC,OAAO,CAAC;YAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,OAAO,QAAiC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,iDAAiD;QACjD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAI,QAAoC,CAAC,QAAQ,CAAC;YACjE,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAkC,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,IAAI,UAAU,KAAK,YAAY,EAAE,CAAC;YAChC,MAAM,aAAa,GAAI,QAAoC,CAAC,YAAY,CAAC;YACzE,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACjC,OAAO,aAAsC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,oDAAoD;QACpD,IAAI,UAAU,KAAK,UAAU,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAI,QAAoC,CAAC,WAAW,CAAC;YACvE,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,OAAO,YAAqC,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEO,kBAAkB,CAAC,QAAsC;QAC/D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;gBACzB,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAA8B,CAAC;YACxC,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY;IAI7C,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAA0B,oBAAoB,CAAC,CAAC;QACpF,uEAAuE;QACvE,IAAI,QAAQ,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9D,OAAO,QAAQ,CAAC,UAA0B,CAAC;QAC7C,CAAC;QACD,2CAA2C;QAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACjC,OAAO,QAAQ,CAAC,GAAG,CAAiB,CAAC;YACvC,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF"}
|
|
@@ -3,15 +3,20 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import { HttpClient } from '../http/HttpClient.js';
|
|
5
5
|
import { BaseResource } from './BaseResource.js';
|
|
6
|
-
import { Character, CharacterMe, Message, CreditLogEntry, GetCharacterOptions, GetCharacterByHandleOptions, ListMessagesOptions, GetMessageOptions, DeleteMessageOptions, CreateMessageOptions, GetCharacterSkillsOptions, GetCharacterPrivilegesOptions, GetCharacterCreditsOptions, GetCharacterCreditlogOptions, GetCharacterPermissionsOptions } from '../types/index.js';
|
|
6
|
+
import { Character, CharacterMe, Message, MessageListItem, CreditLogEntry, GetCharacterOptions, GetCharacterByHandleOptions, ListMessagesOptions, GetMessageOptions, DeleteMessageOptions, CreateMessageOptions, GetCharacterSkillsOptions, GetCharacterPrivilegesOptions, GetCharacterCreditsOptions, GetCharacterCreditlogOptions, GetCharacterPermissionsOptions } from '../types/index.js';
|
|
7
7
|
/**
|
|
8
8
|
* Character messages resource
|
|
9
9
|
*
|
|
10
10
|
* @see https://www.swcombine.com/ws/v2.0/documentation/character/uid/messages/mode/ SW Combine API Documentation
|
|
11
11
|
*/
|
|
12
12
|
export declare class CharacterMessagesResource extends BaseResource {
|
|
13
|
+
private normalizeAndValidateReceivers;
|
|
13
14
|
/**
|
|
14
15
|
* List messages sent or received by character (paginated)
|
|
16
|
+
*
|
|
17
|
+
* Note: list responses return `MessageListItem[]` metadata objects and do not
|
|
18
|
+
* guarantee a `communication` field. Use `get()` for full message content.
|
|
19
|
+
*
|
|
15
20
|
* @requires_auth Yes
|
|
16
21
|
* @requires_scope MESSAGES_READ
|
|
17
22
|
* @param options - Character UID, optional message mode, and optional pagination parameters
|
|
@@ -19,16 +24,35 @@ export declare class CharacterMessagesResource extends BaseResource {
|
|
|
19
24
|
* @param options.mode - 'sent' or 'received'. If omitted, returns both sent and received messages.
|
|
20
25
|
* @param options.start_index - Starting position (1-based). Default: 1
|
|
21
26
|
* @param options.item_count - Number of items to retrieve. Default: 50, Max: 50
|
|
27
|
+
* @returns Array of message metadata items (`MessageListItem[]`)
|
|
22
28
|
* @example
|
|
23
29
|
* const allMessages = await client.character.messages.list({ uid: '1:12345' });
|
|
24
30
|
* const received = await client.character.messages.list({ uid: '1:12345', mode: 'received' });
|
|
25
31
|
* const moreMessages = await client.character.messages.list({ uid: '1:12345', mode: 'received', start_index: 51, item_count: 50 });
|
|
32
|
+
*
|
|
33
|
+
* const firstMessageId = received[0]?.attributes.uid;
|
|
34
|
+
* if (firstMessageId) {
|
|
35
|
+
* const detail = await client.character.messages.get({ uid: '1:12345', messageId: firstMessageId });
|
|
36
|
+
* console.log(detail.communication);
|
|
37
|
+
* }
|
|
26
38
|
*/
|
|
27
|
-
list(options: ListMessagesOptions): Promise<
|
|
39
|
+
list(options: ListMessagesOptions): Promise<MessageListItem[]>;
|
|
28
40
|
/**
|
|
29
41
|
* Get a specific message
|
|
30
42
|
* @requires_auth Yes
|
|
31
43
|
* @requires_scope MESSAGES_READ
|
|
44
|
+
* @param options - Character UID and message UID
|
|
45
|
+
* @param options.uid - Character UID
|
|
46
|
+
* @param options.messageId - Message UID (for example from `list()[i].attributes.uid`)
|
|
47
|
+
* @returns Full message details including `communication`
|
|
48
|
+
* @example
|
|
49
|
+
* const messages = await client.character.messages.list({ uid: '1:12345', mode: 'received' });
|
|
50
|
+
* const messageId = messages[0]?.attributes.uid;
|
|
51
|
+
*
|
|
52
|
+
* if (messageId) {
|
|
53
|
+
* const message = await client.character.messages.get({ uid: '1:12345', messageId });
|
|
54
|
+
* console.log(message.communication);
|
|
55
|
+
* }
|
|
32
56
|
*/
|
|
33
57
|
get(options: GetMessageOptions): Promise<Message>;
|
|
34
58
|
/**
|
|
@@ -42,14 +66,24 @@ export declare class CharacterMessagesResource extends BaseResource {
|
|
|
42
66
|
* @requires_auth Yes
|
|
43
67
|
* @requires_scope MESSAGES_SEND
|
|
44
68
|
* @param options.uid - Character UID sending the message
|
|
45
|
-
* @param options.receivers - Semicolon-separated list of
|
|
69
|
+
* @param options.receivers - Semicolon-separated list of receiver handles (max 25)
|
|
46
70
|
* @param options.communication - Message text content
|
|
71
|
+
* @returns Message response typed as `Message`
|
|
47
72
|
* @example
|
|
73
|
+
* // Valid: handles
|
|
48
74
|
* await client.character.messages.create({
|
|
49
75
|
* uid: '1:12345',
|
|
50
|
-
* receivers: '
|
|
76
|
+
* receivers: 'recipient_handle_1;recipient_handle_2',
|
|
51
77
|
* communication: 'Hello from the SDK!'
|
|
52
78
|
* });
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* // Invalid: UIDs are rejected by the API and pre-validated by this SDK
|
|
82
|
+
* await client.character.messages.create({
|
|
83
|
+
* uid: '1:12345',
|
|
84
|
+
* receivers: '1:12345',
|
|
85
|
+
* communication: 'Test'
|
|
86
|
+
* });
|
|
53
87
|
*/
|
|
54
88
|
create(options: CreateMessageOptions): Promise<Message>;
|
|
55
89
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CharacterResource.d.ts","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"CharacterResource.d.ts","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,SAAS,EACT,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAM3B;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,OAAO,CAAC,6BAA6B;IAqCrC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,IAAI,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAiBpE;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;CAQ9D;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,SAAS,CAAC;CAC5C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,SAAS,EAAE,eAAe,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,UAAU,EAAE;QACV,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,OAAO,EAAE,6BAA6B,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQzG;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,eAAe,CAAC;IAY5B;;;;;;;OAOG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,OAAO,CAAC;CAmBrB;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D;;;;;;;;OAQG;IACG,QAAQ,CAAC,OAAO,EAAE;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,OAAO,CAAC;CAYrB;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;CAa7E;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,wBAAwB,EAAE,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,YAAY;IAC5D;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAI1F;;;OAGG;IACG,SAAS,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAI5E;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAgB,QAAQ,EAAE,yBAAyB,CAAC;IACpD,SAAgB,MAAM,EAAE,uBAAuB,CAAC;IAChD,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IACxD,SAAgB,OAAO,EAAE,wBAAwB,CAAC;IAClD,SAAgB,SAAS,EAAE,0BAA0B,CAAC;IACtD,SAAgB,WAAW,EAAE,4BAA4B,CAAC;gBAE9C,IAAI,EAAE,UAAU;IAU5B;;;;;;;OAOG;IACG,EAAE,IAAI,OAAO,CAAC,WAAW,CAAC;IAIhC;;;;;;;OAOG;IACG,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3D;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAIjF;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CASpF"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import { HttpClient } from '../http/HttpClient.js';
|
|
5
5
|
import { BaseResource } from './BaseResource.js';
|
|
6
|
-
import {
|
|
6
|
+
import { GetNewsItemOptions, ListGNSOptions, ListSimNewsOptions, NewsItem, NewsListResponse } from '../types/index.js';
|
|
7
7
|
/**
|
|
8
8
|
* Galactic News Service (GNS) resource
|
|
9
9
|
*
|
|
@@ -12,6 +12,9 @@ import { NewsItem, GetNewsItemOptions, ListGNSOptions, ListSimNewsOptions } from
|
|
|
12
12
|
export declare class GNSResource extends BaseResource {
|
|
13
13
|
/**
|
|
14
14
|
* List GNS news items (paginated with optional filtering)
|
|
15
|
+
* Returns headline metadata entries (`attributes.id`, `attributes.href`, `attributes.title`, `value`).
|
|
16
|
+
* The returned array also includes pagination metadata at `result.attributes`
|
|
17
|
+
* (`start`, `total`, `count`) from the API response.
|
|
15
18
|
* @requires_auth No
|
|
16
19
|
* @param options - Optional category, pagination, and filtering parameters
|
|
17
20
|
* @param options.category - News category: 'auto', 'economy', 'military', 'political', 'social'
|
|
@@ -25,10 +28,18 @@ export declare class GNSResource extends BaseResource {
|
|
|
25
28
|
* const moreNews = await client.news.gns.list({ start_index: 51, item_count: 50 });
|
|
26
29
|
* const searchNews = await client.news.gns.list({ search: 'battle', author: 'John Doe' });
|
|
27
30
|
* const factionNews = await client.news.gns.list({ faction: 'Empire', faction_type: 'government' });
|
|
31
|
+
* console.log(news[0].attributes.title);
|
|
32
|
+
* console.log(news.attributes.start, news.attributes.total, news.attributes.count);
|
|
28
33
|
*/
|
|
29
|
-
list(options?: ListGNSOptions): Promise<
|
|
34
|
+
list(options?: ListGNSOptions): Promise<NewsListResponse>;
|
|
30
35
|
/**
|
|
31
|
-
* Get specific GNS news item
|
|
36
|
+
* Get a specific GNS news item by numeric ID.
|
|
37
|
+
* Author and faction are normalized to object references with `value`.
|
|
38
|
+
* If the API returns an array, the SDK returns the first normalized item.
|
|
39
|
+
* @example
|
|
40
|
+
* const post = await client.news.gns.get({ id: 49108 });
|
|
41
|
+
* console.log(post.author.value);
|
|
42
|
+
* console.log(post.faction.value);
|
|
32
43
|
*/
|
|
33
44
|
get(options: GetNewsItemOptions): Promise<NewsItem>;
|
|
34
45
|
}
|
|
@@ -40,6 +51,9 @@ export declare class GNSResource extends BaseResource {
|
|
|
40
51
|
export declare class SimNewsResource extends BaseResource {
|
|
41
52
|
/**
|
|
42
53
|
* List Sim News items (paginated with optional filtering)
|
|
54
|
+
* Returns headline metadata entries (`attributes.id`, `attributes.href`, `attributes.title`, `value`).
|
|
55
|
+
* The returned array also includes pagination metadata at `result.attributes`
|
|
56
|
+
* (`start`, `total`, `count`) from the API response.
|
|
43
57
|
* @requires_auth No
|
|
44
58
|
* @param options - Optional category, pagination, and filtering parameters
|
|
45
59
|
* @param options.category - News category: 'player', 'technical', 'community'
|
|
@@ -50,10 +64,18 @@ export declare class SimNewsResource extends BaseResource {
|
|
|
50
64
|
* const playerNews = await client.news.simNews.list({ category: 'player' });
|
|
51
65
|
* const moreNews = await client.news.simNews.list({ start_index: 51, item_count: 50 });
|
|
52
66
|
* const searchNews = await client.news.simNews.list({ search: 'update', author: 'Admin' });
|
|
67
|
+
* console.log(news[0].attributes.title);
|
|
68
|
+
* console.log(news.attributes.start, news.attributes.total, news.attributes.count);
|
|
53
69
|
*/
|
|
54
|
-
list(options?: ListSimNewsOptions): Promise<
|
|
70
|
+
list(options?: ListSimNewsOptions): Promise<NewsListResponse>;
|
|
55
71
|
/**
|
|
56
|
-
* Get specific Sim News item
|
|
72
|
+
* Get a specific Sim News item by numeric ID.
|
|
73
|
+
* Author and faction are normalized to object references with `value`.
|
|
74
|
+
* If the API returns an array, the SDK returns the first normalized item.
|
|
75
|
+
* @example
|
|
76
|
+
* const post = await client.news.simNews.get({ id: 49108 });
|
|
77
|
+
* console.log(post.author.value);
|
|
78
|
+
* console.log(post.faction.value);
|
|
57
79
|
*/
|
|
58
80
|
get(options: GetNewsItemOptions): Promise<NewsItem>;
|
|
59
81
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"NewsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,
|
|
1
|
+
{"version":3,"file":"NewsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAElB,QAAQ,EAER,gBAAgB,EAIjB,MAAM,mBAAmB,CAAC;AA+J3B;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgC/D;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0BnE;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC,SAAgB,OAAO,EAAE,eAAe,CAAC;gBAE7B,IAAI,EAAE,UAAU;CAK7B"}
|
|
@@ -50,8 +50,32 @@ export declare class TypesEntitiesResource extends BaseResource {
|
|
|
50
50
|
*/
|
|
51
51
|
list<T extends TypesEntityType>(options: ListTypesEntitiesOptions<T>): Promise<TypesEntityListItem[]>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
54
|
-
*
|
|
53
|
+
* Returns normalized pagination metadata and items for any `TypesEntityType`.
|
|
54
|
+
*
|
|
55
|
+
* @param options - Entity list options. `start_index` defaults to `1`, `item_count` defaults to `50`,
|
|
56
|
+
* and `class` is optional for class-filtered results.
|
|
57
|
+
* @returns `TypesEntitiesListMetaResponse` with pagination `attributes` and normalized `items`.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* const response = await client.types.entities.listRaw({
|
|
61
|
+
* entityType: 'vehicles',
|
|
62
|
+
* start_index: 1,
|
|
63
|
+
* item_count: 50,
|
|
64
|
+
* });
|
|
65
|
+
* console.log(response.attributes?.total);
|
|
66
|
+
* console.log(response.items[0]?.attributes.uid);
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* const response = await client.types.entities.listRaw({
|
|
70
|
+
* entityType: 'ships',
|
|
71
|
+
* class: 'fighter',
|
|
72
|
+
* start_index: 1,
|
|
73
|
+
* item_count: 25,
|
|
74
|
+
* });
|
|
75
|
+
*
|
|
76
|
+
* for (const item of response.items) {
|
|
77
|
+
* console.log(item.attributes.uid, item.value);
|
|
78
|
+
* }
|
|
55
79
|
*/
|
|
56
80
|
listRaw<T extends TypesEntityType>(options: ListTypesEntitiesOptions<T>): Promise<TypesEntitiesListMetaResponse>;
|
|
57
81
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TypesResource.d.ts","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,6BAA6B,EAE7B,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EAEhB,MAAM,mBAAmB,CAAC;AAU3B,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,WAAW,EAAE,CAAC;CAyB1B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAKjC
|
|
1
|
+
{"version":3,"file":"TypesResource.d.ts","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,6BAA6B,EAE7B,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EAEhB,MAAM,mBAAmB,CAAC;AAU3B,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,WAAW,EAAE,CAAC;CAyB1B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAKjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,OAAO,CAAC,CAAC,SAAS,eAAe,EACrC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAqBzC;;OAEG;IACG,GAAG,CAAC,CAAC,SAAS,eAAe,EACjC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAKxC,OAAO,CAAC,yBAAyB;IAuHjC,OAAO,CAAC,kBAAkB;CAY3B;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAgB,OAAO,EAAE,oBAAoB,CAAC;IAC9C,SAAgB,QAAQ,EAAE,qBAAqB,CAAC;gBAEpC,IAAI,EAAE,UAAU;IAM5B;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;CAc/C"}
|