@anduril-industries/lattice-sdk 2.2.0 → 2.4.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 +26 -4
- package/dist/cjs/Client.d.ts +4 -2
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/entities/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/entities/client/Client.js +24 -12
- package/dist/cjs/api/resources/objects/client/Client.d.ts +10 -3
- package/dist/cjs/api/resources/objects/client/Client.js +31 -16
- package/dist/cjs/api/resources/objects/client/requests/GetObjectRequest.d.ts +7 -3
- package/dist/cjs/api/resources/objects/client/requests/ListObjectsRequest.d.ts +10 -13
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/tasks/client/Client.js +20 -10
- package/dist/cjs/api/types/Entity.d.ts +2 -0
- package/dist/cjs/api/types/MilStd2525C.d.ts +6 -0
- package/dist/cjs/api/types/MilStd2525C.js +5 -0
- package/dist/cjs/api/types/Symbology.d.ts +10 -0
- package/dist/cjs/api/types/Symbology.js +5 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +4 -0
- package/dist/cjs/core/auth/AuthProvider.js +2 -0
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -3
- package/dist/cjs/core/fetcher/Fetcher.js +4 -3
- package/dist/cjs/core/fetcher/index.d.ts +7 -5
- package/dist/cjs/core/fetcher/index.js +7 -5
- package/dist/cjs/core/fetcher/requestWithRetries.js +44 -8
- package/dist/cjs/core/file/exports.d.ts +1 -1
- package/dist/cjs/core/headers.d.ts +2 -3
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +4 -2
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/entities/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/entities/client/Client.mjs +24 -12
- package/dist/esm/api/resources/objects/client/Client.d.mts +10 -3
- package/dist/esm/api/resources/objects/client/Client.mjs +31 -16
- package/dist/esm/api/resources/objects/client/requests/GetObjectRequest.d.mts +7 -3
- package/dist/esm/api/resources/objects/client/requests/ListObjectsRequest.d.mts +10 -13
- package/dist/esm/api/resources/tasks/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/tasks/client/Client.mjs +20 -10
- package/dist/esm/api/types/Entity.d.mts +2 -0
- package/dist/esm/api/types/MilStd2525C.d.mts +6 -0
- package/dist/esm/api/types/MilStd2525C.mjs +4 -0
- package/dist/esm/api/types/Symbology.d.mts +10 -0
- package/dist/esm/api/types/Symbology.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +4 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/index.d.mts +2 -0
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -3
- package/dist/esm/core/fetcher/Fetcher.mjs +4 -3
- package/dist/esm/core/fetcher/index.d.mts +7 -5
- package/dist/esm/core/fetcher/index.mjs +3 -2
- package/dist/esm/core/fetcher/requestWithRetries.mjs +44 -8
- package/dist/esm/core/file/exports.d.mts +1 -1
- package/dist/esm/core/headers.d.mts +2 -3
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +8 -13
- package/reference.md +83 -2
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Lattice SDK TypeScript Library
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@anduril-industries/lattice-sdk)
|
|
6
6
|
|
|
7
|
-
The Lattice SDK TypeScript library provides convenient access to the Lattice
|
|
7
|
+
The Lattice SDK TypeScript library provides convenient access to the Lattice SDK APIs from TypeScript.
|
|
8
8
|
|
|
9
9
|
## Documentation
|
|
10
10
|
|
|
@@ -522,13 +522,23 @@ List endpoints are paginated. The SDK provides an iterator so that you can simpl
|
|
|
522
522
|
import { LatticeClient } from "@anduril-industries/lattice-sdk";
|
|
523
523
|
|
|
524
524
|
const client = new LatticeClient({ token: "YOUR_TOKEN" });
|
|
525
|
-
const response = await client.objects.listObjects(
|
|
525
|
+
const response = await client.objects.listObjects({
|
|
526
|
+
prefix: "prefix",
|
|
527
|
+
sinceTimestamp: "2024-01-15T09:30:00Z",
|
|
528
|
+
pageToken: "pageToken",
|
|
529
|
+
allObjectsInMesh: true,
|
|
530
|
+
});
|
|
526
531
|
for await (const item of response) {
|
|
527
532
|
console.log(item);
|
|
528
533
|
}
|
|
529
534
|
|
|
530
535
|
// Or you can manually iterate page-by-page
|
|
531
|
-
let page = await client.objects.listObjects(
|
|
536
|
+
let page = await client.objects.listObjects({
|
|
537
|
+
prefix: "prefix",
|
|
538
|
+
sinceTimestamp: "2024-01-15T09:30:00Z",
|
|
539
|
+
pageToken: "pageToken",
|
|
540
|
+
allObjectsInMesh: true,
|
|
541
|
+
});
|
|
532
542
|
while (page.hasNextPage()) {
|
|
533
543
|
page = page.getNextPage();
|
|
534
544
|
}
|
|
@@ -548,6 +558,18 @@ const response = await client.entities.longPollEntityEvents(..., {
|
|
|
548
558
|
});
|
|
549
559
|
```
|
|
550
560
|
|
|
561
|
+
### Additional Query String Parameters
|
|
562
|
+
|
|
563
|
+
If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
|
|
564
|
+
|
|
565
|
+
```typescript
|
|
566
|
+
const response = await client.entities.longPollEntityEvents(..., {
|
|
567
|
+
queryParams: {
|
|
568
|
+
'customQueryParamKey': 'custom query param value'
|
|
569
|
+
}
|
|
570
|
+
});
|
|
571
|
+
```
|
|
572
|
+
|
|
551
573
|
### Retries
|
|
552
574
|
|
|
553
575
|
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ export declare namespace LatticeClient {
|
|
|
13
13
|
baseUrl?: core.Supplier<string>;
|
|
14
14
|
token?: core.Supplier<core.BearerToken | undefined>;
|
|
15
15
|
/** Additional headers to include in requests. */
|
|
16
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
16
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
17
17
|
}
|
|
18
18
|
interface RequestOptions {
|
|
19
19
|
/** The maximum time to wait for a response in seconds. */
|
|
@@ -22,8 +22,10 @@ export declare namespace LatticeClient {
|
|
|
22
22
|
maxRetries?: number;
|
|
23
23
|
/** A hook to abort the request. */
|
|
24
24
|
abortSignal?: AbortSignal;
|
|
25
|
+
/** Additional query string parameters to include in the request. */
|
|
26
|
+
queryParams?: Record<string, unknown>;
|
|
25
27
|
/** Additional headers to include in the request. */
|
|
26
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
28
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
27
29
|
}
|
|
28
30
|
}
|
|
29
31
|
export declare class LatticeClient {
|
package/dist/cjs/Client.js
CHANGED
|
@@ -47,8 +47,8 @@ class LatticeClient {
|
|
|
47
47
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
48
48
|
"X-Fern-Language": "JavaScript",
|
|
49
49
|
"X-Fern-SDK-Name": "@anduril-industries/lattice-sdk",
|
|
50
|
-
"X-Fern-SDK-Version": "2.
|
|
51
|
-
"User-Agent": "@anduril-industries/lattice-sdk/2.
|
|
50
|
+
"X-Fern-SDK-Version": "2.4.0",
|
|
51
|
+
"User-Agent": "@anduril-industries/lattice-sdk/2.4.0",
|
|
52
52
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
53
53
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
54
54
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -11,7 +11,7 @@ export declare namespace Entities {
|
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
12
|
token?: core.Supplier<core.BearerToken | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
14
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
16
16
|
interface RequestOptions {
|
|
17
17
|
/** The maximum time to wait for a response in seconds. */
|
|
@@ -20,8 +20,10 @@ export declare namespace Entities {
|
|
|
20
20
|
maxRetries?: number;
|
|
21
21
|
/** A hook to abort the request. */
|
|
22
22
|
abortSignal?: AbortSignal;
|
|
23
|
+
/** Additional query string parameters to include in the request. */
|
|
24
|
+
queryParams?: Record<string, unknown>;
|
|
23
25
|
/** Additional headers to include in the request. */
|
|
24
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
26
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
25
27
|
}
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
@@ -82,11 +82,13 @@ class Entities {
|
|
|
82
82
|
__publishEntity(request, requestOptions) {
|
|
83
83
|
return __awaiter(this, void 0, void 0, function* () {
|
|
84
84
|
var _a, _b, _c;
|
|
85
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
85
86
|
const _response = yield core.fetcher({
|
|
86
|
-
url: core.url.join((
|
|
87
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/entities"),
|
|
87
88
|
method: "PUT",
|
|
88
|
-
headers:
|
|
89
|
+
headers: _headers,
|
|
89
90
|
contentType: "application/json",
|
|
91
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
90
92
|
requestType: "json",
|
|
91
93
|
body: request,
|
|
92
94
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -144,10 +146,12 @@ class Entities {
|
|
|
144
146
|
__getEntity(entityId, requestOptions) {
|
|
145
147
|
return __awaiter(this, void 0, void 0, function* () {
|
|
146
148
|
var _a, _b, _c;
|
|
149
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
147
150
|
const _response = yield core.fetcher({
|
|
148
|
-
url: core.url.join((
|
|
151
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/entities/${encodeURIComponent(entityId)}`),
|
|
149
152
|
method: "GET",
|
|
150
|
-
headers:
|
|
153
|
+
headers: _headers,
|
|
154
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
151
155
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
152
156
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
153
157
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -215,11 +219,13 @@ class Entities {
|
|
|
215
219
|
__overrideEntity(entityId_1, fieldPath_1) {
|
|
216
220
|
return __awaiter(this, arguments, void 0, function* (entityId, fieldPath, request = {}, requestOptions) {
|
|
217
221
|
var _a, _b, _c;
|
|
222
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
218
223
|
const _response = yield core.fetcher({
|
|
219
|
-
url: core.url.join((
|
|
224
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/entities/${encodeURIComponent(entityId)}/override/${encodeURIComponent(fieldPath)}`),
|
|
220
225
|
method: "PUT",
|
|
221
|
-
headers:
|
|
226
|
+
headers: _headers,
|
|
222
227
|
contentType: "application/json",
|
|
228
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
223
229
|
requestType: "json",
|
|
224
230
|
body: request,
|
|
225
231
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -282,10 +288,12 @@ class Entities {
|
|
|
282
288
|
__removeEntityOverride(entityId, fieldPath, requestOptions) {
|
|
283
289
|
return __awaiter(this, void 0, void 0, function* () {
|
|
284
290
|
var _a, _b, _c;
|
|
291
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
285
292
|
const _response = yield core.fetcher({
|
|
286
|
-
url: core.url.join((
|
|
293
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/entities/${encodeURIComponent(entityId)}/override/${encodeURIComponent(fieldPath)}`),
|
|
287
294
|
method: "DELETE",
|
|
288
|
-
headers:
|
|
295
|
+
headers: _headers,
|
|
296
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
289
297
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
290
298
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
291
299
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -357,11 +365,13 @@ class Entities {
|
|
|
357
365
|
__longPollEntityEvents(request, requestOptions) {
|
|
358
366
|
return __awaiter(this, void 0, void 0, function* () {
|
|
359
367
|
var _a, _b, _c;
|
|
368
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
360
369
|
const _response = yield core.fetcher({
|
|
361
|
-
url: core.url.join((
|
|
370
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/entities/events"),
|
|
362
371
|
method: "POST",
|
|
363
|
-
headers:
|
|
372
|
+
headers: _headers,
|
|
364
373
|
contentType: "application/json",
|
|
374
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
365
375
|
requestType: "json",
|
|
366
376
|
body: request,
|
|
367
377
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -417,11 +427,13 @@ class Entities {
|
|
|
417
427
|
__streamEntities() {
|
|
418
428
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
419
429
|
var _a, _b, _c;
|
|
430
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
420
431
|
const _response = yield core.fetcher({
|
|
421
|
-
url: core.url.join((
|
|
432
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/entities/stream"),
|
|
422
433
|
method: "POST",
|
|
423
|
-
headers:
|
|
434
|
+
headers: _headers,
|
|
424
435
|
contentType: "application/json",
|
|
436
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
425
437
|
requestType: "json",
|
|
426
438
|
body: request,
|
|
427
439
|
responseType: "sse",
|
|
@@ -11,7 +11,7 @@ export declare namespace Objects {
|
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
12
|
token?: core.Supplier<core.BearerToken | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
14
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
16
16
|
interface RequestOptions {
|
|
17
17
|
/** The maximum time to wait for a response in seconds. */
|
|
@@ -20,8 +20,10 @@ export declare namespace Objects {
|
|
|
20
20
|
maxRetries?: number;
|
|
21
21
|
/** A hook to abort the request. */
|
|
22
22
|
abortSignal?: AbortSignal;
|
|
23
|
+
/** Additional query string parameters to include in the request. */
|
|
24
|
+
queryParams?: Record<string, unknown>;
|
|
23
25
|
/** Additional headers to include in the request. */
|
|
24
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
26
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
25
27
|
}
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
@@ -41,7 +43,12 @@ export declare class Objects {
|
|
|
41
43
|
* @throws {@link Lattice.InternalServerError}
|
|
42
44
|
*
|
|
43
45
|
* @example
|
|
44
|
-
* await client.objects.listObjects(
|
|
46
|
+
* await client.objects.listObjects({
|
|
47
|
+
* prefix: "prefix",
|
|
48
|
+
* sinceTimestamp: "2024-01-15T09:30:00Z",
|
|
49
|
+
* pageToken: "pageToken",
|
|
50
|
+
* allObjectsInMesh: true
|
|
51
|
+
* })
|
|
45
52
|
*/
|
|
46
53
|
listObjects(request?: Lattice.ListObjectsRequest, requestOptions?: Objects.RequestOptions): Promise<core.Page<Lattice.PathMetadata>>;
|
|
47
54
|
/**
|
|
@@ -69,7 +69,12 @@ class Objects {
|
|
|
69
69
|
* @throws {@link Lattice.InternalServerError}
|
|
70
70
|
*
|
|
71
71
|
* @example
|
|
72
|
-
* await client.objects.listObjects(
|
|
72
|
+
* await client.objects.listObjects({
|
|
73
|
+
* prefix: "prefix",
|
|
74
|
+
* sinceTimestamp: "2024-01-15T09:30:00Z",
|
|
75
|
+
* pageToken: "pageToken",
|
|
76
|
+
* allObjectsInMesh: true
|
|
77
|
+
* })
|
|
73
78
|
*/
|
|
74
79
|
listObjects() {
|
|
75
80
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
@@ -89,11 +94,12 @@ class Objects {
|
|
|
89
94
|
if (allObjectsInMesh != null) {
|
|
90
95
|
_queryParams["allObjectsInMesh"] = allObjectsInMesh.toString();
|
|
91
96
|
}
|
|
97
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
92
98
|
const _response = yield core.fetcher({
|
|
93
|
-
url: core.url.join((
|
|
99
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/objects"),
|
|
94
100
|
method: "GET",
|
|
95
|
-
headers:
|
|
96
|
-
queryParameters: _queryParams,
|
|
101
|
+
headers: _headers,
|
|
102
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
97
103
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
98
104
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
99
105
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -159,14 +165,17 @@ class Objects {
|
|
|
159
165
|
__getObject(objectPath_1) {
|
|
160
166
|
return __awaiter(this, arguments, void 0, function* (objectPath, request = {}, requestOptions) {
|
|
161
167
|
var _a, _b, _c;
|
|
162
|
-
const { "Accept-Encoding": acceptEncoding } = request;
|
|
168
|
+
const { "Accept-Encoding": acceptEncoding, Priority: priority } = request;
|
|
169
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
|
|
170
|
+
Authorization: yield this._getAuthorizationHeader(),
|
|
171
|
+
"Accept-Encoding": acceptEncoding != null ? acceptEncoding : undefined,
|
|
172
|
+
Priority: priority != null ? priority : undefined,
|
|
173
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
163
174
|
const _response = yield core.fetcher({
|
|
164
|
-
url: core.url.join((
|
|
175
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/objects/${encodeURIComponent(objectPath)}`),
|
|
165
176
|
method: "GET",
|
|
166
|
-
headers:
|
|
167
|
-
|
|
168
|
-
"Accept-Encoding": acceptEncoding != null ? acceptEncoding : undefined,
|
|
169
|
-
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
177
|
+
headers: _headers,
|
|
178
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
170
179
|
responseType: "binary-response",
|
|
171
180
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
172
181
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
@@ -230,11 +239,13 @@ class Objects {
|
|
|
230
239
|
return __awaiter(this, void 0, void 0, function* () {
|
|
231
240
|
var _a, _b, _c;
|
|
232
241
|
const _binaryUploadRequest = yield core.file.toBinaryUploadRequest(uploadable);
|
|
242
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), _binaryUploadRequest.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
233
243
|
const _response = yield core.fetcher({
|
|
234
|
-
url: core.url.join((
|
|
244
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/objects/${encodeURIComponent(objectPath)}`),
|
|
235
245
|
method: "POST",
|
|
236
|
-
headers:
|
|
246
|
+
headers: _headers,
|
|
237
247
|
contentType: "application/octet-stream",
|
|
248
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
238
249
|
requestType: "bytes",
|
|
239
250
|
duplex: "half",
|
|
240
251
|
body: _binaryUploadRequest.body,
|
|
@@ -302,10 +313,12 @@ class Objects {
|
|
|
302
313
|
__deleteObject(objectPath, requestOptions) {
|
|
303
314
|
return __awaiter(this, void 0, void 0, function* () {
|
|
304
315
|
var _a, _b, _c;
|
|
316
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
305
317
|
const _response = yield core.fetcher({
|
|
306
|
-
url: core.url.join((
|
|
318
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/objects/${encodeURIComponent(objectPath)}`),
|
|
307
319
|
method: "DELETE",
|
|
308
|
-
headers:
|
|
320
|
+
headers: _headers,
|
|
321
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
309
322
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
310
323
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
311
324
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -367,10 +380,12 @@ class Objects {
|
|
|
367
380
|
__getObjectMetadata(objectPath, requestOptions) {
|
|
368
381
|
return __awaiter(this, void 0, void 0, function* () {
|
|
369
382
|
var _a, _b, _c;
|
|
383
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
370
384
|
const _response = yield core.fetcher({
|
|
371
|
-
url: core.url.join((
|
|
385
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/objects/${encodeURIComponent(objectPath)}`),
|
|
372
386
|
method: "HEAD",
|
|
373
|
-
headers:
|
|
387
|
+
headers: _headers,
|
|
388
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
374
389
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
375
390
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
376
391
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -2,9 +2,13 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Lattice from "../../../../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {}
|
|
8
|
+
*/
|
|
5
9
|
export interface GetObjectRequest {
|
|
6
|
-
/**
|
|
7
|
-
* If set, Lattice will compress the response using the specified compression method. If the header is not defined, or the compression method is set to `identity`, no compression will be applied to the response.
|
|
8
|
-
*/
|
|
10
|
+
/** If set, Lattice will compress the response using the specified compression method. If the header is not defined, or the compression method is set to `identity`, no compression will be applied to the response. */
|
|
9
11
|
"Accept-Encoding"?: Lattice.GetObjectRequestAcceptEncoding;
|
|
12
|
+
/** Indicates a client's preference for the priority of the response. The value is a structured header as defined in RFC 9218. If you do not set the header, Lattice uses the default priority set for the environment. Incremental delivery directives are not supported and will be ignored. */
|
|
13
|
+
Priority?: string;
|
|
10
14
|
}
|
|
@@ -3,23 +3,20 @@
|
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
|
-
* {
|
|
6
|
+
* {
|
|
7
|
+
* prefix: "prefix",
|
|
8
|
+
* sinceTimestamp: "2024-01-15T09:30:00Z",
|
|
9
|
+
* pageToken: "pageToken",
|
|
10
|
+
* allObjectsInMesh: true
|
|
11
|
+
* }
|
|
7
12
|
*/
|
|
8
13
|
export interface ListObjectsRequest {
|
|
9
|
-
/**
|
|
10
|
-
* Filters the objects based on the specified prefix path. If no path is specified, all objects are returned.
|
|
11
|
-
*/
|
|
14
|
+
/** Filters the objects based on the specified prefix path. If no path is specified, all objects are returned. */
|
|
12
15
|
prefix?: string;
|
|
13
|
-
/**
|
|
14
|
-
* Sets the age for the oldest objects to query across the environment.
|
|
15
|
-
*/
|
|
16
|
+
/** Sets the age for the oldest objects to query across the environment. */
|
|
16
17
|
sinceTimestamp?: string;
|
|
17
|
-
/**
|
|
18
|
-
* Base64 and URL-encoded cursor returned by the service to continue paging.
|
|
19
|
-
*/
|
|
18
|
+
/** Base64 and URL-encoded cursor returned by the service to continue paging. */
|
|
20
19
|
pageToken?: string;
|
|
21
|
-
/**
|
|
22
|
-
* Lists objects across all environment nodes in a Lattice Mesh.
|
|
23
|
-
*/
|
|
20
|
+
/** Lists objects across all environment nodes in a Lattice Mesh. */
|
|
24
21
|
allObjectsInMesh?: boolean;
|
|
25
22
|
}
|
|
@@ -11,7 +11,7 @@ export declare namespace Tasks {
|
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
12
|
token?: core.Supplier<core.BearerToken | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
14
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
16
16
|
interface RequestOptions {
|
|
17
17
|
/** The maximum time to wait for a response in seconds. */
|
|
@@ -20,8 +20,10 @@ export declare namespace Tasks {
|
|
|
20
20
|
maxRetries?: number;
|
|
21
21
|
/** A hook to abort the request. */
|
|
22
22
|
abortSignal?: AbortSignal;
|
|
23
|
+
/** Additional query string parameters to include in the request. */
|
|
24
|
+
queryParams?: Record<string, unknown>;
|
|
23
25
|
/** Additional headers to include in the request. */
|
|
24
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
26
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
25
27
|
}
|
|
26
28
|
}
|
|
27
29
|
/**
|
|
@@ -77,11 +77,13 @@ class Tasks {
|
|
|
77
77
|
__createTask() {
|
|
78
78
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
79
79
|
var _a, _b, _c;
|
|
80
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
80
81
|
const _response = yield core.fetcher({
|
|
81
|
-
url: core.url.join((
|
|
82
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/tasks"),
|
|
82
83
|
method: "POST",
|
|
83
|
-
headers:
|
|
84
|
+
headers: _headers,
|
|
84
85
|
contentType: "application/json",
|
|
86
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
85
87
|
requestType: "json",
|
|
86
88
|
body: request,
|
|
87
89
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -139,10 +141,12 @@ class Tasks {
|
|
|
139
141
|
__getTask(taskId, requestOptions) {
|
|
140
142
|
return __awaiter(this, void 0, void 0, function* () {
|
|
141
143
|
var _a, _b, _c;
|
|
144
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
142
145
|
const _response = yield core.fetcher({
|
|
143
|
-
url: core.url.join((
|
|
146
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/tasks/${encodeURIComponent(taskId)}`),
|
|
144
147
|
method: "GET",
|
|
145
|
-
headers:
|
|
148
|
+
headers: _headers,
|
|
149
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
146
150
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
147
151
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
148
152
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -203,11 +207,13 @@ class Tasks {
|
|
|
203
207
|
__updateTaskStatus(taskId_1) {
|
|
204
208
|
return __awaiter(this, arguments, void 0, function* (taskId, request = {}, requestOptions) {
|
|
205
209
|
var _a, _b, _c;
|
|
210
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
206
211
|
const _response = yield core.fetcher({
|
|
207
|
-
url: core.url.join((
|
|
212
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, `api/v1/tasks/${encodeURIComponent(taskId)}/status`),
|
|
208
213
|
method: "PUT",
|
|
209
|
-
headers:
|
|
214
|
+
headers: _headers,
|
|
210
215
|
contentType: "application/json",
|
|
216
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
211
217
|
requestType: "json",
|
|
212
218
|
body: request,
|
|
213
219
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -269,11 +275,13 @@ class Tasks {
|
|
|
269
275
|
__queryTasks() {
|
|
270
276
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
271
277
|
var _a, _b, _c;
|
|
278
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
272
279
|
const _response = yield core.fetcher({
|
|
273
|
-
url: core.url.join((
|
|
280
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/tasks/query"),
|
|
274
281
|
method: "POST",
|
|
275
|
-
headers:
|
|
282
|
+
headers: _headers,
|
|
276
283
|
contentType: "application/json",
|
|
284
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
277
285
|
requestType: "json",
|
|
278
286
|
body: request,
|
|
279
287
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -336,11 +344,13 @@ class Tasks {
|
|
|
336
344
|
__listenAsAgent() {
|
|
337
345
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
338
346
|
var _a, _b, _c;
|
|
347
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
339
348
|
const _response = yield core.fetcher({
|
|
340
|
-
url: core.url.join((
|
|
349
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.LatticeEnvironment.Default, "api/v1/agent/listen"),
|
|
341
350
|
method: "POST",
|
|
342
|
-
headers:
|
|
351
|
+
headers: _headers,
|
|
343
352
|
contentType: "application/json",
|
|
353
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
344
354
|
requestType: "json",
|
|
345
355
|
body: request,
|
|
346
356
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -116,6 +116,8 @@ export * from "./MeanKeplerianElements.js";
|
|
|
116
116
|
export * from "./TleParameters.js";
|
|
117
117
|
export * from "./OrbitMeanElements.js";
|
|
118
118
|
export * from "./Orbit.js";
|
|
119
|
+
export * from "./MilStd2525C.js";
|
|
120
|
+
export * from "./Symbology.js";
|
|
119
121
|
export * from "./TaskQueryResults.js";
|
|
120
122
|
export * from "./EntityIdsSelector.js";
|
|
121
123
|
export * from "./AgentRequest.js";
|
|
@@ -132,6 +132,8 @@ __exportStar(require("./MeanKeplerianElements.js"), exports);
|
|
|
132
132
|
__exportStar(require("./TleParameters.js"), exports);
|
|
133
133
|
__exportStar(require("./OrbitMeanElements.js"), exports);
|
|
134
134
|
__exportStar(require("./Orbit.js"), exports);
|
|
135
|
+
__exportStar(require("./MilStd2525C.js"), exports);
|
|
136
|
+
__exportStar(require("./Symbology.js"), exports);
|
|
135
137
|
__exportStar(require("./TaskQueryResults.js"), exports);
|
|
136
138
|
__exportStar(require("./EntityIdsSelector.js"), exports);
|
|
137
139
|
__exportStar(require("./AgentRequest.js"), exports);
|