@hello.nrfcloud.com/nrfcloud-api-helpers 1.2.1 → 1.3.1

package/dist/api/bulkOps.d.ts

@@ -0,0 +1,17 @@
+import { type Static } from '@sinclair/typebox';
+import { ValidationError } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Bulk-Ops-Requests/operation/FetchBulkOpsRequest
+ */
+export declare const BulkOpsRequestType: import("@sinclair/typebox").TObject<{
+    bulkOpsRequestId: import("@sinclair/typebox").TString;
+    status: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"PENDING">, import("@sinclair/typebox").TLiteral<"IN_PROGRESS">, import("@sinclair/typebox").TLiteral<"FAILED">, import("@sinclair/typebox").TLiteral<"SUCCEEDED">]>;
+}>;
+export declare const bulkOpsRequests: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => (bulkOpsId: string) => Promise<{
+    error: Error | ValidationError;
+} | {
+    result: Static<typeof BulkOpsRequestType>;
+}>;

package/dist/api/bulkOps.js

@@ -0,0 +1,20 @@
+import { Type } from '@sinclair/typebox';
+import { ValidationError, validatedFetch } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Bulk-Ops-Requests/operation/FetchBulkOpsRequest
+ */
+export const BulkOpsRequestType = Type.Object({
+    bulkOpsRequestId: Type.String(), // e.g. '01EZZJVDQJPWT7V4FWNVDHNMM5'
+    status: Type.Union([
+        Type.Literal('PENDING'),
+        Type.Literal('IN_PROGRESS'),
+        Type.Literal('FAILED'),
+        Type.Literal('SUCCEEDED'),
+    ]),
+});
+export const bulkOpsRequests = ({ apiKey, endpoint, }, fetchImplementation) => async (bulkOpsId) => {
+    const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation);
+    return vf({
+        resource: `bulk-ops-requests/${encodeURIComponent(bulkOpsId)}`,
+    }, BulkOpsRequestType);
+};

package/dist/api/groundFix.d.ts

@@ -0,0 +1,25 @@
+import { type Static } from '@sinclair/typebox';
+import { ValidationError } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Ground-Fix
+ */
+export declare const GroundFixType: import("@sinclair/typebox").TObject<{
+    lat: import("@sinclair/typebox").TNumber;
+    lon: import("@sinclair/typebox").TNumber;
+    uncertainty: import("@sinclair/typebox").TNumber;
+    fulfilledWith: import("@sinclair/typebox").TLiteral<"SCELL">;
+}>;
+export declare const groundFix: ({ apiKey, endpoint, }: {
+    apiKey: string;
+    endpoint: URL;
+}, fetchImplementation?: typeof fetch) => (cell: {
+    mcc: string;
+    mnc: string;
+    eci: number;
+    tac: number;
+    rsrp: number;
+}) => Promise<{
+    error: Error | ValidationError;
+} | {
+    result: Static<typeof GroundFixType>;
+}>;

package/dist/api/groundFix.js

@@ -0,0 +1,21 @@
+import { accuracy as TAccuracy, lat as TLat, lng as TLng, } from '@hello.nrfcloud.com/proto/hello';
+import { Type } from '@sinclair/typebox';
+import { JSONPayload, ValidationError, validatedFetch, } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Ground-Fix
+ */
+export const GroundFixType = Type.Object({
+    lat: TLat, // 63.41999531
+    lon: TLng, // 10.42999506
+    uncertainty: TAccuracy, // 2420
+    fulfilledWith: Type.Literal('SCELL'),
+});
+export const groundFix = ({ apiKey, endpoint, }, fetchImplementation) => async (cell) => {
+    const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation);
+    return vf({
+        resource: 'location/ground-fix',
+        payload: JSONPayload({
+            lte: [cell],
+        }),
+    }, GroundFixType);
+};

package/dist/api/index.d.ts

@@ -8,3 +8,6 @@ export * from './deleteAccountDevice.js';
 export * from './getDeviceShadow.js';
 export * from './DeviceShadow.js';
 export * from './updateDeviceShadow.js';
+export * from './serviceToken.js';
+export * from './groundFix.js';
+export * from './bulkOps.js';

package/dist/api/index.js

@@ -8,3 +8,6 @@ export * from './deleteAccountDevice.js';
 export * from './getDeviceShadow.js';
 export * from './DeviceShadow.js';
 export * from './updateDeviceShadow.js';
+export * from './serviceToken.js';
+export * from './groundFix.js';
+export * from './bulkOps.js';

package/dist/api/serviceToken.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Account/operation/GetServiceToken
+ */
+export declare const ServiceToken: import("@sinclair/typebox").TObject<{
+    token: import("@sinclair/typebox").TString;
+}>;
+export declare const serviceToken: (fetchImplementation?: typeof fetch, onError?: (error: Error) => void) => ((args: {
+    apiEndpoint: URL;
+    apiKey: string;
+}) => Promise<string>);

package/dist/api/serviceToken.js

@@ -0,0 +1,17 @@
+import { Type } from '@sinclair/typebox';
+import { validatedFetch } from './validatedFetch.js';
+/**
+ * @link https://api.nrfcloud.com/v1/#tag/Account/operation/GetServiceToken
+ */
+export const ServiceToken = Type.Object({
+    token: Type.String(),
+});
+export const serviceToken = (fetchImplementation, onError) => async ({ apiEndpoint, apiKey }) => {
+    const vf = validatedFetch({ endpoint: apiEndpoint, apiKey }, fetchImplementation);
+    const maybeResult = await vf({ resource: 'account/service-token' }, ServiceToken);
+    if ('error' in maybeResult) {
+        onError?.(maybeResult.error);
+        throw maybeResult.error;
+    }
+    return maybeResult.result.token;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hello.nrfcloud.com/nrfcloud-api-helpers",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Helper functions for integrating nRF Cloud APIs in AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {