Feat/taxonomy publishing by harshitha-cstk · Pull Request #345 · contentstack/contentstack-typescript

harshitha-cstk · 2026-03-12T07:39:22Z

Summary

Adds support for the published Taxonomy Content Delivery API (CDA) to the delivery SDK. Consumers can now fetch published taxonomies and terms, walk the term tree (ancestors/descendants), retrieve localized term versions, and query entries by taxonomy/term — all through a fluent, chainable API off the stack instance.

Note: These endpoints require the taxonomy_publish feature flag to be enabled on the stack's plan. If it is not enabled, the CDA returns 403 taxonomy.feature_disabled.

What's new

New classes wired into Stack:

Entry point	Returns	Purpose
`stack.taxonomy()`	`TaxonomyQuery`	List all taxonomies / query entries by taxonomy
`stack.taxonomy(uid)`	`Taxonomy`	A single taxonomy
`stack.taxonomy(uid).term(termUid)`	`Term`	A single term
`stack.taxonomy(uid).term()`	`TermQuery`	All terms in a taxonomy

Endpoint coverage

CDA endpoint	SDK call
`GET /taxonomies`	`stack.taxonomy().find()`
`GET /taxonomies/:uid`	`stack.taxonomy(uid).fetch()`
`GET /taxonomies/:uid/terms`	`stack.taxonomy(uid).term().find()`
`GET /taxonomies/:uid/terms/:term`	`stack.taxonomy(uid).term(term).fetch()`
`GET .../terms/:term/locales`	`stack.taxonomy(uid).term(term).locales()`
`GET .../terms/:term/ancestors`	`stack.taxonomy(uid).term(term).ancestors()`
`GET .../terms/:term/descendants`	`stack.taxonomy(uid).term(term).descendants()`

Query-parameter support

Chainable helpers to apply the common CDA query parameters:

Taxonomy: includeFallback(), includeBranch(), param(), addParams(), and a locale argument on fetch(locale?).
Term: depth(), includeFallback(), includeBranch(), param(), addParams(), and a locale argument on fetch(locale?); params are forwarded on fetch/locales/ancestors/descendants.
TermQuery: depth(), skip(), limit(), includeCount(), includeFallback(), includeBranch(), locale(), param(), addParams().

Types

BaseTaxonomy, BaseTerm response interfaces.
TaxonomyQueryOperation enum for tree operators ($above, $below, $eq_above, $eq_below) used in entry-by-taxonomy queries.

Usage

import contentstack from '@contentstack/delivery-sdk';

const stack = contentstack.stack({ apiKey, deliveryToken, environment });

// All taxonomies
const taxonomies = await stack.taxonomy().find();

// Single taxonomy (with locale fallback)
const taxonomy = await stack.taxonomy('categories').includeFallback().fetch('hi-in');

// All terms in a taxonomy, paginated with a count
const terms = await stack.taxonomy('regions').term()
  .limit(20).skip(0).includeCount().find();

// A single term and its tree
const term = await stack.taxonomy('regions').term('california').fetch();
const ancestors = await stack.taxonomy('regions').term('california').ancestors();
const descendants = await stack.taxonomy('regions').term('usa').depth(2).descendants();
const localized = await stack.taxonomy('regions').term('california').locales();

Testing

Unit tests (mocked) for Taxonomy, Term, TermQuery, and TaxonomyQuery, including assertions that the query parameters reach the request.
API/integration test suites for the taxonomy and term endpoints.

Notes / follow-ups

The /taxonomies/entries (entries-by-taxonomy) path is set on TaxonomyQuery but find() currently resolves to /taxonomies; wiring a dedicated call for entries-by-taxonomy with tree operators is a follow-up.
Term.locales() targets /taxonomies/:uid/terms/:uid/locales; confirm against the finalized CDA route (/taxonomy_definitions/... in the spec) before release.

…taxonomy management

feat dx-3628 get all taxonomies

get a single taxonomy

…ement

…seDataMock for consistency in tests

feat: Add Term and TermQuery classes

… and adjust related tests

Feat/dx 3632 terms loacales

feat: Add ancestors method to Term class and update related tests

…ion and fetch methods

…lished status and feature flag requirements

feat: Add descendants method to Term class and update related tests

…nomy-api

…y-api Feat/dx 3797 update taxonomy api

github-actions · 2026-03-12T07:39:34Z

We regret to inform you that you are currently not able to merge your changes into the main branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the development branch. Our team will then review the changes and work with you to ensure a successful merge into the main branch.

…t new directory structure

github-actions · 2026-03-12T07:48:29Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-03-12T07:48:40Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-07-15T07:11:31Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

Adds locale-aware retrieval for taxonomy and term CDA endpoints (cdn.contentstack.io) to cover the localized-delivery flow (CD-11371). - Taxonomy.fetch(locale?) — pass locale to GET /taxonomies/{uid} - TermQuery.locale(code) + includeFallback() — chainable params on GET /taxonomies/{uid}/terms for locale and fallback filtering - Term.fetch(locale?) — pass locale to GET /taxonomies/{uid}/terms/{uid} - Fixed incorrect JSDoc on Term.fetch (copy-paste from descendants) - Fixed broken test imports pointing to non-existent src/lib/* paths Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

feat: add locale and includeFallback support to taxonomy CDA delivery

github-actions · 2026-07-15T11:32:50Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

…rmQuery Add chainable helpers so common CDA query params can be sent on the published taxonomy/term endpoints, which previously issued requests with no params at all: - Term: depth(), includeFallback(), includeBranch(), param(), addParams() and locale support on fetch(); all request methods (fetch/locales/ ancestors/descendants) now forward _queryParams. - Taxonomy: includeFallback(), includeBranch(), param(), addParams(), and locale support on fetch() (fetch() now forwards _queryParams). - TermQuery: depth(), skip(), limit(), includeCount(), includeFallback(), includeBranch(), locale(), param(), addParams(). Also fix broken unit-test imports (src/lib/* -> src/taxonomy/*, src/query/*) so the taxonomy suites load, and add coverage asserting the params reach the request. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-07-15T11:37:10Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-07-15T11:46:09Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-07-15T11:54:43Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

…m-query Add mock fixtures and unit/API test cases exercising locale-based fetch and query behavior across Taxonomy, Term, and TermQuery.

github-actions · 2026-07-15T12:38:58Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-07-15T13:38:50Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

github-actions · 2026-07-15T14:01:41Z

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type	Threshold	Result
🔴 Critical Severity	10	✅ Passed
🟠 High Severity	25	✅ Passed
🟡 Medium Severity	500	✅ Passed
🔵 Low Severity	1000	✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity	SLA Threshold (with/no fixes)	Status
🔴 Critical	15 / 30 days	✅ Passed
🟠 High	30 / 120 days	✅ Passed
🟡 Medium	90 / 365 days	✅ Passed
🔵 Low	180 / 365 days	✅ Passed

✅ BUILD PASSED - All security checks passed

harshitha-cstk and others added 28 commits October 13, 2025 14:00

feat: Implement Taxonomy class and update TaxonomyQuery for enhanced …

240d7f5

…taxonomy management

Merge pull request #240 from contentstack/feat/dx-3628-get-all-taxonomy

77caa3b

feat dx-3628 get all taxonomies

get a single taxonomy

df96f25

Merge pull request #242 from contentstack/feat/dx-3629-single-taxonomy

056fc6d

get a single taxonomy

feat: Add Term and TermQuery classes for enhanced taxonomy term manag…

c213dd8

…ement

refactor: Rename TermQueryFindResponseDataMock to termQueryFindRespon…

b7e629a

…seDataMock for consistency in tests

Merge pull request #243 from contentstack/feat/dx-3630-get-terms

6ed4fdb

feat: Add Term and TermQuery classes

feat: Add locales method to Term class and corresponding tests

908f206

refactor: Update locales method in Term class to return data directly…

92d633d

… and adjust related tests

Merge pull request #247 from contentstack/feat/dx-3632-terms-loacales

33bca3b

Feat/dx 3632 terms loacales

feat: Add ancestors method to Term class and update related tests

c4695d8

Merge pull request #248 from contentstack/feat/dx-3634-ancestors

7a8b8a4

feat: Add ancestors method to Term class and update related tests

feat: Add descendants method to Term class and update related tests

4e97212

feat: Enhance Taxonomy and TermQuery classes with detailed documentat…

519c7a3

…ion and fetch methods

docs: Update descriptions in Taxonomy and Term classes to clarify pub…

62e3994

…lished status and feature flag requirements

feat: type definitions for taxonomy management

6a8122f

Merge pull request #249 from contentstack/feat/dx-3633-descendants

75c7d9a

feat: Add descendants method to Term class and update related tests

Merge branch 'main' into feat/dx-3797-update-taxonomy-api

19aa8d5

refactor: update API endpoints from /taxonomy-manager to /taxonomies

13fa7d9

Merge branch 'main' into feat/taxonomy-publishing

251a61c

Merge branch 'feat/taxonomy-publishing' into feat/dx-3797-update-taxo…

d88c4fc

…nomy-api

Merge pull request #284 from contentstack/feat/dx-3797-update-taxonom…

a85d2a2

…y-api Feat/dx 3797 update taxonomy api

Merge branch 'main' into feat/taxonomy-publishing

63b49fd

Merge branch 'main' into feat/taxonomy-publishing

38e9def

test: update locales test case to include assertions

43bc2aa

Merge branch 'development' into feat/taxonomy-publishing

071aef5

refactor: reorganize taxonomy imports and add Taxonomy and Term classes

ed590e2

chore: remove unused Taxonomy import from stack.ts

5587efd

harshitha-cstk requested a review from a team as a code owner March 12, 2026 07:39

harshitha-cstk added 3 commits March 12, 2026 13:13

refactor: update import paths for Taxonomy and Term classes to reflec…

7ed8c16

…t new directory structure

update package-lock

09268cc

Merge branch 'main' into feat/taxonomy-publishing

f14f4e9

harshithad0703 requested a review from a team as a code owner March 12, 2026 07:47

Merge branch 'main' into feat/taxonomy-publishing

2e0be5a

Merge branch 'development' into feat/taxonomy-publishing

cf621e8

cs-raj and others added 2 commits July 15, 2026 15:57

Merge pull request #374 from contentstack/enhc/taxonomy-localisation-2

dae3f07

feat: add locale and includeFallback support to taxonomy CDA delivery

version bump

cdd2fee

add taxonomy localization test cases

8121f6a

test: add locale/includeFallback coverage for taxonomy, term, and ter…

82fc012

…m-query Add mock fixtures and unit/API test cases exercising locale-based fetch and query behavior across Taxonomy, Term, and TermQuery.

netrajpatel previously approved these changes Jul 15, 2026

View reviewed changes

fix: tests

5a7b189

cs-raj dismissed netrajpatel’s stale review via 5a7b189 July 15, 2026 13:38

chore: fix test cases

5801073

netrajpatel approved these changes Jul 15, 2026

View reviewed changes

cs-raj merged commit 5a8e9c0 into development Jul 15, 2026
10 checks passed

cs-raj deleted the feat/taxonomy-publishing branch July 15, 2026 14:06

OMpawar-21 approved these changes Jul 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat/taxonomy publishing#345

Feat/taxonomy publishing#345
cs-raj merged 41 commits into
developmentfrom
feat/taxonomy-publishing

harshitha-cstk commented Mar 12, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Mar 12, 2026

Uh oh!

github-actions Bot commented Mar 12, 2026

Uh oh!

github-actions Bot commented Mar 12, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

harshitha-cstk commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What's new

Endpoint coverage

Query-parameter support

Types

Usage

Testing

Notes / follow-ups

Uh oh!

github-actions Bot commented Mar 12, 2026

Uh oh!

github-actions Bot commented Mar 12, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Mar 12, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

github-actions Bot commented Jul 15, 2026

🔒 Security Scan Results

⏱️ SLA Breach Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

harshitha-cstk commented Mar 12, 2026 •

edited

Loading