@ps-aux/api-client-angular 0.5.0-rc2 → 0.7.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 psaux
+
+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,20 @@
+# @ps-aux/api-client-angular
+
+Angular HttpClient wrapper that implements Observable-based API requests.
+
+## Install
+- npm install @ps-aux/api-client-angular
+
+## Usage
+
+```ts
+import { HttpClient } from '@angular/common/http'
+import { createHttpClient } from '@ps-aux/api-client-angular'
+
+const http = createHttpClient(angularHttpClient)
+
+http.request({ path: '/users', method: 'GET' }).subscribe(console.log)
+```
+
+## License
+MIT

package/dist/index.esm.js

@@ -1,259 +1,4 @@
 import { map } from 'rxjs';
-import qs from 'qs';
-
-const { isArray } = Array;
-
-function fromPairs(listOfPairs){
-  const toReturn = {};
-  listOfPairs.forEach(([ prop, value ]) => toReturn[ prop ] = value);
-
-  return toReturn
-}
-
-function partitionObject(predicate, iterable){
-  const yes = {};
-  const no = {};
-  Object.entries(iterable).forEach(([ prop, value ]) => {
-    if (predicate(value, prop)){
-      yes[ prop ] = value;
-    } else {
-      no[ prop ] = value;
-    }
-  });
-
-  return [ yes, no ]
-}
-
-function partitionArray(
-  predicate, list, indexed = false
-){
-  const yes = [];
-  const no = [];
-  let counter = -1;
-
-  while (counter++ < list.length - 1){
-    if (
-      indexed ? predicate(list[ counter ], counter) : predicate(list[ counter ])
-    ){
-      yes.push(list[ counter ]);
-    } else {
-      no.push(list[ counter ]);
-    }
-  }
-
-  return [ yes, no ]
-}
-
-function partition(predicate, iterable){
-  if (arguments.length === 1){
-    return listHolder => partition(predicate, listHolder)
-  }
-  if (!isArray(iterable)) return partitionObject(predicate, iterable)
-
-  return partitionArray(predicate, iterable)
-}
-
-var flat = flatten$1;
-flatten$1.flatten = flatten$1;
-flatten$1.unflatten = unflatten;
-
-function isBuffer (obj) {
-  return obj &&
-    obj.constructor &&
-    (typeof obj.constructor.isBuffer === 'function') &&
-    obj.constructor.isBuffer(obj)
-}
-
-function keyIdentity (key) {
-  return key
-}
-
-function flatten$1 (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const maxDepth = opts.maxDepth;
-  const transformKey = opts.transformKey || keyIdentity;
-  const output = {};
-
-  function step (object, prev, currentDepth) {
-    currentDepth = currentDepth || 1;
-    Object.keys(object).forEach(function (key) {
-      const value = object[key];
-      const isarray = opts.safe && Array.isArray(value);
-      const type = Object.prototype.toString.call(value);
-      const isbuffer = isBuffer(value);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      const newKey = prev
-        ? prev + delimiter + transformKey(key)
-        : transformKey(key);
-
-      if (!isarray && !isbuffer && isobject && Object.keys(value).length &&
-        (!opts.maxDepth || currentDepth < maxDepth)) {
-        return step(value, newKey, currentDepth + 1)
-      }
-
-      output[newKey] = value;
-    });
-  }
-
-  step(target);
-
-  return output
-}
-
-function unflatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const overwrite = opts.overwrite || false;
-  const transformKey = opts.transformKey || keyIdentity;
-  const result = {};
-
-  const isbuffer = isBuffer(target);
-  if (isbuffer || Object.prototype.toString.call(target) !== '[object Object]') {
-    return target
-  }
-
-  // safely ensure that the key is
-  // an integer.
-  function getkey (key) {
-    const parsedKey = Number(key);
-
-    return (
-      isNaN(parsedKey) ||
-      key.indexOf('.') !== -1 ||
-      opts.object
-    ) ? key
-      : parsedKey
-  }
-
-  function addKeys (keyPrefix, recipient, target) {
-    return Object.keys(target).reduce(function (result, key) {
-      result[keyPrefix + delimiter + key] = target[key];
-
-      return result
-    }, recipient)
-  }
-
-  function isEmpty (val) {
-    const type = Object.prototype.toString.call(val);
-    const isArray = type === '[object Array]';
-    const isObject = type === '[object Object]';
-
-    if (!val) {
-      return true
-    } else if (isArray) {
-      return !val.length
-    } else if (isObject) {
-      return !Object.keys(val).length
-    }
-  }
-
-  target = Object.keys(target).reduce(function (result, key) {
-    const type = Object.prototype.toString.call(target[key]);
-    const isObject = (type === '[object Object]' || type === '[object Array]');
-    if (!isObject || isEmpty(target[key])) {
-      result[key] = target[key];
-      return result
-    } else {
-      return addKeys(
-        key,
-        result,
-        flatten$1(target[key], opts)
-      )
-    }
-  }, {});
-
-  Object.keys(target).forEach(function (key) {
-    const split = key.split(delimiter).map(transformKey);
-    let key1 = getkey(split.shift());
-    let key2 = getkey(split[0]);
-    let recipient = result;
-
-    while (key2 !== undefined) {
-      if (key1 === '__proto__') {
-        return
-      }
-
-      const type = Object.prototype.toString.call(recipient[key1]);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      // do not write over falsey, non-undefined values if overwrite is false
-      if (!overwrite && !isobject && typeof recipient[key1] !== 'undefined') {
-        return
-      }
-
-      if ((overwrite && !isobject) || (!overwrite && recipient[key1] == null)) {
-        recipient[key1] = (
-          typeof key2 === 'number' &&
-          !opts.object ? [] : {}
-        );
-      }
-
-      recipient = recipient[key1];
-      if (split.length > 0) {
-        key1 = getkey(split.shift());
-        key2 = getkey(split[0]);
-      }
-    }
-
-    // unflatten again for 'messy objects'
-    recipient[key1] = unflatten(target[key], opts);
-  });
-
-  return result
-}
-
-/**
- *  Brings the 1st level to the 0th level.
- *  Flats the object by nesting with '.' path separator.
- */
-const serializeQueryForSpringBoot = (obj) => {
-    const parts = [];
-    Object.entries(obj).forEach(([key, val]) => {
-        if (Array.isArray(val)) {
-            val.forEach((v) => {
-                parts.push([key, v]);
-            });
-        }
-        else if (typeof val === 'object') {
-            objectToParams(val).forEach(([key, val]) => {
-                parts.push([key, val.toString()]);
-            });
-        }
-        else {
-            parts.push([key, val]);
-        }
-    });
-    return parts.map((p) => `${p[0]}=${p[1]}`).join('&');
-};
-const flatten = (obj) => {
-    const r = flat.flatten(obj);
-    //   { empty: {} } would be { empty: {} } instead of empty array
-    return Object.entries(r).filter(([k, v]) => typeof v !== 'object');
-};
-const objectToParams = (obj) => {
-    const [arrayProps, nonArrayProps] = partition((e) => Array.isArray(e[1]), Object.entries(obj));
-    const withoutArrayProps = fromPairs(nonArrayProps);
-    const res = flatten(withoutArrayProps);
-    arrayProps.forEach(([k, vals]) => {
-        vals.forEach((v) => res.push([k, v]));
-    });
-    return res;
-};
-
-// @ts-ignore
-const serializeQueryWithQs = (obj) => {
-    return qs.stringify(obj);
-};
 
 const fileResFilenameRegex = /filename="([^"]+)"/;
 const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
@@ -265,25 +10,23 @@ const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
 };
 
 const ContentType = {
+    Json: 'application/json',
     FormData: 'multipart/form-data'
 };
 
-const qsUrlConverter = () => ({ query, path }) => {
-    return {
-        url: path + (query ? `?${serializeQueryWithQs(query)}` : '')
-    };
-};
-const springBootUrlConverter = () => ({ query, path }) => {
+const noOpUrlConverter = () => ({ query, path }) => {
     return {
-        url: path + (query ? `?${serializeQueryForSpringBoot(query)}` : '')
+        url: path,
+        params: query
     };
 };
-const createHttpClient = (client, urlConverter = qsUrlConverter()) => {
+const createHttpClient = (client, urlConverter = noOpUrlConverter()) => {
     return {
         request: (req) => {
             const { url, params } = urlConverter(req);
             const isBlob = req.format === 'document';
             const obs = client.request(req.method, url, {
+                headers: req.headers,
                 params,
                 body: prepareBody(req.body, req.type),
                 responseType: (isBlob ? 'blob' : 'json'),
@@ -311,7 +54,7 @@ const prepareBody = (payload, type) => {
 const convertToFormData = (payload) => {
     const formData = new FormData();
     const addProp = (key, val) => {
-        if (Array.isArray(val) || val instanceof FileList) {
+        if (Array.isArray(val) || (typeof FileList !== 'undefined' && val instanceof FileList)) {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore - seems that FileList is iterable despite the warning
             // TODO change to other iteration method if this is not true
@@ -330,4 +73,4 @@ const convertToFormData = (payload) => {
     return formData;
 };
 
-export { createHttpClient, qsUrlConverter, springBootUrlConverter };
+export { ContentType, createHttpClient };

package/dist/index.js

@@ -1,261 +1,6 @@
 'use strict';
 
 var rxjs = require('rxjs');
-var qs = require('qs');
-
-const { isArray } = Array;
-
-function fromPairs(listOfPairs){
-  const toReturn = {};
-  listOfPairs.forEach(([ prop, value ]) => toReturn[ prop ] = value);
-
-  return toReturn
-}
-
-function partitionObject(predicate, iterable){
-  const yes = {};
-  const no = {};
-  Object.entries(iterable).forEach(([ prop, value ]) => {
-    if (predicate(value, prop)){
-      yes[ prop ] = value;
-    } else {
-      no[ prop ] = value;
-    }
-  });
-
-  return [ yes, no ]
-}
-
-function partitionArray(
-  predicate, list, indexed = false
-){
-  const yes = [];
-  const no = [];
-  let counter = -1;
-
-  while (counter++ < list.length - 1){
-    if (
-      indexed ? predicate(list[ counter ], counter) : predicate(list[ counter ])
-    ){
-      yes.push(list[ counter ]);
-    } else {
-      no.push(list[ counter ]);
-    }
-  }
-
-  return [ yes, no ]
-}
-
-function partition(predicate, iterable){
-  if (arguments.length === 1){
-    return listHolder => partition(predicate, listHolder)
-  }
-  if (!isArray(iterable)) return partitionObject(predicate, iterable)
-
-  return partitionArray(predicate, iterable)
-}
-
-var flat = flatten$1;
-flatten$1.flatten = flatten$1;
-flatten$1.unflatten = unflatten;
-
-function isBuffer (obj) {
-  return obj &&
-    obj.constructor &&
-    (typeof obj.constructor.isBuffer === 'function') &&
-    obj.constructor.isBuffer(obj)
-}
-
-function keyIdentity (key) {
-  return key
-}
-
-function flatten$1 (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const maxDepth = opts.maxDepth;
-  const transformKey = opts.transformKey || keyIdentity;
-  const output = {};
-
-  function step (object, prev, currentDepth) {
-    currentDepth = currentDepth || 1;
-    Object.keys(object).forEach(function (key) {
-      const value = object[key];
-      const isarray = opts.safe && Array.isArray(value);
-      const type = Object.prototype.toString.call(value);
-      const isbuffer = isBuffer(value);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      const newKey = prev
-        ? prev + delimiter + transformKey(key)
-        : transformKey(key);
-
-      if (!isarray && !isbuffer && isobject && Object.keys(value).length &&
-        (!opts.maxDepth || currentDepth < maxDepth)) {
-        return step(value, newKey, currentDepth + 1)
-      }
-
-      output[newKey] = value;
-    });
-  }
-
-  step(target);
-
-  return output
-}
-
-function unflatten (target, opts) {
-  opts = opts || {};
-
-  const delimiter = opts.delimiter || '.';
-  const overwrite = opts.overwrite || false;
-  const transformKey = opts.transformKey || keyIdentity;
-  const result = {};
-
-  const isbuffer = isBuffer(target);
-  if (isbuffer || Object.prototype.toString.call(target) !== '[object Object]') {
-    return target
-  }
-
-  // safely ensure that the key is
-  // an integer.
-  function getkey (key) {
-    const parsedKey = Number(key);
-
-    return (
-      isNaN(parsedKey) ||
-      key.indexOf('.') !== -1 ||
-      opts.object
-    ) ? key
-      : parsedKey
-  }
-
-  function addKeys (keyPrefix, recipient, target) {
-    return Object.keys(target).reduce(function (result, key) {
-      result[keyPrefix + delimiter + key] = target[key];
-
-      return result
-    }, recipient)
-  }
-
-  function isEmpty (val) {
-    const type = Object.prototype.toString.call(val);
-    const isArray = type === '[object Array]';
-    const isObject = type === '[object Object]';
-
-    if (!val) {
-      return true
-    } else if (isArray) {
-      return !val.length
-    } else if (isObject) {
-      return !Object.keys(val).length
-    }
-  }
-
-  target = Object.keys(target).reduce(function (result, key) {
-    const type = Object.prototype.toString.call(target[key]);
-    const isObject = (type === '[object Object]' || type === '[object Array]');
-    if (!isObject || isEmpty(target[key])) {
-      result[key] = target[key];
-      return result
-    } else {
-      return addKeys(
-        key,
-        result,
-        flatten$1(target[key], opts)
-      )
-    }
-  }, {});
-
-  Object.keys(target).forEach(function (key) {
-    const split = key.split(delimiter).map(transformKey);
-    let key1 = getkey(split.shift());
-    let key2 = getkey(split[0]);
-    let recipient = result;
-
-    while (key2 !== undefined) {
-      if (key1 === '__proto__') {
-        return
-      }
-
-      const type = Object.prototype.toString.call(recipient[key1]);
-      const isobject = (
-        type === '[object Object]' ||
-        type === '[object Array]'
-      );
-
-      // do not write over falsey, non-undefined values if overwrite is false
-      if (!overwrite && !isobject && typeof recipient[key1] !== 'undefined') {
-        return
-      }
-
-      if ((overwrite && !isobject) || (!overwrite && recipient[key1] == null)) {
-        recipient[key1] = (
-          typeof key2 === 'number' &&
-          !opts.object ? [] : {}
-        );
-      }
-
-      recipient = recipient[key1];
-      if (split.length > 0) {
-        key1 = getkey(split.shift());
-        key2 = getkey(split[0]);
-      }
-    }
-
-    // unflatten again for 'messy objects'
-    recipient[key1] = unflatten(target[key], opts);
-  });
-
-  return result
-}
-
-/**
- *  Brings the 1st level to the 0th level.
- *  Flats the object by nesting with '.' path separator.
- */
-const serializeQueryForSpringBoot = (obj) => {
-    const parts = [];
-    Object.entries(obj).forEach(([key, val]) => {
-        if (Array.isArray(val)) {
-            val.forEach((v) => {
-                parts.push([key, v]);
-            });
-        }
-        else if (typeof val === 'object') {
-            objectToParams(val).forEach(([key, val]) => {
-                parts.push([key, val.toString()]);
-            });
-        }
-        else {
-            parts.push([key, val]);
-        }
-    });
-    return parts.map((p) => `${p[0]}=${p[1]}`).join('&');
-};
-const flatten = (obj) => {
-    const r = flat.flatten(obj);
-    //   { empty: {} } would be { empty: {} } instead of empty array
-    return Object.entries(r).filter(([k, v]) => typeof v !== 'object');
-};
-const objectToParams = (obj) => {
-    const [arrayProps, nonArrayProps] = partition((e) => Array.isArray(e[1]), Object.entries(obj));
-    const withoutArrayProps = fromPairs(nonArrayProps);
-    const res = flatten(withoutArrayProps);
-    arrayProps.forEach(([k, vals]) => {
-        vals.forEach((v) => res.push([k, v]));
-    });
-    return res;
-};
-
-// @ts-ignore
-const serializeQueryWithQs = (obj) => {
-    return qs.stringify(obj);
-};
 
 const fileResFilenameRegex = /filename="([^"]+)"/;
 const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
@@ -267,25 +12,23 @@ const getFileNameFromContentDispositionHeader = (contentDispositionHeader) => {
 };
 
 const ContentType = {
+    Json: 'application/json',
     FormData: 'multipart/form-data'
 };
 
-const qsUrlConverter = () => ({ query, path }) => {
-    return {
-        url: path + (query ? `?${serializeQueryWithQs(query)}` : '')
-    };
-};
-const springBootUrlConverter = () => ({ query, path }) => {
+const noOpUrlConverter = () => ({ query, path }) => {
     return {
-        url: path + (query ? `?${serializeQueryForSpringBoot(query)}` : '')
+        url: path,
+        params: query
     };
 };
-const createHttpClient = (client, urlConverter = qsUrlConverter()) => {
+const createHttpClient = (client, urlConverter = noOpUrlConverter()) => {
     return {
         request: (req) => {
             const { url, params } = urlConverter(req);
             const isBlob = req.format === 'document';
             const obs = client.request(req.method, url, {
+                headers: req.headers,
                 params,
                 body: prepareBody(req.body, req.type),
                 responseType: (isBlob ? 'blob' : 'json'),
@@ -313,7 +56,7 @@ const prepareBody = (payload, type) => {
 const convertToFormData = (payload) => {
     const formData = new FormData();
     const addProp = (key, val) => {
-        if (Array.isArray(val) || val instanceof FileList) {
+        if (Array.isArray(val) || (typeof FileList !== 'undefined' && val instanceof FileList)) {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore - seems that FileList is iterable despite the warning
             // TODO change to other iteration method if this is not true
@@ -332,6 +75,5 @@ const convertToFormData = (payload) => {
     return formData;
 };
 
+exports.ContentType = ContentType;
 exports.createHttpClient = createHttpClient;
-exports.qsUrlConverter = qsUrlConverter;
-exports.springBootUrlConverter = springBootUrlConverter;

package/package.json

@@ -1,23 +1,70 @@
 {
   "name": "@ps-aux/api-client-angular",
-  "version": "0.5.0-rc2",
+  "version": "0.7.0-rc.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.esm.js",
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c --watch",
+    "test": "vitest",
     "pub": "npm run build && npm --access public publish",
     "tc": "tsc"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "psaux",
+  "license": "MIT",
   "dependencies": {
-    "qs": "^6.11.2",
-    "@ps-aux/api-client-common": "^0.0.1"
+    "@local/shared": "*"
+  },
+  "bundledDependencies": [
+    "@local/shared"
+  ],
+  "devDependencies": {
+    "@angular/common": "^19.0.0 || ^20.0.0",
+    "@angular/compiler": "^19.0.0 || ^20.0.0"
   },
   "peerDependencies": {
-    "rxjs": "^7.8.1",
-    "@angular/core": "^19.0.0 || ^20.0.0"
-  }
+    "@angular/core": "^19.0.0 || ^20.0.0",
+    "@angular/common": "^19.0.0 || ^20.0.0",
+    "rxjs": "^7.8.1"
+  },
+  "description": "Angular HttpClient wrapper that implements Observable-based API requests.",
+  "keywords": [
+    "openapi",
+    "api",
+    "client",
+    "angular",
+    "http",
+    "rxjs",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ps-aux/api-tests.git",
+    "directory": "packages/api-client-angular"
+  },
+  "homepage": "https://github.com/ps-aux/api-tests",
+  "bugs": {
+    "url": "https://github.com/ps-aux/api-tests/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/index.js",
+    "dist/index.esm.js",
+    "dist/index.d.ts",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "sideEffects": false
 }

package/dist/AngularApiHttpClient.d.ts

@@ -1,5 +0,0 @@
-import { HttpClient as AngularHttpClient } from '@angular/common/http';
-import { UrlConverter, ObservableHttpClient } from '@ps-aux/api-client-common';
-export declare const qsUrlConverter: () => UrlConverter;
-export declare const springBootUrlConverter: () => UrlConverter;
-export declare const createHttpClient: (client: AngularHttpClient, urlConverter?: UrlConverter) => ObservableHttpClient<never>;

package/dist/_index.d.ts

@@ -1 +0,0 @@
-export { createHttpClient, springBootUrlConverter, qsUrlConverter } from './AngularApiHttpClient';

package/dist/index.d.ts

@@ -1 +0,0 @@
-export { createHttpClient, springBootUrlConverter, qsUrlConverter } from './AngularApiHttpClient';

package/dist/serializeQuery.d.ts

@@ -1,2 +0,0 @@
-export declare const serializeQuery: (obj: any) => any;
-export declare const flattenObject: (obj: any, prefix?: string) => any;

package/rollup.config.mjs

@@ -1,29 +0,0 @@
-import typescript from 'rollup-plugin-typescript2'
-import resolve from '@rollup/plugin-node-resolve'
-import commonjs from '@rollup/plugin-commonjs'
-
-/**
- * @type {import('rollup').RollupOptions}
- */
-const config = {
-    input: 'src/index.ts',
-    output: [
-        {
-            file: `dist/index.js`,
-            format: 'cjs',
-        },
-        {
-            file: `dist/index.esm.js`,
-            format: 'es',
-        },
-    ],
-    plugins: [
-        typescript(),
-        resolve(),
-        commonjs(),
-    ],
-    external: ['qs', 'rxjs'],
-
-}
-export default config
-

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "allowJs": true
-  },
-  "extends": "../../tsconfig.json",
-  "include": [
-    "src/**/*.ts"
-  ]
-}