@quba/sensitive-data-protection 0.0.1

package/README.md

@@ -0,0 +1,60 @@
+# @quba/sensitive-data-protection@0.0.1
+
+A TypeScript SDK client for the app.quba.ae API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install @quba/sensitive-data-protection --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  SensitiveDataProtectionApi,
+} from '@quba/sensitive-data-protection';
+import type { HealthCheckRequest } from '@quba/sensitive-data-protection';
+
+async function example() {
+  console.log("🚀 Testing @quba/sensitive-data-protection SDK...");
+  const api = new SensitiveDataProtectionApi();
+
+  try {
+    const data = await api.healthCheck();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *https://app.quba.ae/api/sdp*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*SensitiveDataProtectionApi* | [**healthCheck**](docs/SensitiveDataProtectionApi.md#healthcheck) | **GET** /health | Health
+*SensitiveDataProtectionApi* | [**scanText**](docs/SensitiveDataProtectionApi.md#scantext) | **POST** /scan | Scan Text
+
+
+### Models
+
+- [HTTPValidationError](docs/HTTPValidationError.md)
+- [ScanRequestBody](docs/ScanRequestBody.md)
+- [ScanResponseBody](docs/ScanResponseBody.md)
+- [ScanResult](docs/ScanResult.md)
+- [ValidationError](docs/ValidationError.md)
+- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+

package/dist/index.d.mts

@@ -0,0 +1,429 @@
+//#region src/runtime.d.ts
+/**
+ * Sensitive Data Protection API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+declare const BASE_PATH: string;
+interface ConfigurationParameters {
+  basePath?: string;
+  fetchApi?: FetchAPI;
+  middleware?: Middleware[];
+  queryParamsStringify?: (params: HTTPQuery) => string;
+  username?: string;
+  password?: string;
+  apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+  headers?: HTTPHeaders;
+  credentials?: RequestCredentials;
+}
+declare class Configuration {
+  private configuration;
+  constructor(configuration?: ConfigurationParameters);
+  set config(configuration: Configuration);
+  get basePath(): string;
+  get fetchApi(): FetchAPI | undefined;
+  get middleware(): Middleware[];
+  get queryParamsStringify(): (params: HTTPQuery) => string;
+  get username(): string | undefined;
+  get password(): string | undefined;
+  get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+  get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+  get headers(): HTTPHeaders | undefined;
+  get credentials(): RequestCredentials | undefined;
+}
+declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+declare class BaseAPI {
+  protected configuration: Configuration;
+  private static readonly jsonRegex;
+  private middleware;
+  constructor(configuration?: Configuration);
+  withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+  withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+  withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+  /**
+   * Check if the given MIME is a JSON MIME.
+   * JSON MIME examples:
+   *   application/json
+   *   application/json; charset=UTF8
+   *   APPLICATION/JSON
+   *   application/vnd.company+json
+   * @param mime - MIME (Multipurpose Internet Mail Extensions)
+   * @return True if the given MIME is JSON, false otherwise.
+   */
+  protected isJsonMime(mime: string | null | undefined): boolean;
+  protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+  private createFetchParams;
+  private fetchApi;
+  /**
+   * Create a shallow clone of `this` by constructing a new instance
+   * and then shallow cloning data members.
+   */
+  private clone;
+}
+declare class ResponseError extends Error {
+  response: Response;
+  name: "ResponseError";
+  constructor(response: Response, msg?: string);
+}
+declare class FetchError extends Error {
+  cause: Error;
+  name: "FetchError";
+  constructor(cause: Error, msg?: string);
+}
+declare class RequiredError extends Error {
+  field: string;
+  name: "RequiredError";
+  constructor(field: string, msg?: string);
+}
+declare const COLLECTION_FORMATS: {
+  csv: string;
+  ssv: string;
+  tsv: string;
+  pipes: string;
+};
+type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+type Json = any;
+type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+type HTTPHeaders = {
+  [key: string]: string;
+};
+type HTTPQuery = {
+  [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+type HTTPBody = Json | FormData | URLSearchParams;
+type HTTPRequestInit = {
+  headers?: HTTPHeaders;
+  method: HTTPMethod;
+  credentials?: RequestCredentials;
+  body?: HTTPBody;
+};
+type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+type InitOverrideFunction = (requestContext: {
+  init: HTTPRequestInit;
+  context: RequestOpts;
+}) => Promise<RequestInit>;
+interface FetchParams {
+  url: string;
+  init: RequestInit;
+}
+interface RequestOpts {
+  path: string;
+  method: HTTPMethod;
+  headers: HTTPHeaders;
+  query?: HTTPQuery;
+  body?: HTTPBody;
+}
+declare function querystring(params: HTTPQuery, prefix?: string): string;
+declare function exists(json: any, key: string): boolean;
+declare function mapValues(data: any, fn: (item: any) => any): {
+  [key: string]: any;
+};
+declare function canConsumeForm(consumes: Consume[]): boolean;
+interface Consume {
+  contentType: string;
+}
+interface RequestContext {
+  fetch: FetchAPI;
+  url: string;
+  init: RequestInit;
+}
+interface ResponseContext {
+  fetch: FetchAPI;
+  url: string;
+  init: RequestInit;
+  response: Response;
+}
+interface ErrorContext {
+  fetch: FetchAPI;
+  url: string;
+  init: RequestInit;
+  error: unknown;
+  response?: Response;
+}
+interface Middleware {
+  pre?(context: RequestContext): Promise<FetchParams | void>;
+  post?(context: ResponseContext): Promise<Response | void>;
+  onError?(context: ErrorContext): Promise<Response | void>;
+}
+interface ApiResponse<T> {
+  raw: Response;
+  value(): Promise<T>;
+}
+interface ResponseTransformer<T> {
+  (json: any): T;
+}
+declare class JSONApiResponse<T> {
+  raw: Response;
+  private transformer;
+  constructor(raw: Response, transformer?: ResponseTransformer<T>);
+  value(): Promise<T>;
+}
+declare class VoidApiResponse {
+  raw: Response;
+  constructor(raw: Response);
+  value(): Promise<void>;
+}
+declare class BlobApiResponse {
+  raw: Response;
+  constructor(raw: Response);
+  value(): Promise<Blob>;
+}
+declare class TextApiResponse {
+  raw: Response;
+  constructor(raw: Response);
+  value(): Promise<string>;
+}
+//#endregion
+//#region src/models/ValidationErrorLocInner.d.ts
+/**
+ * Sensitive Data Protection API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ValidationErrorLocInner
+ */
+interface ValidationErrorLocInner {}
+/**
+ * Check if a given object implements the ValidationErrorLocInner interface.
+ */
+declare function instanceOfValidationErrorLocInner(value: object): value is ValidationErrorLocInner;
+declare function ValidationErrorLocInnerFromJSON(json: any): ValidationErrorLocInner;
+declare function ValidationErrorLocInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationErrorLocInner;
+declare function ValidationErrorLocInnerToJSON(json: any): ValidationErrorLocInner;
+declare function ValidationErrorLocInnerToJSONTyped(value?: ValidationErrorLocInner | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/models/ValidationError.d.ts
+/**
+ *
+ * @export
+ * @interface ValidationError
+ */
+interface ValidationError {
+  /**
+   *
+   * @type {Array<ValidationErrorLocInner>}
+   * @memberof ValidationError
+   */
+  loc: Array<ValidationErrorLocInner>;
+  /**
+   *
+   * @type {string}
+   * @memberof ValidationError
+   */
+  msg: string;
+  /**
+   *
+   * @type {string}
+   * @memberof ValidationError
+   */
+  type: string;
+}
+/**
+ * Check if a given object implements the ValidationError interface.
+ */
+declare function instanceOfValidationError(value: object): value is ValidationError;
+declare function ValidationErrorFromJSON(json: any): ValidationError;
+declare function ValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationError;
+declare function ValidationErrorToJSON(json: any): ValidationError;
+declare function ValidationErrorToJSONTyped(value?: ValidationError | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/models/HTTPValidationError.d.ts
+/**
+ *
+ * @export
+ * @interface HTTPValidationError
+ */
+interface HTTPValidationError {
+  /**
+   *
+   * @type {Array<ValidationError>}
+   * @memberof HTTPValidationError
+   */
+  detail?: Array<ValidationError>;
+}
+/**
+ * Check if a given object implements the HTTPValidationError interface.
+ */
+declare function instanceOfHTTPValidationError(value: object): value is HTTPValidationError;
+declare function HTTPValidationErrorFromJSON(json: any): HTTPValidationError;
+declare function HTTPValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): HTTPValidationError;
+declare function HTTPValidationErrorToJSON(json: any): HTTPValidationError;
+declare function HTTPValidationErrorToJSONTyped(value?: HTTPValidationError | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/models/ScanRequestBody.d.ts
+/**
+ * Sensitive Data Protection API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ScanRequestBody
+ */
+interface ScanRequestBody {
+  /**
+   *
+   * @type {string}
+   * @memberof ScanRequestBody
+   */
+  text: string;
+  /**
+   *
+   * @type {string}
+   * @memberof ScanRequestBody
+   */
+  language?: string;
+  /**
+   *
+   * @type {Array<string>}
+   * @memberof ScanRequestBody
+   */
+  entities?: Array<string>;
+  /**
+   *
+   * @type {number}
+   * @memberof ScanRequestBody
+   */
+  confidence_threshold?: number | null;
+}
+/**
+ * Check if a given object implements the ScanRequestBody interface.
+ */
+declare function instanceOfScanRequestBody(value: object): value is ScanRequestBody;
+declare function ScanRequestBodyFromJSON(json: any): ScanRequestBody;
+declare function ScanRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScanRequestBody;
+declare function ScanRequestBodyToJSON(json: any): ScanRequestBody;
+declare function ScanRequestBodyToJSONTyped(value?: ScanRequestBody | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/models/ScanResult.d.ts
+/**
+ * Sensitive Data Protection API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ScanResult
+ */
+interface ScanResult {
+  /**
+   *
+   * @type {number}
+   * @memberof ScanResult
+   */
+  start: number;
+  /**
+   *
+   * @type {number}
+   * @memberof ScanResult
+   */
+  end: number;
+  /**
+   *
+   * @type {number}
+   * @memberof ScanResult
+   */
+  score: number;
+  /**
+   *
+   * @type {string}
+   * @memberof ScanResult
+   */
+  entity_type: string;
+}
+/**
+ * Check if a given object implements the ScanResult interface.
+ */
+declare function instanceOfScanResult(value: object): value is ScanResult;
+declare function ScanResultFromJSON(json: any): ScanResult;
+declare function ScanResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScanResult;
+declare function ScanResultToJSON(json: any): ScanResult;
+declare function ScanResultToJSONTyped(value?: ScanResult | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/models/ScanResponseBody.d.ts
+/**
+ *
+ * @export
+ * @interface ScanResponseBody
+ */
+interface ScanResponseBody {
+  /**
+   *
+   * @type {Array<ScanResult>}
+   * @memberof ScanResponseBody
+   */
+  results: Array<ScanResult>;
+}
+/**
+ * Check if a given object implements the ScanResponseBody interface.
+ */
+declare function instanceOfScanResponseBody(value: object): value is ScanResponseBody;
+declare function ScanResponseBodyFromJSON(json: any): ScanResponseBody;
+declare function ScanResponseBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScanResponseBody;
+declare function ScanResponseBodyToJSON(json: any): ScanResponseBody;
+declare function ScanResponseBodyToJSONTyped(value?: ScanResponseBody | null, ignoreDiscriminator?: boolean): any;
+//#endregion
+//#region src/apis/SensitiveDataProtectionApi.d.ts
+interface ScanTextRequest {
+  ScanRequestBody: ScanRequestBody;
+}
+/**
+ *
+ */
+declare class SensitiveDataProtectionApi extends BaseAPI {
+  /**
+   * Return basic health probe result.
+   * Health
+   */
+  healthCheckRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<string>>;
+  /**
+   * Return basic health probe result.
+   * Health
+   */
+  healthCheck(initOverrides?: RequestInit | InitOverrideFunction): Promise<string>;
+  /**
+   * Scan the provided text for sensitive data.
+   * Scan Text
+   */
+  scanTextRaw(requestParameters: ScanTextRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ScanResponseBody>>;
+  /**
+   * Scan the provided text for sensitive data.
+   * Scan Text
+   */
+  scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
+}
+//#endregion
+export { ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, DefaultConfig, ErrorContext, FetchAPI, FetchError, FetchParams, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, Middleware, ModelPropertyNaming, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfHTTPValidationError, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };

package/dist/index.mjs

@@ -0,0 +1,504 @@
+//#region src/runtime.ts
+/**
+* Sensitive Data Protection API
+* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+*
+* The version of the OpenAPI document: 0.0.1
+* 
+*
+* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+* https://openapi-generator.tech
+* Do not edit the class manually.
+*/
+const BASE_PATH = "https://app.quba.ae/api/sdp".replace(/\/+$/, "");
+var Configuration = class {
+	constructor(configuration = {}) {
+		this.configuration = configuration;
+	}
+	set config(configuration) {
+		this.configuration = configuration;
+	}
+	get basePath() {
+		return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+	}
+	get fetchApi() {
+		return this.configuration.fetchApi;
+	}
+	get middleware() {
+		return this.configuration.middleware || [];
+	}
+	get queryParamsStringify() {
+		return this.configuration.queryParamsStringify || querystring;
+	}
+	get username() {
+		return this.configuration.username;
+	}
+	get password() {
+		return this.configuration.password;
+	}
+	get apiKey() {
+		const apiKey = this.configuration.apiKey;
+		if (apiKey) return typeof apiKey === "function" ? apiKey : () => apiKey;
+	}
+	get accessToken() {
+		const accessToken = this.configuration.accessToken;
+		if (accessToken) return typeof accessToken === "function" ? accessToken : async () => accessToken;
+	}
+	get headers() {
+		return this.configuration.headers;
+	}
+	get credentials() {
+		return this.configuration.credentials;
+	}
+};
+const DefaultConfig = new Configuration();
+/**
+* This is the base class for all generated API classes.
+*/
+var BaseAPI = class BaseAPI {
+	static {
+		this.jsonRegex = new RegExp("^(:?application/json|[^;/ 	]+/[^;/ 	]+[+]json)[ 	]*(:?;.*)?$", "i");
+	}
+	constructor(configuration = DefaultConfig) {
+		this.configuration = configuration;
+		this.fetchApi = async (url, init) => {
+			let fetchParams = {
+				url,
+				init
+			};
+			for (const middleware of this.middleware) if (middleware.pre) fetchParams = await middleware.pre({
+				fetch: this.fetchApi,
+				...fetchParams
+			}) || fetchParams;
+			let response = void 0;
+			try {
+				response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+			} catch (e) {
+				for (const middleware of this.middleware) if (middleware.onError) response = await middleware.onError({
+					fetch: this.fetchApi,
+					url: fetchParams.url,
+					init: fetchParams.init,
+					error: e,
+					response: response ? response.clone() : void 0
+				}) || response;
+				if (response === void 0) if (e instanceof Error) throw new FetchError(e, "The request failed and the interceptors did not return an alternative response");
+				else throw e;
+			}
+			for (const middleware of this.middleware) if (middleware.post) response = await middleware.post({
+				fetch: this.fetchApi,
+				url: fetchParams.url,
+				init: fetchParams.init,
+				response: response.clone()
+			}) || response;
+			return response;
+		};
+		this.middleware = configuration.middleware;
+	}
+	withMiddleware(...middlewares) {
+		const next = this.clone();
+		next.middleware = next.middleware.concat(...middlewares);
+		return next;
+	}
+	withPreMiddleware(...preMiddlewares) {
+		const middlewares = preMiddlewares.map((pre) => ({ pre }));
+		return this.withMiddleware(...middlewares);
+	}
+	withPostMiddleware(...postMiddlewares) {
+		const middlewares = postMiddlewares.map((post) => ({ post }));
+		return this.withMiddleware(...middlewares);
+	}
+	/**
+	* Check if the given MIME is a JSON MIME.
+	* JSON MIME examples:
+	*   application/json
+	*   application/json; charset=UTF8
+	*   APPLICATION/JSON
+	*   application/vnd.company+json
+	* @param mime - MIME (Multipurpose Internet Mail Extensions)
+	* @return True if the given MIME is JSON, false otherwise.
+	*/
+	isJsonMime(mime) {
+		if (!mime) return false;
+		return BaseAPI.jsonRegex.test(mime);
+	}
+	async request(context, initOverrides) {
+		const { url, init } = await this.createFetchParams(context, initOverrides);
+		const response = await this.fetchApi(url, init);
+		if (response && response.status >= 200 && response.status < 300) return response;
+		throw new ResponseError(response, "Response returned an error code");
+	}
+	async createFetchParams(context, initOverrides) {
+		let url = this.configuration.basePath + context.path;
+		if (context.query !== void 0 && Object.keys(context.query).length !== 0) url += "?" + this.configuration.queryParamsStringify(context.query);
+		const headers = Object.assign({}, this.configuration.headers, context.headers);
+		Object.keys(headers).forEach((key) => headers[key] === void 0 ? delete headers[key] : {});
+		const initOverrideFn = typeof initOverrides === "function" ? initOverrides : async () => initOverrides;
+		const initParams = {
+			method: context.method,
+			headers,
+			body: context.body,
+			credentials: this.configuration.credentials
+		};
+		const overriddenInit = {
+			...initParams,
+			...await initOverrideFn({
+				init: initParams,
+				context
+			})
+		};
+		let body;
+		if (isFormData(overriddenInit.body) || overriddenInit.body instanceof URLSearchParams || isBlob(overriddenInit.body)) body = overriddenInit.body;
+		else if (this.isJsonMime(headers["Content-Type"])) body = JSON.stringify(overriddenInit.body);
+		else body = overriddenInit.body;
+		const init = {
+			...overriddenInit,
+			body
+		};
+		return {
+			url,
+			init
+		};
+	}
+	/**
+	* Create a shallow clone of `this` by constructing a new instance
+	* and then shallow cloning data members.
+	*/
+	clone() {
+		const constructor = this.constructor;
+		const next = new constructor(this.configuration);
+		next.middleware = this.middleware.slice();
+		return next;
+	}
+};
+function isBlob(value) {
+	return typeof Blob !== "undefined" && value instanceof Blob;
+}
+function isFormData(value) {
+	return typeof FormData !== "undefined" && value instanceof FormData;
+}
+var ResponseError = class extends Error {
+	constructor(response, msg) {
+		super(msg);
+		this.response = response;
+		this.name = "ResponseError";
+	}
+};
+var FetchError = class extends Error {
+	constructor(cause, msg) {
+		super(msg);
+		this.cause = cause;
+		this.name = "FetchError";
+	}
+};
+var RequiredError = class extends Error {
+	constructor(field, msg) {
+		super(msg);
+		this.field = field;
+		this.name = "RequiredError";
+	}
+};
+const COLLECTION_FORMATS = {
+	csv: ",",
+	ssv: " ",
+	tsv: "	",
+	pipes: "|"
+};
+function querystring(params, prefix = "") {
+	return Object.keys(params).map((key) => querystringSingleKey(key, params[key], prefix)).filter((part) => part.length > 0).join("&");
+}
+function querystringSingleKey(key, value, keyPrefix = "") {
+	const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+	if (value instanceof Array) {
+		const multiValue = value.map((singleValue) => encodeURIComponent(String(singleValue))).join(`&${encodeURIComponent(fullKey)}=`);
+		return `${encodeURIComponent(fullKey)}=${multiValue}`;
+	}
+	if (value instanceof Set) return querystringSingleKey(key, Array.from(value), keyPrefix);
+	if (value instanceof Date) return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+	if (value instanceof Object) return querystring(value, fullKey);
+	return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function exists(json, key) {
+	const value = json[key];
+	return value !== null && value !== void 0;
+}
+function mapValues(data, fn) {
+	const result = {};
+	for (const key of Object.keys(data)) result[key] = fn(data[key]);
+	return result;
+}
+function canConsumeForm(consumes) {
+	for (const consume of consumes) if ("multipart/form-data" === consume.contentType) return true;
+	return false;
+}
+var JSONApiResponse = class {
+	constructor(raw, transformer = (jsonValue) => jsonValue) {
+		this.raw = raw;
+		this.transformer = transformer;
+	}
+	async value() {
+		return this.transformer(await this.raw.json());
+	}
+};
+var VoidApiResponse = class {
+	constructor(raw) {
+		this.raw = raw;
+	}
+	async value() {}
+};
+var BlobApiResponse = class {
+	constructor(raw) {
+		this.raw = raw;
+	}
+	async value() {
+		return await this.raw.blob();
+	}
+};
+var TextApiResponse = class {
+	constructor(raw) {
+		this.raw = raw;
+	}
+	async value() {
+		return await this.raw.text();
+	}
+};
+
+//#endregion
+//#region src/models/ValidationErrorLocInner.ts
+/**
+* Check if a given object implements the ValidationErrorLocInner interface.
+*/
+function instanceOfValidationErrorLocInner(value) {
+	return true;
+}
+function ValidationErrorLocInnerFromJSON(json) {
+	return ValidationErrorLocInnerFromJSONTyped(json, false);
+}
+function ValidationErrorLocInnerFromJSONTyped(json, ignoreDiscriminator) {
+	return json;
+}
+function ValidationErrorLocInnerToJSON(json) {
+	return ValidationErrorLocInnerToJSONTyped(json, false);
+}
+function ValidationErrorLocInnerToJSONTyped(value, ignoreDiscriminator = false) {
+	return value;
+}
+
+//#endregion
+//#region src/models/ValidationError.ts
+/**
+* Check if a given object implements the ValidationError interface.
+*/
+function instanceOfValidationError(value) {
+	if (!("loc" in value) || value["loc"] === void 0) return false;
+	if (!("msg" in value) || value["msg"] === void 0) return false;
+	if (!("type" in value) || value["type"] === void 0) return false;
+	return true;
+}
+function ValidationErrorFromJSON(json) {
+	return ValidationErrorFromJSONTyped(json, false);
+}
+function ValidationErrorFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"loc": json["loc"].map(ValidationErrorLocInnerFromJSON),
+		"msg": json["msg"],
+		"type": json["type"]
+	};
+}
+function ValidationErrorToJSON(json) {
+	return ValidationErrorToJSONTyped(json, false);
+}
+function ValidationErrorToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"loc": value["loc"].map(ValidationErrorLocInnerToJSON),
+		"msg": value["msg"],
+		"type": value["type"]
+	};
+}
+
+//#endregion
+//#region src/models/HTTPValidationError.ts
+/**
+* Check if a given object implements the HTTPValidationError interface.
+*/
+function instanceOfHTTPValidationError(value) {
+	return true;
+}
+function HTTPValidationErrorFromJSON(json) {
+	return HTTPValidationErrorFromJSONTyped(json, false);
+}
+function HTTPValidationErrorFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return { "detail": json["detail"] == null ? void 0 : json["detail"].map(ValidationErrorFromJSON) };
+}
+function HTTPValidationErrorToJSON(json) {
+	return HTTPValidationErrorToJSONTyped(json, false);
+}
+function HTTPValidationErrorToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return { "detail": value["detail"] == null ? void 0 : value["detail"].map(ValidationErrorToJSON) };
+}
+
+//#endregion
+//#region src/models/ScanRequestBody.ts
+/**
+* Check if a given object implements the ScanRequestBody interface.
+*/
+function instanceOfScanRequestBody(value) {
+	if (!("text" in value) || value["text"] === void 0) return false;
+	return true;
+}
+function ScanRequestBodyFromJSON(json) {
+	return ScanRequestBodyFromJSONTyped(json, false);
+}
+function ScanRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"text": json["text"],
+		"language": json["language"] == null ? void 0 : json["language"],
+		"entities": json["entities"] == null ? void 0 : json["entities"],
+		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"]
+	};
+}
+function ScanRequestBodyToJSON(json) {
+	return ScanRequestBodyToJSONTyped(json, false);
+}
+function ScanRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"text": value["text"],
+		"language": value["language"],
+		"entities": value["entities"],
+		"confidence_threshold": value["confidence_threshold"]
+	};
+}
+
+//#endregion
+//#region src/models/ScanResult.ts
+/**
+* Check if a given object implements the ScanResult interface.
+*/
+function instanceOfScanResult(value) {
+	if (!("start" in value) || value["start"] === void 0) return false;
+	if (!("end" in value) || value["end"] === void 0) return false;
+	if (!("score" in value) || value["score"] === void 0) return false;
+	if (!("entity_type" in value) || value["entity_type"] === void 0) return false;
+	return true;
+}
+function ScanResultFromJSON(json) {
+	return ScanResultFromJSONTyped(json, false);
+}
+function ScanResultFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"start": json["start"],
+		"end": json["end"],
+		"score": json["score"],
+		"entity_type": json["entity_type"]
+	};
+}
+function ScanResultToJSON(json) {
+	return ScanResultToJSONTyped(json, false);
+}
+function ScanResultToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"start": value["start"],
+		"end": value["end"],
+		"score": value["score"],
+		"entity_type": value["entity_type"]
+	};
+}
+
+//#endregion
+//#region src/models/ScanResponseBody.ts
+/**
+* Check if a given object implements the ScanResponseBody interface.
+*/
+function instanceOfScanResponseBody(value) {
+	if (!("results" in value) || value["results"] === void 0) return false;
+	return true;
+}
+function ScanResponseBodyFromJSON(json) {
+	return ScanResponseBodyFromJSONTyped(json, false);
+}
+function ScanResponseBodyFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return { "results": json["results"].map(ScanResultFromJSON) };
+}
+function ScanResponseBodyToJSON(json) {
+	return ScanResponseBodyToJSONTyped(json, false);
+}
+function ScanResponseBodyToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return { "results": value["results"].map(ScanResultToJSON) };
+}
+
+//#endregion
+//#region src/apis/SensitiveDataProtectionApi.ts
+/**
+* Sensitive Data Protection API
+* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+*
+* The version of the OpenAPI document: 0.0.1
+* 
+*
+* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+* https://openapi-generator.tech
+* Do not edit the class manually.
+*/
+/**
+* 
+*/
+var SensitiveDataProtectionApi = class extends BaseAPI {
+	/**
+	* Return basic health probe result.
+	* Health
+	*/
+	async healthCheckRaw(initOverrides) {
+		const response = await this.request({
+			path: `/health`,
+			method: "GET",
+			headers: {},
+			query: {}
+		}, initOverrides);
+		if (this.isJsonMime(response.headers.get("content-type"))) return new JSONApiResponse(response);
+		else return new TextApiResponse(response);
+	}
+	/**
+	* Return basic health probe result.
+	* Health
+	*/
+	async healthCheck(initOverrides) {
+		return await (await this.healthCheckRaw(initOverrides)).value();
+	}
+	/**
+	* Scan the provided text for sensitive data.
+	* Scan Text
+	*/
+	async scanTextRaw(requestParameters, initOverrides) {
+		if (requestParameters["ScanRequestBody"] == null) throw new RequiredError("ScanRequestBody", "Required parameter \"ScanRequestBody\" was null or undefined when calling scanText().");
+		const queryParameters = {};
+		const headerParameters = {};
+		headerParameters["Content-Type"] = "application/json";
+		const response = await this.request({
+			path: `/scan`,
+			method: "POST",
+			headers: headerParameters,
+			query: queryParameters,
+			body: ScanRequestBodyToJSON(requestParameters["ScanRequestBody"])
+		}, initOverrides);
+		return new JSONApiResponse(response, (jsonValue) => ScanResponseBodyFromJSON(jsonValue));
+	}
+	/**
+	* Scan the provided text for sensitive data.
+	* Scan Text
+	*/
+	async scanText(ScanRequestBody, initOverrides) {
+		return await (await this.scanTextRaw({ ScanRequestBody }, initOverrides)).value();
+	}
+};
+
+//#endregion
+export { BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, DefaultConfig, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, RequiredError, ResponseError, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfHTTPValidationError, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@quba/sensitive-data-protection",
+  "description": "SDK for Sensitive Data Protection Service",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "https://quba.ae",
+  "version": "0.0.1",
+  "keywords": [
+    "sensitive data protection",
+    "sdp",
+    "de-identification",
+    "data privacy",
+    "data anonymization",
+    "dlp",
+    "data loss prevention",
+    "pii",
+    "personal data"
+  ],
+  "author": "Quba Ltd",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src/docs",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsdown"
+  },
+  "packageManager": "pnpm@10.26.2",
+  "devDependencies": {
+    "tsdown": "0.18.4",
+    "typescript": "^5.9.3"
+  }
+}