@safercity/sdk 0.3.0 → 0.3.2

package/README.md

@@ -2,11 +2,36 @@
 
 Official SaferCity API client for TypeScript/JavaScript.
 
+## What's New in v0.3.2
+
+- **Proxy Mode Enhanced** - `ProxyModeConfig` now supports `tenantId`, `userId`, and custom `headers`. White-label apps can pass tenant context through the proxy without exposing credentials.
+- **Banner API Fix** - Fixed `banner.get()` parameter from `radius` to `days` to match the API schema.
+
+```tsx
+// New proxy mode with tenant support
+<SaferCityProvider
+  mode="proxy"
+  proxyBaseUrl="/api/safercity"
+  tenantId="tenant-123"        // Sent as X-Tenant-ID header
+  userId="user-456"            // For user-scoped operations
+  headers={{ 'X-App': 'my-app' }}
+>
+  <App />
+</SaferCityProvider>
+```
+
+## What's New in v0.3.1
+
+- **Simplified Return Types** - Domain methods now return the API response body directly instead of wrapping in `ApiResponse<T>`. For example, `client.health.check()` returns `Promise<{ status: string; timestamp: string }>` directly. No more `result.data.data.id` — just `result.data.id`.
+- **Strongly Typed Errors** - All SDK methods throw `SaferCityApiError` on non-2xx responses with typed `status`, `error`, `message`, and `details` fields. Error handling is unchanged from v0.3.0.
+- **Low-Level Access Preserved** - `client._client.get()` and `ServerClient.get()` still return the full `ApiResponse<T>` with `{ data, status, headers }` for cases where you need HTTP metadata.
+
 ## What's New in v0.3.0
 
 - **Typed SDK via OpenAPI Codegen** - All request/response types are now auto-generated from the API's OpenAPI spec using `@hey-api/openapi-ts`. This guarantees 1:1 type alignment between the SDK and API — no more manual type mismatches.
 - **Re-exported Generated Types** - All generated API types (request bodies, response shapes, error types) are re-exported from `@safercity/sdk` for direct use in your application.
 - **Correct Field Names** - Request bodies now use the exact API field names (`emailAddress` not `email`, `panicType` not `panicTypeId`, `phoneNumber` not `phone`).
+- **Simplified Return Types** - Domain methods now return the API response body directly instead of wrapping in `ApiResponse<T>`. Access `result.data.id` instead of `result.data.data.id`.
 - **Richer Response Types** - Response types now include the full API response structure (e.g., `{ success: boolean; data: {...}; message?: string }`).
 
 ## What's New in v0.2.0
@@ -93,22 +118,22 @@ const client = createSaferCityClient({
 });
 
 // Health check
-const { data: health } = await client.health.check();
+const health = await client.health.check();
 console.log('API Status:', health.status);
 
 // Get user (auto-resolves userId from client if not passed)
-const { data: user } = await client.users.get();
-console.log('User:', user);
+const user = await client.users.get();
+console.log('User:', user.data.firstName);
 
 // Create panic (userId is optional if set on client)
-const { data: panic } = await client.panics.create({
+const panic = await client.panics.create({
   userId: 'user-123',
   panicType: 'emergency',
   latitude: -26.2041,
   longitude: 28.0473,
 });
 
-console.log('Panic created:', panic.id);
+console.log('Panic created:', panic.data.id);
 ```
 
 ## Server Client
@@ -130,8 +155,8 @@ const client = createServerClient({
 
 // All requests are automatically authenticated with OAuth tokens
 // Tokens are refreshed automatically before expiration
-const { data: users } = await client.users.list(); // Admin only
-const { data: panic } = await client.panics.create({
+const users = await client.users.list(); // Admin only
+const panic = await client.panics.create({
   userId: 'user-123',
   panicType: 'emergency',
   latitude: -26.2041,

package/dist/index.cjs

@@ -49,7 +49,7 @@ function createSaferCityClient(options) {
       /**
        * Check API health status
        */
-      check: () => baseClient.get("/health")
+      check: () => baseClient.get("/health").then((r) => r.data)
     },
     // ==================
     // Authentication
@@ -58,11 +58,11 @@ function createSaferCityClient(options) {
       /**
        * Get current authentication context
        */
-      whoami: () => baseClient.get("/auth/whoami"),
+      whoami: () => baseClient.get("/auth/whoami").then((r) => r.data),
       /**
        * Check if authenticated (optional auth)
        */
-      check: () => baseClient.get("/auth/optional")
+      check: () => baseClient.get("/auth/optional").then((r) => r.data)
     },
     // ==================
     // Users (user-scoped)
@@ -71,15 +71,15 @@ function createSaferCityClient(options) {
       /**
        * Create user (used by tenant apps to register users)
        */
-      create: (body) => baseClient.post("/v1/users", body),
+      create: (body) => baseClient.post("/v1/users", body).then((r) => r.data),
       /**
        * Get user by ID
        */
-      get: (userId2) => baseClient.get(`/v1/users/${resolveUserId(userId2)}`),
+      get: (userId2) => baseClient.get(`/v1/users/${resolveUserId(userId2)}`).then((r) => r.data),
       /**
        * Update user (user can update self)
        */
-      update: (userId2, body) => baseClient.put(`/v1/users/${resolveUserId(userId2)}`, body)
+      update: (userId2, body) => baseClient.put(`/v1/users/${resolveUserId(userId2)}`, body).then((r) => r.data)
     },
     // ==================
     // Panics
@@ -88,9 +88,12 @@ function createSaferCityClient(options) {
       /**
        * Create panic
        */
-      create: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post("/v1/panic", { ...body, userId: resolvedUserId });
+      create: async (body) => {
+        const response = await baseClient.post("/v1/panic", {
+          ...body,
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Get panic by ID
@@ -100,25 +103,31 @@ function createSaferCityClient(options) {
           ...query,
           userId: resolveUserId(query?.userId)
         }
-      }),
+      }).then((r) => r.data),
       /**
        * Update panic location
        */
-      updateLocation: (panicId, body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.put(`/v1/panic/${panicId}/location`, { ...body, userId: resolvedUserId });
+      updateLocation: async (panicId, body) => {
+        const response = await baseClient.put(`/v1/panic/${panicId}/location`, {
+          ...body,
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Cancel panic
        */
-      cancel: (panicId, body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.put(`/v1/panic/${panicId}/cancel`, { ...body, userId: resolvedUserId });
+      cancel: async (panicId, body) => {
+        const response = await baseClient.put(`/v1/panic/${panicId}/cancel`, {
+          ...body,
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Get available panic types for a user
        */
-      types: (userId2) => baseClient.get(`/v1/panic/types/${resolveUserId(userId2)}`),
+      types: (userId2) => baseClient.get(`/v1/panic/types/${resolveUserId(userId2)}`).then((r) => r.data),
       /**
        * Stream panic updates (SSE)
        */
@@ -141,32 +150,35 @@ function createSaferCityClient(options) {
       /**
        * Create panic information profile
        */
-      create: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post("/v1/panic-information", { ...body, userId: resolvedUserId });
+      create: async (body) => {
+        const response = await baseClient.post("/v1/panic-information", {
+          ...body,
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Get panic information by ID
        */
-      get: (id) => baseClient.get(`/v1/panic-information/${id}`),
+      get: (id) => baseClient.get(`/v1/panic-information/${id}`).then((r) => r.data),
       /**
        * Get panic information by user ID
        */
-      getByUser: (userId2) => baseClient.get(`/v1/panic-information/user/${resolveUserId(userId2)}`),
+      getByUser: (userId2) => baseClient.get(`/v1/panic-information/user/${resolveUserId(userId2)}`).then((r) => r.data),
       /**
        * Update panic information
        */
-      update: (id, body) => baseClient.put(`/v1/panic-information/${id}`, body),
+      update: (id, body) => baseClient.put(`/v1/panic-information/${id}`, body).then((r) => r.data),
       /**
        * Delete panic information
        */
-      delete: (id) => baseClient.delete(`/v1/panic-information/${id}`),
+      delete: (id) => baseClient.delete(`/v1/panic-information/${id}`).then((r) => r.data),
       /**
        * Validate user eligibility for panic services
        */
       validateEligibility: (userId2) => baseClient.get(
         `/v1/panic-information/validation/${resolveUserId(userId2)}`
-      )
+      ).then((r) => r.data)
     },
     // ==================
     // Subscriptions
@@ -175,35 +187,38 @@ function createSaferCityClient(options) {
       /**
        * List subscription types
        */
-      listTypes: () => baseClient.get("/v1/subscriptions/types"),
+      listTypes: () => baseClient.get("/v1/subscriptions/types").then((r) => r.data),
       /**
        * Create subscription
        */
-      create: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post("/v1/subscriptions", { ...body, userId: resolvedUserId });
+      create: async (body) => {
+        const response = await baseClient.post("/v1/subscriptions", {
+          ...body,
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * List subscriptions
        */
-      list: (query) => {
-        const resolvedUserId = resolveUserId(query?.userId);
-        return baseClient.get("/v1/subscriptions", {
+      list: async (query) => {
+        const response = await baseClient.get("/v1/subscriptions", {
           query: {
             ...query,
-            userId: resolvedUserId
+            userId: resolveUserId(query?.userId)
           }
-        });
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Subscribe a user to a subscription type
        */
-      subscribeUser: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post(
+      subscribeUser: async (body) => {
+        const response = await baseClient.post(
           "/v1/subscriptions/subscribe-user",
-          { ...body, userId: resolvedUserId }
-        );
+          { ...body, userId: resolveUserId(body.userId) }
+        ).then((r) => r.data);
+        return response;
       }
     },
     // ==================
@@ -213,22 +228,22 @@ function createSaferCityClient(options) {
       /**
        * Create subscriber
        */
-      createSubscriber: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post("/v1/notifications/subscribers", {
+      createSubscriber: async (body) => {
+        const response = await baseClient.post("/v1/notifications/subscribers", {
           ...body,
-          userId: resolvedUserId
-        });
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Trigger notification
        */
-      trigger: (body) => {
-        const resolvedUserId = resolveUserId(body.userId);
-        return baseClient.post("/v1/notifications/trigger", {
+      trigger: async (body) => {
+        const response = await baseClient.post("/v1/notifications/trigger", {
           ...body,
-          userId: resolvedUserId
-        });
+          userId: resolveUserId(body.userId)
+        }).then((r) => r.data);
+        return response;
       },
       /**
        * Bulk trigger notifications
@@ -236,20 +251,20 @@ function createSaferCityClient(options) {
       bulkTrigger: (body) => baseClient.post(
         "/v1/notifications/bulk-trigger",
         body
-      ),
+      ).then((r) => r.data),
       /**
        * Get user preferences
        */
       getPreferences: (userId2) => baseClient.get(
         `/v1/notifications/preferences/${resolveUserId(userId2)}`
-      ),
+      ).then((r) => r.data),
       /**
        * Update user preferences
        */
       updatePreferences: (userId2, body) => baseClient.put(
         `/v1/notifications/preferences/${resolveUserId(userId2)}`,
         body
-      )
+      ).then((r) => r.data)
     },
     // ==================
     // Location Safety
@@ -258,7 +273,7 @@ function createSaferCityClient(options) {
       /**
        * Check location safety
        */
-      check: (body) => baseClient.post("/v1/locations/safety-check", body)
+      check: (body) => baseClient.post("/v1/locations/safety-check", body).then((r) => r.data)
     },
     // ==================
     // Banner
@@ -267,7 +282,7 @@ function createSaferCityClient(options) {
       /**
        * Get crime banner data for a location
        */
-      get: (body) => baseClient.post("/v1/banner", body)
+      get: (body) => baseClient.post("/v1/banner", body).then((r) => r.data)
     },
     // ==================
     // Crimes
@@ -276,19 +291,19 @@ function createSaferCityClient(options) {
       /**
        * List crimes
        */
-      list: (query) => baseClient.get("/v1/crimes/list", { query }),
+      list: (query) => baseClient.get("/v1/crimes/list", { query }).then((r) => r.data),
       /**
        * Get crime categories
        */
-      categories: () => baseClient.get("/v1/crime-categories"),
+      categories: () => baseClient.get("/v1/crime-categories").then((r) => r.data),
       /**
        * Get crime types
        */
-      types: () => baseClient.get("/v1/crime-types"),
+      types: () => baseClient.get("/v1/crime-types").then((r) => r.data),
       /**
        * Get crime categories with their types
        */
-      categoriesWithTypes: () => baseClient.get("/v1/crime-categories/withTypes")
+      categoriesWithTypes: () => baseClient.get("/v1/crime-categories/withTypes").then((r) => r.data)
     }
   };
 }
@@ -349,7 +364,7 @@ var ServerClient = class extends sdkCore.BaseClient {
    */
   get health() {
     return {
-      check: () => this.get("/health")
+      check: () => this.get("/health").then((r) => r.data)
     };
   }
   // ==================
@@ -363,11 +378,11 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Get current authentication context
        */
-      whoami: () => this.get("/auth/whoami"),
+      whoami: () => this.get("/auth/whoami").then((r) => r.data),
       /**
        * Check if authenticated (optional auth)
        */
-      check: () => this.get("/auth/optional")
+      check: () => this.get("/auth/optional").then((r) => r.data)
     };
   }
   // ==================
@@ -381,19 +396,19 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Get access token
        */
-      token: (body) => this.post("/v1/oauth/token", body),
+      token: (body) => this.post("/v1/oauth/token", body).then((r) => r.data),
       /**
        * Refresh access token
        */
-      refresh: (body) => this.post("/v1/oauth/refresh", body),
+      refresh: (body) => this.post("/v1/oauth/refresh", body).then((r) => r.data),
       /**
        * Introspect token
        */
-      introspect: (body) => this.post("/v1/oauth/introspect", body),
+      introspect: (body) => this.post("/v1/oauth/introspect", body).then((r) => r.data),
       /**
        * Revoke token
        */
-      revoke: (body) => this.post("/v1/oauth/revoke", body)
+      revoke: (body) => this.post("/v1/oauth/revoke", body).then((r) => r.data)
     };
   }
   // ==================
@@ -407,11 +422,11 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Create a new tenant
        */
-      create: (body) => this.post("/v1/tenants", body),
+      create: (body) => this.post("/v1/tenants", body).then((r) => r.data),
       /**
        * List tenants (admin)
        */
-      list: (query) => this.get("/v1/tenants", { query })
+      list: (query) => this.get("/v1/tenants", { query }).then((r) => r.data)
     };
   }
   // ==================
@@ -425,15 +440,15 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Exchange setup token for credentials
        */
-      setup: (body) => this.post("/v1/credentials", body),
+      setup: (body) => this.post("/v1/credentials", body).then((r) => r.data),
       /**
        * List credentials
        */
-      list: () => this.get("/v1/credentials"),
+      list: () => this.get("/v1/credentials").then((r) => r.data),
       /**
        * Revoke credential
        */
-      revoke: (credentialId) => this.delete(`/v1/credentials/${credentialId}`)
+      revoke: (credentialId) => this.delete(`/v1/credentials/${credentialId}`).then((r) => r.data)
     };
   }
   // ==================
@@ -447,27 +462,27 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Create user
        */
-      create: (body) => this.post("/v1/users", body),
+      create: (body) => this.post("/v1/users", body).then((r) => r.data),
       /**
        * List users
        */
-      list: (query) => this.get("/v1/users", { query }),
+      list: (query) => this.get("/v1/users", { query }).then((r) => r.data),
       /**
        * Get user by ID
        */
-      get: (userId) => this.get(`/v1/users/${userId}`),
+      get: (userId) => this.get(`/v1/users/${userId}`).then((r) => r.data),
       /**
        * Update user
        */
-      update: (userId, body) => this.put(`/v1/users/${userId}`, body),
+      update: (userId, body) => this.put(`/v1/users/${userId}`, body).then((r) => r.data),
       /**
        * Update user status
        */
-      updateStatus: (userId, body) => this.patch(`/v1/users/${userId}/status`, body),
+      updateStatus: (userId, body) => this.patch(`/v1/users/${userId}/status`, body).then((r) => r.data),
       /**
        * Delete user
        */
-      delete: (userId) => this.delete(`/v1/users/${userId}`)
+      delete: (userId) => this.delete(`/v1/users/${userId}`).then((r) => r.data)
     };
   }
   // ==================
@@ -481,27 +496,27 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Create panic
        */
-      create: (body) => this.post("/v1/panic", body),
+      create: (body) => this.post("/v1/panic", body).then((r) => r.data),
       /**
        * Get panic by ID
        */
-      get: (panicId, query) => this.get(`/v1/panic/${panicId}`, { query }),
+      get: (panicId, query) => this.get(`/v1/panic/${panicId}`, { query }).then((r) => r.data),
       /**
        * List panics
        */
-      list: (query) => this.get("/v1/panic", { query }),
+      list: (query) => this.get("/v1/panic", { query }).then((r) => r.data),
       /**
        * Update panic location
        */
-      updateLocation: (panicId, body) => this.put(`/v1/panic/${panicId}/location`, body),
+      updateLocation: (panicId, body) => this.put(`/v1/panic/${panicId}/location`, body).then((r) => r.data),
       /**
        * Cancel panic
        */
-      cancel: (panicId, body) => this.put(`/v1/panic/${panicId}/cancel`, body),
+      cancel: (panicId, body) => this.put(`/v1/panic/${panicId}/cancel`, body).then((r) => r.data),
       /**
        * Get available panic types for a user
        */
-      types: (userId) => this.get(`/v1/panic/types/${userId}`)
+      types: (userId) => this.get(`/v1/panic/types/${userId}`).then((r) => r.data)
     };
   }
   // ==================
@@ -515,23 +530,23 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * List subscription types
        */
-      listTypes: () => this.get("/v1/subscriptions/types"),
+      listTypes: () => this.get("/v1/subscriptions/types").then((r) => r.data),
       /**
        * Create subscription
        */
-      create: (body) => this.post("/v1/subscriptions", body),
+      create: (body) => this.post("/v1/subscriptions", body).then((r) => r.data),
       /**
        * List subscriptions
        */
-      list: (query) => this.get("/v1/subscriptions", { query }),
+      list: (query) => this.get("/v1/subscriptions", { query }).then((r) => r.data),
       /**
        * Get subscription stats
        */
-      stats: () => this.get("/v1/subscriptions/stats"),
+      stats: () => this.get("/v1/subscriptions/stats").then((r) => r.data),
       /**
        * Subscribe a user to a subscription type
        */
-      subscribeUser: (body) => this.post("/v1/subscriptions/subscribe-user", body)
+      subscribeUser: (body) => this.post("/v1/subscriptions/subscribe-user", body).then((r) => r.data)
     };
   }
   // ==================
@@ -545,28 +560,28 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Create subscriber
        */
-      createSubscriber: (body) => this.post("/v1/notifications/subscribers", body),
+      createSubscriber: (body) => this.post("/v1/notifications/subscribers", body).then((r) => r.data),
       /**
        * Trigger notification
        */
-      trigger: (body) => this.post("/v1/notifications/trigger", body),
+      trigger: (body) => this.post("/v1/notifications/trigger", body).then((r) => r.data),
       /**
        * Bulk trigger notifications
        */
-      bulkTrigger: (body) => this.post("/v1/notifications/bulk-trigger", body),
+      bulkTrigger: (body) => this.post("/v1/notifications/bulk-trigger", body).then((r) => r.data),
       /**
        * Get user preferences
        */
       getPreferences: (userId) => this.get(
         `/v1/notifications/preferences/${userId}`
-      ),
+      ).then((r) => r.data),
       /**
        * Update user preferences
        */
       updatePreferences: (userId, body) => this.put(
         `/v1/notifications/preferences/${userId}`,
         body
-      )
+      ).then((r) => r.data)
     };
   }
   // ==================
@@ -580,33 +595,33 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Create panic information profile
        */
-      create: (body) => this.post("/v1/panic-information", body),
+      create: (body) => this.post("/v1/panic-information", body).then((r) => r.data),
       /**
        * List panic information records
        */
-      list: (query) => this.get("/v1/panic-information", { query }),
+      list: (query) => this.get("/v1/panic-information", { query }).then((r) => r.data),
       /**
        * Get panic information by ID
        */
-      get: (id) => this.get(`/v1/panic-information/${id}`),
+      get: (id) => this.get(`/v1/panic-information/${id}`).then((r) => r.data),
       /**
        * Get panic information by user ID
        */
-      getByUser: (userId) => this.get(`/v1/panic-information/user/${userId}`),
+      getByUser: (userId) => this.get(`/v1/panic-information/user/${userId}`).then((r) => r.data),
       /**
        * Update panic information
        */
-      update: (id, body) => this.put(`/v1/panic-information/${id}`, body),
+      update: (id, body) => this.put(`/v1/panic-information/${id}`, body).then((r) => r.data),
       /**
        * Delete panic information
        */
-      delete: (id) => this.delete(`/v1/panic-information/${id}`),
+      delete: (id) => this.delete(`/v1/panic-information/${id}`).then((r) => r.data),
       /**
        * Validate user eligibility for panic services
        */
       validateEligibility: (userId) => this.get(
         `/v1/panic-information/validation/${userId}`
-      )
+      ).then((r) => r.data)
     };
   }
   // ==================
@@ -620,7 +635,7 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Check location safety
        */
-      check: (body) => this.post("/v1/locations/safety-check", body)
+      check: (body) => this.post("/v1/locations/safety-check", body).then((r) => r.data)
     };
   }
   // ==================
@@ -634,7 +649,7 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * Get crime banner data for a location
        */
-      get: (body) => this.post("/v1/banner", body)
+      get: (body) => this.post("/v1/banner", body).then((r) => r.data)
     };
   }
   // ==================
@@ -648,19 +663,19 @@ var ServerClient = class extends sdkCore.BaseClient {
       /**
        * List crimes
        */
-      list: (query) => this.get("/v1/crimes/list", { query }),
+      list: (query) => this.get("/v1/crimes/list", { query }).then((r) => r.data),
       /**
        * Get crime categories
        */
-      categories: () => this.get("/v1/crime-categories"),
+      categories: () => this.get("/v1/crime-categories").then((r) => r.data),
       /**
        * Get crime types
        */
-      types: () => this.get("/v1/crime-types"),
+      types: () => this.get("/v1/crime-types").then((r) => r.data),
       /**
        * Get crime categories with their types
        */
-      categoriesWithTypes: () => this.get("/v1/crime-categories/withTypes")
+      categoriesWithTypes: () => this.get("/v1/crime-categories/withTypes").then((r) => r.data)
     };
   }
 };