@microsoft/paris - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

dist/lib/models/api-call-backend-config.interface.d.ts

@@ -6,10 +6,51 @@ import { EntityConfigFunctionOrValue } from "../entity/entity.config";
 export interface ApiCallBackendConfigInterface<T = any, TRawData = any> {
+    /**
+     * The URL to use for HTTP requests.
+     */
     endpoint?: EntityConfigFunctionOrValue;
+    /**
+     * If `cache` is specified, entities will be cached according to the cache settings.
+     * Note: cache refers to individual items (such as received from `getItemById` or with an ApiCall), not queries.
+     */
     cache?: boolean | DataCacheSettings<T>;
+    /**
+     * The domain to use for all calls for this Entity/ApiCall. Used as a prefix for all HTTP requests.
+     * Set to an empty string to avoid this altogether (in case the data arrives from an external URL, for example).
+     * If not set and not an empty string, Paris will use config.apiRoot instead.
+     */
     baseUrl?: EntityConfigFunctionOrValue;
+    /**
+     * Query params to always send when requesting data.
+     */
     fixedData?: {
         [index: string]: any;
     };
+    /**
+     * If `true`, a value that's specified in DataQuery.params and is an array will result in multiple params in the HTTP request
+     * @example <caption>Using separateArrayParams</caption>
+     * ```typescript
+     * @Entity({
+     * 	singularName: 'My entity',
+     * 	pluralName: 'My entities',
+     * 	endpoint: 'myentity',
+     * 	separateArrayParams: true
+     * })
+     * export class MyEntity extends EntityModelBase{}
+     *
+     * paris.query(MyEntity, { where: { foo: ['bar', 'lish'] }})
+     * 	.subscribe((dataSet:DataSet<MyEntity>) => console.log(dataSet));
+     * ```
+     *
+     * In this example, the API call will be to (config.apiRoot)/myentity?foo=bar&foo=lish.
+     * If separateArrayParams wasn't specified as `true`, the api call would have been to:
+     * (config.apiRoot)/myentity?foo=bar,lish
+     */
     separateArrayParams?: boolean;
+    /**
+     * A function that if specifies, parses whatever is received from the API call, before Paris starts handling it.
+     * @param {TRawData} data
+     * @param {ParisConfig} config
+     * @param {DataQuery} query
+     */
     parseData?: (data: TRawData, config?: ParisConfig, query?: DataQuery) => T;
 }

dist/lib/services/data-store.service.js

@@ -24,2 +24,4 @@ import { Http } from "./http.service";
     DataStoreService.prototype.getEndpointUrl = function (endpoint, baseUrl) {
+        if (baseUrl === '')
+            return endpoint;
         return (baseUrl || this.config.apiRoot || "") + "/" + endpoint;
@@ -26,0 +28,0 @@ };

package.json

 {
 	"name": "@microsoft/paris",
-	"version": "1.1.1",
+	"version": "1.1.2",
 	"description": "Library for the implementation of Domain Driven Design in Angular/TypeScript apps",
@@ -5,0 +5,0 @@ "repository": {

tsconfig.json

@@ -0,0 +0,0 @@ {

tsconfig.lib.json

@@ -0,0 +0,0 @@ {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

607418

increased by28.46%

Number of package files

136

increased by0.74%

Lines of code

4119

increased by1.05%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes