signet-core 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Signet Tech, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+# Signet API SDK
+
+TypeScript/JavaScript SDK for the Signet API with built-in DPoP (Distributed Proof of Possession) authentication support.
+
+## Installation
+
+```bash
+npm install @signet/sdk
+# or
+yarn add @signet/sdk
+# or
+pnpm add @signet/sdk
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { Configuration, PartnerApi } from '@signet/sdk';
+import { generateDPoPKeyPair, createDPoPProof } from '@signet/sdk/utils/dpop';
+
+// Initialize SDK
+const config = new Configuration({
+  basePath: 'https://api.getsignet.xyz',
+});
+
+// Generate DPoP key pair
+const keyPair = await generateDPoPKeyPair();
+
+// Create DPoP proof for token request
+const dpopProof = await createDPoPProof(keyPair, {
+  method: 'POST',
+  url: 'https://api.getsignet.xyz/oauth/token',
+});
+
+// Use SDK with DPoP
+const api = new PartnerApi(config);
+// DPoP will be automatically included in requests
+```
+
+### JavaScript Example
+
+```javascript
+const { Configuration, PartnerApi } = require('@signet/sdk');
+const { generateDPoPKeyPair, createDPoPProof } = require('@signet/sdk/utils/dpop');
+
+// Initialize SDK
+const config = new Configuration({
+  basePath: 'https://api.getsignet.xyz',
+});
+
+// Generate DPoP key pair
+const keyPair = await generateDPoPKeyPair();
+
+// Create DPoP proof for token request
+const dpopProof = await createDPoPProof(keyPair, {
+  method: 'POST',
+  url: 'https://api.getsignet.xyz/oauth/token',
+});
+
+// Use SDK with DPoP
+const api = new PartnerApi(config);
+```
+
+### DPoP Authentication
+
+The SDK includes DPoP utilities for secure token binding. See the [DPoP documentation](https://github.com/signet/sdks/blob/main/docs/DPOP.md) for detailed usage.
+
+## API Reference
+
+This SDK provides access to the following API services:
+
+- **Credentials API**: User enrollment and credential management
+- **Fraud API**: Fraud detection and reporting
+- **Partner API**: Partner and client management
+
+## License
+
+MIT
+
+## Author
+
+Rafal Zacher (CTO @ Signet Tech, inc.)

package/apis/BlacklistApi.ts

@@ -0,0 +1,312 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credentials Service API
+ * API documentation for the Credentials service - Mandate and Enrollment endpoints  API documentation for the Fraud service - Blacklist, Device, Geo, IP, Reporting, and Risk endpoints  API documentation for the Partner service - Management endpoints
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  BlacklistControllerBlacklistClientRequest,
+  BlacklistControllerRemoveBlacklistClientRequest,
+} from '../models/index';
+import {
+    BlacklistControllerBlacklistClientRequestFromJSON,
+    BlacklistControllerBlacklistClientRequestToJSON,
+    BlacklistControllerRemoveBlacklistClientRequestFromJSON,
+    BlacklistControllerRemoveBlacklistClientRequestToJSON,
+} from '../models/index';
+
+export interface BlacklistControllerBlacklistClientOperationRequest {
+    blacklistControllerBlacklistClientRequest: BlacklistControllerBlacklistClientRequest;
+}
+
+export interface BlacklistControllerCheckBlacklistRequest {
+    clientId: string;
+}
+
+export interface BlacklistControllerGetBlacklistedClientsRequest {
+    offset?: number;
+    limit?: number;
+}
+
+export interface BlacklistControllerRemoveBlacklistClientOperationRequest {
+    blacklistControllerRemoveBlacklistClientRequest: BlacklistControllerRemoveBlacklistClientRequest;
+}
+
+/**
+ * BlacklistApi - interface
+ * 
+ * @export
+ * @interface BlacklistApiInterface
+ */
+export interface BlacklistApiInterface {
+    /**
+     * Adds a client to the blacklist with specified reasons for fraud detection.
+     * @summary Add client to blacklist
+     * @param {BlacklistControllerBlacklistClientRequest} blacklistControllerBlacklistClientRequest Blacklist request with structured risk reasons
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlacklistApiInterface
+     */
+    blacklistControllerBlacklistClientRaw(requestParameters: BlacklistControllerBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Adds a client to the blacklist with specified reasons for fraud detection.
+     * Add client to blacklist
+     */
+    blacklistControllerBlacklistClient(requestParameters: BlacklistControllerBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Checks if a specific client is blacklisted by the partner organization.
+     * @summary Check if client is blacklisted
+     * @param {string} clientId Client UUID to check
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlacklistApiInterface
+     */
+    blacklistControllerCheckBlacklistRaw(requestParameters: BlacklistControllerCheckBlacklistRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Checks if a specific client is blacklisted by the partner organization.
+     * Check if client is blacklisted
+     */
+    blacklistControllerCheckBlacklist(requestParameters: BlacklistControllerCheckBlacklistRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Retrieves a paginated list of all blacklisted clients for the partner organization.
+     * @summary Get all blacklisted clients
+     * @param {number} [offset] Pagination offset (default: 0)
+     * @param {number} [limit] Maximum number of results (1-100, default: 20)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlacklistApiInterface
+     */
+    blacklistControllerGetBlacklistedClientsRaw(requestParameters: BlacklistControllerGetBlacklistedClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Retrieves a paginated list of all blacklisted clients for the partner organization.
+     * Get all blacklisted clients
+     */
+    blacklistControllerGetBlacklistedClients(requestParameters: BlacklistControllerGetBlacklistedClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Removes a client from the blacklist, allowing them to use services again.
+     * @summary Remove client from blacklist
+     * @param {BlacklistControllerRemoveBlacklistClientRequest} blacklistControllerRemoveBlacklistClientRequest Blacklist removal request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlacklistApiInterface
+     */
+    blacklistControllerRemoveBlacklistClientRaw(requestParameters: BlacklistControllerRemoveBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Removes a client from the blacklist, allowing them to use services again.
+     * Remove client from blacklist
+     */
+    blacklistControllerRemoveBlacklistClient(requestParameters: BlacklistControllerRemoveBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class BlacklistApi extends runtime.BaseAPI implements BlacklistApiInterface {
+
+    /**
+     * Adds a client to the blacklist with specified reasons for fraud detection.
+     * Add client to blacklist
+     */
+    async blacklistControllerBlacklistClientRaw(requestParameters: BlacklistControllerBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['blacklistControllerBlacklistClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'blacklistControllerBlacklistClientRequest',
+                'Required parameter "blacklistControllerBlacklistClientRequest" was null or undefined when calling blacklistControllerBlacklistClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/blacklist`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: BlacklistControllerBlacklistClientRequestToJSON(requestParameters['blacklistControllerBlacklistClientRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Adds a client to the blacklist with specified reasons for fraud detection.
+     * Add client to blacklist
+     */
+    async blacklistControllerBlacklistClient(requestParameters: BlacklistControllerBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.blacklistControllerBlacklistClientRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Checks if a specific client is blacklisted by the partner organization.
+     * Check if client is blacklisted
+     */
+    async blacklistControllerCheckBlacklistRaw(requestParameters: BlacklistControllerCheckBlacklistRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError(
+                'clientId',
+                'Required parameter "clientId" was null or undefined when calling blacklistControllerCheckBlacklist().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/blacklist/client/{clientId}`;
+        urlPath = urlPath.replace(`{${"clientId"}}`, encodeURIComponent(String(requestParameters['clientId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Checks if a specific client is blacklisted by the partner organization.
+     * Check if client is blacklisted
+     */
+    async blacklistControllerCheckBlacklist(requestParameters: BlacklistControllerCheckBlacklistRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.blacklistControllerCheckBlacklistRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Retrieves a paginated list of all blacklisted clients for the partner organization.
+     * Get all blacklisted clients
+     */
+    async blacklistControllerGetBlacklistedClientsRaw(requestParameters: BlacklistControllerGetBlacklistedClientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/blacklist/all`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Retrieves a paginated list of all blacklisted clients for the partner organization.
+     * Get all blacklisted clients
+     */
+    async blacklistControllerGetBlacklistedClients(requestParameters: BlacklistControllerGetBlacklistedClientsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.blacklistControllerGetBlacklistedClientsRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Removes a client from the blacklist, allowing them to use services again.
+     * Remove client from blacklist
+     */
+    async blacklistControllerRemoveBlacklistClientRaw(requestParameters: BlacklistControllerRemoveBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['blacklistControllerRemoveBlacklistClientRequest'] == null) {
+            throw new runtime.RequiredError(
+                'blacklistControllerRemoveBlacklistClientRequest',
+                'Required parameter "blacklistControllerRemoveBlacklistClientRequest" was null or undefined when calling blacklistControllerRemoveBlacklistClient().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("DPoP", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/fraud/v1/blacklist`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+            body: BlacklistControllerRemoveBlacklistClientRequestToJSON(requestParameters['blacklistControllerRemoveBlacklistClientRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Removes a client from the blacklist, allowing them to use services again.
+     * Remove client from blacklist
+     */
+    async blacklistControllerRemoveBlacklistClient(requestParameters: BlacklistControllerRemoveBlacklistClientOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.blacklistControllerRemoveBlacklistClientRaw(requestParameters, initOverrides);
+    }
+
+}

package/apis/CommsApi.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credentials Service API
+ * API documentation for the Credentials service - Mandate and Enrollment endpoints  API documentation for the Fraud service - Blacklist, Device, Geo, IP, Reporting, and Risk endpoints  API documentation for the Partner service - Management endpoints
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CommsControllerCheckClientStatusRequest,
+} from '../models/index';
+import {
+    CommsControllerCheckClientStatusRequestFromJSON,
+    CommsControllerCheckClientStatusRequestToJSON,
+} from '../models/index';
+
+export interface CommsControllerCheckClientStatusOperationRequest {
+    commsControllerCheckClientStatusRequest: CommsControllerCheckClientStatusRequest;
+}
+
+/**
+ * CommsApi - interface
+ * 
+ * @export
+ * @interface CommsApiInterface
+ */
+export interface CommsApiInterface {
+    /**
+     * Service-to-service endpoint to check if a client is blacklisted or has high risk score. Protected by service key authentication.
+     * @summary Check client blacklist and risk status
+     * @param {CommsControllerCheckClientStatusRequest} commsControllerCheckClientStatusRequest Client status check request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommsApiInterface
+     */
+    commsControllerCheckClientStatusRaw(requestParameters: CommsControllerCheckClientStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Service-to-service endpoint to check if a client is blacklisted or has high risk score. Protected by service key authentication.
+     * Check client blacklist and risk status
+     */
+    commsControllerCheckClientStatus(requestParameters: CommsControllerCheckClientStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class CommsApi extends runtime.BaseAPI implements CommsApiInterface {
+
+    /**
+     * Service-to-service endpoint to check if a client is blacklisted or has high risk score. Protected by service key authentication.
+     * Check client blacklist and risk status
+     */
+    async commsControllerCheckClientStatusRaw(requestParameters: CommsControllerCheckClientStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['commsControllerCheckClientStatusRequest'] == null) {
+            throw new runtime.RequiredError(
+                'commsControllerCheckClientStatusRequest',
+                'Required parameter "commsControllerCheckClientStatusRequest" was null or undefined when calling commsControllerCheckClientStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/fraud/v1/comms/check-client-status`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CommsControllerCheckClientStatusRequestToJSON(requestParameters['commsControllerCheckClientStatusRequest']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Service-to-service endpoint to check if a client is blacklisted or has high risk score. Protected by service key authentication.
+     * Check client blacklist and risk status
+     */
+    async commsControllerCheckClientStatus(requestParameters: CommsControllerCheckClientStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.commsControllerCheckClientStatusRaw(requestParameters, initOverrides);
+    }
+
+}