├── .github ├── dependabot.yml └── workflows │ ├── build.yml │ ├── github-maintenance.yml │ ├── publish.yml │ └── update-gradle-wrapper.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── logo.svg ├── settings.gradle └── src └── main └── kotlin └── io └── viascom └── nanoid └── NanoId.kt /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | 4 | # Enable version updates for GitHub Actions 5 | - package-ecosystem: "github-actions" 6 | directory: "/" 7 | schedule: 8 | interval: "daily" 9 | time: "15:00" 10 | timezone: "Europe/Zurich" 11 | target-branch: "main" 12 | labels: 13 | - "github-actions" 14 | - "dependencies" 15 | 16 | # Enable version updates for Gradle 17 | - package-ecosystem: "gradle" 18 | directory: "/" 19 | schedule: 20 | interval: "daily" 21 | time: "15:00" 22 | timezone: "Europe/Zurich" 23 | target-branch: "main" 24 | labels: 25 | - "gradle" 26 | - "dependencies" 27 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: 6 | - '*' 7 | paths-ignore: 8 | - '**.md' 9 | - '.github/**' 10 | workflow_dispatch: 11 | 12 | jobs: 13 | build: 14 | name: Build Pipeline 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Setup timezone 19 | run: | 20 | sudo timedatectl set-timezone Europe/Zurich 21 | timedatectl 22 | 23 | - name: Check out the repo 24 | uses: actions/checkout@v4 25 | 26 | - name: Set up Java JDK 27 | uses: actions/setup-java@v4 28 | with: 29 | distribution: 'zulu' 30 | java-version: '19' 31 | java-package: jdk 32 | architecture: x64 33 | cache: 'gradle' 34 | check-latest: false 35 | 36 | - name: Change wrapper permissions 37 | run: chmod +x ./gradlew 38 | 39 | - name: Validate Gradle wrapper 40 | uses: gradle/wrapper-validation-action@v3 41 | 42 | - name: Build with Gradle 43 | run: ./gradlew build --warn --full-stacktrace 44 | 45 | - name: Upload Artifacts 46 | uses: actions/upload-artifact@v4 47 | with: 48 | name: build-libs 49 | path: build/libs 50 | retention-days: 3 51 | -------------------------------------------------------------------------------- /.github/workflows/github-maintenance.yml: -------------------------------------------------------------------------------- 1 | name: GitHub Maintenance 2 | on: 3 | workflow_dispatch: 4 | schedule: 5 | - cron: '0 3 * * *' # Run daily at 03:00 6 | 7 | jobs: 8 | github_maintenance: 9 | name: Execute Maintenance 10 | runs-on: ubuntu-latest 11 | 12 | permissions: 13 | actions: write 14 | 15 | steps: 16 | - name: Delete workflow runs 17 | uses: viascom/github-maintenance-action@v0.0.2 -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish release 2 | 3 | on: 4 | release: 5 | types: [ published ] 6 | 7 | jobs: 8 | publish-release: 9 | name: Publish nanoid-kotlin Artifacts 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - name: Setup timezone 14 | run: | 15 | sudo timedatectl set-timezone Europe/Zurich 16 | timedatectl 17 | 18 | - name: Check out the repo 19 | uses: actions/checkout@v4 20 | 21 | - name: Set up Java JDK 22 | uses: actions/setup-java@v4 23 | with: 24 | distribution: 'zulu' 25 | java-version: '19' 26 | java-package: jdk 27 | architecture: x64 28 | cache: 'gradle' 29 | check-latest: false 30 | 31 | - name: Validate Gradle wrapper 32 | uses: gradle/wrapper-validation-action@v3 33 | 34 | - name: Decode GPG Key 35 | run: | 36 | mkdir -p ~/.gradle/ 37 | echo "${{secrets.SIGNING_SECRET_KEY_RING_FILE}}" > ~/.gradle/secring.gpg.b64 38 | base64 -d ~/.gradle/secring.gpg.b64 > ~/.gradle/secring.gpg 39 | 40 | - name: Publish to ossh 41 | run: ./gradlew publish -Psigning.keyId=${{secrets.SIGNING_KEY_ID}} -Psigning.password='${{secrets.SIGNING_PASSWORD}}' -Psigning.secretKeyRingFile=$(echo ~/.gradle/secring.gpg) --warn --stacktrace 42 | env: 43 | OSSRH_USERNAME: ${{secrets.OSSRH_USERNAME}} 44 | OSSRH_PASSWORD: ${{secrets.OSSRH_PASSWORD}} 45 | 46 | - name: Upload Artifacts 47 | uses: actions/upload-artifact@v4 48 | with: 49 | name: build-libs 50 | path: build/libs 51 | retention-days: 90 52 | -------------------------------------------------------------------------------- /.github/workflows/update-gradle-wrapper.yml: -------------------------------------------------------------------------------- 1 | name: Update Gradle Wrapper 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "0 0 * * *" 7 | 8 | jobs: 9 | update-gradle-wrapper: 10 | name: Daily check to upgrade Gradle Wrapper 11 | runs-on: self-hosted 12 | 13 | steps: 14 | - name: Setup timezone 15 | run: | 16 | sudo timedatectl set-timezone Europe/Zurich 17 | timedatectl 18 | 19 | - uses: actions/checkout@v4 20 | 21 | - name: Change wrapper permissions 22 | run: chmod +x ./gradlew 23 | 24 | - name: Update Gradle Wrapper 25 | uses: gradle-update/update-gradle-wrapper-action@v1 26 | with: 27 | labels: dependencies, gradle 28 | reviewers: nik-sta -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | !gradle-wrapper.jar 23 | 24 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 25 | hs_err_pid* 26 | gradle.properties 27 | .gradle/ 28 | .idea/ 29 | out/ 30 | build/ 31 | *.iml 32 | .DS_Store 33 | .jpb 34 | .fastRequest/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Nano ID for Kotlin 2 | 3 | Maven central 4 | Kotlin Version 5 | Java Version 6 | license Apache 2.0 7 | 8 | _Inspired by the following parent project: [ai/nanoid](https://github.com/ai/nanoid)_ 9 | 10 | Nano ID logo by Anton Lovchikov 11 | 12 | A tiny, secure, URL-friendly, unique string ID generator for Kotlin. 13 | 14 | > “An amazing level of senseless perfectionism, which is simply impossible not to respect.” 15 | 16 | * **Small.** Just a simple Kotlin class. 17 | * **Safe.** It uses SecureRandom random generator. 18 | * **Short IDs.** It uses a larger alphabet than UUID (`A-Za-z0-9_-`). So ID size was reduced from 36 to 21 symbols. 19 | * **Portable**. Nano ID was ported 20 | to [over 20 programming languages](https://github.com/ai/nanoid/blob/main/README.md#other-programming-languages). 21 | 22 | ## How to use 23 | 24 | Add nanoid-kotlin as a dependency to your project. 25 | 26 | Gradle: 27 | ```gradle 28 | dependencies { 29 | implementation 'io.viascom.nanoid:nanoid:1.0.1' 30 | } 31 | ``` 32 | 33 | Maven: 34 | ```xml 35 | 36 | io.viascom.nanoid 37 | nanoid 38 | 1.0.1 39 | 40 | ``` 41 | 42 | Start using it: 43 | 44 | ```kotlin 45 | val id = NanoId.generate() 46 | ``` 47 | 48 | ```kotlin 49 | val idWithCustomLength = NanoId.generate(10) 50 | val idWithCustomAlphabet = NanoId.generate(alphabet = "ABC123") 51 | ``` 52 | 53 | ## Calculating the additional bytes factor for a custom alphabet 54 | 55 | If you change the alphabet of the `NanoId.generate()` function, you could optimize the performance by calculating a new additional 56 | bytes factor with the following function: 57 | 58 | ```kotlin 59 | val bytesFactor = NanoId.calculateAdditionalBytesFactor("ABC123") 60 | val id = NanoId.generate(21, "ABC123", bytesFactor) 61 | ``` 62 | 63 | Utilizing a custom-calculated additional bytes factor in `NanoId.generate()` enhances string generation performance. This factor 64 | determines how many bytes are generated in a single batch, optimizing computational efficiency. Generating an optimal number 65 | of bytes per batch minimizes redundant operations and conserves memory. 66 | 67 | ## Usage Guide: `NanoId.generateOptimized()` 68 | 69 | The `NanoId.generateOptimized()` function is an advanced version of the `NanoId.generate()` function designed for higher performance and 70 | lower memory overhead. While it provides a more efficient mechanism to generate unique identifiers, it assumes that you 71 | know precisely how you want to use it. 72 | 73 | 🚫 **Warning**: No checks are performed inside `NanoId.generateOptimized()`. Use it only if you're sure about the parameters you' 74 | re passing. 75 | 76 | ### Example Usage 77 | 78 | Generate a NanoId String of length 10 using the default alphabet set: 79 | 80 | ```kotlin 81 | val id = NanoId.generateOptimized(10, "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", 63, 16) 82 | ``` 83 | 84 | ### Tips: 85 | 86 | - **Performance**: This function is optimized for performance, so it's ideal for scenarios where high-speed ID 87 | generation is needed. 88 | - **Alphabet Set**: The larger your alphabet set, the more unique your generated IDs will be, but also consider the mask 89 | and step parameters' adjustments. 90 | - **Customization**: Feel free to adjust the parameters to suit your specific needs, but always be cautious about the 91 | values you're inputting. 92 | 93 | By following this guide, you can seamlessly integrate the `NanoId.generateOptimized()` function into your projects and enjoy the 94 | benefits of its optimized performance. 95 | 96 | ## 🌱 Contributors Welcome 97 | 98 | - 🐛 **Encountered a Bug?** Let us know with an issue. Every bit of feedback helps enhance the project. 99 | 100 | - 💡 **Interested in Contributing Code?** Simply fork and submit a pull request. Every contribution, no matter its size, is valued. 101 | 102 | - 📣 **Have Some Ideas?** We're always open to suggestions. Initiate an issue for discussions or to share your insights. 103 | 104 | All relevant details about the project can be found in this README. 105 | 106 | Your active participation 🤝 is a cornerstone of **nanoid-kotlin**. Thank you for joining us on this journey. 107 | 108 | ## 🖥️ Authors 109 | 110 | * **Patrick Bösch** - *Initial work* - [itsmefox](https://github.com/itsmefox) 111 | * **Nikola Stanković** - *Initial work* - [nik-sta](https://github.com/nik-sta) 112 | 113 | See also the list of [contributors](https://github.com/viascom/nanoid-kotlin/contributors) who participated in this 114 | project. 💕 115 | 116 | ## License 117 | 118 | This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. 119 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 2 | 3 | plugins { 4 | id "idea" 5 | id "java-library" 6 | id "maven-publish" 7 | id "signing" 8 | id "org.jetbrains.kotlin.jvm" version "1.9.23" 9 | } 10 | 11 | ext { 12 | major = 1 13 | minor = 0 14 | patch = 1 15 | 16 | isCiServer = System.getenv("GITHUB_ACTIONS") != null || System.getProperty("GITHUB_ACTIONS") != null 17 | } 18 | 19 | group "io.viascom.nanoid" 20 | version = "${major}.${minor}.${patch}${isCiServer ? "" : "-SNAPSHOT"}" 21 | project.logger.lifecycle("Version of this build: ${version}") 22 | 23 | jar { 24 | archiveClassifier.set("") 25 | 26 | manifest { 27 | attributes "Implementation-Version": "${project.version}" 28 | } 29 | 30 | duplicatesStrategy = DuplicatesStrategy.INCLUDE 31 | } 32 | 33 | java { 34 | withSourcesJar() 35 | withJavadocJar() 36 | toolchain { 37 | languageVersion.set(JavaLanguageVersion.of(17)) 38 | } 39 | } 40 | 41 | repositories { 42 | mavenCentral() 43 | } 44 | 45 | dependencies { 46 | //====== Kotlin ====== 47 | implementation "org.jetbrains.kotlin:kotlin-stdlib" 48 | } 49 | 50 | tasks.withType(KotlinCompile).configureEach { 51 | kotlinOptions.jvmTarget = JavaVersion.VERSION_17 52 | kotlinOptions.freeCompilerArgs = ["-Xjvm-default=all"] 53 | } 54 | 55 | publishing { 56 | repositories { 57 | maven { 58 | def releaseRepo = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" 59 | def snapshotRepo = "https://s01.oss.sonatype.org/content/repositories/snapshots/" 60 | 61 | name = "OSSRH" 62 | url = isCiServer ? releaseRepo : snapshotRepo 63 | 64 | credentials { 65 | username = findProperty("ossrhUsername") ?: System.getenv("OSSRH_USERNAME") 66 | password = findProperty("ossrhPassword") ?: System.getenv("OSSRH_PASSWORD") 67 | } 68 | } 69 | } 70 | 71 | publications { 72 | mavenJava(MavenPublication) { 73 | from components.java 74 | 75 | pom { 76 | groupId = "io.viascom.nanoid" 77 | name = "nanoid" 78 | description = "." 79 | url = "https://github.com/viascom/nanoid-kotlin" 80 | packaging = "jar" 81 | 82 | licenses { 83 | license { 84 | name = 'Apache-2.0 license' 85 | url = 'https://www.apache.org/licenses/LICENSE-2.0' 86 | } 87 | } 88 | 89 | scm { 90 | url = "https://github.com/viascom/nanoid-kotlin" 91 | connection = "scm:git://github.com/viascom/nanoid-kotlin.git" 92 | developerConnection = "scm:git://github.com/viascom/nanoid-kotlin.git" 93 | } 94 | 95 | developers { 96 | developer { 97 | id = "itsmefox" 98 | name = "Patrick Bösch" 99 | email = "patrick.boesch@viascom.email" 100 | organizationUrl = "https://viascom.io/" 101 | } 102 | developer { 103 | id = "nik-sta" 104 | name = "Nikola Stankovic" 105 | email = "nikola.stankovic@viascom.email" 106 | organizationUrl = "https://viascom.io/" 107 | } 108 | } 109 | } 110 | } 111 | } 112 | } 113 | 114 | signing { 115 | sign publishing.publications.mavenJava 116 | } 117 | 118 | tasks.withType(Sign).configureEach { 119 | onlyIf { isCiServer } 120 | } 121 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/viascom/nanoid-kotlin/0a9fe0e85aa029fd4c29d6c13265f7d6b128ef8e/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionSha256Sum=544c35d6bd849ae8a5ed0bcea39ba677dc40f49df7d1835561582da2009b961d 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip 5 | networkTimeout=10000 6 | validateDistributionUrl=true 7 | zipStoreBase=GRADLE_USER_HOME 8 | zipStorePath=wrapper/dists 9 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 1>&2 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 48 | echo. 1>&2 49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 50 | echo location of your Java installation. 1>&2 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 1>&2 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 62 | echo. 1>&2 63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 64 | echo location of your Java installation. 1>&2 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "nanoid" 2 | -------------------------------------------------------------------------------- /src/main/kotlin/io/viascom/nanoid/NanoId.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2023 Viascom Ltd liab. Co 3 | * 4 | * Licensed to the Apache Software Foundation (ASF) under one 5 | * or more contributor license agreements. See the NOTICE file 6 | * distributed with this work for additional information 7 | * regarding copyright ownership. The ASF licenses this file 8 | * to you under the Apache License, Version 2.0 (the 9 | * "License"); you may not use this file except in compliance 10 | * with the License. You may obtain a copy of the License at 11 | * 12 | * http://www.apache.org/licenses/LICENSE-2.0 13 | * 14 | * Unless required by applicable law or agreed to in writing, 15 | * software distributed under the License is distributed on an 16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 | * KIND, either express or implied. See the License for the 18 | * specific language governing permissions and limitations 19 | * under the License. 20 | */ 21 | 22 | package io.viascom.nanoid 23 | 24 | import org.jetbrains.annotations.NotNull 25 | import java.security.SecureRandom 26 | import java.util.* 27 | import kotlin.math.abs 28 | import kotlin.math.ceil 29 | 30 | /** 31 | * NanoId is a utility object providing functions for generating secure, URL-friendly, unique identifiers. 32 | * 33 | * The object offers methods for generating random strings with adjustable parameters like size, alphabet, 34 | * overhead factor, and a custom random number generator. 35 | * 36 | * Example usage: 37 | * ``` 38 | * val id = NanoId.generate() 39 | * ``` 40 | */ 41 | object NanoId { 42 | 43 | /** 44 | * Generates a random string based on specified or default parameters. 45 | * 46 | * @param size The desired length of the generated string. Default is 21. 47 | * @param alphabet The set of characters to choose from for generating the string. Default includes alphanumeric characters along with "_" and "-". 48 | * @param additionalBytesFactor The additional bytes factor used for calculating the step size. Default is 1.6. 49 | * @param random The random number generator to use. Default is `SecureRandom`. 50 | * @return The generated random string. 51 | * @throws IllegalArgumentException if the alphabet is empty or larger than 255 characters, or if the size is not greater than zero. 52 | */ 53 | @JvmOverloads 54 | @JvmStatic 55 | fun generate( 56 | @NotNull 57 | size: Int = 21, 58 | @NotNull 59 | alphabet: String = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", 60 | @NotNull 61 | additionalBytesFactor: Double = 1.6, 62 | @NotNull 63 | random: Random = SecureRandom() 64 | ): String { 65 | require(!(alphabet.isEmpty() || alphabet.length >= 256)) { "alphabet must contain between 1 and 255 symbols." } 66 | require(size > 0) { "size must be greater than zero." } 67 | require(additionalBytesFactor >= 1) { "additionalBytesFactor must be greater or equal 1." } 68 | 69 | val mask = calculateMask(alphabet) 70 | val step = calculateStep(size, alphabet, additionalBytesFactor) 71 | 72 | return generateOptimized(size, alphabet, mask, step, random) 73 | } 74 | 75 | /** 76 | * Generates an optimized random string of a specified size using the given alphabet, mask, and step. 77 | * Optionally, you can specify a custom random number generator. This optimized version is designed for 78 | * higher performance and lower memory overhead. 79 | * 80 | * @param size The desired length of the generated string. 81 | * @param alphabet The set of characters to choose from for generating the string. 82 | * @param mask The mask used for mapping random bytes to alphabet indices. Should be `(2^n) - 1` where `n` is a power of 2 less than or equal to the alphabet size. 83 | * @param step The number of random bytes to generate in each iteration. A larger value may speed up the function but increase memory usage. 84 | * @param random The random number generator. Default is `SecureRandom`. 85 | * @return The generated optimized string. 86 | */ 87 | @JvmOverloads 88 | @JvmStatic 89 | fun generateOptimized(@NotNull size: Int, @NotNull alphabet: String, @NotNull mask: Int, @NotNull step: Int, @NotNull random: Random = SecureRandom()): String { 90 | val idBuilder = StringBuilder(size) 91 | val bytes = ByteArray(step) 92 | while (true) { 93 | random.nextBytes(bytes) 94 | for (i in 0 until step) { 95 | val alphabetIndex = bytes[i].toInt() and mask 96 | if (alphabetIndex < alphabet.length) { 97 | idBuilder.append(alphabet[alphabetIndex]) 98 | if (idBuilder.length == size) { 99 | return idBuilder.toString() 100 | } 101 | } 102 | } 103 | } 104 | } 105 | 106 | /** 107 | * Calculates the optimal additional bytes factor needed for the generation of the step size, which is used to generate random bytes in each iteration. 108 | * 109 | * @param alphabet The set of characters to use for generating the string. 110 | * @return The additional bytes factor, rounded to two decimal places. 111 | */ 112 | @JvmStatic 113 | fun calculateAdditionalBytesFactor(@NotNull alphabet: String): Double { 114 | val mask = calculateMask(alphabet) 115 | return (1 + abs((mask - alphabet.length.toDouble()) / alphabet.length)).round(2) 116 | } 117 | 118 | /** 119 | * Calculates the mask used to map random bytes to indices in the alphabet. 120 | * 121 | * @param alphabet The set of characters to use for generating the string. 122 | * @return The calculated mask value. 123 | */ 124 | @JvmStatic 125 | fun calculateMask(@NotNull alphabet: String) = (2 shl (Integer.SIZE - 1 - Integer.numberOfLeadingZeros(alphabet.length - 1))) - 1 126 | 127 | /** 128 | * Calculates the number of random bytes to generate in each iteration for a given size and alphabet. 129 | * 130 | * @param size The length of the generated string. 131 | * @param alphabet The set of characters to use for generating the string. 132 | * @param additionalBytesFactor The additional bytes factor. Default value is calculated using `calculateAdditionalBytesFactor()`. 133 | * @return The number of random bytes to generate in each iteration. 134 | */ 135 | @JvmStatic 136 | @JvmOverloads 137 | fun calculateStep(@NotNull size: Int, @NotNull alphabet: String, @NotNull additionalBytesFactor: Double = calculateAdditionalBytesFactor(alphabet)) = 138 | ceil(additionalBytesFactor * calculateMask(alphabet) * size / alphabet.length).toInt() 139 | 140 | @JvmSynthetic 141 | internal fun Double.round(decimals: Int): Double { 142 | var multiplier = 1.0 143 | repeat(decimals) { multiplier *= 10 } 144 | return kotlin.math.round(this * multiplier) / multiplier 145 | } 146 | } 147 | --------------------------------------------------------------------------------