@space-df/sdk 0.0.1-dev.36 → 0.0.1-dev.38

package/dist/src/index.ts

@@ -8,10 +8,6 @@ export interface ClientOptions {
      * Defaults to process.env['SPACEDF_ORG_ID'].
      */
     organization?: string | null | undefined;
-    /**
-     * Defaults to process.env['SPACEDF_API_KEY'].
-     */
-    APIKey?: string | undefined;
     /**
      * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
      *
@@ -96,7 +92,6 @@ export class SpaceDFSDK extends Core.APIClient {
      * API Client for interfacing with the Spacedf SDK API.
      *
      * @param {string | null | undefined} [opts.organization=process.env['SPACEDF_ORG_ID'] ?? null]
-     * @param {string | undefined} [opts.APIKey=process.env['SPACEDF_API_KEY']]
      * @param {string} [opts.baseURL=process.env['SPACEDF_SDK_BASE_URL'] ?? https://api.v0.spacedf.net/] - Override the default base URL for the API.
      * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
      * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -109,19 +104,16 @@ export class SpaceDFSDK extends Core.APIClient {
     constructor({
         baseURL = Core.readEnv('SPACEDF_SDK_BASE_URL'),
         organization = Core.readEnv('SPACEDF_ORG_ID') ?? null,
-        APIKey = Core.readEnv('SPACEDF_API_KEY'),
         allowMultiOrgs = false,
         ...opts
     }: ClientOptions = {}) {
         const options: ClientOptions = {
             organization,
-            APIKey,
             baseURL,
             ...opts,
         };
 
         super({
-            APIKey: options.APIKey,
             baseURL: options.baseURL!,
             timeout: options.timeout ?? 60 * 1000 /* 1 minute */,
             httpAgent: options.httpAgent,
@@ -131,7 +123,6 @@ export class SpaceDFSDK extends Core.APIClient {
         });
 
         this._options = options;
-        this.APIKey = APIKey;
         this.organization = organization;
     }
 
@@ -171,9 +162,8 @@ export class SpaceDFSDK extends Core.APIClient {
     protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
         const accessToken = (this.allowMultiOrgs && opts.accessToken) || this.accessToken || '';
         const Authorization = `Bearer ${accessToken}`;
-        const APIKey = (this.allowMultiOrgs && opts.APIKey) || this.APIKey;
 
-        return accessToken ? { Authorization, 'x-api-key': APIKey } : { 'x-api-key': APIKey };
+        return accessToken ? { Authorization } : {};
     }
 
     public setAccessToken(token: string | null): void {

package/dist/src/resources/telemetry/geofences.ts

@@ -0,0 +1,91 @@
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { ListParamsResponse, ListResponse } from '../../types/api';
+
+type Condition =
+    | { time_between: { start: string; end: string } }
+    | { weekday_in: number[] }
+    | { distance_from_geofence_km: { lte: number } }
+    | { and: Condition[] }
+    | { or: Condition[] }
+    | { not: Condition[] };
+
+type Coordinate = [number, number];
+
+type PolygonGeometry = {
+    type: 'Polygon';
+    coordinates: Coordinate[][][];
+};
+
+type FeatureProperties = {
+    mode: 'rectangle' | 'angled-rectangle' | string;
+    color: string;
+};
+
+interface Feature {
+    type: 'Feature';
+    geometry: PolygonGeometry;
+    properties: FeatureProperties;
+    id: string;
+}
+
+export interface Geofence {
+    id: string;
+    name: string;
+    color: string;
+    type_zone: 'safe' | 'danger';
+    definition: {
+        conditions: {
+            and: Condition[];
+        };
+    };
+    geometry: Feature[];
+}
+
+export type GeofencesListResponse = ListResponse<Geofence>;
+
+export interface GeofencesListParams extends ListParamsResponse {
+    name?: string;
+}
+
+export class Geofences extends APIResource {
+    list(params: GeofencesListParams, options?: Core.RequestOptions): Core.APIPromise<GeofencesListResponse> {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/geofences`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+    create(params: Omit<Geofence, 'id'>, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        const { ...body } = params;
+        return this._client.post(`/telemetry/v1/geofences`, {
+            body,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        return this._client.get(`/telemetry/v1/geofences/${id}`, {
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    update(id: string, params: Omit<Geofence, 'id'>, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        const { ...body } = params;
+        return this._client.put(`/telemetry/v1/geofences/${id}`, {
+            body,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    delete(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+        return this._client.delete(`/telemetry/v1/geofences/${id}`, {
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}

package/dist/src/resources/telemetry/index.ts

@@ -1,10 +1,12 @@
 import { APIResource } from "../../resource";
 import { Entities } from './entities';
 import { Alerts } from './alerts';
+import { Geofences } from './geofences';
 
 export class Telemetry extends APIResource {
     entities: Entities = new Entities(this._client);
     alerts: Alerts = new Alerts(this._client);
+    geofences: Geofences = new Geofences(this._client);
 }
 
 export * from './entities';

package/dist/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.1-dev.36';
+export const VERSION = '0.0.1-dev.38';

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.1-dev.36";
+export declare const VERSION = "0.0.1-dev.38";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.1-dev.36';
+exports.VERSION = '0.0.1-dev.38';
 //# sourceMappingURL=version.js.map

package/dist/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.1-dev.36';
+export const VERSION = '0.0.1-dev.38';
 //# sourceMappingURL=version.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@space-df/sdk",
-  "version": "0.0.1-dev.36",
+  "version": "0.0.1-dev.38",
   "description": "The official TypeScript library for the Spacedf SDK API",
   "author": "Spacedf SDK <support@digitalfortress.dev>",
   "types": "dist/index.d.ts",

package/src/core.ts

@@ -128,7 +128,6 @@ export abstract class APIClient {
     timeout: number;
     httpAgent: Agent | undefined;
     allowMultiOrgs: boolean;
-    APIKey: string | undefined;
 
     private fetch: Fetch;
     protected idempotencyHeader?: string;
@@ -139,7 +138,6 @@ export abstract class APIClient {
         timeout = 60 * 1000, // 1 minute
         httpAgent,
         fetch: overriddenFetch,
-        APIKey,
         allowMultiOrgs = false,
     }: {
         baseURL: string;
@@ -147,14 +145,12 @@ export abstract class APIClient {
         timeout: number | undefined;
         httpAgent: Agent | undefined;
         fetch: Fetch | undefined;
-        APIKey: string | undefined;
         allowMultiOrgs: boolean;
     }) {
         this.baseURL = baseURL;
         this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
         this.timeout = validatePositiveInteger('timeout', timeout);
         this.httpAgent = httpAgent;
-        this.APIKey = APIKey;
         this.allowMultiOrgs = allowMultiOrgs;
 
         this.fetch = overriddenFetch ?? fetch;
@@ -684,7 +680,6 @@ export type RequestOptions<Req = unknown | Record<string, unknown> | Readable |
     idempotencyKey?: string;
     organization?: string;
     accessToken?: string;
-    APIKey?: string;
 
     __binaryRequest?: boolean | undefined;
     __binaryResponse?: boolean | undefined;
@@ -708,7 +703,6 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
     idempotencyKey: true,
     organization: true,
     accessToken: true,
-    APIKey: true,
 
     __binaryRequest: true,
     __binaryResponse: true,

package/src/index.ts

@@ -8,10 +8,6 @@ export interface ClientOptions {
      * Defaults to process.env['SPACEDF_ORG_ID'].
      */
     organization?: string | null | undefined;
-    /**
-     * Defaults to process.env['SPACEDF_API_KEY'].
-     */
-    APIKey?: string | undefined;
     /**
      * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
      *
@@ -96,7 +92,6 @@ export class SpaceDFSDK extends Core.APIClient {
      * API Client for interfacing with the Spacedf SDK API.
      *
      * @param {string | null | undefined} [opts.organization=process.env['SPACEDF_ORG_ID'] ?? null]
-     * @param {string | undefined} [opts.APIKey=process.env['SPACEDF_API_KEY']]
      * @param {string} [opts.baseURL=process.env['SPACEDF_SDK_BASE_URL'] ?? https://api.v0.spacedf.net/] - Override the default base URL for the API.
      * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
      * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -109,19 +104,16 @@ export class SpaceDFSDK extends Core.APIClient {
     constructor({
         baseURL = Core.readEnv('SPACEDF_SDK_BASE_URL'),
         organization = Core.readEnv('SPACEDF_ORG_ID') ?? null,
-        APIKey = Core.readEnv('SPACEDF_API_KEY'),
         allowMultiOrgs = false,
         ...opts
     }: ClientOptions = {}) {
         const options: ClientOptions = {
             organization,
-            APIKey,
             baseURL,
             ...opts,
         };
 
         super({
-            APIKey: options.APIKey,
             baseURL: options.baseURL!,
             timeout: options.timeout ?? 60 * 1000 /* 1 minute */,
             httpAgent: options.httpAgent,
@@ -131,7 +123,6 @@ export class SpaceDFSDK extends Core.APIClient {
         });
 
         this._options = options;
-        this.APIKey = APIKey;
         this.organization = organization;
     }
 
@@ -171,9 +162,8 @@ export class SpaceDFSDK extends Core.APIClient {
     protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
         const accessToken = (this.allowMultiOrgs && opts.accessToken) || this.accessToken || '';
         const Authorization = `Bearer ${accessToken}`;
-        const APIKey = (this.allowMultiOrgs && opts.APIKey) || this.APIKey;
 
-        return accessToken ? { Authorization, 'x-api-key': APIKey } : { 'x-api-key': APIKey };
+        return accessToken ? { Authorization } : {};
     }
 
     public setAccessToken(token: string | null): void {

package/src/resources/telemetry/geofences.ts

@@ -0,0 +1,91 @@
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { ListParamsResponse, ListResponse } from '../../types/api';
+
+type Condition =
+    | { time_between: { start: string; end: string } }
+    | { weekday_in: number[] }
+    | { distance_from_geofence_km: { lte: number } }
+    | { and: Condition[] }
+    | { or: Condition[] }
+    | { not: Condition[] };
+
+type Coordinate = [number, number];
+
+type PolygonGeometry = {
+    type: 'Polygon';
+    coordinates: Coordinate[][][];
+};
+
+type FeatureProperties = {
+    mode: 'rectangle' | 'angled-rectangle' | string;
+    color: string;
+};
+
+interface Feature {
+    type: 'Feature';
+    geometry: PolygonGeometry;
+    properties: FeatureProperties;
+    id: string;
+}
+
+export interface Geofence {
+    id: string;
+    name: string;
+    color: string;
+    type_zone: 'safe' | 'danger';
+    definition: {
+        conditions: {
+            and: Condition[];
+        };
+    };
+    geometry: Feature[];
+}
+
+export type GeofencesListResponse = ListResponse<Geofence>;
+
+export interface GeofencesListParams extends ListParamsResponse {
+    name?: string;
+}
+
+export class Geofences extends APIResource {
+    list(params: GeofencesListParams, options?: Core.RequestOptions): Core.APIPromise<GeofencesListResponse> {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/geofences`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+    create(params: Omit<Geofence, 'id'>, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        const { ...body } = params;
+        return this._client.post(`/telemetry/v1/geofences`, {
+            body,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        return this._client.get(`/telemetry/v1/geofences/${id}`, {
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    update(id: string, params: Omit<Geofence, 'id'>, options?: Core.RequestOptions): Core.APIPromise<Geofence> {
+        const { ...body } = params;
+        return this._client.put(`/telemetry/v1/geofences/${id}`, {
+            body,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+
+    delete(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+        return this._client.delete(`/telemetry/v1/geofences/${id}`, {
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}

package/src/resources/telemetry/index.ts

@@ -1,10 +1,12 @@
 import { APIResource } from '@space-df/sdk/resource';
 import { Entities } from './entities';
 import { Alerts } from './alerts';
+import { Geofences } from './geofences';
 
 export class Telemetry extends APIResource {
     entities: Entities = new Entities(this._client);
     alerts: Alerts = new Alerts(this._client);
+    geofences: Geofences = new Geofences(this._client);
 }
 
 export * from './entities';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.1-dev.36';
+export const VERSION = '0.0.1-dev.38';