@cra-risk-management/sdk 1.0.0 → 1.0.1

package/dist/client.d.ts

@@ -0,0 +1,124 @@
+export = Client;
+declare class Client {
+    /**
+     * @param {Object} options
+     * @param {string} options.baseURL
+     * @param {number} [options.timeout]
+     * @param {string} [options.username]
+     * @param {string} [options.password]
+     * @param {string} [options.authEndpoint]
+     * @param {number} [options.maxRetries]
+     */
+    constructor(options?: {
+        baseURL: string;
+        timeout?: number | undefined;
+        username?: string | undefined;
+        password?: string | undefined;
+        authEndpoint?: string | undefined;
+        maxRetries?: number | undefined;
+    });
+    baseURL: string;
+    authEndpoint: string;
+    timeout: number;
+    maxRetries: number;
+    username: string | null;
+    password: string | null;
+    token: any;
+    tokenExpiry: number | null;
+    defaultHeaders: {
+        "Content-Type": string;
+    };
+    municipalities: MunicipalitiesClient;
+    criticalPoints: CriticalPointsClient;
+    users: UsersClient;
+    /**
+     * Authenticate
+     * @returns {Promise<string>} Access Token
+     */
+    authenticate(): Promise<string>;
+    /**
+     * Check if token is valid.
+     * @returns {boolean}
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Ensures client is authenticated.
+     * @private
+     */
+    private ensureAuthenticated;
+    /**
+     * HTTP request
+     * @private
+     */
+    private _request;
+    /**
+     * Create structured error
+     * @private
+     */
+    private _createError;
+    /**
+     * Check if error is retryable
+     * @private
+     */
+    private _isRetryableError;
+    /**
+     * Delay helper for retry backoff
+     * @private
+     */
+    private _delay;
+    /**
+     * Login with username and password
+     * @param {string} username
+     * @param {string} password
+     * @returns {Promise<string>} Access token
+     */
+    login(username: string, password: string): Promise<string>;
+    /**
+     * Logout (clear credentials and token)
+     */
+    logout(): void;
+    /**
+     * Set credentials without authenticating
+     * @param {string} username
+     * @param {string} password
+     */
+    setCredentials(username: string, password: string): void;
+    /**
+     * Set token directly (if you already have one)
+     * @param {string} token
+     * @param {number} [expiresIn] - Expiry in seconds
+     */
+    setToken(token: string, expiresIn?: number): void;
+    /**
+     * GET request
+     * @param {string} endpoint
+     * @param {Object} [params]
+     */
+    get(endpoint: string, params?: Object): Promise<any>;
+    /**
+     * POST request
+     * @param {string} endpoint
+     * @param {Object} [params]
+     */
+    post(endpoint: string, data: any): Promise<any>;
+    /**
+     * PATCH request
+     * @param {string} endpoint
+     * @param {Object} data
+     */
+    patch(endpoint: string, data: Object): Promise<any>;
+    /**
+     * DELETE request
+     * @param {string} endpoint
+     */
+    delete(endpoint: string): Promise<any>;
+    /**
+     * Special request to confirm data
+     * @param {string} endpoint
+     * @param {number} id
+     */
+    confirm(endpoint: string, id: number): Promise<any>;
+}
+import MunicipalitiesClient = require("../src/resources/municipalities");
+import CriticalPointsClient = require("../src/resources/criticalPoints");
+import UsersClient = require("../src/resources/users");

package/dist/models/criticalPoints.d.ts

@@ -0,0 +1,34 @@
+type CriticalPointCreate = {
+    description: string;
+    municipality_id: number;
+    event_type_id: number;
+    event_zone_id: number;
+    user_id?: number | undefined;
+    image_id?: string | undefined;
+    datetime?: Date | undefined;
+    confirmed?: number | undefined;
+    geometry: string;
+};
+type CriticalPoint = {
+    id: number;
+    description: string;
+    municipality_id: number;
+    event_type_id: number;
+    event_zone_id: number;
+    user_id: number;
+    image_id: string;
+    datetime: Date;
+    confirmed: number;
+    geometry: string;
+};
+type CriticalPointUpdate = {
+    description?: string | undefined;
+    municipality_id?: number | undefined;
+    event_type_id?: number | undefined;
+    event_zone_id?: number | undefined;
+    user_id?: number | undefined;
+    image_id?: string | undefined;
+    datetime?: Date | undefined;
+    confirmed?: number | undefined;
+    geometry?: string | undefined;
+};

package/dist/models/eventTypes.d.ts

@@ -0,0 +1,16 @@
+export type EventTypeCreate = {
+    event_type: string;
+    icon: string;
+    color: string;
+};
+export type EventType = {
+    id: number;
+    event_type: string;
+    icon: string;
+    color: string;
+};
+export type EventTypeUpdate = {
+    event_type?: string | undefined;
+    icon?: string | undefined;
+    color?: string | undefined;
+};

package/dist/models/eventZones.d.ts

@@ -0,0 +1,16 @@
+export type EventZoneCreate = {
+    event_zone: string;
+    icon: string;
+    color: string;
+};
+export type EventZone = {
+    id: number;
+    event_zone: string;
+    icon: string;
+    color: string;
+};
+export type EventZoneUpdate = {
+    event_zone?: string | undefined;
+    icon?: string | undefined;
+    color?: string | undefined;
+};

package/dist/models/municipalities.d.ts

@@ -0,0 +1,13 @@
+export type MunicipalityCreate = {
+    name: string;
+    geometry: string;
+};
+export type Municipality = {
+    id: number;
+    name: string;
+    geometry: string;
+};
+export type MunicipalityUpdate = {
+    name?: string | undefined;
+    geometry?: string | undefined;
+};

package/dist/models/observations.d.ts

@@ -0,0 +1,22 @@
+export type ObservationCreate = {
+    information: string;
+    critical_point_id: string;
+    image_id?: string | undefined;
+    datetime?: Date | undefined;
+    confirmed?: number | undefined;
+};
+export type Observation = {
+    id: number;
+    information: string;
+    critical_point_id: string;
+    image_id: string;
+    datetime: Date;
+    confirmed: number;
+};
+export type ObservationUpdate = {
+    information?: string | undefined;
+    critical_point_id?: string | undefined;
+    image_id?: string | undefined;
+    datetime?: Date | undefined;
+    confirmed?: number | undefined;
+};

package/dist/models/users.d.ts

@@ -0,0 +1,3 @@
+export type UserCreate = any;
+export type User = any;
+export type UserUpdate = any;

package/dist/resources/criticalPoints.d.ts

@@ -0,0 +1,176 @@
+export = CriticalPoints;
+declare class CriticalPoints {
+    constructor(client: any);
+    client: any;
+    endpoint: string;
+    attributes: CriticalPointAttributes;
+    /**
+     * List all critical points.
+     * @param {Object} [params]
+     * @param {number} [params.event_type_id]
+     * @param {number} [params.event_zone_id]
+     * @param {number} [params.municipality_id]
+     * @param {number} [params.user_id]
+     * @param {boolean} [params.confirmed]
+     * @param {Date} [params.from_datetime]
+     * @param {Date} [params.to_datetime]
+     * @returns {Promise<import("../models/criticalPoints").CriticalPoint[]>}
+     */
+    list(params?: {
+        event_type_id?: number | undefined;
+        event_zone_id?: number | undefined;
+        municipality_id?: number | undefined;
+        user_id?: number | undefined;
+        confirmed?: boolean | undefined;
+        from_datetime?: Date | undefined;
+        to_datetime?: Date | undefined;
+    }): Promise<any[]>;
+    /**
+     * Get one critical point by its ID.
+     * @param {number} id
+     * @param {Object} params
+     * @returns {Promise<import("../models/criticalPoints").CriticalPoint>}
+     */
+    get(id: number, params?: Object): Promise<any>;
+    /**
+     * Create a critical point instance.
+     * @param {import("../models/criticalPoints").CriticalPointCreate} data
+     * @returns {Promise<import("../models/criticalPoints").CriticalPoint>}
+     */
+    create(data: any): Promise<any>;
+    /**
+     * Patch critical point.
+     * @param {number} id
+     * @param {import("../models/criticalPoints").CriticalPointUpdate} data
+     * @returns {Promise<import("../models/criticalPoints").CriticalPoint>}
+     */
+    update(id: number, data: any): Promise<any>;
+    /**
+     * Delete a critical point.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}
+declare class CriticalPointAttributes {
+    constructor(client: any);
+    client: any;
+    endpoint: string;
+    eventZones: EventZoneAttribute;
+    eventTypes: EventTypeAttribute;
+    observations: ObservationAttribute;
+}
+declare class EventZoneAttribute {
+    constructor(client: any, parentEndpoint: any);
+    client: any;
+    endpoint: string;
+    /**
+     * Get all event zones.
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/eventZones").EventZone[]>}
+     */
+    list(params?: Object): Promise<import("../models/eventZones").EventZone[]>;
+    /**
+     * Get one event zone by its ID.
+     * @param {number} id
+     * @param {object} [params]
+     * @returns {Promise<import("../models/eventZones").EventZone>}
+     */
+    get(id: number, params?: object): Promise<import("../models/eventZones").EventZone>;
+    /**
+     * Create an event zone instance.
+     * @param {import("../models/eventZones").EventZoneCreate} data
+     * @returns {Promise<import("../models/eventZones").EventZone>}
+     */
+    create(data: import("../models/eventZones").EventZoneCreate): Promise<import("../models/eventZones").EventZone>;
+    /**
+     * Update event zone.
+     * @param {number} id
+     * @param {import("../models/eventZones").EventZoneUpdate} data
+     * @returns {Promise<import("../models/eventZones").EventZone>}
+     */
+    update(id: number, data: import("../models/eventZones").EventZoneUpdate): Promise<import("../models/eventZones").EventZone>;
+    /**
+     * Delete event zone by ID.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}
+declare class EventTypeAttribute {
+    constructor(client: any, parentEndpoint: any);
+    client: any;
+    endpoint: string;
+    /**
+     * List all event types.
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/eventTypes").EventType[]>}
+     */
+    list(params?: Object): Promise<import("../models/eventTypes").EventType[]>;
+    /**
+     * Get one event type by its ID.
+     * @param {number} id
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/eventTypes").EventType>}
+     */
+    get(id: number, params?: Object): Promise<import("../models/eventTypes").EventType>;
+    /**
+     * Create event type instance.
+     * @param {import("../models/eventTypes").EventTypeCreate} data
+     * @returns {Promise<import("../models/eventTypes").EventType>}
+     */
+    create(data: import("../models/eventTypes").EventTypeCreate): Promise<import("../models/eventTypes").EventType>;
+    /**
+     * Update event type.
+     * @param {number} id
+     * @param {import("../models/eventTypes").EventTypeUpdate} data
+     * @returns {Promise<import("../models/eventTypes").EventType>}
+     */
+    update(id: number, data: import("../models/eventTypes").EventTypeUpdate): Promise<import("../models/eventTypes").EventType>;
+    /**
+     * Delete event type instance.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}
+declare class ObservationAttribute {
+    constructor(client: any, parentEndpoint: any);
+    client: any;
+    endpoint: string;
+    /**
+     * List observations.
+     * @param {Object} [params]
+     * @param {number} [params.critical_point_id]
+     * @returns {Promise<import("../models/observations").Observation[]>}
+     */
+    list(params?: {
+        critical_point_id?: number | undefined;
+    }): Promise<import("../models/observations").Observation[]>;
+    /**
+     * Get one observation by ID.
+     * @param {number} id
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/observations").Observation>}
+     */
+    get(id: number, params?: Object): Promise<import("../models/observations").Observation>;
+    /**
+     * Create observation instance.
+     * @param {import("../models/observations").ObservationCreate} data
+     * @returns {Promise<import("../models/observations").Observation>}
+     */
+    create(data: import("../models/observations").ObservationCreate): Promise<import("../models/observations").Observation>;
+    /**
+     * Update observation instance.
+     * @param {number} id
+     * @param {import("../models/observations").ObservationUpdate} data
+     * @returns {Promise<import("../models/observations").Observation>}
+     */
+    update(id: number, data: import("../models/observations").ObservationUpdate): Promise<import("../models/observations").Observation>;
+    /**
+     * Delete observation.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}

package/dist/resources/municipalities.d.ts

@@ -0,0 +1,41 @@
+export = Municipalities;
+declare class Municipalities {
+    /**
+     * @param {import("../client")} client
+     */
+    constructor(client: import("../client"));
+    client: import("../client");
+    endpoint: string;
+    /**
+     * List all municipalities.
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/municipalities").Municipality[]>}
+     */
+    list(params?: Object): Promise<import("../models/municipalities").Municipality[]>;
+    /**
+     * Get a municipality instance by id.
+     * @param {number} id
+     * @param {Object} [params]
+     * @returns {Promise<import("../models/municipalities").Municipality>}
+     */
+    get(id: number, params?: Object): Promise<import("../models/municipalities").Municipality>;
+    /**
+     * Create a municipality instance.
+     * @param {import("../models/municipalities").MunicipalityCreate} data
+     * @returns {Promise<import("../models/municipalities").Municipality>}
+     */
+    create(data: import("../models/municipalities").MunicipalityCreate): Promise<import("../models/municipalities").Municipality>;
+    /**
+     * Update a municipality instance.
+     * @param {number} id
+     * @param {import("../models/municipalities").MunicipalityUpdate} data
+     * @returns {Promise<import("../models/municipalities").Municipality>}
+     */
+    update(id: number, data: import("../models/municipalities").MunicipalityUpdate): Promise<import("../models/municipalities").Municipality>;
+    /**
+     * Delete municipality instance.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}

package/dist/resources/users.d.ts

@@ -0,0 +1,41 @@
+export = Users;
+declare class Users {
+    /**
+     * @param {import("../client")} client
+     */
+    constructor(client: import("../client"));
+    client: import("../client");
+    endpoint: string;
+    /**
+     * Get all Users.
+     * @param {Object} params
+     * @returns {Promise<import("../models/users").User[]>}
+     */
+    list(params?: Object): Promise<import("../models/users").User[]>;
+    /**
+     * Get one User by ID.
+     * @param {number} id
+     * @param {Object} params
+     * @returns {Promise<import("../models/users").User>}
+     */
+    get(id: number, params?: Object): Promise<import("../models/users").User>;
+    /**
+     * Create an User instance
+     * @param {import("../models/users").UserCreate} data
+     * @returns {Promise<import("../models/users").User>}
+     */
+    create(data: import("../models/users").UserCreate): Promise<import("../models/users").User>;
+    /**
+     * Update User instance.
+     * @param {number} id
+     * @param {import("../models/users").UserUpdate} data
+     * @returns {Promise<import("../models/users").User}
+     */
+    update(id: number, data: import("../models/users").UserUpdate): Promise<import("../models/users").User>;
+    /**
+     * Delete user instance.
+     * @param {number} id
+     * @returns {Promise<void>}
+     */
+    delete(id: number): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cra-risk-management/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Software Development Kit for JS apps - CRA Risk Management API Client",
   "main": "src/client.js",
   "keywords": [
@@ -20,8 +20,12 @@
     "url": "https://github.com/CRA-Risk-Management/sdk-js/issues"
   },
   "homepage": "https://github.com/CRA-Risk-Management/sdk-js#readme",
+  "scripts": {
+    "build:types": "tsc"
+  },
   "files": [
     "src/",
+    "dist/",
     "LICENSE",
     "README.md",
     "CHANGELOG.md"
@@ -33,6 +37,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "node-fetch": "^2.7.0"
+    "node-fetch": "^2.7.0",
+    "typescript": "^5.9.3"
   }
 }

package/src/resources/criticalPoints.js

@@ -79,7 +79,7 @@ class EventZoneAttribute {
   /**
    * Get all event zones.
    * @param {Object} [params] 
-   * @returns {promise<import("../models/eventZones").EventZone[]>}
+   * @returns {Promise<import("../models/eventZones").EventZone[]>}
    */
   async list(params = {}) {
     return this.client.get(`${this.endpoint}/items`, params);