Skip to content

Latest commit

 

History

History
1022 lines (546 loc) · 57.5 KB

CHANGELOG.md

File metadata and controls

1022 lines (546 loc) · 57.5 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

7.5.1 (2024-10-08)

Bug Fixes

  • Prevent mutation of global headers config (8abba41)

7.5.0 (2024-10-08)

Features

  • adds support for defining global headers in IManagementClientConfig (6582914)
  • updates deps (3d6fe1f)

7.4.0 (2024-10-03)

Features

  • adds 'display_timezone' to ContentItemElement class. Fixes mapping of components in element (bd1b082)

7.3.0 (2024-09-26)

Features

Bug Fixes

  • adds 'display_timezone' to date time element (fixes #157) (663d828)

7.2.0 (2024-08-15)

Features

  • updates deps (& fixes Axios vulnerability), updates eslint config (b6ce5bb)

7.1.1 (2024-08-14)

Bug Fixes

  • Use full reference contract for asset folders (adds ability to reference asset folder by codename) (8a6a5a5)

7.1.0 (2024-08-13)

Features

  • Add spaces to item, installs prettier as devDep (86e85d4)
  • Adds support for asset folder codenames (d032c7b)

7.0.0 (2024-07-29)

⚠ BREAKING CHANGES

  • Removes deprecated listWorkflowSteps and changeWorkflowStepOfLanguageVariant queries
  • Removes deprecated 'workflow_step' from language variant model

Features

  • Adds support for schedule and due_date props in language variants (b60a84c)
  • Adds support for copy data options when cloning environment (fixes #150) (5a7df98)
  • Adds support for setting due_date when upserting language variant (34cc81b)
  • Adds support for Web spotlight API endpoints (activate/deactivate/get status) (4070892)
  • Removes deprecated 'workflow_step' from language variant model (a687bf1)
  • Removes deprecated listWorkflowSteps and changeWorkflowStepOfLanguageVariant queries (a56173c)
  • updates deps & sets required node.js to <= 20 (98b0cc1)

6.5.0 (2024-07-02)

Features

  • Adds support for fetching published language variants (8fc4668)

6.4.0 (2024-06-28)

Features

6.3.1 (2024-06-26)

6.3.0 (2024-05-17)

Features

  • Adds elements property to asset model (a07f051)

6.2.1 (2024-05-07)

Bug Fixes

  • Fixes invalid filter types in webhooks
  • Adds missing headers property to webhook data model

6.2.0 (2024-04-29)

Features

6.1.0 (2024-04-02)

Features

  • adds support for move operation type, adds support for under taxonomy modification prop (fixes #146) (e70be03)

6.0.0 (2024-03-21)

⚠ BREAKING CHANGES

  • change element types to discriminated union. Renames IElementShared to Element and changes it to type instead of interface (#144)

Features

  • add new webhook filters (#143) (ae43650)
  • change element types to discriminated union. Renames IElementShared to Element and changes it to type instead of interface (#144) (7d35f3e)
  • change the folder patch operation type into a discriminated union (#142) (6994c3a)
  • updates dev deps (d9a7873)

5.9.0 (2024-02-29)

Features

Bug Fixes

5.8.2 (2024-01-29)

Bug Fixes

  • Adds 'components' to element models (d0ac229)

5.8.1 (2024-01-29)

Bug Fixes

  • Fixes missing listQueryConfig when using toAllPromise (5d4868e)
  • Updates webhook contract models (actions) (#134) (1cf2e4c)

5.8.0 (2024-01-22)

Features

5.7.0 (2023-12-06)

Features

Bug Fixes

  • Downgrades TS due to incompatibility with karma tests (d10c486)
  • Uses 'null' type for element's value property contract (7d9d78e)

5.6.0 (2023-11-16)

Features

  • updates deps (updated core-sdk with latest axios), updates node to be >= 16 (5fca107)

5.5.0 (2023-11-01)

Features

  • Adds support for fetching assets by codename (fixes #124) (6ee4603)
  • updates deps (42cc023)

5.4.0 (2023-10-24)

Features

Bug Fixes

  • Change modify asset folders value not required (#123) (d4714c7)

5.3.0 (2023-09-07)

Features

  • Adds codename & collection support for assets (fixes #122) (f08684f)
  • updates deps (a81784b)

5.2.0 (2023-07-31)

Features

  • updates '@kontent-ai/core-sdk' dependency (4616d3b)

5.1.0 (2023-07-31)

Features

  • adds 'scheduled_step' property to workflow (fixes #116) (9a5d161)
  • adds support 'external_id' property when referencing content type in new content items (fixes #119) (4ced950)
  • adds support for 'getPreviewConfiguration' API endpoint (#95) (6f8c7a5)
  • adds support for 'modifyPreviewConfiguration' query (#95) (2baa8ff)
  • updates all dependencies & migrates to eslint from tslint (15dcc29)

Bug Fixes

  • fixes mapping of enable & disable webhook responses which causes exception to occur (21ecdda)
  • ITaxonomy element data is missing name property #113 (#114) (d07b457)
  • makes 'codename' in url slug element optional (fixes #118) (751c445)
  • makes id in multiple choice option non-required (fixes #117) (2d9143b)
  • typo (#112) (066b363)

5.0.0 (2023-04-12)

⚠ BREAKING CHANGES

  • Renames all project related properties & types & queries to reflect new environment naming conventions, also removes deprecated validateProject query

Features

  • Adds support for spaces & adds null support for regex flag (#109) (d11e5f1)
  • Renames all project related properties & types & queries to reflect new environment naming conventions, also removes deprecated validateProject query (e99f007)
  • updates dependencies (788779b)
  • updates dependencies (bdaa2c7)

4.1.0 (2023-03-08)

Features

  • Add spaces support (#105) (d765d45), closes #104
  • Adds id field to IAddContentItemPostCOntract and makes id and codename nullable (#101) (14cd7ae)
  • adds support for limiting workflows to collections (#96) (bcbdde7)
  • Unifies shared elements models (#100) (3a59a45)
  • updates deps (26ba21e)

4.0.0 (2023-01-18)

⚠ BREAKING CHANGES

  • Adds ability to specify workflow in upsertLanguageVariant query (#93)

Updated way of using the upsertLanguageVariant is:

import { ManagementClient } from '@kontent-ai/management-sdk';

const client = new ManagementClient({
  environmentId: '<YOUR_PROJECT_ID>',
  apiKey: '<YOUR_API_KEY>'
});

const response = await client
    .upsertLanguageVariant()
    .byItemCodename('x')
    .byLanguageCodename('x')
    .withData((builder) => {
        return {
            elements: [
                builder.textElement({
                    element: {
                        codename: 'xElementCodename'
                    },
                    value: 'xText'
                }),
            ],
            workflow: {
                step_identifier: {
                    codename: 'y'
                },
                workflow_identifier: {
                    codename: 'x'
                }
            }
        }
    })
    .toPromise();

Features

  • Add workflow to upsert variant (#93) (9472209)
  • remove is_non_localizable property from unsupported type elements in MAPI (561583c)
  • Update dependencies (#98) (8e31e20)

3.4.0 (2022-10-03)

Features

Bug Fixes

  • Fixes mapping of type & variant issue types in new validation endpoint (fixes #87) (5e02276)

3.3.0 (2022-09-14)

Features

  • Adds default value support for linked items & asset elements (fixes #84), updates default property signature (bd13ec2)

3.2.0 (2022-09-14)

Features

  • adds support for h5 & h6 in rich text elements (fixes #85) (59acd6d)
  • updates deps (f501c9f)

3.1.0 (2022-08-08)

Features

  • Adds support for new validation endpoints (fixes #81) (ed06430)
  • updates dev dependencies (c5404be)

Bug Fixes

  • Removes 'codename' property from snippet element data as it is not supported (fixes #83) (861c88f)

3.0.1 (2022-07-25)

Bug Fixes

  • Fixes 'uploadAssetFromUrl ' method from never resolving by cloning config and making sure proper headers are used for 'addAsset' method (fixes #82) (c12fa3c)

3.0.0 (2022-07-14)

3.0.0-0 (2022-07-14)

2.9.2 (2022-07-13)

Bug Fixes

  • Use PUT request for update workflow query (7e49a58)

2.9.1 (2022-07-13)

Bug Fixes

  • Handle errors where 'error_code' is equal to '0' (3ef7fa0)

2.9.0 (2022-07-13)

Features

  • Adds support for default values in text, taxonomy, date time, multiple choice and number elements (eb22c57)
  • Moves WorkflowColor to WorkflowContracts and uses it for contracts as well as in models (f6ef3cc)
  • Renames 'changeWorkflowLanguageVariant' to 'changeWorkflowOfLanguageVariant' (2a77dee)
  • updates all dev dependencies (24a8c89)

Bug Fixes

  • Adds missing 'await' in post query (d2a4c69)

2.8.0 (2022-06-30)

Features

  • Adds support for default values in text, taxonomy, date time, multiple choice and number elements (eb22c57)
  • updates all dev dependencies (24a8c89)

2.7.0 (2022-05-24)

Features

  • adds additional properties to add webhook model (3426c7f)

Bug Fixes

  • makes webhook triggers optional (fc83181)

2.6.0 (2022-05-19)

Features

  • Adds support for 'Update workflow' query (fixes #78) (c98fb2e)
  • Adds support for allowed link types (2fc7689)
  • updates dependencies (2686a9b)

2.5.0 (2022-04-14)

Features

  • Implements new workflow endpoints (#74) (2931924)
  • updates dev dependencies (447de8d)

2.4.0 (2022-03-28)

Features

Bug Fixes

  • Adds missing IAssetElement to ContentTypeElementModel type (12f9a9e)

2.3.0 (2022-03-23)

Features

2.2.0 (2022-03-17)

Features

  • adds is_non_localizable property to type elements (5ef6096)

2.1.0 (2022-03-10)

New add / upsert asset query syntax

The upsertAsset and addAsset queries now use builder that helps setting new asset's elements property. Currently, only taxonomy element is supported. You may need to update your syntax to following format:

    client.addAsset()
        .withData((builder) => {
            return {
                descriptions: [],
                elements: [
                   builder.taxonomyElement({
                    element: {
                        codename: 'taxonomy-categories'
                    },
                    value: [
                        {
                            codename: 'coffee'
                        },
                        {
                            codename: 'brewing'
                        }
                    ]
                })
                ],
                    file_reference: {
                        id: 'x',
                        type: 'internal'
                    }
                };
            })
        .toPromise();

Features

  • adds support for Environment endpoints
  • adds support for asset rendition endpoints (fixes #68) (9e22f6e)
  • adds support for taxonomy elements (fixes #71) (d8f3f21)
  • updates deps (945ad06)

2.0.2 (2022-01-20)

2.0.2-0 (2022-01-20)

Bug Fixes

  • Return urlSlugElement() to elements builder (41e63c2)

2.0.1 (2022-01-19)

Bug Fixes

  • Correct the generic get() HTTP method (65946d8)

2.0.0 (2022-01-13)

Features

  • Adds management client factory and updates docs to use it (14aa84e)
  • Adds support for listing project roles (1aae040)
  • Adds support for project user endpoints (abe35f9)
  • Adds support for Subscription API (subscription projects & users), updates client configuration by separating management & subscription endpoints (e43ccc3)
  • Adds support for view role (acb653c)
  • updates all dependencies to latest versions (4bc7fcd)
  • Uses list query for taxonomy list endpoint and removes temporary taxonomy response included due to a breaking change in API some time ago (827279d)

Bug Fixes

  • fixes scripts & cuts prerelease (3c25601)

2.0.0-0 (2022-01-13)

Features

  • Adds management client factory and updates docs to use it (14aa84e)
  • Adds support for listing project roles (1aae040)
  • Adds support for project user endpoints (abe35f9)
  • Adds support for Subscription API (subscription projects & users), updates client configuration by separating management & subscription endpoints (e43ccc3)
  • Adds support for view role (acb653c)
  • updates all dependencies to latest versions (4bc7fcd)
  • Uses list query for taxonomy list endpoint and removes temporary taxonomy response included due to a breaking change in API some time ago (827279d)

1.8.0 (2021-12-16)

  • Adds validation message to Text element regex property

1.7.0 (2021-11-29)

Features

  • adds guidelines to taxonomy element data model (9f436cd)
  • adds support for subpages element & uses type in favor of enum for some models (5713d8f)
  • adds validation_regex support for text element (ac81a48)
  • improves types for element builders (0c076c6)
  • removes unnecessary builder code by extending content type snippet builder (728a5e1)
  • updates dependencies (391b29b)

1.6.0 (2021-11-02)

Features

1.5.0 (2021-09-24)

Features

1.4.0 (2021-08-25)

Features

Bug Fixes

  • adds 'id' property to component rich text model (fixes #50) (e038feb)

1.3.0 (2021-08-12)

Features

1.2.0 (2021-07-30)

Features

  • adds environment to project information (fixes #49) (3b49ccf)

1.1.0 (2021-07-19)

Migration from 0.x.y

There are some notable changes when migrating from 0.x.y (latest release 0.4.10) version of sdk:

  • Rxjs was removed from dependencies and is no longer included with this SDK. One major benefit is reduced complexity & size of this library (about 30-40% size reduction).
  • toObservable was removed without replacement in favor of toPromise. If you need to keep using Observable, use from operator that comes with rxjs (https://www.learnrxjs.io/learn-rxjs/operators/creation/from)
  • Distributed files, formats and paths were modified. Available outputs: dist/bundles, dist/cjs, dist/es6, dist/es2020, dist/esnext
  • isDeveloper configuration option was removed without replacement
  • retryStrategy configuration was updated and simplifies. New options are listed at https://github.com/Kentico/kontent-core-js/blob/7ec7faaa779a4aa55802ade927f296cc3619a720/lib/http/http.models.ts#L16
  • Support for additional endpoints:
    • Create, update & list of collections
    • List language variants by collection
    • Create asset + binary file from external URL
  • Improved typings for content type elements
  • Other minor improvements & bug fixes

Features

  • adds mode & searchableValue to variant element model and contract (13d9b84)
  • adds support for constructing edit urls (fixes #10) (ba2fc2e)
  • adds support for creating & updating collections (db2a1d2)
  • adds support for listing collections (01bcc2b)
  • adds support for listing language variants by collection (f12a877)
  • adds support for taxonomy 'term_count_limit' option (fixes #48) (f19aae4)
  • adds support for uploading assets & binary files from url (fixes #18), adds automatic mime type detection support (d54a0b8)
  • adds types support for content type elements (fixes #46) (01f7c82)
  • removes 'isDeveloperMode' config property as its not utilized anymore (986cc40)
  • removes "_" from dist folder names (079c1f6)
  • updates deps (43e857c)
  • updates deps (6123ea0)
  • updates deps (fe0778d)
  • updates deps (fixes retry strategy) (946f864)
  • updates kontent-core dependency to v9 (dd25dd4)
  • use 'mime' npm instead of 'mime-type' due to browser compatibility support (2200b73)

Bug Fixes

  • fixes cjs folder name (d470214)
  • fixes commonjs folder output (5abf59f)
  • fixes package.json entry modules (0fa0176)

0.4.10 (2021-04-21)

Features

  • adds support for enabling / disabling webhooks (485cfe0)

0.4.9 (2021-04-21)

Features

  • adds support for codename in workflow related endpoints & queries (fixes #35) (98f1ddf)
  • adds url encoding tests & changes name of internal base query props (6413d3f)
  • simplifies scripts & update dependencies (b948be5)

Bug Fixes

  • fixes contract for 'type' in 'UpsertContentItem' query (fixes #39) (a9e72ab)

0.4.8 (2021-01-08)

Features

0.4.7 (2020-12-15)

Features

  • adds 'cancel scheduled unpublish' endpoint support (9860c1b)

0.4.6 (2020-12-14)

Features

  • adds support for new unpublish / schedule unpublish endpoint & removes deprecated unpublish endpoint (fixes #28) (4da0b6b)
  • unifies publish / unpublish naming convention, removes unsused query models (cc78e90)
  • updates all dependencies (6b2e7c1)

Bug Fixes

  • makes 'item_count_limit' optional (fixes #29) (826a0eb)

0.4.5 (2020-11-23)

Features

  • updates all dependencies, uses axios models directly instead of proxy models (53837e1)

0.4.4 (2020-11-12)

Bug Fixes

  • uses correct query identifier for upsert content item query (6079c04)

0.4.3 (2020-10-23)

Bug Fixes

  • fixes interface typo (applied_to -> applies_to) in content type elements builder (b019338)

0.4.2 (2020-10-21)

Bug Fixes

  • encodes url by default. Fixes errors when url contained special characters (such as space in filename within uploadBinaryFile method) (7c318f5)

0.4.1 (2020-10-07)

Features

  • adds 'responseFetched' callback configuration property to IContentManagementListQueryConfig (f2371f8)

0.4.0 (2020-09-30)

⚠ BREAKING CHANGES

  • adds new rich text element properties and removes class mapping of content type element properties. Reason for this removal is that the model class was missing many of existing properties (e.g. rich text element & text element properties are very different) and there was no benefit in using this class.
  • refactors language variants query - adds builder similar to addContentType query which gives developers intellisense and better control over creating variants

Features

  • adds new rich text element properties and removes class mapping of content type element properties. Reason for this removal is that the model class was missing many of existing properties (e.g. rich text element & text element properties are very different) and there was no benefit in using this class. (fec3fc4)
  • adds support for collections (fixes #26) (9f653b0)
  • refactors language variants query - adds builder similar to addContentType query which gives developers intellisense and better control over creating variants (e4c003e)
  • updates deps + refactors content management error handling (9b5ca5b)

0.3.20 (2020-06-24)

Features

  • adds missing type properties to content item contract (fixes #12) (022e267)
  • adds support for generic queries (POST, PATCH, GET, PUT & PATCH) (ce00b49)
  • adds support for modify taxonomy query (fixes #15) (fd96edc)
  • hints file reference 'internal' type (0ad6476)
  • updates deps (db94674)

Bug Fixes

  • uses correct url property for add taxonomy query (7ba17dc)

0.3.19 (2020-04-08)

Features

0.3.18 (2020-02-25)

Features

  • adds 'codename' to content item upsert model & makes 'type' optional (2c2b4fa)
  • removes deprecated sitemap locations (71bda7e)

Bug Fixes

  • removes data processing in asset update request data (7898689)
  • uses proper model without additional processing for adding taxonomies (585fd4e)

0.3.17 (2020-01-23)

Features

  • adds support for content groups in content types and adds missing external id props to content type & snippet (20a71fd)

0.3.16 (2020-01-22)

Features

  • adds support for 'modifyContentTypeSnippet' endpoint (a326689)

0.3.15 (2020-01-21)

Features

  • Added is_required to ILinkedItemsInType

0.3.14 (2020-01-15)

Bug Fixes

  • assigns raw data to asset folders correctly (654ef6b)

0.3.13 (2020-01-15)

Bug Fixes

  • re-release due to leftover files in dist folder (no code changes) (eb84a96)

0.3.12 (2020-01-15)

Bug Fixes

  • fixes typo in 'ILinkedITemsInType' elements builder interface (fc36157)
  • removes obsolete update asset query in favor of upsert query which is now in sync with other endpoints and use proper input data and indentifiers (9308880)

0.3.11 (2020-01-14)

Features

  • adds '_raw' property to language variant with component (58fcb6b)

0.3.10 (2020-01-13)

Features

  • adds new url property to asset contract & models (fd188c1)

0.3.9 (2020-01-09)

Bug Fixes

  • assigns raw data to language model (e09e7c1)
  • fixes model for adding assets (f938501)

0.3.8 (2020-01-09)

Bug Fixes

  • removes elements query data from delete language variant query (f7cee7a)

0.3.7 (2020-01-09)

Features

  • adds support delete language variant API endpoint (90188c7)

0.3.6 (2020-01-07)

Features

  • updates all dependencies (reworks retryStrategy options to give more control over what errors should be retried) (29dc496)

0.3.5 (2020-01-06)

Features

  • exposes more mapping methods (e.g. mapping contentType instead of whole response) (c01804f)

0.3.4 (2020-01-06)

Features

  • adds '_raw' property with original data to base models & fixes incorrect model for content type snippes responses (c4606c8)

0.3.3 (2020-01-06)

Bug Fixes

  • fixes return type of 'toAllPromise' so that it matched original 'toAllPromise'. Adds type check test for items in listing query. (212829e)

0.3.2 (2019-12-19)

Features

  • creates MappingService and exposes it via ManagementClient. This service can be used for mapping raw data to SDK models. (146b4b7)

0.3.1 (2019-12-19)

Features

  • adds ability to set delay between requests made by listing queries to prevent being rate limited by CM API (b561d10)

0.3.0 (2019-12-18)

⚠ BREAKING CHANGES

  • implements ability to get all items with automatic paging using toAllPromise and toAllPromise extension methods. This commit changes names of some responses and also changes name of property holding paged items to 'items'.

Features

  • adds support for list/add/modify asset folders endpoints (b35b08d)
  • implements ability to get all items with automatic paging using toAllPromise and toAllPromise extension methods. This commit changes names of some responses and also changes name of property holding paged items to 'items'. (c77353f)

Bug Fixes

  • fixes incorrect import source in readme (5642343)
  • uses base github url in package.json to fix automatic commit url generation (38b243e)

0.2.8 (2019-12-16)

Features

  • adds codename to add taxonomy data model (7bb118b)
  • adds support for add/get/list webhooks endpoints (5744e94)
  • adds support for project information endpoint (234f175)
  • adds support for retrieving single taxonomy items (0cdb48f)
  • adds support for setting content item codename during creation (94c1f94)
  • adds support for updating conten item codename (9c7786e)

Bug Fixes

  • uses internal id for content type identifier instead of external id (bb6d46b)

0.2.7 (2019-11-21)

Features

  • add support for 'ListLanguageVariantsOfContentTypeWithVariants' API endpoint (008f5e5)
  • adds additional language reference properties and fixes filename (73109ad)

0.2.6 (2019-11-21)

Bug Fixes

  • uses reference contract instead of reference object (5df58b1)

0.2.5 (2019-11-20)

Bug Fixes

  • updates @kentico/kontent-core dep which removes testing warn logging in console (cf38dbe)

0.2.4 (2019-11-13)

Features

  • adds codename property to 'addContentType' and 'addContentTypeSnippet' queries, adds 'content_groups' property to 'addContentType' (bec6a8c)

0.2.3 (2019-11-13)

Features

  • adds 'isDeveloperMode' client configuration option. If this option is enabled, additional errors are logged in console. (7d64864)
  • adds optional data query builder class and uses it for 'publishOrScheduleLanguageVariant' method to allow for skipping data. Fixes #5 (e5cb868)
  • adds support for pagination with x-continuation header token, adds ability to set headers in query config, internally refactors the way headers are retrieved, changes debug response type to include strongly typed properties (7efafc0)
  • internal - separates query builders from queries (513d058)

Bug Fixes

  • removes the ability to set entire query config to prevent overriding headers (8115e2a)
  • sets correct data model for modifying language (fixes #7) (ae740e4)

0.2.2 (2019-11-05)

Features

  • adds elements builder for add content type snippet query (74249a9)
  • adds elements builder with models for convenient creation of new content types (6b0128e)

Bug Fixes

  • updates kontent-core package which fixes http retry requests (5545f10)

0.2.1 (2019-10-31)

Bug Fixes

  • Fixes modifyLanguage request type (#3) (cc989ce)
  • Updates kontent-core package which fixes patch requests incorrectly using put callback (e9faa5d)

0.2.0 (2019-10-25)

⚠ BREAKING CHANGES

  • implements 'modifyContentType' endpoint, uses new retry policy & uses standard versioning

Features

  • implements 'modifyContentType' endpoint, uses new retry policy & uses standard versioning (75a9e74)