@edirect/tokenization 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,90 @@
+# Tokenization Service Node.js
+
+This README provides instructions on how to use the `Tokenization` class in the Tokenization Service Node.js project.
+
+## Installation
+
+To install the necessary dependencies, run:
+
+```bash
+npm install --save @edirect/tokenization
+```
+
+## Usage
+
+The `Tokenization` class provides methods to tokenize and detokenize payloads. Below is an example of how to use the class.
+
+### Importing the Tokenization Class
+
+```javascript
+import { Tokenization } from "@edirect/tokenization";
+```
+
+### Creating an Instance
+
+To create an instance of the `Tokenization` class, you need to provide the base URL of the tokenization service.
+
+```javascript
+const baseUrl = "https://tokenization-service.api.example.com";
+const tokenization = new Tokenization(baseUrl);
+```
+
+### Tokenizing a Payload
+
+To tokenize a payload, use the `tokenize` method. You need to provide the authentication token, tenant, configuration, and the payload to be tokenized.
+
+```javascript
+const auth = 'your-auth-token';
+const tenant = 'your-tenant';
+const config = 'your-config';
+const payload = {
+    name: 'John Doe',
+    email: 'johndoe@test.com',
+    phone: '123-456-7890'
+    payment: {
+        cardNumber: '1234 5678 9012 3456',
+        expirationDate: '12/23',
+        cvv: '123'
+    }
+};
+
+const tokenizedData = await tokenization.tokenize(auth, tenant, config, payload);
+console.log('Tokenized Payload:', tokenizedData);
+```
+
+### Detokenizing a Payload
+
+To detokenize a payload, use the `detokenize` method. You need to provide the authentication token, tenant, configuration, and the payload to be detokenized.
+
+```javascript
+const detokenizedData = await tokenization.detokenize(auth, tenant, config, payload);
+console.log("Detokenized Payload:", detokenizedData);
+```
+
+## API
+
+### `Tokenization`
+
+#### `constructor(baseUrl: string)`
+
+Creates an instance of the `Tokenization` class.
+
+- `baseUrl`: The base URL of the tokenization service.
+
+#### `tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>`
+
+Tokenizes the given payload.
+
+- `auth`: The authentication token.
+- `tenant`: The tenant to tokenize the payload for.
+- `config`: The configuration for tokenization.
+- `payload`: The payload to tokenize.
+
+#### `detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>`
+
+Detokenizes the given payload.
+
+- `auth`: The authentication token.
+- `tenant`: The tenant to detokenize the payload for.
+- `config`: The configuration for detokenization.
+- `payload`: The payload to detokenize.

package/dist/index.d.mts

@@ -1,76 +1,8 @@
-/**
- * @file This file contains the models used in the application.
- */
-
-/**
- * The classification of a field.
- * 0: The field is not sensitive.
- * 1: The field is sensitive.
- */
-type Classification = 0 | 1;
-/**
- * The model of a field classification.
- * @property path The path of the field.
- * @property classification The classification of the field.
- * @example
- * {
- *      path: "data.*.name",
- *      classification: 1
- * }
- * @see Classification
- */
-type FieldClassification = {
-    path: string;
-    classification: Classification;
-};
-/**
- * The model of a configuration.
- * @property key The key of the configuration.
- * @property tenant The tenant of the configuration.
- * @property defaultClassification The default classification of the configuration.
- * @property fields The fields of the configuration.
- * @example
- * {
- *      key: "configuration",
- *      tenant: "tenant",
- *      defaultClassification: 0,
- *      fields: [
- *          {
- *              path: "data.*.name",
- *             classification: 1
- *         }
- *    ]
- * }
- * @see FieldClassification
- * @see Classification
- */
-type Configuration = {
-    key: string;
-    tenant: string;
-    defaultClassification: Classification;
-    fields: FieldClassification[];
-};
 /**
  * The model of a token payload.
  */
 type TokenPayload = Record<string, unknown>;
-type TokenizationClientConfig = {
-    services?: {
-        tokenizationService?: ITokenizationService;
-        configurationService?: IConfigurationService;
-    };
-};
 
-interface ITokenizationService {
-    tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
-    detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
-}
-interface IConfigurationService {
-    get(auth: string, tenant: string, config: string): Promise<Configuration | undefined>;
-    create(auth: string, tenant: string, config: Configuration): Promise<Configuration>;
-    update(auth: string, tenant: string, config: Configuration): Promise<Configuration>;
-    delete(auth: string, tenant: string, config: string): Promise<void>;
-}
 interface ITokenizationApp {
     tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
     detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
@@ -85,7 +17,7 @@ declare class Tokenization {
      * The constructor of the TokenizationClient class.
      * @param url The URL of the tokenization server.
      */
-    constructor(configOrApp?: TokenizationClientConfig | ITokenizationApp);
+    constructor(baseUrlOrApp?: string | ITokenizationApp);
     /**
      * Tokenizes the given payload.
      * @param tenant The tenant to tokenize the payload for.

package/dist/index.d.ts

@@ -1,76 +1,8 @@
-/**
- * @file This file contains the models used in the application.
- */
-
-/**
- * The classification of a field.
- * 0: The field is not sensitive.
- * 1: The field is sensitive.
- */
-type Classification = 0 | 1;
-/**
- * The model of a field classification.
- * @property path The path of the field.
- * @property classification The classification of the field.
- * @example
- * {
- *      path: "data.*.name",
- *      classification: 1
- * }
- * @see Classification
- */
-type FieldClassification = {
-    path: string;
-    classification: Classification;
-};
-/**
- * The model of a configuration.
- * @property key The key of the configuration.
- * @property tenant The tenant of the configuration.
- * @property defaultClassification The default classification of the configuration.
- * @property fields The fields of the configuration.
- * @example
- * {
- *      key: "configuration",
- *      tenant: "tenant",
- *      defaultClassification: 0,
- *      fields: [
- *          {
- *              path: "data.*.name",
- *             classification: 1
- *         }
- *    ]
- * }
- * @see FieldClassification
- * @see Classification
- */
-type Configuration = {
-    key: string;
-    tenant: string;
-    defaultClassification: Classification;
-    fields: FieldClassification[];
-};
 /**
  * The model of a token payload.
  */
 type TokenPayload = Record<string, unknown>;
-type TokenizationClientConfig = {
-    services?: {
-        tokenizationService?: ITokenizationService;
-        configurationService?: IConfigurationService;
-    };
-};
 
-interface ITokenizationService {
-    tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
-    detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
-}
-interface IConfigurationService {
-    get(auth: string, tenant: string, config: string): Promise<Configuration | undefined>;
-    create(auth: string, tenant: string, config: Configuration): Promise<Configuration>;
-    update(auth: string, tenant: string, config: Configuration): Promise<Configuration>;
-    delete(auth: string, tenant: string, config: string): Promise<void>;
-}
 interface ITokenizationApp {
     tokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
     detokenize(auth: string, tenant: string, config: string, payload: TokenPayload): Promise<TokenPayload>;
@@ -85,7 +17,7 @@ declare class Tokenization {
      * The constructor of the TokenizationClient class.
      * @param url The URL of the tokenization server.
      */
-    constructor(configOrApp?: TokenizationClientConfig | ITokenizationApp);
+    constructor(baseUrlOrApp?: string | ITokenizationApp);
     /**
      * Tokenizes the given payload.
      * @param tenant The tenant to tokenize the payload for.

package/dist/index.js

@@ -291,22 +291,14 @@ var Tokenization = class {
    * The constructor of the TokenizationClient class.
    * @param url The URL of the tokenization server.
    */
-  constructor(configOrApp) {
-    if (configOrApp && "tokenize" in configOrApp && "detokenize" in configOrApp) {
-      this.app = configOrApp;
+  constructor(baseUrlOrApp) {
+    if (baseUrlOrApp && typeof baseUrlOrApp !== "string") {
+      this.app = baseUrlOrApp;
       return;
     }
-    if (configOrApp && "services" in configOrApp && configOrApp.services && "tokenizationService" in configOrApp.services && "configurationService" in configOrApp.services && configOrApp.services.tokenizationService && configOrApp.services.configurationService) {
-      const tokenizationService2 = configOrApp.services.tokenizationService;
-      const configurationService2 = configOrApp.services.configurationService;
-      this.app = new TokenizationApp(tokenizationService2, configurationService2);
-      return;
-    }
-    const tokenizationService = new TokenizationService(
-      process.env.TOKENIZATION_SERVICE_BASE_URL
-    );
+    const tokenizationService = new TokenizationService(baseUrlOrApp);
     const configurationService = new ConfigurationService(
-      process.env.CONFIGURATION_SERVICE_BASE_URL
+      baseUrlOrApp
     );
     this.app = new TokenizationApp(tokenizationService, configurationService);
     return;

package/dist/index.mjs

@@ -265,22 +265,14 @@ var Tokenization = class {
    * The constructor of the TokenizationClient class.
    * @param url The URL of the tokenization server.
    */
-  constructor(configOrApp) {
-    if (configOrApp && "tokenize" in configOrApp && "detokenize" in configOrApp) {
-      this.app = configOrApp;
+  constructor(baseUrlOrApp) {
+    if (baseUrlOrApp && typeof baseUrlOrApp !== "string") {
+      this.app = baseUrlOrApp;
       return;
     }
-    if (configOrApp && "services" in configOrApp && configOrApp.services && "tokenizationService" in configOrApp.services && "configurationService" in configOrApp.services && configOrApp.services.tokenizationService && configOrApp.services.configurationService) {
-      const tokenizationService2 = configOrApp.services.tokenizationService;
-      const configurationService2 = configOrApp.services.configurationService;
-      this.app = new TokenizationApp(tokenizationService2, configurationService2);
-      return;
-    }
-    const tokenizationService = new TokenizationService(
-      process.env.TOKENIZATION_SERVICE_BASE_URL
-    );
+    const tokenizationService = new TokenizationService(baseUrlOrApp);
     const configurationService = new ConfigurationService(
-      process.env.CONFIGURATION_SERVICE_BASE_URL
+      baseUrlOrApp
     );
     this.app = new TokenizationApp(tokenizationService, configurationService);
     return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/tokenization",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Javascript library for tokenization service",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -25,10 +25,7 @@
     "type": "git",
     "url": "https://bitbucket.org/gofrank/tokenization-service-js.git"
   },
-  "bugs": {
-    "url": "https://github.com/gofrank/tokenization-service-js/issues"
-  },
-  "homepage": "https://github.com/gofrank/tokenization-service-js#readme",
+  "homepage": "https://bolttech.io",
   "devDependencies": {
     "@types/node": "^22.10.1",
     "@vitest/coverage-istanbul": "^2.1.8",