Skip to content

feat(utilities): add readGlobalFieldSchemas utility function#2650

Open
cs-raj wants to merge 4 commits into
v2-devfrom
enhc/DX-9464
Open

feat(utilities): add readGlobalFieldSchemas utility function#2650
cs-raj wants to merge 4 commits into
v2-devfrom
enhc/DX-9464

Conversation

@cs-raj

@cs-raj cs-raj commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds readGlobalFieldSchemas(dirPath, ignoredFiles?) to @contentstack/cli-utilities
  • Thin wrapper around the existing readContentTypeSchemas — identical behaviour, purpose-specific name
  • Exported from the package index so all downstream packages can import it directly

Why

Global fields now export as individual {uid}.json files (one per field) rather than a single bulk globalfields.json array. Import, content-types, and audit modules need to scan a directory and read all those files. Using readContentTypeSchemas directly would work but is semantically misleading — callers working with global fields should call a function that names its intent clearly.

Changes

File Change
packages/contentstack-utilities/src/content-type-utils.ts Added readGlobalFieldSchemas wrapper before readContentTypeSchemas

Notes

  • No behavioural change to readContentTypeSchemas — it is unchanged
  • The default ignore list (schema.json, .DS_Store, __master.json, __priority.json, field_rules_uid.json) is inherited from readContentTypeSchemas and applies equally to global field directories
  • This PR is a prerequisite for the cli-plugins changes that consume this function

Test plan

  • pnpm --filter @contentstack/cli-utilities build completes without errors
  • readGlobalFieldSchemas is present in the compiled lib/content-type-utils.d.ts
  • Importing readGlobalFieldSchemas from @contentstack/cli-utilities resolves correctly in downstream packages after rebuild

🤖 Generated with Claude Code

@cs-raj @claude
feat(utilities): add readGlobalFieldSchemas utility function
6940f82 
Adds a thin wrapper around readContentTypeSchemas specifically for global
fields, enabling callers to read per-file {uid}.json exports from the
global_fields directory with a semantically accurate function name.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cs-raj
cs-raj requested a review from a team as a code owner July 22, 2026 19:36
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

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

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 2 37 25 ✅ Passed
🟡 Medium Severity 0 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

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

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

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 37
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

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

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 0 25 ✅ Passed
🟡 Medium Severity 0 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

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

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

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 0
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@cs-raj @claude
fix(utilities): add globalfields.json to readGlobalFieldSchemas ignor…
5f58ed7 
…e list

Prevents silent data corruption when a CLI v1 export archive containing
global_fields/globalfields.json is passed to readGlobalFieldSchemas — the
bulk array file is now skipped instead of being parsed as a single schema
element. readContentTypeSchemas is unaffected.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

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

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 0 25 ✅ Passed
🟡 Medium Severity 0 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

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

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

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 0
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

@cs-raj @claude
test(utilities): add readGlobalFieldSchemas unit tests and assert rea…
f42e59b 
…dContentTypeSchemas unchanged

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

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

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 0 25 ✅ Passed
🟡 Medium Severity 0 2 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

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

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

ℹ️ Vulnerabilities Without Available Fixes (Informational Only)

The following vulnerabilities were detected but do not have fixes available (no upgrade or patch). These are excluded from failure thresholds:

  • Critical without fixes: 0
  • High without fixes: 0
  • Medium without fixes: 2
  • Low without fixes: 0

✅ BUILD PASSED - All security checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@cs-raj