@cloudize/sdk-core 24.1.5 → 24.1.9

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Cloudize Limited.
+Copyright (c) 2025 Cloudize Limited.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/classes/resource.container.d.ts

@@ -1,5 +1,5 @@
 import { IRestClient, RestClientResponse } from '@cloudize/rest-client';
-import { IResourceContainer, IResourceObject, ResourceContainerIncludedResourceTypes, ResourceHeaderParams, ResourcePathParams, ResourceFilterName, ResourceFilterValue, ResourceIncludeOption, ResourceSortOption, SDKConfiguration } from '..';
+import { IResourceContainer, IResourceObject, ResourceContainerFacets, ResourceContainerIncludedResourceTypes, ResourceFacetField, ResourceFieldName, ResourceHeaderParams, ResourceObjectType, ResourcePathParams, ResourceFilterName, ResourceFilterValue, ResourceIncludeOption, ResourceSortOption, SDKConfiguration } from '..';
 export declare enum ResourceFilterType {
     Equal = "equal",
     NotEqual = "!equal",
@@ -18,6 +18,7 @@ export default class ResourceContainer implements IResourceContainer {
     private _count;
     private _countQueryHash;
     protected _data: IResourceObject | IResourceObject[];
+    protected _facets: ResourceContainerFacets;
     protected _includes: ResourceContainerIncludedResourceTypes;
     private _queryParams;
     private readonly _restClient;
@@ -26,6 +27,7 @@ export default class ResourceContainer implements IResourceContainer {
     protected pathParams: ResourcePathParams;
     constructor(params?: ResourceContainerParams);
     get data(): IResourceObject | IResourceObject[];
+    get facets(): ResourceContainerFacets;
     get includes(): ResourceContainerIncludedResourceTypes;
     get restClient(): IRestClient;
     get sdkConfig(): SDKConfiguration;
@@ -49,6 +51,8 @@ export default class ResourceContainer implements IResourceContainer {
     GetHeaders(action: string): ResourceHeaderParams;
     private GetQueryParams;
     IncludedObject(type: string, id: string): IResourceObject;
+    Facet(fields: ResourceFacetField[]): IResourceContainer;
+    Fields(resourceType: ResourceObjectType, fields: ResourceFieldName[]): IResourceContainer;
     Filter(filter: ResourceFilterName, selector: ResourceFilterType, value: ResourceFilterValue): IResourceContainer;
     Sort(option: ResourceSortOption): IResourceContainer;
     Include(include: ResourceIncludeOption): IResourceContainer;

package/lib/classes/resource.container.js

@@ -29,6 +29,7 @@ var ResourceFilterType;
 class ResourceContainer {
     constructor(params) {
         this._data = undefined;
+        this._facets = undefined;
         this._includes = {};
         this._restClient = (0, json_1.isDefined)(params === null || params === void 0 ? void 0 : params.restClient) ? params === null || params === void 0 ? void 0 : params.restClient : new rest_client_1.RestClient();
         this._sdkConfig = (0, json_1.isDefined)(params === null || params === void 0 ? void 0 : params.sdkConfig) ? params === null || params === void 0 ? void 0 : params.sdkConfig : (0, __1.SDKConfig)();
@@ -36,6 +37,7 @@ class ResourceContainer {
         this.pathParams = {};
         this._queryParams = {
             includes: {},
+            fields: {},
             filters: {},
             sort: undefined,
             pagination: {},
@@ -44,6 +46,9 @@ class ResourceContainer {
     get data() {
         throw new Error('Method or Property not implemented.');
     }
+    get facets() {
+        return this._facets;
+    }
     get includes() {
         return this._includes;
     }
@@ -76,6 +81,7 @@ class ResourceContainer {
     }
     ClearData() {
         this._data = undefined;
+        this._facets = undefined;
         this._includes = {};
     }
     AddResourceToMemoryStructure(obj) {
@@ -138,6 +144,24 @@ class ResourceContainer {
                 }
             }
         }
+        if ((0, json_1.hasProperty)(response.data, 'meta') && (0, json_1.isObject)(response.data.meta)) {
+            if ((0, json_1.hasProperty)(response.data.meta, 'facets') && (0, json_1.isObject)(response.data.meta.facets)) {
+                this._facets = {};
+                for (const facetFieldName in response.data.meta.facets) {
+                    if ((0, json_1.hasProperty)(response.data.meta.facets, facetFieldName)) {
+                        this._facets[facetFieldName] = {};
+                        for (const facetValue in response.data.meta.facets[facetFieldName]) {
+                            if ((0, json_1.hasProperty)(response.data.meta.facets[facetFieldName], facetValue)) {
+                                if ((0, json_1.isDefinedAndNotNull)(response.data.meta.facets[facetFieldName][facetValue])
+                                    && (0, json_1.isNumber)(response.data.meta.facets[facetFieldName][facetValue])) {
+                                    this._facets[facetFieldName][facetValue] = response.data.meta.facets[facetFieldName][facetValue];
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
     }
     Add() {
         throw new Error('Method or Property not implemented.');
@@ -227,6 +251,7 @@ class ResourceContainer {
     InitParams() {
         this._queryParams = {
             includes: {},
+            fields: {},
             filters: {},
             sort: undefined,
             pagination: {},
@@ -279,6 +304,14 @@ class ResourceContainer {
         }
         if (includeList.length > 0)
             queryParams.include = includeList.join(',');
+        if ((0, json_1.hasProperty)(this._queryParams, 'facets') && (0, json_1.isDefined)(this._queryParams.facets)) {
+            queryParams.facets = this._queryParams.facets;
+        }
+        for (const resourceType in this._queryParams.fields) {
+            if ((0, json_1.hasProperty)(this._queryParams.fields, resourceType)) {
+                queryParams[`fields[${resourceType}]`] = this._queryParams.fields[resourceType];
+            }
+        }
         if ((0, json_1.hasProperty)(this._queryParams.pagination, 'offset'))
             queryParams['page[offset]'] = this._queryParams.pagination.offset;
         if ((0, json_1.hasProperty)(this._queryParams.pagination, 'page'))
@@ -294,6 +327,14 @@ class ResourceContainer {
     IncludedObject(type, id) {
         throw new Error('Method or Property not implemented.');
     }
+    Facet(fields) {
+        this._queryParams.facets = fields.join(',');
+        return this;
+    }
+    Fields(resourceType, fields) {
+        this._queryParams.fields[resourceType] = fields.join(',');
+        return this;
+    }
     Filter(filter, selector, value) {
         this._queryParams.filters[`${selector}:${filter}`] = value;
         return this;

package/lib/interfaces/index.d.ts

@@ -1,2 +1,2 @@
 export { ISDKError, ISDKRequestError, ISDKException, ISDKRequestException, } from './sdk.errors';
-export { IResourceContainer, ResourceContainerIncludedResourceTypes, ResourceFilterName, ResourceFilterValue, ResourceSortOption, ResourceIncludeOption, IResourceObject, IResourceObjectAttributes, IResourceObjectRelationships, GeospatialPoint, ResourceObjectAttributeBase, ResourceObjectAttributesLoadType, ResourceObjectRelationshipLinkObject, ResourceObjectRelationshipLink, ResourceObjectRelationshipsLinks, ResourceObjectRelationshipsLoadType, ResourceObjectRelationship, ResourceObjectRelationships, ResourceObjectUri, ResourceObjectRelationshipBase, } from './resource.interfaces';
+export { IResourceContainer, ResourceContainerFacetValue, ResourceContainerFacets, ResourceContainerIncludedResourceTypes, ResourceFacetField, ResourceFieldName, ResourceFilterName, ResourceFilterValue, ResourceObjectType, ResourceSortOption, ResourceIncludeOption, IResourceObject, IResourceObjectAttributes, IResourceObjectRelationships, GeospatialPoint, ResourceObjectAttributeBase, ResourceObjectAttributesLoadType, ResourceObjectRelationshipLinkObject, ResourceObjectRelationshipLink, ResourceObjectRelationshipsLinks, ResourceObjectRelationshipsLoadType, ResourceObjectRelationship, ResourceObjectRelationships, ResourceObjectUri, ResourceObjectRelationshipBase, } from './resource.interfaces';

package/lib/interfaces/resource.interfaces.d.ts

@@ -19,6 +19,12 @@ export type ResourceObjectRelationshipLink = {
 export type ResourceObjectRelationshipsLinks = {
     data: ResourceObjectRelationshipLinkObject[];
 };
+export type ResourceContainerFacetValue = {
+    [value: string]: number;
+};
+export type ResourceContainerFacets = {
+    [fieldName: string]: ResourceContainerFacetValue;
+};
 export type ResourceContainerIncludedResources = {
     [id: string]: IResourceObject;
 };
@@ -70,15 +76,20 @@ export interface IResourceObject {
     UpdateAttributes(value: any): void;
     UpdateRelationships(value: any): void;
 }
+export type ResourceFacetField = string;
+export type ResourceFieldName = string;
 export type ResourceFilterName = string;
 export type ResourceFilterValue = string;
 export type ResourceSortOption = string;
 export type ResourceIncludeOption = string;
 export interface IResourceContainer {
     data: IResourceObject | IResourceObject[];
+    facets: ResourceContainerFacets;
     includes: ResourceContainerIncludedResourceTypes;
     restClient: IRestClient;
     uri: string;
+    Facet(fields: ResourceFacetField[]): IResourceContainer;
+    Fields(resource: ResourceObjectType, fields: ResourceFieldName[]): IResourceContainer;
     Filter(filter: ResourceFilterName, selector: ResourceFilterType, value: ResourceFilterValue): IResourceContainer;
     GetHeaders(action: string): ResourceHeaderParams;
     Sort(option: ResourceSortOption): IResourceContainer;

package/package.json

@@ -13,7 +13,7 @@
   ],
   "description": "Cloudize SDK Core",
   "license": "MIT",
-  "version": "24.1.5",
+  "version": "24.1.9",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
@@ -33,26 +33,26 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@cloudize/json": "^24.1.5",
-    "@cloudize/rest-client": "^24.1.5",
+    "@cloudize/json": "^24.1.8",
+    "@cloudize/rest-client": "^24.1.8",
     "object-hash": "^3.0.0"
   },
   "devDependencies": {
     "@types/date-and-time": "^0.13.0",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.15",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.14",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
-    "date-and-time": "^3.4.1",
-    "eslint": "^8.57.0",
+    "date-and-time": "^3.6.0",
+    "eslint": "^8.57.1",
     "eslint-config-airbnb": "^19.0.4",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsx-a11y": "^6.9.0",
-    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^4.6.2",
     "jest": "^29.7.0",
-    "ts-jest": "^29.2.4",
-    "typescript": "^5.5.4"
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
   },
   "eslintConfig": {},
   "repository": {