@apigames/sdk-core 22.1.16 → 22.1.17

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

@@ -1,5 +1,5 @@
 import { IRestClient, RestClientResponse } from '@apigames/rest-client';
-import { IResourceContainer, IResourceObject, ResourceFilterName, ResourceFilterValue, ResourceIncludeOption, ResourcePathParams, ResourceSortOption } from '..';
+import { IResourceContainer, IResourceObject, ResourceContainerIncludedResourceTypes, ResourcePathParams, ResourceQueryFilterName, ResourceQueryFilterValue, ResourceQueryIncludeOption, ResourceQuerySortOption } from '..';
 export declare enum ResourceFilterType {
     Equal = "equal",
     NotEqual = "!equal",
@@ -14,11 +14,13 @@ export default class ResourceContainer implements IResourceContainer {
     private _count;
     private _countQueryHash;
     protected _data: IResourceObject | IResourceObject[];
+    protected _includes: ResourceContainerIncludedResourceTypes;
     private _queryParams;
     private readonly _restClient;
     protected pathParams: ResourcePathParams;
     constructor(restClient?: IRestClient);
     get data(): IResourceObject | IResourceObject[];
+    get includes(): ResourceContainerIncludedResourceTypes;
     get restClient(): IRestClient;
     get uri(): string;
     isResourceObject(value: any): value is IResourceObject;
@@ -39,9 +41,9 @@ export default class ResourceContainer implements IResourceContainer {
     private GetHeaders;
     private GetQueryParams;
     IncludedObject(type: string, id: string): IResourceObject;
-    Filter(filter: ResourceFilterName, selector: ResourceFilterType, value: ResourceFilterValue): IResourceContainer;
-    Sort(option: ResourceSortOption): IResourceContainer;
-    Include(include: ResourceIncludeOption): IResourceContainer;
+    Filter(filter: ResourceQueryFilterName, selector: ResourceFilterType, value: ResourceQueryFilterValue): IResourceContainer;
+    Sort(option: ResourceQuerySortOption): IResourceContainer;
+    Include(include: ResourceQueryIncludeOption): IResourceContainer;
     PageOffset(pageOffset: number, pageSize: number): IResourceContainer;
     PageNumber(pageNumber: number, pageSize: number): IResourceContainer;
 }

package/lib/classes/resource.container.js

@@ -29,6 +29,7 @@ var ResourceFilterType;
 class ResourceContainer {
     constructor(restClient) {
         this._data = undefined;
+        this._includes = {};
         this._restClient = (0, json_1.isDefined)(restClient) ? restClient : new rest_client_1.RestClient();
         this.pathParams = {};
         this._queryParams = {
@@ -41,6 +42,9 @@ class ResourceContainer {
     get data() {
         throw new Error('Method or Property not implemented.');
     }
+    get includes() {
+        return this._includes;
+    }
     get restClient() {
         return this._restClient;
     }
@@ -67,6 +71,7 @@ class ResourceContainer {
     }
     ClearData() {
         this._data = undefined;
+        this._includes = {};
     }
     AddResourceToMemoryStructure(obj) {
         if ((0, json_1.isDefined)(this.data)) {
@@ -110,14 +115,22 @@ class ResourceContainer {
         if ((0, json_1.hasProperty)(response.data, 'data')) {
             if ((0, json_1.isArray)(response.data.data)) {
                 this._data = [];
-                for (const resource of response.data.data) {
-                    this.AddResourceToMemoryStructure(this.LoadResourceData(resource));
+                for (const resourceData of response.data.data) {
+                    this.AddResourceToMemoryStructure(this.LoadResourceData(resourceData));
                 }
             }
             else if ((0, json_1.isObject)(response.data.data)) {
                 this.AddResourceToMemoryStructure(this.LoadResourceData(response.data.data));
             }
         }
+        if ((0, json_1.hasProperty)(response.data, 'included')) {
+            if ((0, json_1.isArray)(response.data.included)) {
+                for (const resourceData of response.data.included) {
+                    const resourceObject = this.LoadResourceData(resourceData);
+                    this._includes[resourceObject.type][resourceObject.id] = resourceObject;
+                }
+            }
+        }
     }
     Add() {
         throw new Error('Method or Property not implemented.');

package/lib/classes/resource.object.js

@@ -107,23 +107,23 @@ class ResourceObject {
             for (const fieldName in data) {
                 if ((0, json_1.hasProperty)(data, fieldName)) {
                     if ((0, json_1.isDefinedAndNotNull)(data[fieldName])) {
-                        if ((0, json_1.isArrayOfStrings)(data[fieldName])) {
+                        if ((0, __1.isResourceObjectRelationships)(data[fieldName])) {
                             payload[fieldName] = {
                                 data: [],
                             };
-                            for (const key of data[fieldName]) {
+                            for (const relationship of data[fieldName]) {
                                 payload[fieldName].data.push({
-                                    type: this.RelationshipType(fieldName),
-                                    id: key,
+                                    type: relationship.type,
+                                    id: relationship.id,
                                 });
                             }
                         }
-                        else if ((0, json_1.isString)(data[fieldName])) {
+                        else if ((0, __1.isResourceObjectRelationship)(data[fieldName])) {
                             if ((0, json_1.isUndefined)(shadow) || !(0, json_1.areEqual)(shadow[fieldName], data[fieldName])) {
                                 payload[fieldName] = {
                                     data: {
-                                        type: this.RelationshipType(fieldName),
-                                        id: data[fieldName],
+                                        type: data[fieldName].type,
+                                        id: data[fieldName].id,
                                     },
                                 };
                             }

package/lib/interfaces/index.d.ts

@@ -1,3 +1,2 @@
 export { ISDKError, ISDKRequestError, ISDKException, ISDKRequestException, } from './sdk.errors';
-export { IResourceContainer, ResourceFilterName, ResourceFilterValue, ResourceSortOption, ResourceIncludeOption, } from './resource.container';
-export { IResourceObject, IResourceObjectAttributes, IResourceObjectRelationships, GeospatialPoint, ResourceObjectAttributeBase, ResourceObjectAttributesLoadType, ResourceObjectRelationshipLinkObject, ResourceObjectRelationship, ResourceObjectRelationships, ResourceObjectRelationshipsLoadType, ResourceObjectRelationshipKey, ResourceObjectRelationshipKeys, ResourceObjectUri, ResourceObjectRelationshipBase, } from './resource.object';
+export { IResourceContainer, ResourceContainerIncludedResourceTypes, ResourceQueryFilterName, ResourceQueryFilterValue, ResourceQuerySortOption, ResourceQueryIncludeOption, IResourceObject, IResourceObjectAttributes, IResourceObjectRelationships, GeospatialPoint, ResourceObjectAttributeBase, ResourceObjectAttributesLoadType, ResourceObjectRelationshipLinkObject, ResourceObjectRelationshipLink, ResourceObjectRelationshipsLinks, ResourceObjectRelationshipsLoadType, ResourceObjectRelationship, ResourceObjectRelationships, ResourceObjectUri, ResourceObjectRelationshipBase, } from './resource.interfaces';

package/lib/interfaces/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceObjectRelationshipBase = exports.ResourceObjectRelationshipsLoadType = exports.ResourceObjectAttributesLoadType = exports.ResourceObjectAttributeBase = exports.GeospatialPoint = void 0;
-var resource_object_1 = require("./resource.object");
-Object.defineProperty(exports, "GeospatialPoint", { enumerable: true, get: function () { return resource_object_1.GeospatialPoint; } });
-Object.defineProperty(exports, "ResourceObjectAttributeBase", { enumerable: true, get: function () { return resource_object_1.ResourceObjectAttributeBase; } });
-Object.defineProperty(exports, "ResourceObjectAttributesLoadType", { enumerable: true, get: function () { return resource_object_1.ResourceObjectAttributesLoadType; } });
-Object.defineProperty(exports, "ResourceObjectRelationshipsLoadType", { enumerable: true, get: function () { return resource_object_1.ResourceObjectRelationshipsLoadType; } });
-Object.defineProperty(exports, "ResourceObjectRelationshipBase", { enumerable: true, get: function () { return resource_object_1.ResourceObjectRelationshipBase; } });
+exports.ResourceObjectRelationshipBase = exports.ResourceObjectRelationship = exports.ResourceObjectRelationshipsLoadType = exports.ResourceObjectAttributesLoadType = exports.ResourceObjectAttributeBase = exports.GeospatialPoint = void 0;
+var resource_interfaces_1 = require("./resource.interfaces");
+Object.defineProperty(exports, "GeospatialPoint", { enumerable: true, get: function () { return resource_interfaces_1.GeospatialPoint; } });
+Object.defineProperty(exports, "ResourceObjectAttributeBase", { enumerable: true, get: function () { return resource_interfaces_1.ResourceObjectAttributeBase; } });
+Object.defineProperty(exports, "ResourceObjectAttributesLoadType", { enumerable: true, get: function () { return resource_interfaces_1.ResourceObjectAttributesLoadType; } });
+Object.defineProperty(exports, "ResourceObjectRelationshipsLoadType", { enumerable: true, get: function () { return resource_interfaces_1.ResourceObjectRelationshipsLoadType; } });
+Object.defineProperty(exports, "ResourceObjectRelationship", { enumerable: true, get: function () { return resource_interfaces_1.ResourceObjectRelationship; } });
+Object.defineProperty(exports, "ResourceObjectRelationshipBase", { enumerable: true, get: function () { return resource_interfaces_1.ResourceObjectRelationshipBase; } });

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

@@ -0,0 +1,91 @@
+import { IRestClient } from '@apigames/rest-client';
+import { ResourceFilterType } from '../classes';
+export declare type ResourceObjectType = string;
+export declare type ResourceObjectIdentifier = string;
+export declare enum ResourceObjectAttributesLoadType {
+    Replace = 0,
+    Update = 1
+}
+export interface IResourceObjectAttributes {
+    LoadData(data: any, action: ResourceObjectAttributesLoadType): void;
+}
+export declare type ResourceObjectRelationshipLinkObject = {
+    type: ResourceObjectType;
+    id: ResourceObjectIdentifier;
+};
+export declare type ResourceObjectRelationshipLink = {
+    data: ResourceObjectRelationshipLinkObject;
+};
+export declare type ResourceObjectRelationshipsLinks = {
+    data: ResourceObjectRelationshipLinkObject[];
+};
+export declare type ResourceContainerIncludedResources = {
+    [id: string]: IResourceObject;
+};
+export declare type ResourceContainerIncludedResourceTypes = {
+    [type: string]: ResourceContainerIncludedResources;
+};
+export declare class ResourceObjectRelationship {
+    private _includes;
+    type: ResourceObjectType;
+    id: ResourceObjectIdentifier;
+    constructor(includes: ResourceContainerIncludedResourceTypes, type: ResourceObjectType, id?: ResourceObjectIdentifier);
+    get target(): IResourceObject;
+}
+export declare type ResourceObjectRelationships = ResourceObjectRelationship[];
+export declare enum ResourceObjectRelationshipsLoadType {
+    Replace = 0,
+    Update = 1
+}
+export interface IResourceObjectRelationships {
+    LoadData(data: any, action: ResourceObjectRelationshipsLoadType): void;
+}
+export declare type ResourceObjectUri = string;
+export declare class ResourceObjectAttributeBase {
+    protected static LoadDateTime(value: string): Date;
+    protected static LoadGeospatialPoint(value: any): GeospatialPoint;
+}
+export declare class GeospatialPoint extends ResourceObjectAttributeBase implements IResourceObjectAttributes {
+    longitude: number;
+    latitude: number;
+    LoadData(data: any): void;
+}
+export declare class ResourceObjectRelationshipBase {
+    private _includes;
+    constructor(includes: ResourceContainerIncludedResourceTypes);
+    protected LoadRelationshipData(expectedType: string, value: any): ResourceObjectRelationship;
+    static RelationshipType(relationshipName: string): string;
+}
+export interface IResourceObject {
+    type: ResourceObjectType;
+    id?: ResourceObjectIdentifier;
+    attributes: IResourceObjectAttributes;
+    relationships: IResourceObjectRelationships;
+    uri: ResourceObjectUri;
+    LoadData(value: any): IResourceObject;
+    Delete(): Promise<void>;
+    Save(): Promise<void>;
+    UpdateAttributes(value: any): void;
+    UpdateRelationships(value: any): void;
+}
+export declare type ResourceQueryFilterName = string;
+export declare type ResourceQueryFilterValue = string;
+export declare type ResourceQuerySortOption = string;
+export declare type ResourceQueryIncludeOption = string;
+export interface IResourceContainer {
+    data: IResourceObject | IResourceObject[];
+    includes: ResourceContainerIncludedResourceTypes;
+    restClient: IRestClient;
+    uri: string;
+    Filter(filter: ResourceQueryFilterName, selector: ResourceFilterType, value: ResourceQueryFilterValue): IResourceContainer;
+    Sort(option: ResourceQuerySortOption): IResourceContainer;
+    Include(include: ResourceQueryIncludeOption): IResourceContainer;
+    PageOffset(pageOffset: number, pageSize: number): IResourceContainer;
+    PageNumber(pageNumber: number, pageSize: number): IResourceContainer;
+    Add(): IResourceObject;
+    Count(): Promise<number>;
+    Delete(resource: IResourceObject): Promise<void>;
+    Find(): Promise<void>;
+    Get(id: string): Promise<void>;
+    IncludedObject(type: ResourceObjectType, id: ResourceObjectIdentifier): IResourceObject;
+}

package/lib/interfaces/{resource.object.js → resource.interfaces.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceObjectRelationshipBase = exports.GeospatialPoint = exports.ResourceObjectAttributeBase = exports.ResourceObjectRelationshipsLoadType = exports.ResourceObjectAttributesLoadType = void 0;
+exports.ResourceObjectRelationshipBase = exports.GeospatialPoint = exports.ResourceObjectAttributeBase = exports.ResourceObjectRelationshipsLoadType = exports.ResourceObjectRelationship = exports.ResourceObjectAttributesLoadType = void 0;
 const json_1 = require("@apigames/json");
 const helpers_1 = require("../helpers");
 var ResourceObjectAttributesLoadType;
@@ -8,6 +8,21 @@ var ResourceObjectAttributesLoadType;
     ResourceObjectAttributesLoadType[ResourceObjectAttributesLoadType["Replace"] = 0] = "Replace";
     ResourceObjectAttributesLoadType[ResourceObjectAttributesLoadType["Update"] = 1] = "Update";
 })(ResourceObjectAttributesLoadType = exports.ResourceObjectAttributesLoadType || (exports.ResourceObjectAttributesLoadType = {}));
+class ResourceObjectRelationship {
+    constructor(includes, type, id) {
+        this._includes = includes;
+        this.type = type;
+        if (id)
+            this.id = id;
+    }
+    get target() {
+        if ((0, json_1.isDefined)(this.type) && (0, json_1.isDefined)(this.id) && (0, json_1.isDefined)(this._includes[this.type][this.id])) {
+            return this._includes[this.type][this.id];
+        }
+        return undefined;
+    }
+}
+exports.ResourceObjectRelationship = ResourceObjectRelationship;
 var ResourceObjectRelationshipsLoadType;
 (function (ResourceObjectRelationshipsLoadType) {
     ResourceObjectRelationshipsLoadType[ResourceObjectRelationshipsLoadType["Replace"] = 0] = "Replace";
@@ -30,12 +45,15 @@ class GeospatialPoint extends ResourceObjectAttributeBase {
 }
 exports.GeospatialPoint = GeospatialPoint;
 class ResourceObjectRelationshipBase {
-    static LoadRelationshipKey(expectedType, value) {
+    constructor(includes) {
+        this._includes = includes;
+    }
+    LoadRelationshipData(expectedType, value) {
         if ((0, json_1.isDefined)(value) && ((0, json_1.hasProperty)(value, 'data') && (0, json_1.isObject)(value.data)
             && (0, json_1.hasProperty)(value.data, 'type') && (0, json_1.isString)(value.data.type)
             && (value.data.type === expectedType)
             && (0, json_1.hasProperty)(value.data, 'id') && (0, json_1.isString)(value.data.id)))
-            return value.data.id;
+            return new ResourceObjectRelationship(this._includes, value.data.type, value.data.id);
         return undefined;
     }
     static RelationshipType(relationshipName) {

package/lib/type-guards/index.d.ts

@@ -1,3 +1,6 @@
 import { ResourceContainer, ResourceObject } from '../classes';
+import { ResourceObjectRelationship, ResourceObjectRelationships } from '../interfaces';
 export declare function isResourceContainer(value: any): value is ResourceContainer;
 export declare function isResourceObject(value: any): value is ResourceObject;
+export declare function isResourceObjectRelationship(value: any): value is ResourceObjectRelationship;
+export declare function isResourceObjectRelationships(value: any): value is ResourceObjectRelationships;

package/lib/type-guards/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isResourceObject = exports.isResourceContainer = void 0;
+exports.isResourceObjectRelationships = exports.isResourceObjectRelationship = exports.isResourceObject = exports.isResourceContainer = void 0;
 const json_1 = require("@apigames/json");
 const classes_1 = require("../classes");
+const interfaces_1 = require("../interfaces");
 function isResourceContainer(value) {
     return (0, json_1.isDefinedAndNotNull)(value) && (value instanceof classes_1.ResourceContainer);
 }
@@ -13,3 +14,17 @@ function isResourceObject(value) {
         && (typeof value.type === 'string');
 }
 exports.isResourceObject = isResourceObject;
+function isResourceObjectRelationship(value) {
+    return (0, json_1.isDefinedAndNotNull)(value) && (value instanceof interfaces_1.ResourceObjectRelationship);
+}
+exports.isResourceObjectRelationship = isResourceObjectRelationship;
+function isResourceObjectRelationships(value) {
+    if ((0, json_1.isArray)(value)) {
+        let allValid = true;
+        for (const relationship of value)
+            allValid = allValid && isResourceObjectRelationship(relationship);
+        return allValid;
+    }
+    return false;
+}
+exports.isResourceObjectRelationships = isResourceObjectRelationships;

package/package.json

@@ -13,7 +13,7 @@
   ],
   "description": "API Games SDK Core",
   "license": "MIT",
-  "version": "22.1.16",
+  "version": "22.1.17",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {

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

@@ -1,23 +0,0 @@
-import { IRestClient } from '@apigames/rest-client';
-import { IResourceObject, ResourceObjectIdentifier, ResourceObjectType } from './resource.object';
-import { ResourceFilterType } from '../classes/resource.container';
-export declare type ResourceFilterName = string;
-export declare type ResourceFilterValue = string;
-export declare type ResourceSortOption = string;
-export declare type ResourceIncludeOption = string;
-export interface IResourceContainer {
-    data: IResourceObject | IResourceObject[];
-    restClient: IRestClient;
-    uri: string;
-    Filter(filter: ResourceFilterName, selector: ResourceFilterType, value: ResourceFilterValue): IResourceContainer;
-    Sort(option: ResourceSortOption): IResourceContainer;
-    Include(include: ResourceIncludeOption): IResourceContainer;
-    PageOffset(pageOffset: number, pageSize: number): IResourceContainer;
-    PageNumber(pageNumber: number, pageSize: number): IResourceContainer;
-    Add(): IResourceObject;
-    Count(): Promise<number>;
-    Delete(resource: IResourceObject): Promise<void>;
-    Find(): Promise<void>;
-    Get(id: string): Promise<void>;
-    IncludedObject(type: ResourceObjectType, id: ResourceObjectIdentifier): IResourceObject;
-}

package/lib/interfaces/resource.container.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,54 +0,0 @@
-export declare type ResourceObjectType = string;
-export declare type ResourceObjectIdentifier = string;
-export declare enum ResourceObjectAttributesLoadType {
-    Replace = 0,
-    Update = 1
-}
-export interface IResourceObjectAttributes {
-    LoadData(data: any, action: ResourceObjectAttributesLoadType): void;
-}
-export declare type ResourceObjectRelationshipLinkObject = {
-    type: ResourceObjectType;
-    id: ResourceObjectIdentifier;
-};
-export declare type ResourceObjectRelationship = {
-    data: ResourceObjectRelationshipLinkObject;
-};
-export declare type ResourceObjectRelationships = {
-    data: ResourceObjectRelationshipLinkObject[];
-};
-export declare type ResourceObjectRelationshipKey = string;
-export declare type ResourceObjectRelationshipKeys = ResourceObjectRelationshipKey[];
-export declare enum ResourceObjectRelationshipsLoadType {
-    Replace = 0,
-    Update = 1
-}
-export interface IResourceObjectRelationships {
-    LoadData(data: any, action: ResourceObjectRelationshipsLoadType): void;
-}
-export declare type ResourceObjectUri = string;
-export declare class ResourceObjectAttributeBase {
-    protected static LoadDateTime(value: string): Date;
-    protected static LoadGeospatialPoint(value: any): GeospatialPoint;
-}
-export declare class GeospatialPoint extends ResourceObjectAttributeBase implements IResourceObjectAttributes {
-    longitude: number;
-    latitude: number;
-    LoadData(data: any): void;
-}
-export declare class ResourceObjectRelationshipBase {
-    protected static LoadRelationshipKey(expectedType: string, value: any): ResourceObjectRelationshipKey;
-    static RelationshipType(relationshipName: string): string;
-}
-export interface IResourceObject {
-    type: ResourceObjectType;
-    id?: ResourceObjectIdentifier;
-    attributes: IResourceObjectAttributes;
-    relationships: IResourceObjectRelationships;
-    uri: ResourceObjectUri;
-    LoadData(value: any): IResourceObject;
-    Delete(): Promise<void>;
-    Save(): Promise<void>;
-    UpdateAttributes(value: any): void;
-    UpdateRelationships(value: any): void;
-}