ngx-gp-api-core 0.0.1

package/README.md

@@ -0,0 +1,34 @@
+# GP API Core
+A library that provides business logic endpoints to interact with the GP Widgets Resource Server on a higher abstraction level. No deeper knowledge of the endpoints of the resource server necessary for application of the provided functions.
+
+## Building
+
+To build the library, run:
+
+```bash
+ng build ngx-gp-api-core
+```
+
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+### Publishing the Library
+
+Once the project is built, you can publish your library by following these steps:
+
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/ngx-gp-api-core
+   ```
+
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
+
+## Running unit tests
+
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+
+```bash
+ng test
+```

package/fesm2022/ngx-gp-api-core.mjs

@@ -0,0 +1,115 @@
+import * as i0 from '@angular/core';
+import { inject, Injectable } from '@angular/core';
+import { HttpHeaders, HttpErrorResponse, HttpClient } from '@angular/common/http';
+import { throwError } from 'rxjs';
+import { catchError } from 'rxjs/operators';
+
+function buildAuthHeaders(bearerToken) {
+    let headers = new HttpHeaders();
+    if (bearerToken)
+        headers = headers.set('Authorization', `Bearer ${bearerToken}`);
+    return headers;
+}
+
+class ApiError extends Error {
+    status;
+    payload;
+    url;
+    constructor(message, status, payload, url) {
+        super(message);
+        this.status = status;
+        this.payload = payload;
+        this.url = url;
+        this.name = 'ApiError';
+    }
+}
+function toApiError(err, url) {
+    if (err instanceof HttpErrorResponse) {
+        const payload = err.error;
+        const message = (typeof payload === 'string' && payload) ||
+            (payload && (payload.message || payload.error)) ||
+            err.message ||
+            `HTTP error ${err.status}`;
+        return new ApiError(message, err.status, payload, url ?? err.url ?? undefined);
+    }
+    return new ApiError(err?.message || 'Request failed', undefined, undefined, url);
+}
+
+function get(http, opts) {
+    const headers = buildAuthHeaders(opts.bearerToken);
+    if (opts.responseType === 'blob') {
+        return http
+            .get(opts.url, { headers, responseType: 'blob' })
+            .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+    }
+    return http
+        .get(opts.url, { headers, responseType: 'json' })
+        .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+}
+
+function post(http, opts) {
+    let headers = buildAuthHeaders(opts.bearerToken);
+    headers = headers.set('Content-Type', 'application/json');
+    if (opts.responseType === 'blob') {
+        return http
+            .post(opts.url, opts.body, { headers, responseType: 'blob' })
+            .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+    }
+    return http
+        .post(opts.url, opts.body, { headers, responseType: 'json' })
+        .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+}
+
+function put(http, opts) {
+    let headers = buildAuthHeaders(opts.bearerToken);
+    headers = headers.set('Content-Type', 'application/json');
+    if (opts.responseType === 'blob') {
+        return http
+            .put(opts.url, opts.body, { headers, responseType: 'blob' })
+            .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+    }
+    return http
+        .put(opts.url, opts.body, { headers, responseType: 'json' })
+        .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+}
+
+function delete_(http, opts) {
+    const headers = buildAuthHeaders(opts.bearerToken);
+    return http
+        .delete(opts.url, { headers, responseType: 'json' })
+        .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));
+}
+
+class GPApiCore {
+    http = inject(HttpClient);
+    get(opts) {
+        return get(this.http, opts);
+    }
+    post(opts) {
+        return post(this.http, opts);
+    }
+    put(opts) {
+        return put(this.http, opts);
+    }
+    delete(opts) {
+        return delete_(this.http, opts);
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.1.5", ngImport: i0, type: GPApiCore, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.1.5", ngImport: i0, type: GPApiCore, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.1.5", ngImport: i0, type: GPApiCore, decorators: [{
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
+
+/*
+ * Public API Surface of ngx-gp-api-core
+ */
+//TODO: Adjust exports to what actually should be public
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { GPApiCore };
+//# sourceMappingURL=ngx-gp-api-core.mjs.map

package/fesm2022/ngx-gp-api-core.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngx-gp-api-core.mjs","sources":["../../../projects/ngx-gp-api-core/src/lib/http-helpers/request-helpers.ts","../../../projects/ngx-gp-api-core/src/lib/http-helpers/api-error.ts","../../../projects/ngx-gp-api-core/src/lib/requests/get.ts","../../../projects/ngx-gp-api-core/src/lib/requests/post.ts","../../../projects/ngx-gp-api-core/src/lib/requests/put.ts","../../../projects/ngx-gp-api-core/src/lib/requests/delete.ts","../../../projects/ngx-gp-api-core/src/lib/ngx-gp-api-core.ts","../../../projects/ngx-gp-api-core/src/public-api.ts","../../../projects/ngx-gp-api-core/src/ngx-gp-api-core.ts"],"sourcesContent":["import { HttpHeaders } from '@angular/common/http';\n\nexport function buildAuthHeaders(bearerToken?: string) {\n  let headers = new HttpHeaders();\n  if (bearerToken) headers = headers.set('Authorization', `Bearer ${bearerToken}`);\n  return headers;\n}\n","import { HttpErrorResponse } from '@angular/common/http';\n\nexport class ApiError extends Error {\n  constructor(\n    message: string,\n    public readonly status?: number,\n    public readonly payload?: unknown,\n    public readonly url?: string\n  ) {\n    super(message);\n    this.name = 'ApiError';\n  }\n}\n\nexport function toApiError(err: unknown, url?: string): ApiError {\n  if (err instanceof HttpErrorResponse) {\n    const payload = err.error;\n    const message =\n      (typeof payload === 'string' && payload) ||\n      (payload && (payload.message || payload.error)) ||\n      err.message ||\n      `HTTP error ${err.status}`;\n\n    return new ApiError(message, err.status, payload, url ?? err.url ?? undefined);\n  }\n\n  return new ApiError((err as any)?.message || 'Request failed', undefined, undefined, url);\n}\n","import {RequestOptionsBlob, RequestOptionsJson} from '../http-helpers/request-options';\nimport { buildAuthHeaders } from '../http-helpers/request-helpers';\nimport {HttpClient} from '@angular/common/http';\nimport {Observable, throwError} from 'rxjs';\nimport {catchError} from 'rxjs/operators';\nimport {toApiError} from '../http-helpers/api-error';\n\nexport function get<T = unknown>(\n  http: HttpClient,\n  opts: RequestOptionsJson | RequestOptionsBlob\n): Observable<T | Blob> {\n  const headers = buildAuthHeaders(opts.bearerToken);\n\n  if (opts.responseType === 'blob') {\n    return http\n      .get(opts.url, { headers, responseType: 'blob' as const })\n      .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n  }\n\n  return http\n    .get<T>(opts.url, { headers, responseType: 'json' as const })\n    .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n}\n","import {HttpClient} from '@angular/common/http';\nimport {Observable, throwError} from 'rxjs';\nimport {catchError} from 'rxjs/operators';\n\nimport {toApiError} from '../http-helpers/api-error';\nimport {BodyRequestOptionsBlob, BodyRequestOptionsJson} from '../http-helpers/request-options';\nimport {buildAuthHeaders} from '../http-helpers/request-helpers';\n\nexport function post<T = unknown>(\n  http: HttpClient,\n  opts: BodyRequestOptionsJson | BodyRequestOptionsBlob\n): Observable<T | Blob> {\n\n  let headers = buildAuthHeaders(opts.bearerToken);\n\n  headers = headers.set('Content-Type', 'application/json');\n\n  if (opts.responseType === 'blob') {\n    return http\n      .post(opts.url, opts.body, {headers, responseType: 'blob' as const})\n      .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n  }\n\n  return http\n    .post<T>(opts.url, opts.body, {headers, responseType: 'json' as const})\n    .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n}\n","import {HttpClient} from '@angular/common/http';\nimport {Observable, throwError} from 'rxjs';\nimport {catchError} from 'rxjs/operators';\n\nimport {toApiError} from '../http-helpers/api-error';\nimport {BodyRequestOptionsBlob, BodyRequestOptionsJson} from '../http-helpers/request-options';\nimport {buildAuthHeaders} from '../http-helpers/request-helpers';\n\nexport function put<T = unknown>(\n  http: HttpClient,\n  opts: BodyRequestOptionsJson | BodyRequestOptionsBlob\n): Observable<T | Blob> {\n  let headers = buildAuthHeaders(opts.bearerToken);\n\n  headers = headers.set('Content-Type', 'application/json');\n\n  if (opts.responseType === 'blob') {\n    return http\n      .put(opts.url, opts.body, {headers, responseType: 'blob' as const})\n      .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n  }\n\n  return http\n    .put<T>(opts.url, opts.body, {headers, responseType: 'json' as const})\n    .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n}\n","import {HttpClient} from '@angular/common/http';\nimport {Observable, throwError} from 'rxjs';\nimport {buildAuthHeaders} from '../http-helpers/request-helpers';\nimport {catchError} from 'rxjs/operators';\nimport {toApiError} from '../http-helpers/api-error';\nimport {BaseRequestOptions} from '../http-helpers/request-options';\n\nexport function delete_<T = unknown>(\n  http: HttpClient,\n  opts: BaseRequestOptions\n): Observable<T> {\n  const headers = buildAuthHeaders(opts.bearerToken);\n\n  return http\n    .delete<T>(opts.url, {headers, responseType: 'json' as const})\n    .pipe(catchError((e) => throwError(() => toApiError(e, opts.url))));\n}\n","import { inject, Injectable } from '@angular/core';\nimport { Observable } from 'rxjs';\nimport { HttpClient } from '@angular/common/http';\n\nimport { get } from './requests/get';\nimport { post } from './requests/post';\nimport { put } from './requests/put';\nimport { delete_ } from './requests/delete';\nimport {\n  BaseRequestOptions,\n  RequestOptionsBlob,\n  RequestOptionsJson,\n  BodyRequestOptionsBlob,\n  BodyRequestOptionsJson\n} from './http-helpers/request-options';\n\n@Injectable({ providedIn: 'root' })\nexport class GPApiCore {\n  private http = inject(HttpClient);\n\n  public get<T = unknown>(opts: RequestOptionsJson | RequestOptionsBlob): Observable<T | Blob> {\n    return get<T>(this.http, opts as any);\n  }\n\n  public post<T = unknown>(opts: BodyRequestOptionsJson | BodyRequestOptionsBlob): Observable<T | Blob> {\n    return post<T>(this.http, opts as any);\n  }\n\n  public put<T = unknown>(opts: BodyRequestOptionsJson | BodyRequestOptionsBlob): Observable<T | Blob> {\n    return put<T>(this.http, opts as any);\n  }\n\n  public delete<T = unknown>(opts: BaseRequestOptions): Observable<T>{\n    return delete_(this.http, opts as any);\n  }\n}\n","/*\n * Public API Surface of ngx-gp-api-core\n */\n\n//TODO: Adjust exports to what actually should be public\nexport { GPApiCore } from './lib/ngx-gp-api-core';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;;;AAEM,SAAU,gBAAgB,CAAC,WAAoB,EAAA;AACnD,IAAA,IAAI,OAAO,GAAG,IAAI,WAAW,EAAE;AAC/B,IAAA,IAAI,WAAW;QAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,CAAA,OAAA,EAAU,WAAW,CAAA,CAAE,CAAC;AAChF,IAAA,OAAO,OAAO;AAChB;;ACJM,MAAO,QAAS,SAAQ,KAAK,CAAA;AAGf,IAAA,MAAA;AACA,IAAA,OAAA;AACA,IAAA,GAAA;AAJlB,IAAA,WAAA,CACE,OAAe,EACC,MAAe,EACf,OAAiB,EACjB,GAAY,EAAA;QAE5B,KAAK,CAAC,OAAO,CAAC;QAJE,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,OAAO,GAAP,OAAO;QACP,IAAA,CAAA,GAAG,GAAH,GAAG;AAGnB,QAAA,IAAI,CAAC,IAAI,GAAG,UAAU;IACxB;AACD;AAEK,SAAU,UAAU,CAAC,GAAY,EAAE,GAAY,EAAA;AACnD,IAAA,IAAI,GAAG,YAAY,iBAAiB,EAAE;AACpC,QAAA,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK;QACzB,MAAM,OAAO,GACX,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO;aACtC,OAAO,KAAK,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;AAC/C,YAAA,GAAG,CAAC,OAAO;AACX,YAAA,CAAA,WAAA,EAAc,GAAG,CAAC,MAAM,CAAA,CAAE;AAE5B,QAAA,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,SAAS,CAAC;IAChF;AAEA,IAAA,OAAO,IAAI,QAAQ,CAAE,GAAW,EAAE,OAAO,IAAI,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC;AAC3F;;ACpBM,SAAU,GAAG,CACjB,IAAgB,EAChB,IAA6C,EAAA;IAE7C,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;AAElD,IAAA,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,EAAE;AAChC,QAAA,OAAO;AACJ,aAAA,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAe,EAAE;aACxD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE;AAEA,IAAA,OAAO;AACJ,SAAA,GAAG,CAAI,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAe,EAAE;SAC3D,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACvE;;ACdM,SAAU,IAAI,CAClB,IAAgB,EAChB,IAAqD,EAAA;IAGrD,IAAI,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAEhD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAEzD,IAAA,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,EAAE;AAChC,QAAA,OAAO;AACJ,aAAA,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,YAAY,EAAE,MAAe,EAAC;aAClE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE;AAEA,IAAA,OAAO;AACJ,SAAA,IAAI,CAAI,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,YAAY,EAAE,MAAe,EAAC;SACrE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACvE;;AClBM,SAAU,GAAG,CACjB,IAAgB,EAChB,IAAqD,EAAA;IAErD,IAAI,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAEhD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAEzD,IAAA,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,EAAE;AAChC,QAAA,OAAO;AACJ,aAAA,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,YAAY,EAAE,MAAe,EAAC;aACjE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE;AAEA,IAAA,OAAO;AACJ,SAAA,GAAG,CAAI,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,YAAY,EAAE,MAAe,EAAC;SACpE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACvE;;AClBM,SAAU,OAAO,CACrB,IAAgB,EAChB,IAAwB,EAAA;IAExB,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;AAElD,IAAA,OAAO;AACJ,SAAA,MAAM,CAAI,IAAI,CAAC,GAAG,EAAE,EAAC,OAAO,EAAE,YAAY,EAAE,MAAe,EAAC;SAC5D,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACvE;;MCCa,SAAS,CAAA;AACZ,IAAA,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;AAE1B,IAAA,GAAG,CAAc,IAA6C,EAAA;QACnE,OAAO,GAAG,CAAI,IAAI,CAAC,IAAI,EAAE,IAAW,CAAC;IACvC;AAEO,IAAA,IAAI,CAAc,IAAqD,EAAA;QAC5E,OAAO,IAAI,CAAI,IAAI,CAAC,IAAI,EAAE,IAAW,CAAC;IACxC;AAEO,IAAA,GAAG,CAAc,IAAqD,EAAA;QAC3E,OAAO,GAAG,CAAI,IAAI,CAAC,IAAI,EAAE,IAAW,CAAC;IACvC;AAEO,IAAA,MAAM,CAAc,IAAwB,EAAA;QACjD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAW,CAAC;IACxC;uGAjBW,SAAS,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAT,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,SAAS,cADI,MAAM,EAAA,CAAA;;2FACnB,SAAS,EAAA,UAAA,EAAA,CAAA;kBADrB,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;AChBlC;;AAEG;AAEH;;ACJA;;AAEG;;;;"}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "ngx-gp-api-core",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@angular/common": "^21.1.0",
+    "@angular/core": "^21.1.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/ngx-gp-api-core.mjs",
+  "typings": "types/ngx-gp-api-core.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./types/ngx-gp-api-core.d.ts",
+      "default": "./fesm2022/ngx-gp-api-core.mjs"
+    }
+  }
+}

package/types/ngx-gp-api-core.d.ts

@@ -0,0 +1,31 @@
+import { Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+
+interface BaseRequestOptions {
+    url: string;
+    bearerToken?: string;
+}
+type RequestOptionsJson = BaseRequestOptions & {
+    responseType?: 'json';
+};
+type RequestOptionsBlob = BaseRequestOptions & {
+    responseType: 'blob';
+};
+type BodyRequestOptionsJson = RequestOptionsJson & {
+    body: unknown;
+};
+type BodyRequestOptionsBlob = RequestOptionsBlob & {
+    body: unknown;
+};
+
+declare class GPApiCore {
+    private http;
+    get<T = unknown>(opts: RequestOptionsJson | RequestOptionsBlob): Observable<T | Blob>;
+    post<T = unknown>(opts: BodyRequestOptionsJson | BodyRequestOptionsBlob): Observable<T | Blob>;
+    put<T = unknown>(opts: BodyRequestOptionsJson | BodyRequestOptionsBlob): Observable<T | Blob>;
+    delete<T = unknown>(opts: BaseRequestOptions): Observable<T>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GPApiCore, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GPApiCore>;
+}
+
+export { GPApiCore };