@kontent-ai/delivery-sdk 12.0.0-0

package/lib/services/mapping.service.ts

@@ -0,0 +1,171 @@
+import { IDeliveryClientConfig } from '../config';
+import { Contracts } from '../contracts';
+import { GenericElementMapper, ItemMapper, LanguageMapper, TaxonomyMapper, TypeMapper } from '../mappers';
+import { Responses, IContentItem, IPagination } from '../models';
+
+export interface IMappingService {
+    listContentTypesResponse(data: Contracts.IListContentTypeContract): Responses.IListContentTypesResponse;
+
+    itemsFeedResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IItemsFeedContract
+    ): Responses.IListItemsFeedResponse<TContentItem>;
+
+    viewContentTypeResponse(data: Contracts.IViewContentTypeContract): Responses.IViewContentTypeResponse;
+
+    viewContentItemResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IViewContentItemContract
+    ): Responses.IViewContentItemResponse<TContentItem>;
+
+    listContentItemsResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IListContentItemsContract
+    ): Responses.IListContentItemsResponse<TContentItem>;
+
+    viewTaxonomyResponse(data: Contracts.IViewTaxonomyGroupContract): Responses.IViewTaxonomyResponse;
+
+    listTaxonomiesResponse(data: Contracts.IListTaxonomyGroupsContract): Responses.IListTaxonomiesResponse;
+
+    viewContentTypeElementResponse(
+        data: Contracts.IViewContentTypeElementContract
+    ): Responses.IViewContentTypeElementResponse;
+
+    listLanguagesResponse(data: Contracts.IListLanguagesContract): Responses.IListLanguagesResponse;
+}
+
+export class MappingService implements IMappingService {
+    private readonly typeMapper: TypeMapper;
+    private readonly languageMapper: LanguageMapper;
+    private readonly itemMapper: ItemMapper;
+    private readonly taxonomyMapper: TaxonomyMapper;
+    private readonly genericElementMapper: GenericElementMapper;
+
+    constructor(readonly config: IDeliveryClientConfig) {
+        this.typeMapper = new TypeMapper();
+        this.languageMapper = new LanguageMapper();
+        this.itemMapper = new ItemMapper(config);
+        this.taxonomyMapper = new TaxonomyMapper();
+        this.genericElementMapper = new GenericElementMapper();
+    }
+
+    /**
+     * Gets response for list of languages
+     * @param data Response data
+     */
+    listLanguagesResponse(data: Contracts.IListLanguagesContract): Responses.IListLanguagesResponse {
+        return {
+            items: this.languageMapper.mapMultipleLanguages(data),
+            pagination: this.mapPagination(data.pagination)
+        };
+    }
+
+    /**
+     * Gets response for getting a multiple type
+     * @param data Response data
+     */
+    listContentTypesResponse(data: Contracts.IListContentTypeContract): Responses.IListContentTypesResponse {
+        return {
+            items: this.typeMapper.mapMultipleTypes(data),
+            pagination: this.mapPagination(data.pagination)
+        };
+    }
+
+    /**
+     * Gets response for single type
+     * @param data Response data
+     * @param options Options
+     */
+    viewContentTypeResponse(data: Contracts.IViewContentTypeContract): Responses.IViewContentTypeResponse {
+        return {
+            type: this.typeMapper.mapSingleType(data)
+        };
+    }
+
+    itemsFeedResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IItemsFeedContract
+    ): Responses.IListItemsFeedResponse<TContentItem> {
+        const itemsResult = this.itemMapper.mapItems<TContentItem>({
+            linkedItems: Object.values(data.modular_content),
+            mainItems: data.items
+        });
+
+        return {
+            items: itemsResult.items,
+            linkedItems: itemsResult.linkedItems
+        };
+    }
+
+    /**
+     * Gets response for getting single item
+     * @param data Response data
+     * @param queryConfig Query configuration
+     */
+    viewContentItemResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IViewContentItemContract
+    ): Responses.IViewContentItemResponse<TContentItem> {
+        const itemResult = this.itemMapper.mapSingleItemFromResponse<TContentItem>(data);
+
+        return {
+            item: itemResult.item,
+            linkedItems: itemResult.linkedItems
+        };
+    }
+
+    /**
+     * Gets response for getting multiple items
+     * @param data Response data
+     * @param queryConfig Query configuration
+     */
+    listContentItemsResponse<TContentItem extends IContentItem = IContentItem>(
+        data: Contracts.IListContentItemsContract
+    ): Responses.IListContentItemsResponse<TContentItem> {
+        const itemsResult = this.itemMapper.mapMultipleItemsFromResponse<TContentItem>(data);
+
+        return {
+            items: itemsResult.items,
+            pagination: this.mapPagination(data.pagination),
+            linkedItems: itemsResult.linkedItems
+        };
+    }
+
+    /**
+     * Gets response for getting single taxonomy item
+     * @param data Response data
+     */
+    viewTaxonomyResponse(data: Contracts.IViewTaxonomyGroupContract): Responses.IViewTaxonomyResponse {
+        return {
+            taxonomy: this.taxonomyMapper.mapTaxonomy(data.system, data.terms)
+        };
+    }
+
+    /**
+     * Gets response for getting multiples taxonomies
+     * @param data Response data
+     */
+    listTaxonomiesResponse(data: Contracts.IListTaxonomyGroupsContract): Responses.IListTaxonomiesResponse {
+        return {
+            items: this.taxonomyMapper.mapTaxonomies(data.taxonomies),
+            pagination: this.mapPagination(data.pagination)
+        };
+    }
+
+    /**
+     * Gets response for getting single content type element
+     * @param data Response data
+     */
+    viewContentTypeElementResponse(
+        data: Contracts.IViewContentTypeElementContract
+    ): Responses.IViewContentTypeElementResponse {
+        return {
+            element: this.genericElementMapper.mapElement(data)
+        };
+    }
+
+    private mapPagination(paginationContract: Contracts.IPaginationContract): IPagination {
+        return {
+            skip: paginationContract.skip,
+            count: paginationContract.count,
+            limit: paginationContract.limit,
+            nextPage: paginationContract.next_page,
+            totalCount: paginationContract.total_count ?? null
+        };
+    }
+}

package/lib/utilities/delivery-url.helper.ts

@@ -0,0 +1,17 @@
+import * as urlParse from 'url-parse';
+
+export class DeliveryUrlHelper {
+    replaceAssetDomain(originalAssetUrl: string, customDomain: string): string {
+        const urlPath = this.getUrlPathname(originalAssetUrl);
+
+        return `${customDomain}${urlPath}`;
+    }
+
+    getUrlPathname(url: string): string {
+        const parsedUrl = urlParse(url);
+
+        return parsedUrl.pathname;
+    }
+}
+
+export const deliveryUrlHelper = new DeliveryUrlHelper();

package/lib/utilities/guid.helper.ts

@@ -0,0 +1,9 @@
+import { v4 as uuidv4 } from 'uuid';
+
+export class GuidHelper {
+    genereateGuid(): string {
+        return uuidv4();
+    }
+}
+
+export const guidHelper = new GuidHelper();

package/lib/utilities/index.ts

@@ -0,0 +1,4 @@
+export * from './linked-items.helper';
+export * from './guid.helper';
+export * from './delivery-url.helper';
+export * from './text-helper';

package/lib/utilities/linked-items.helper.ts

@@ -0,0 +1,16 @@
+import { IContentItem, IContentItemsContainer } from '../models/item-models';
+
+export class LinkedItemsHelper {
+
+    convertLinkedItemsToArray(linkedItems: IContentItemsContainer): IContentItem[] {
+        const linkedItemsArray: IContentItem[] = [];
+
+        for (const linkedItemKey of Object.keys(linkedItems)) {
+            linkedItemsArray.push(linkedItems[linkedItemKey]);
+        }
+
+        return linkedItemsArray;
+    }
+}
+
+export const linkedItemsHelper = new LinkedItemsHelper();

package/lib/utilities/text-helper.ts

@@ -0,0 +1,25 @@
+export class TextHelper {
+    getPropertyNameRegex(): RegExp {
+        return /[\&\(\)\?\-\=\'\"\§\!\%\:\_\s.]+(.)?/g;
+    }
+
+    removeZeroWidthCharacters(str: string): string {
+        return str.replace(/[\u200B-\u200D\uFEFF]/g, '');
+    }
+
+    addUnderscoreWhenStarsWithNumber(str: string): string {
+        if (this.startsWithNumber(str)) {
+            return `_${str}`;
+        }
+        return str;
+    }
+
+    startsWithNumber(str: string): boolean {
+        if (str.match(/^\d/)) {
+            return true;
+        }
+        return false;
+    }
+}
+
+export const textHelper = new TextHelper();

package/package.json

@@ -0,0 +1,94 @@
+{
+    "name": "@kontent-ai/delivery-sdk",
+    "version": "12.0.0-0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/kontent-ai/delivery-sdk-js"
+    },
+    "private": false,
+    "author": "richard sustek",
+    "license": "MIT",
+    "description": "Official Kontent.AI Delivery API SDK",
+    "keywords": [
+        "Kontent",
+        "Kontent.ai",
+        "Kontent SDK",
+        "Kontent API",
+        "Kontent Delivery",
+        "Kontent Javascript",
+        "Kontent Node.js",
+        "Kontent Typescript"
+    ],
+    "engines": {
+        "node": ">= 8"
+    },
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/es6/index.js",
+    "es2015": "./dist/es6/index.js",
+    "types": "./dist/cjs/index.d.ts",
+    "standard-version": {
+        "scripts": {
+            "postchangelog": "npm run set-sdk-version"
+        }
+    },
+    "scripts": {
+        "release": "npm run ts-lint:check && standard-version",
+        "release:major": "npm run ts-lint:check && standard-version --release-as major",
+        "release:major:beta": "npm run ts-lint:check && standard-version --prerelease --release-as major",
+        "release:beta": "standard-version --prerelease",
+        "ts-lint:fix": "npm run ts-lint:check -- --fix",
+        "ts-lint:check": "tslint --project ./tsconfig.json",
+        "test:browser": "karma start karma.conf.js",
+        "test:gh-actions": "karma start karma-gh-actions.conf.js",
+        "test:node": "npm run build:commonjs && npx mocha -- \"test/node/**/*.js\" --timeout 15000",
+        "test:all": "npm run test:node && npm run test:gh-actions",
+        "new-patch": "npm version patch && npm run set-sdk-version && npm run check-version ",
+        "new-minor": "npm version minor && npm run set-sdk-version && npm run check-version ",
+        "new-major": "npm version major && npm run set-sdk-version && npm run check-version ",
+        "prepublishOnly": "npm run ts-lint:check && npm run check-version  && npm run build:all && npm run test:all",
+        "set-sdk-version": "node ./misc/set-sdk-version.js",
+        "check-version": "npx ts-node ./misc/verify-sdk-version.ts",
+        "webpack:dev": "webpack -- --mode development --config webpack.config.js --progress",
+        "webpack:prod": "webpack -- --mode production --config webpack.config.js --progress",
+        "publish:beta": "npm publish --tag=next",
+        "build:umd": "npm run webpack:dev && npm run webpack:prod",
+        "build:es6": "tsc -m es6 --outDir dist/es6 --p tsconfig.prod.json",
+        "build:esnext": "tsc -m esnext --outDir dist/esnext --p tsconfig.prod.json",
+        "build:commonjs": "tsc -m commonjs --outDir dist/cjs --p tsconfig.prod.json",
+        "build:all": "npm run build:umd && npm run build:es6 && npm run build:esnext && npm run build:commonjs",
+        "bundle-stats:min": "npm run build:umd && webpack-bundle-analyzer dist/bundles/stats.min.json",
+        "bundle-stats": "npm run build:umd && webpack-bundle-analyzer dist/bundles/stats.json"
+    },
+    "dependencies": {
+        "@kontent-ai/core-sdk": "10.0.0",
+        "uuid": "8.3.2",
+        "url-parse": "1.5.10"
+    },
+    "devDependencies": {
+        "@types/url-parse": "1.4.8",
+        "@types/jasmine": "4.0.3",
+        "@types/node": "17.0.35",
+        "@types/uuid": "8.3.4",
+        "colors": "1.4.0",
+        "jasmine-core": "4.1.1",
+        "jasmine-spec-reporter": "7.0.0",
+        "karma": "6.3.20",
+        "karma-chrome-launcher": "3.1.1",
+        "karma-cli": "2.0.0",
+        "karma-coverage-istanbul-reporter": "3.0.3",
+        "karma-jasmine": "5.0.1",
+        "karma-jasmine-html-reporter": "1.7.0",
+        "karma-sourcemap-loader": "0.3.8",
+        "karma-typescript": "5.5.3",
+        "karma-typescript-es6-transform": "5.5.3",
+        "lcov-parse": "1.0.0",
+        "mocha": "10.0.0",
+        "standard-version": "9.5.0",
+        "ts-loader": "9.3.0",
+        "tslint": "6.1.3",
+        "typescript": "4.6.4",
+        "webpack": "5.72.1",
+        "webpack-bundle-analyzer": "4.5.0",
+        "webpack-cli": "4.9.2"
+    }
+}