marketplace-hub-client 0.0.1 → 0.0.2

package/README.md

@@ -1,63 +1,97 @@
-# MarketplaceHubClient
+# Marketplace Hub Client Library
 
-This  version 21.
+A professional, enterprise-grade Angular client library for interacting with the Marketplace Hub API. This library features built-in security, standard response wrapping, and a developer-friendly interface.
 
-## Code scaffolding
+## Features
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+- **Standardized API Responses**: All endpoints return a consistent `ApiResponse<T>` wrapper.
+- **Automated Authentication**: Built-in interceptor for `HMAC-SHA256` request signing and `API-KEY` management.
+- **Type Safety**: Fully typed models generated for all API entities.
+- **Idempotency**: Automatic `Idempotency-Key` generation for safe mutating requests (`POST`, `PUT`, `PATCH`).
 
-```bash
-ng generate component component-name
-```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## Installation
 
 ```bash
-ng generate --help
+npm install marketplace-hub-client
 ```
 
-## Building
-
-To build the library, run:
-
-```bash
-ng build marketplace-hub-client
-```
+## Quick Start
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+### 1. Provide the API in your app
 
-### Publishing the Library
+In your `app.config.ts`:
 
-Once the project is built, you can publish your library by following these steps:
+```typescript
+import { ApplicationConfig } from '@angular/core';
+import { provideApi } from 'marketplace-hub-client';
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/marketplace-hub-client
-   ```
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideApi({
+      basePath: 'https://api.marketplace-hub.com',
+      api_key: 'YOUR_API_KEY',
+      apiSecret: 'YOUR_API_SECRET' // Used for HMAC signature
+    })
+  ]
+};
+```
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+### 2. Inject and use Services
+
+```typescript
+import { Component, OnInit, inject } from '@angular/core';
+import { ContentService, ProductResponse, ApiResponse } from 'marketplace-hub-client';
+
+@Component({
+  selector: 'app-product-list',
+  standalone: true,
+  template: `
+    <div *ngIf="products">
+      <h3>{{ products.message.detail }}</h3>
+      <ul>
+        <li *ngFor="let product of products.data.content">
+          {{ product.name }} - {{ product.price }}
+        </li>
+      </ul>
+    </div>
+  `
+})
+export class ProductListComponent implements OnInit {
+  private contentService = inject(ContentService);
+  products?: ApiResponse<any>;
+
+  ngOnInit() {
+    this.contentService.getProducts({ page: 0, size: 10 }).subscribe(response => {
+      this.products = response;
+    });
+  }
+}
+```
 
-## Running unit tests
+## API Response Structure
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+Every response from the library follows this structure:
 
-```bash
-ng test
+```typescript
+export interface ApiResponse<T> {
+  timestamp: number;
+  status: number;
+  message: {
+    detail: string;
+  };
+  data: T;
+}
 ```
 
-## Running end-to-end tests
+## Authentication Headers
 
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
+The library automatically injects the following headers for every request when configured:
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+- `X-API-KEY`: Your provided API Key.
+- `X-TIMESTAMP`: Current epoch timestamp.
+- `X-SIGNATURE`: `HMAC-SHA256(body + timestamp, secret)` encoded in Base64.
+- `Idempotency-Key`: A unique UUID for mutating requests.
 
-## Additional Resources
+## License
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+MIT © ITWays

package/fesm2022/marketplace-hub-client.mjs

@@ -405,14 +405,10 @@ class BaseService {
 /**
  * Marketplace Hub API
  *
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
+ * This client library provides a professional interface for interacting with the Marketplace Hub API.
  */
 /* tslint:disable:no-unused-variable member-ordering */
-class ContentAPIService extends BaseService {
+class ContentService extends BaseService {
     httpClient;
     constructor(httpClient, basePath, configuration) {
         super(basePath, configuration);
@@ -922,10 +918,10 @@ class ContentAPIService extends BaseService {
             reportProgress: reportProgress
         });
     }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentAPIService, deps: [{ token: i1.HttpClient }, { token: BASE_PATH, optional: true }, { token: Configuration, optional: true }], target: i0.ɵɵFactoryTarget.Injectable });
-    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentAPIService, providedIn: 'root' });
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentService, deps: [{ token: i1.HttpClient }, { token: BASE_PATH, optional: true }, { token: Configuration, optional: true }], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentService, providedIn: 'root' });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentAPIService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.0", ngImport: i0, type: ContentService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root'
@@ -939,7 +935,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.0", ngImpor
                     type: Optional
                 }] }] });
 
-const APIS = [ContentAPIService];
+const APIS = [ContentService];
 
 /**
  * Marketplace Hub API
@@ -1220,5 +1216,5 @@ function provideApi(configOrBasePath) {
  * Generated bundle index. Do not edit.
  */
 
-export { APIS, ApiModule, BASE_PATH, COLLECTION_FORMATS, CategoryResponse, Configuration, ContentAPIService, ProductResponse, PublicPaymentMethodResponse, apiAuthenticationInterceptor, provideApi };
+export { APIS, ApiModule, BASE_PATH, COLLECTION_FORMATS, CategoryResponse, Configuration, ContentService, ProductResponse, PublicPaymentMethodResponse, apiAuthenticationInterceptor, provideApi };
 //# sourceMappingURL=marketplace-hub-client.mjs.map