{"id":31974684,"url":"https://github.com/splitio/split-openfeature-provider-js","last_synced_at":"2025-10-14T20:20:23.445Z","repository":{"id":150815607,"uuid":"525948104","full_name":"splitio/split-openfeature-provider-js","owner":"splitio","description":"Open Feature Javascript Provider for Split.io","archived":false,"fork":false,"pushed_at":"2025-09-05T21:37:49.000Z","size":132,"stargazers_count":23,"open_issues_count":4,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-05T23:31:32.975Z","etag":null,"topics":["feature-flags","feature-toggles","featureflags","javascript","js","openfeature","sdk","splitio"],"latest_commit_sha":null,"homepage":"https://split.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splitio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"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":"2022-08-17T20:44:56.000Z","updated_at":"2025-08-25T17:07:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"dd9f7722-efa2-4dea-bc3f-8251a2c7a7ee","html_url":"https://github.com/splitio/split-openfeature-provider-js","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/splitio/split-openfeature-provider-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splitio%2Fsplit-openfeature-provider-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splitio%2Fsplit-openfeature-provider-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splitio%2Fsplit-openfeature-provider-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splitio%2Fsplit-openfeature-provider-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splitio","download_url":"https://codeload.github.com/splitio/split-openfeature-provider-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splitio%2Fsplit-openfeature-provider-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279021032,"owners_count":26086947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["feature-flags","feature-toggles","featureflags","javascript","js","openfeature","sdk","splitio"],"created_at":"2025-10-14T20:20:14.445Z","updated_at":"2025-10-14T20:20:23.439Z","avatar_url":"https://github.com/splitio.png","language":"JavaScript","readme":"# Split OpenFeature Provider for NodeJS\n[![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social\u0026label=Follow\u0026maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)\n\n## Overview\nThis Provider is designed to allow the use of OpenFeature with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.\n\n## Compatibility\nIt supports **Node.js version 14.x or later**.\n\n\n## Getting started\nBelow is a simple example that describes the instantiation of the Split Provider. Please see the [OpenFeature Documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api) for details on how to use the OpenFeature SDK.\n\n### Add the Split provider\n\n```sh\nnpm install @splitsoftware/openfeature-js-split-provider\n```\n\n### Confirm peer dependencies are installed\n```sh\nnpm install @splitsoftware/splitio\nnpm install @openfeature/server-sdk\n```\n\n### Register the Split provider with OpenFeature using sdk apiKey\n```js\nconst OpenFeature = require('@openfeature/server-sdk').OpenFeature;\nconst OpenFeatureSplitProvider = require('@splitsoftware/openfeature-js-split-provider').OpenFeatureSplitProvider;\n\nconst authorizationKey = 'your auth key'\nconst provider = new OpenFeatureSplitProvider(authorizationKey);\nOpenFeature.setProvider(provider);\n```\n\n### Register the Split provider with OpenFeature using splitFactory\n```js\nconst OpenFeature = require('@openfeature/server-sdk').OpenFeature;\nconst SplitFactory = require('@splitsoftware/splitio').SplitFactory;\nconst OpenFeatureSplitProvider = require('@splitsoftware/openfeature-js-split-provider').OpenFeatureSplitProvider;\n\nconst authorizationKey = 'your auth key'\nconst splitFactory = SplitFactory({core: {authorizationKey}});\nconst provider = new OpenFeatureSplitProvider(splitFactory);\nOpenFeature.setProvider(provider);\n```\n\n### Register the Split provider with OpenFeature using splitClient\n```js\nconst OpenFeature = require('@openfeature/server-sdk').OpenFeature;\nconst SplitFactory = require('@splitsoftware/splitio').SplitFactory;\nconst OpenFeatureSplitProvider = require('@splitsoftware/openfeature-js-split-provider').OpenFeatureSplitProvider;\n\nconst authorizationKey = 'your auth key'\nconst splitClient = SplitFactory({core: {authorizationKey}}).client();\nconst provider = new OpenFeatureSplitProvider({splitClient});\nOpenFeature.setProvider(provider);\n```\n\n## Use of OpenFeature with Split\nAfter the initial setup you can use OpenFeature according to their [documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api/).\n\nOne important note is that the Split Provider **requires a targeting key** to be set. Often times this should be set when evaluating the value of a flag by [setting an EvaluationContext](https://docs.openfeature.dev/docs/reference/concepts/evaluation-context) which contains the targeting key. An example flag evaluation is\n```js\nconst client = openFeature.getClient('CLIENT_NAME');\n\nconst context: EvaluationContext = {\n  targetingKey: 'TARGETING_KEY',\n};\nconst boolValue = await client.getBooleanValue('boolFlag', false, context);\n```\nIf the same targeting key is used repeatedly, the evaluation context may be set at the client level \n```js\nconst context: EvaluationContext = {\n  targetingKey: 'TARGETING_KEY',\n};\nclient.setEvaluationContext(context)\n```\nor at the OpenFeatureAPI level \n```js\nconst context: EvaluationContext = {\n  targetingKey: 'TARGETING_KEY',\n};\nOpenFeatureAPI.getInstance().setCtx(context)\n```\nIf the context was set at the client or api level, it is not required to provide it during flag evaluation.\n\n## Evaluate with details\nUse the get*Details(...) APIs to get the value and rich context (variant, reason, error code, metadata). This provider includes the Split treatment config as a raw JSON string under flagMetadata[\"config\"]\n\n```js\nconst booleanTreatment = await client.getBooleanDetails('boolFlag', false, context);\n\nconst config = booleanTreatment.flagMetadata.config\n```\n\n## Tracking\n\nTo use track(eventName, context, details) you must provide:\n\n- A non-blank `eventName`.\n- A context with:\n  - `targetingKey` (non-blank).\n  - `trafficType` (string, e.g. \"user\" or \"account\").\n\nOptional:\n\n- details with:\n  - `value`: numeric event value (defaults to 0).\n  - `properties`: map of attributes (prefer primitives: string/number/boolean/null).\n\nExample:\n```js\nconst context = { targetingKey: 'user-123', trafficType: 'account' }\nconst details = { value: 19.99, plan: 'pro', coupon: 'WELCOME10' }\n\nclient.track('checkout.completed', context, details)\n```\n## Submitting issues\n \nThe Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/split-openfeature-provider-nodejs/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.\n\n## Contributing\nPlease see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).\n\n## License\nLicensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).\n\n## About Split\n \nSplit is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.\n \nTo learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.\n \nSplit has built and maintains SDKs for:\n \n* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)\n* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)\n* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)\n* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://help.split.io/hc/en-us/articles/26988707417869-Elixir-Thin-Client-SDK)\n* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)\n* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)\n* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)\n* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)\n* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)\n* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)\n* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)\n* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)\n* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)\n* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)\n* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)\n* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)\n* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)\n* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)\n \nFor a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93\u0026query=%20only%3Apublic%20).\n \n**Learn more about Split:**\n \nVisit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitio%2Fsplit-openfeature-provider-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplitio%2Fsplit-openfeature-provider-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitio%2Fsplit-openfeature-provider-js/lists"}