contensis-management-api/src/tags/tag-operations.spec.ts

Client for managing content using the Contensis Management API

import * as Contensis from '../index';
import { getDefaultAuthenticateUrl, getDefaultConfig, getDefaultFetchRequest, setDefaultSpy } from '../specs-utils.spec';
import fetch from 'cross-fetch';
import { TagUsageInfo } from '../models';
import { PagedList } from 'contensis-core-api';

const Zengenti = { Contensis };
const global = window || this;
global.fetch = fetch;

describe('Tag Operations', () => {

    describe('Get tag', () => {
        const get = {
            id: 'cb588ac4-859a-4ebc-b14f-a39dee4786b0',
            value: 'car',
            label: {
                'en-GB': 'Car',
                'fr-FR': 'Voiture',
            },
            groupId: 'keywords',
            version: {
                createdBy: 'j.smith',
                created: '2024-01-22T09:30:11.2340981Z',
                modifiedBy: 'j.smith',
                modified: '2024-01-22T09:30:11.2340981Z',
                versionNo: '1.0',
            },
            usageCount: 156,
        };

        beforeEach(() => {
            setDefaultSpy(global, get);

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('by id', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const tag = await client.tags.get(get.id);

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/tags/${get.id}?language=en-US`,
                getDefaultFetchRequest()
            ]);

            expect(tag).not.toBeNull();
            expect(tag.id).toEqual(get.id);
        });

        it('by label', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const tag = await client.tags.get({
                groupId: 'keywords', label: 'Car', language: 'en-GB'
            });

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/taggroups/${get.groupId}/tags?label=${get.label['en-GB']}&language=en-GB`,
                getDefaultFetchRequest()
            ]);

            expect(tag).not.toBeNull();
            expect(tag.id).toEqual(get.id);
        });
    });

    describe('List tags', () => {
        beforeEach(() => {
            setDefaultSpy(global, {
                pageIndex: 0,
                pageSize: 25,
                totalCount: 2492,
                pageCount: 100,
                items: [
                    {
                        id: 'tree',
                        label: {
                            'en-GB': 'Tree',
                            'fr-FR': 'Arbre',
                        },
                        groupId: 'keywords',
                        version: {
                            createdBy: 'j.smith',
                            created: '2024-01-22T09:30:11.2340981Z',
                            modifiedBy: 'j.smith',
                            modified: '2024-01-22T09:30:11.2340981Z',
                            versionNo: '1.0',
                        },
                        usageCount: 156,
                    },
                ],
            });

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('with default options', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());
            const tags = await client.tags.list();

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                'http://my-website.com/api/management/projects/myProject/tags?language=en-US&pageIndex=0&pageSize=25',
                getDefaultFetchRequest()
            ]);

            expect(tags).not.toBeNull();
            expect(tags.items.length).toEqual(1);
            expect(tags.items[0].id).toEqual('tree');
        });

        it('with all options', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());
            const tags = await client.tags.list({
                groupId: 'keywords',
                language: 'en-GB',
                q: 'tree',
                pageOptions: { pageIndex: 1, pageSize: 50 },
                order: ['label']
            });

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/taggroups/keywords/tags?language=en-GB&order=label&pageIndex=1&pageSize=50&q=tree`,
                getDefaultFetchRequest()
            ]);

            expect(tags).not.toBeNull();
            expect(tags.items.length).toEqual(1);
            expect(tags.items[0].id).toEqual('tree');
        });

        it('with no group id or language', async () => {
            const client = Zengenti.Contensis.Client.create({ ...getDefaultConfig(), language: undefined });
            const tags = await client.tags.list({
                pageOptions: { pageIndex: 1, pageSize: 50 },
                order: ['label'],
                q: 'tree'
            });

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                'http://my-website.com/api/management/projects/myProject/tags?order=label&pageIndex=1&pageSize=50&q=tree',
                getDefaultFetchRequest()
            ]);

            expect(tags).not.toBeNull();
            expect(tags.items.length).toEqual(1);
            expect(tags.items[0].id).toEqual('tree');
        });
    });

    describe('Create tag', () => {
        const tag = {
            value: 'car',
            groupId: 'keywords',
            label: {
                'en-GB': 'Car',
                'fr-FR': 'Voiture',
            },
        };

        beforeEach(() => {
            setDefaultSpy(global, tag);

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('for valid tag', async () => {

            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const created = await client.tags.create(tag);

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/tags`,
                getDefaultFetchRequest('POST', null, JSON.stringify(tag))
            ]);

            expect(created).not.toBeNull();
            expect(created.value).toEqual(tag.value);
        });

    });

    describe('Update tag', () => {
        const tag = {
            id: '1',
            value: 'car',
            groupId: 'keywords',
            label: {
                'en-GB': 'Car',
                'fr-FR': 'Voiture',
            },
        };

        beforeEach(() => {
            setDefaultSpy(global, tag);

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('for valid group', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const updated = await client.tags.update(tag);

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/tags/${tag.id}`,
                getDefaultFetchRequest('PUT', null, JSON.stringify(tag))
            ]);

            expect(updated).not.toBeNull();
            expect(updated.value).toEqual(tag.value);
        });

    });

    describe('Delete tag', () => {
        const tagId = '1';

        beforeEach(() => {
            setDefaultSpy(global, null);

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('for single tag with replacement tag id', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const result = await client.tags.delete(tagId, '2');

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/tags/${tagId}?replacementTagId=2`,
                getDefaultFetchRequest('DELETE')
            ]);

            expect(result).toEqual(null);
        });

    });

    describe('Delete multiple tags', () => {
        beforeEach(() => {
            setDefaultSpy(global, {
                success: [{
                    id: '1',
                }],
                failed: [{
                    id: '2',
                    error: {
                        type: 'Error',
                        message:
                            "A tag with ID '2' does not exist",
                        data: null,
                    },
                }],
            });

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('in tag group', async () => {
            const bulkOptions = { groupId: 'keywords', ids: ['1', '2'] }

            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const deleted = await client.tags.delete(bulkOptions);

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                `http://my-website.com/api/management/projects/myProject/taggroups/${bulkOptions.groupId}/tags/bulk`,
                getDefaultFetchRequest('DELETE', null, JSON.stringify(bulkOptions.ids))
            ]);

            expect(deleted).not.toBeNull();
            expect(deleted.success.length).toEqual(1);
            expect(deleted.failed.length).toEqual(1);
        });

    });

    describe('Get tag usage', () => {
        beforeEach(() => {
            setDefaultSpy(global, {
                totalArchivedCount: 0,
                totalRecycleBinCount: 0,
                pageIndex: 0,
                pageSize: 3,
                totalCount: 15,
                pageCount: 5,
                items: [
                    {
                        id: '14ea7102-5de8-4a50-a2f2-7d68a09b459b',
                        language: 'en-GB',
                        title: 'Charlie and the chocolate factory',
                        description: null,
                        fieldId: 'author[0]',
                        contentTypeId: 'book',
                        dataFormat: 'entry',
                        workflowState: 'draft',
                    },
                    {
                        id: '1e2c7905-75f7-47f4-b1cb-b84129078e50',
                        language: 'en-GB',
                        title: 'The witches',
                        description: null,
                        fieldId: 'author[0]',
                        contentTypeId: 'book',
                        dataFormat: 'entry',
                        workflowState: 'versionComplete',
                    },
                    {
                        id: '1e2c7905-75f7-47f4-b1cb-b84129078e50',
                        language: 'fr-FR',
                        title: 'Les sorcières',
                        description: null,
                        fieldId: 'author[0]',
                        contentTypeId: 'book',
                        dataFormat: 'entry',
                        workflowState: 'versionComplete',
                    },
                ],
            } as PagedList<TagUsageInfo>);

            Zengenti.Contensis.Client.defaultClientConfig = null;
            Zengenti.Contensis.Client.configure({
                fetchFn: global.fetch
            });
        });

        it('by id and no language', async () => {
            const client = Zengenti.Contensis.Client.create({
                ...getDefaultConfig(),
                language: undefined
            });

            const usage = await client.tags.getUsage('1');

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                'http://my-website.com/api/management/projects/myProject/tags/1/usage?pageIndex=0&pageSize=25',
                getDefaultFetchRequest()
            ]);

            expect(usage).not.toBeNull();
            expect(usage.items.length).toEqual(3);
            expect(usage.items[1].contentTypeId).toEqual('book');
        });

        it('with all options', async () => {
            const client = Zengenti.Contensis.Client.create(getDefaultConfig());

            const usage = await client.tags.getUsage({
                id: '1',
                language: 'fr-FR',
                pageOptions: { pageIndex: 1, pageSize: 50 },
                q: 'witches',
                versionStatus: 'latest'
            });

            expect(global.fetch).toHaveBeenCalledTimes(2);

            expect((global.fetch as any).calls.first().args[0]).toEqual(getDefaultAuthenticateUrl());

            expect((global.fetch as any).calls.mostRecent().args).toEqual([
                'http://my-website.com/api/management/projects/myProject/tags/1/usage?language=fr-FR&pageIndex=1&pageSize=50&q=witches&versionStatus=latest',
                getDefaultFetchRequest()
            ]);

            expect(usage).not.toBeNull();
            expect(usage.items.length).toEqual(3);
            expect(usage.items[1].contentTypeId).toEqual('book');
        });
    });
});