{"id":41370292,"url":"https://github.com/arez/arez-persist","last_synced_at":"2026-01-23T09:25:28.405Z","repository":{"id":57739964,"uuid":"263785570","full_name":"arez/arez-persist","owner":"arez","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-21T07:06:02.000Z","size":907,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-21T18:59:44.558Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://arez.github.io/persist","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-05-14T01:34:50.000Z","updated_at":"2026-01-21T07:06:04.000Z","dependencies_parsed_at":"2024-05-31T05:46:26.324Z","dependency_job_id":"8ab51de0-2b85-4d49-b261-a0cbf5e37c1e","html_url":"https://github.com/arez/arez-persist","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"purl":"pkg:github/arez/arez-persist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arez%2Farez-persist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arez%2Farez-persist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arez%2Farez-persist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arez%2Farez-persist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arez","download_url":"https://codeload.github.com/arez/arez-persist/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arez%2Farez-persist/sbom","scorecard":{"id":206246,"data":{"date":"2025-08-11","repo":{"name":"github.com/arez/arez-persist","commit":"a29d2045c5ae64d15188cf5af7498e0814b8c916"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.5,"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":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","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":"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":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/automerge.yml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":10,"reason":"all dependencies are pinned","details":["Info:   1 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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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: Apache License 2.0: 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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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"}}]},"last_synced_at":"2025-08-16T23:50:59.818Z","repository_id":57739964,"created_at":"2025-08-16T23:50:59.818Z","updated_at":"2025-08-16T23:50:59.818Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28686235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","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":"2026-01-23T09:25:27.015Z","updated_at":"2026-01-23T09:25:28.394Z","avatar_url":"https://github.com/arez.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Arez-Persist\n\n[![Build Status](https://api.travis-ci.com/arez/arez-persist.svg?branch=master)](http://travis-ci.com/arez/arez-persist)\n[\u003cimg src=\"https://img.shields.io/maven-central/v/org.realityforge.arez.persist/arez-persist.svg?label=latest%20release\"/\u003e](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.realityforge.arez.persist%22)\n\nThis library provides annotation driven infrastructure for persisting observable properties on\nArez components. The library has built-in support for storing properties in memory, within a browser\nsession or across browser sessions but allows users to supply their own mechanisms for persisting state.\n\n## Quick Start\n\nThe simplest way to use the library;\n\n* add the following dependencies into the build system. i.e.\n\n```xml\n\u003cdependency\u003e\n   \u003cgroupId\u003eorg.realityforge.arez.persist\u003c/groupId\u003e\n   \u003cartifactId\u003earez-persist-core\u003c/artifactId\u003e\n   \u003cversion\u003e0.59\u003c/version\u003e\n\u003c/dependency\u003e\n```\n* To enable the annotation processor used by the framework, you need add the following\n  snippet to configure the maven compiler plugin from within the `pom.xml`:\n\n```xml\n\u003cproject\u003e\n  ...\n  \u003cplugins\u003e\n    ...\n      \u003cplugin\u003e\n        \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n        \u003cartifactId\u003emaven-compiler-plugin\u003c/artifactId\u003e\n        \u003cversion\u003e3.5.1\u003c/version\u003e\n        \u003cconfiguration\u003e\n          \u003csource\u003e1.8\u003c/source\u003e\n          \u003ctarget\u003e1.8\u003c/target\u003e\n          \u003cuseIncrementalCompilation\u003efalse\u003c/useIncrementalCompilation\u003e\n          \u003cannotationProcessorPaths\u003e\n            \u003cpath\u003e\n               \u003cgroupId\u003eorg.realityforge.arez.persist\u003c/groupId\u003e\n               \u003cartifactId\u003earez-persist-processor\u003c/artifactId\u003e\n               \u003cversion\u003e0.59\u003c/version\u003e\n            \u003c/path\u003e\n          \u003c/annotationProcessorPaths\u003e\n        \u003c/configuration\u003e\n      \u003c/plugin\u003e\n      ...\n    \u003c/plugins\u003e\n  \u003c/build\u003e\n\u003c/project\u003e\n```\n\n* If you are using ArezPersist within a GWT application you will also need to inherit the appropriate\n  GWT module in your `.gwt.xml` file. It is usually sufficient to add:\n\n```xml\n\u003cmodule\u003e\n  ...\n  \u003cinherits name='arez.persist.Persist'/\u003e\n  ...\n\u003c/module\u003e\n```\n\n  If you want the framework to perform validation and invariant checking you can instead inherit\n  the `Dev` module instead. The `Dev` module is very useful during development as it adds a\n  level of safety and error checking, but it should not be used in production environments as it adds\n  some overhead in terms of code size and execution speed. The `Dev` module can be added via:\n\n```xml\n\u003cmodule\u003e\n  ...\n  \u003cinherits name='arez.persist.PersistDev'/\u003e\n  ...\n\u003c/module\u003e\n```\n\n* Configure the stores used to persist component state. There are 3 types of store included in the\n  library. One store is purely in memory and is lost on application reload, one persists to the\n  browser's session storage and thus will be restored even when the tab is reloaded and the last is\n  stored in the browser's local storage and is persisted even after the tab is closed.\n\n  The in-memory store is automatically created unless disable at compile time. (See the compile-time\n  settings in the `Persist.gwt.xml` module). While the other two stores must be explicitly created\n  via:\n\n```java\n// register a \"session\" store using the browsers session storage. Store state under\n// the \"myapp\" key in the session storage.\nArezPersistBrowserUtil.registerSessionStore( \"myapp\" );\n\n// register a \"local\" store using the browsers local storage. Store state under\n// the \"myapp\" key in the local storage.\nArezPersistBrowserUtil.registerLocalStore( \"myapp\" );\n```\n\n* Explicitly register converters for any types that may need them. The converters are responsible for\n  encoding values in a form compatible with the stores. The actual converters needed will depend on the\n  types of the properties marked with the `@Persist` annotation and the requirements of the store.\n\n  This library is expected to be used within a browser context where all non-double values are represented\n  as doubles when stored as json objects which is how the inbuilt local and session stores persist state.\n  As such, the library defines several converters that can be registered by invoking methods on the\n  `ArezPersistBrowserUtil` class. If these converters are not used then they should not be registered as\n  each converter adds some overhead. However, the converters useful in a browser may be registered via:\n\n```java\nArezPersistBrowserUtil.registerCharacterConverter();\nArezPersistBrowserUtil.registerByteConverter();\nArezPersistBrowserUtil.registerShortConverter();\nArezPersistBrowserUtil.registerIntegerConverter();\nArezPersistBrowserUtil.registerLongConverter();\nArezPersistBrowserUtil.registerFloatConverter();\n```\n\n  A developer can also register custom converters via:\n\n```java\nArezPersist.registerConverter( SomeType.class, new SomeTypeConverter() );\n```\n\n* Next, the arez component that you want to persist the state of must be annotated with the\n  `@PersistType` annotation. The state of an `@Observable` annotated property can be persisted\n  by annotating the getter with `@Persist`. The store used to persist the proeprty can be\n  specified as a parameter on the `@Persist` annotation. See the javadocs for the `@Persist`\n  and `@PersistType` annotations for further details.\n\n  It should be noted that the `@ArezComponent.requireId` and `@ArezComponent.disposeNotifier` parameters\n  must resolve to `ENABLE` for `ArezPersist` to work but the annotation processor will not yet generate\n  errors if this is not the case. The arez component should also have a string component id or one maps\n  to a string in stable manner.\n\n```java\n@PersistType\n@ArezComponent( requireId = Feature.ENABLE, disposeNotifier = Feature.ENABLE )\npublic abstract class TreeNode\n{\n  ...\n  // Store the \"expanded\" flag for tree node in local storage\n  @Persist( store = StoreTypes.LOCAL )\n  @Observable\n  public abstract boolean isExpanded();\n\n  public abstract void setExpanded( boolean expanded );\n  ...\n}\n```\n\n# More Information\n\nFor more information about component, please see the [Website](https://arez.github.io/persist). For the\nsource code and project support please visit the [GitHub project](https://github.com/arez/arez-persist).\n\n# Contributing\n\nThe component was released as open source so others could benefit from the project. We are thankful for any\ncontributions from the community. A [Code of Conduct](CODE_OF_CONDUCT.md) has been put in place and\na [Contributing](CONTRIBUTING.md) document is under development.\n\n# License\n\nThe component is licensed under [Apache License, Version 2.0](LICENSE).\n\n# Credit\n\n* [Stock Software](http://www.stocksoftware.com.au/) for providing significant support in building and\n  maintaining Arez-Persist.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farez%2Farez-persist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farez%2Farez-persist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farez%2Farez-persist/lists"}