{"id":13881066,"url":"https://github.com/contentful/ui-extensions-sdk","last_synced_at":"2026-05-13T22:01:53.176Z","repository":{"id":38355818,"uuid":"45402653","full_name":"contentful/ui-extensions-sdk","owner":"contentful","description":"A JavaScript library to develop custom apps for Contentful","archived":false,"fork":false,"pushed_at":"2026-01-23T21:30:25.000Z","size":11362,"stargazers_count":129,"open_issues_count":27,"forks_count":33,"subscribers_count":75,"default_branch":"main","last_synced_at":"2026-01-24T09:48:21.919Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.contentful.com/developers/docs/extensibility/app-framework/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/contentful.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-11-02T15:21:05.000Z","updated_at":"2026-01-23T21:28:56.000Z","dependencies_parsed_at":"2023-09-27T01:05:53.071Z","dependency_job_id":"2cbaefc6-4500-4076-961f-e21c533af29c","html_url":"https://github.com/contentful/ui-extensions-sdk","commit_stats":{"total_commits":1986,"total_committers":83,"mean_commits":"23.927710843373493","dds":0.5070493454179255,"last_synced_commit":"cb81f5e59e0a98385225f4c7c1d2ba6459eaec72"},"previous_names":["contentful/widget-sdk"],"tags_count":216,"template":false,"template_full_name":null,"purl":"pkg:github/contentful/ui-extensions-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fui-extensions-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fui-extensions-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fui-extensions-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fui-extensions-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/contentful","download_url":"https://codeload.github.com/contentful/ui-extensions-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/contentful%2Fui-extensions-sdk/sbom","scorecard":{"id":303449,"data":{"date":"2025-08-11","repo":{"name":"github.com/contentful/ui-extensions-sdk","commit":"ad4a4d1df67c403a77dedf9f4ad91950f5b19d27"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.2,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":5,"reason":"Found 13/22 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:17","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:18","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/dependabot-approve-and-request-merge.yml:8","Warn: no topLevel permission defined: .github/workflows/codeql.yml:1","Warn: no topLevel permission defined: .github/workflows/dependabot-approve-and-request-merge.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/contentful/ui-extensions-sdk/codeql.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/contentful/ui-extensions-sdk/codeql.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/contentful/ui-extensions-sdk/codeql.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabot-approve-and-request-merge.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/contentful/ui-extensions-sdk/dependabot-approve-and-request-merge.yml/main?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/contentful/.github/SECURITY.md:1","Info: Found linked content: github.com/contentful/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/contentful/.github/SECURITY.md:1","Info: Found text in security policy: github.com/contentful/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Branch-Protection","score":1,"reason":"branch protection is not maximal on development and all release branches","details":["Warn: branch protection not enabled for branch 'canary'","Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Info: codeowner review is required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T21:21:33.908Z","repository_id":38355818,"created_at":"2025-08-17T21:21:33.908Z","updated_at":"2025-08-17T21:21:33.908Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28889871,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"ssl_error","status_checked_at":"2026-01-29T21:06:42.160Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T08:03:57.149Z","updated_at":"2026-05-13T22:01:53.170Z","avatar_url":"https://github.com/contentful.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# App SDK\n\nThe App SDK (formerly known as UI Extensions SDK) is a JavaScript library that allows developers to create custom Contentful Apps\nfor the Contentful Web App. Every Contentful App has to include the library in its source.\n\n## Resources\n\n- [App SDK reference](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/)\n- [App Framework general documentation](https://www.contentful.com/developers/docs/extensibility/app-framework/)\n- [UI Extensions general documentation](https://www.contentful.com/developers/docs/extensibility/ui-extensions/)\n- [Contentful Apps Management HTTP API reference](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/app-definitions)\n- [Contentful Apps FAQ](https://www.contentful.com/developers/docs/extensibility/app-framework/faq/)\n- [Contentful Apps repository](https://github.com/contentful/apps)\n- [Contentful Marketplace](https://www.contentful.com/developers/marketplace/)\n- [Contentful Changelog](https://www.contentful.com/developers/changelog/)\n- [Forma 36: The Contentful Design System](https://f36.contentful.com/)\n- [Forma 36 guide for Contentful Apps](https://www.contentful.com/developers/docs/extensibility/ui-extensions/component-library/)\n- [`create-contentful-app`](https://github.com/contentful/create-contentful-app) - CLI tool for developing apps without the hassle of managing build configurations\n- [`contentful-ui-extensions-sdk` at npm](https://www.npmjs.com/package/contentful-ui-extensions-sdk)\n\n## Getting help\n\nTechnical questions, feedback, or feature requests can be provided directly through the GitHub issues\nfor this repository. However, if you are a paying customer or at any point business sensitive\ninformation needs to be discussed, then the conversation should be handled via our\n[support system](https://www.contentful.com/support/).\n\n## Development\n\n### Publishing\n\nA new package version is automatically published to npm using [semantic-release](https://github.com/semantic-release/semantic-release).\n\nTo manually publish the package, run `npm run publish-all`.\n\nThis repository is published as two packages with identical data. We recommend using `@contentful/app-sdk`.\n\n- `@contentful/app-sdk`\n- `contentful-ui-extensions-sdk`\n\n#### Canary releases\n\nThis package has two main development streams: `latest` and `canary`.\n\nThe default and stable releases are always published under the `latest` tag (as per npm convention).\nThe release under the `canary` tag is to be considered unstable and potentially breaking.\nYou should not rely on it in production.\n\nTo start a new alpha version of the package follow these steps:\n\n1. Checkout the `canary` branch.\n2. Reset canary to the latest main: `git reset --hard origin/main`\n3. Create a new branch with your changes from `canary`\n4. Create a PR that merges into `canary`.\n\n### File Structure\n\n#### `docs`\n\nFormer home of the documentation and reference for this library. This is now deprecated and you should use links above.\n\n#### `lib`\n\nIncludes the files constituting the SDK and the associated types.\n\nTop level files are split by feature. Most of them map 1-to-1 to an API (keep reading for the outliers). When APIs are\nconsidered too small to be in a separate file, they are part of the [`api`](./lib/api.ts) file.\n\n- [`channel`](./lib/channel.ts) and [`signal`](./lib/signal.ts) abstract the communication between an App and the host;\n- [`locations`](./lib/locations.ts) exports available location where you can run App;\n- [`initialize`](./lib/initialize.ts) creates an initializer to start an App within Contentful's App Framework.\n\nAll the typings are in the [`types`](./lib/types) folder and they map 1-to-1 APIs, when they make sense.\nThe [`entities`](./lib/types/entities.ts) file maps Contentful entities in TypeScript.\n[`utils`](./lib/types/utils.ts) includes utility types, meant to save on characters to type.\n\n#### `scripts`\n\nIncludes utility tools for maintainers.\n\n#### `test`\n\nIncludes unit tests (run by [mocha](https://mochajs.org/))\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontentful%2Fui-extensions-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontentful%2Fui-extensions-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontentful%2Fui-extensions-sdk/lists"}