From 014ab7c022b9696b984d7e22543f5296faa94f81 Mon Sep 17 00:00:00 2001 From: Mayank Date: Mon, 17 Jun 2024 15:15:23 +0530 Subject: [PATCH 01/27] Clean up --- .changeset/README.md | 8 - .changeset/config.json | 11 - .deepsource.toml | 22 - .github/FUNDING.yml | 14 - .github/ISSUE_TEMPLATE/bug_report.md | 40 - .github/ISSUE_TEMPLATE/feature_request.md | 19 - .github/workflows/docs.yml | 45 - .github/workflows/publish.yml | 76 - .github/workflows/test.yml | 34 - .gitignore | 39 - .npmrc | 1 - .prettierignore | 5 - .prettierrc | 9 - .tkb | 29 - .vscode/extensions.json | 3 - .vscode/settings.json | 32 - CODE_OF_CONDUCT.md | 53 - LICENSE | 373 ----- README.md | 75 - SECURITY.md | 23 - contributing.md | 107 -- docs/assets/highlight.css | 120 -- docs/assets/icons.js | 15 - docs/assets/icons.svg | 1 - docs/assets/main.js | 59 - docs/assets/navigation.js | 1 - docs/assets/search.js | 1 - docs/assets/style.css | 1412 ----------------- docs/functions/index.index.html | 12 - docs/functions/plugins_persist.persist.html | 3 - docs/functions/utils.createHook.html | 2 - docs/functions/utils.createSetter.html | 2 - docs/functions/utils.createSubcriber.html | 2 - docs/functions/utils.initWithPlugins.html | 2 - docs/functions/utils.useRGSWithPlugins.html | 14 - docs/functions/with_plugins.create.html | 10 - docs/functions/with_plugins.withPlugins.html | 4 - docs/index.html | 33 - .../plugins_persist.PersistOptions.html | 7 - docs/md-docs/1.getting-started.md | 94 -- docs/md-docs/2.leveraging-plugins.md | 64 - docs/md-docs/3.creating-plugins.md | 1 - docs/modules/Guides.html | 3 - docs/modules/index.html | 5 - docs/modules/plugins.html | 3 - docs/modules/plugins_persist.html | 3 - docs/modules/utils._internal_.html | 6 - docs/modules/utils.html | 12 - docs/modules/with_plugins.html | 4 - docs/types/utils.Plugin.html | 1 - docs/types/utils.SetStateAction.html | 1 - docs/types/utils.SetterArgType.html | 1 - docs/types/utils.ValueType.html | 1 - docs/types/utils._internal_.Listener.html | 1 - docs/types/utils._internal_.Mutate.html | 1 - docs/types/utils._internal_.RGS.html | 1 - docs/types/utils._internal_.Record.html | 2 - docs/types/utils._internal_.Subscriber.html | 1 - docs/variables/Guides.A_Quick_Start.html | 24 - .../Guides.B_Leveraging_Plugins.html | 21 - docs/variables/utils.globalRGS.html | 1 - examples/nextjs/.eslintrc.js | 3 - examples/nextjs/.gitignore | 34 - examples/nextjs/CHANGELOG.md | 171 -- examples/nextjs/README.md | 28 - examples/nextjs/app/favicon.ico | Bin 1150 -> 0 bytes examples/nextjs/app/layout.tsx | 16 - examples/nextjs/app/page.tsx | 3 - examples/nextjs/cache/config.json | 6 - examples/nextjs/next-env.d.ts | 5 - examples/nextjs/next.config.js | 4 - examples/nextjs/package.json | 30 - examples/nextjs/tsconfig.json | 8 - examples/remix/.eslintrc.cjs | 4 - examples/remix/.gitignore | 1 - examples/remix/CHANGELOG.md | 142 -- examples/remix/app/root.tsx | 29 - examples/remix/app/routes/_index.tsx | 3 - examples/remix/package.json | 37 - examples/remix/remix.config.js | 9 - examples/remix/remix.env.d.ts | 2 - examples/remix/tsconfig.json | 22 - examples/vite/.eslintrc.cjs | 15 - examples/vite/.gitignore | 37 - examples/vite/CHANGELOG.md | 170 -- examples/vite/README.md | 25 - examples/vite/index.html | 13 - examples/vite/package.json | 32 - examples/vite/public/vite.svg | 1 - examples/vite/src/App.tsx | 5 - examples/vite/src/main.tsx | 15 - examples/vite/src/vite-env.d.ts | 1 - examples/vite/tsconfig.json | 24 - examples/vite/tsconfig.node.json | 10 - examples/vite/vite.config.ts | 7 - lib/r18gs/.eslintrc.js | 3 - lib/r18gs/.gitignore | 2 - lib/r18gs/CHANGELOG.md | 110 -- lib/r18gs/README.md | 75 - lib/r18gs/package.json | 81 - lib/r18gs/src/Guides.ts | 155 -- lib/r18gs/src/index.ts | 35 - lib/r18gs/src/plugins/index.ts | 1 - lib/r18gs/src/plugins/persist.ts | 65 - lib/r18gs/src/utils.ts | 138 -- lib/r18gs/src/with-plugins.ts | 58 - lib/r18gs/tests/create.test.tsx | 89 -- lib/r18gs/tests/plugins/persist.test.tsx | 79 - lib/r18gs/tests/use-rgs.test.tsx | 37 - lib/r18gs/tsconfig-build.json | 10 - lib/r18gs/tsconfig.json | 5 - lib/r18gs/tsup.config.ts | 45 - lib/r18gs/typedoc.config.js | 21 - lib/r18gs/vitest.config.ts | 18 - md-docs/1.getting-started.md | 94 -- md-docs/2.leveraging-plugins.md | 64 - md-docs/3.creating-plugins.md | 1 - package.json | 20 - packages/eslint-config-custom/CHANGELOG.md | 7 - packages/eslint-config-custom/README.md | 3 - packages/eslint-config-custom/library.js | 33 - packages/eslint-config-custom/next.js | 43 - packages/eslint-config-custom/package.json | 10 - .../eslint-config-custom/react-internal.js | 40 - packages/shared-ui/.eslintrc.js | 3 - .../shared-ui/hooks/use-persistant-counter.ts | 4 - packages/shared-ui/index.ts | 1 - packages/shared-ui/package.json | 28 - packages/shared-ui/src/cards/card.tsx | 18 - packages/shared-ui/src/cards/cards.module.css | 75 - packages/shared-ui/src/cards/index.tsx | 27 - packages/shared-ui/src/cards/star-me-card.tsx | 13 - packages/shared-ui/src/common/logo.tsx | 5 - packages/shared-ui/src/common/select.tsx | 25 - .../shared-ui/src/constants/global-states.ts | 1 - packages/shared-ui/src/declaration.d.ts | 4 - packages/shared-ui/src/globals.css | 115 -- packages/shared-ui/src/index.ts | 1 - packages/shared-ui/src/root-layout.module.css | 153 -- packages/shared-ui/src/root-layout.tsx | 32 - packages/shared-ui/src/root/counter.tsx | 21 - packages/shared-ui/src/root/description.tsx | 25 - packages/shared-ui/src/root/display.tsx | 14 - packages/shared-ui/src/root/footer.tsx | 10 - packages/shared-ui/src/root/hero.tsx | 37 - .../shared-ui/src/root/persistant-counter.tsx | 27 - packages/shared-ui/tsconfig.json | 5 - packages/tsconfig/base.json | 21 - packages/tsconfig/nextjs.json | 21 - packages/tsconfig/package.json | 9 - packages/tsconfig/react-library.json | 11 - pnpm-workspace.yaml | 4 - tsconfig.json | 6 - turbo.json | 31 - 154 files changed, 5970 deletions(-) delete mode 100644 .changeset/README.md delete mode 100644 .changeset/config.json delete mode 100644 .deepsource.toml delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/workflows/docs.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .gitignore delete mode 100644 .npmrc delete mode 100644 .prettierignore delete mode 100644 .prettierrc delete mode 100644 .tkb delete mode 100644 .vscode/extensions.json delete mode 100644 .vscode/settings.json delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 LICENSE delete mode 100644 README.md delete mode 100644 SECURITY.md delete mode 100644 contributing.md delete mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/icons.js delete mode 100644 docs/assets/icons.svg delete mode 100644 docs/assets/main.js delete mode 100644 docs/assets/navigation.js delete mode 100644 docs/assets/search.js delete mode 100644 docs/assets/style.css delete mode 100644 docs/functions/index.index.html delete mode 100644 docs/functions/plugins_persist.persist.html delete mode 100644 docs/functions/utils.createHook.html delete mode 100644 docs/functions/utils.createSetter.html delete mode 100644 docs/functions/utils.createSubcriber.html delete mode 100644 docs/functions/utils.initWithPlugins.html delete mode 100644 docs/functions/utils.useRGSWithPlugins.html delete mode 100644 docs/functions/with_plugins.create.html delete mode 100644 docs/functions/with_plugins.withPlugins.html delete mode 100644 docs/index.html delete mode 100644 docs/interfaces/plugins_persist.PersistOptions.html delete mode 100644 docs/md-docs/1.getting-started.md delete mode 100644 docs/md-docs/2.leveraging-plugins.md delete mode 100644 docs/md-docs/3.creating-plugins.md delete mode 100644 docs/modules/Guides.html delete mode 100644 docs/modules/index.html delete mode 100644 docs/modules/plugins.html delete mode 100644 docs/modules/plugins_persist.html delete mode 100644 docs/modules/utils._internal_.html delete mode 100644 docs/modules/utils.html delete mode 100644 docs/modules/with_plugins.html delete mode 100644 docs/types/utils.Plugin.html delete mode 100644 docs/types/utils.SetStateAction.html delete mode 100644 docs/types/utils.SetterArgType.html delete mode 100644 docs/types/utils.ValueType.html delete mode 100644 docs/types/utils._internal_.Listener.html delete mode 100644 docs/types/utils._internal_.Mutate.html delete mode 100644 docs/types/utils._internal_.RGS.html delete mode 100644 docs/types/utils._internal_.Record.html delete mode 100644 docs/types/utils._internal_.Subscriber.html delete mode 100644 docs/variables/Guides.A_Quick_Start.html delete mode 100644 docs/variables/Guides.B_Leveraging_Plugins.html delete mode 100644 docs/variables/utils.globalRGS.html delete mode 100644 examples/nextjs/.eslintrc.js delete mode 100644 examples/nextjs/.gitignore delete mode 100644 examples/nextjs/CHANGELOG.md delete mode 100644 examples/nextjs/README.md delete mode 100644 examples/nextjs/app/favicon.ico delete mode 100644 examples/nextjs/app/layout.tsx delete mode 100644 examples/nextjs/app/page.tsx delete mode 100644 examples/nextjs/cache/config.json delete mode 100644 examples/nextjs/next-env.d.ts delete mode 100644 examples/nextjs/next.config.js delete mode 100644 examples/nextjs/package.json delete mode 100644 examples/nextjs/tsconfig.json delete mode 100644 examples/remix/.eslintrc.cjs delete mode 100644 examples/remix/.gitignore delete mode 100644 examples/remix/CHANGELOG.md delete mode 100644 examples/remix/app/root.tsx delete mode 100644 examples/remix/app/routes/_index.tsx delete mode 100644 examples/remix/package.json delete mode 100644 examples/remix/remix.config.js delete mode 100644 examples/remix/remix.env.d.ts delete mode 100644 examples/remix/tsconfig.json delete mode 100644 examples/vite/.eslintrc.cjs delete mode 100644 examples/vite/.gitignore delete mode 100644 examples/vite/CHANGELOG.md delete mode 100644 examples/vite/README.md delete mode 100644 examples/vite/index.html delete mode 100644 examples/vite/package.json delete mode 100644 examples/vite/public/vite.svg delete mode 100644 examples/vite/src/App.tsx delete mode 100644 examples/vite/src/main.tsx delete mode 100644 examples/vite/src/vite-env.d.ts delete mode 100644 examples/vite/tsconfig.json delete mode 100644 examples/vite/tsconfig.node.json delete mode 100644 examples/vite/vite.config.ts delete mode 100644 lib/r18gs/.eslintrc.js delete mode 100644 lib/r18gs/.gitignore delete mode 100644 lib/r18gs/CHANGELOG.md delete mode 100644 lib/r18gs/README.md delete mode 100644 lib/r18gs/package.json delete mode 100644 lib/r18gs/src/Guides.ts delete mode 100644 lib/r18gs/src/index.ts delete mode 100644 lib/r18gs/src/plugins/index.ts delete mode 100644 lib/r18gs/src/plugins/persist.ts delete mode 100644 lib/r18gs/src/utils.ts delete mode 100644 lib/r18gs/src/with-plugins.ts delete mode 100644 lib/r18gs/tests/create.test.tsx delete mode 100644 lib/r18gs/tests/plugins/persist.test.tsx delete mode 100644 lib/r18gs/tests/use-rgs.test.tsx delete mode 100644 lib/r18gs/tsconfig-build.json delete mode 100644 lib/r18gs/tsconfig.json delete mode 100644 lib/r18gs/tsup.config.ts delete mode 100644 lib/r18gs/typedoc.config.js delete mode 100644 lib/r18gs/vitest.config.ts delete mode 100644 md-docs/1.getting-started.md delete mode 100644 md-docs/2.leveraging-plugins.md delete mode 100644 md-docs/3.creating-plugins.md delete mode 100644 package.json delete mode 100644 packages/eslint-config-custom/CHANGELOG.md delete mode 100644 packages/eslint-config-custom/README.md delete mode 100644 packages/eslint-config-custom/library.js delete mode 100644 packages/eslint-config-custom/next.js delete mode 100644 packages/eslint-config-custom/package.json delete mode 100644 packages/eslint-config-custom/react-internal.js delete mode 100644 packages/shared-ui/.eslintrc.js delete mode 100644 packages/shared-ui/hooks/use-persistant-counter.ts delete mode 100644 packages/shared-ui/index.ts delete mode 100644 packages/shared-ui/package.json delete mode 100644 packages/shared-ui/src/cards/card.tsx delete mode 100644 packages/shared-ui/src/cards/cards.module.css delete mode 100644 packages/shared-ui/src/cards/index.tsx delete mode 100644 packages/shared-ui/src/cards/star-me-card.tsx delete mode 100644 packages/shared-ui/src/common/logo.tsx delete mode 100644 packages/shared-ui/src/common/select.tsx delete mode 100644 packages/shared-ui/src/constants/global-states.ts delete mode 100644 packages/shared-ui/src/declaration.d.ts delete mode 100644 packages/shared-ui/src/globals.css delete mode 100644 packages/shared-ui/src/index.ts delete mode 100644 packages/shared-ui/src/root-layout.module.css delete mode 100644 packages/shared-ui/src/root-layout.tsx delete mode 100644 packages/shared-ui/src/root/counter.tsx delete mode 100644 packages/shared-ui/src/root/description.tsx delete mode 100644 packages/shared-ui/src/root/display.tsx delete mode 100644 packages/shared-ui/src/root/footer.tsx delete mode 100644 packages/shared-ui/src/root/hero.tsx delete mode 100644 packages/shared-ui/src/root/persistant-counter.tsx delete mode 100644 packages/shared-ui/tsconfig.json delete mode 100644 packages/tsconfig/base.json delete mode 100644 packages/tsconfig/nextjs.json delete mode 100644 packages/tsconfig/package.json delete mode 100644 packages/tsconfig/react-library.json delete mode 100644 pnpm-workspace.yaml delete mode 100644 tsconfig.json delete mode 100644 turbo.json diff --git a/.changeset/README.md b/.changeset/README.md deleted file mode 100644 index e5b6d8d6..00000000 --- a/.changeset/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Changesets - -Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works -with multi-package repos, or single-package repos to help you version and publish your code. You can -find the full documentation for it [in our repository](https://github.com/changesets/changesets) - -We have a quick list of common questions to get you started engaging with this project in -[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) diff --git a/.changeset/config.json b/.changeset/config.json deleted file mode 100644 index ab848d1a..00000000 --- a/.changeset/config.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json", - "changelog": "@changesets/cli/changelog", - "commit": false, - "fixed": [], - "linked": [], - "access": "restricted", - "baseBranch": "main", - "updateInternalDependencies": "patch", - "ignore": [] -} diff --git a/.deepsource.toml b/.deepsource.toml deleted file mode 100644 index 0af08500..00000000 --- a/.deepsource.toml +++ /dev/null @@ -1,22 +0,0 @@ -version = 1 - -test_patterns = [ - "test/**/*.*", - "**/*.test.*" -] - -exclude_patterns = ["docs/**"] - -[[analyzers]] -name = "javascript" - - [analyzers.meta] - plugins = ["react"] - environment = [ - "nodejs", - "vitest", - "browser" - ] - -[[transformers]] -name = "prettier" \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 95f5d426..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,14 +0,0 @@ -# These are supported funding model platforms - -github: [mayank1513] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] -polar: mayank1513 -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry -custom: [https://pages.razorpay.com/mayank1513] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9b77ea71..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: "" -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] - -**Smartphone (please complete the following information):** - -- Device: [e.g. iPhone6] -- OS: [e.g. iOS8.1] -- Browser [e.g. stock browser, safari] -- Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2bc5d5f7..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "" -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 8c2a6b39..00000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Update dependencies and Docs - -on: - push: - branches: [main] - schedule: - - cron: "0 */8 * * *" -jobs: - generate-docs: - if: github.event.repository.owner.login == 'react18-tools' - runs-on: ubuntu-latest - permissions: - packages: write - contents: write - steps: - - uses: actions/checkout@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - - uses: actions/setup-node@v4 - with: - registry-url: https://registry.npmjs.org - node-version: 20 - - run: npm i -g pnpm && pnpm i - name: Install dependencies - - name: Test - run: npm test - - run: git status && git clean -f -d && git status - name: clean up working directory - - run: npx @turbo/codemod update . && pnpm update --latest -w - name: Update dependencies - - run: pnpm build - name: Build all apps to make sure it is not broken due to dependency upgrades - - name: Run unit tests - run: pnpm test - - name: Generate/update docs - run: pnpm doc - - name: Setup Git - run: | - git config --global user.name "react18-tools" - git config --global user.email "mayank.srmu@gmail.com" - git fetch - git checkout main - - name: Save upgraded packages back to repo - run: git add . && git commit -m "upgrade deps && docs" && git push origin main diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index 07973245..00000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: Publish to NPM - -# publish only when package json has changed - assuming version upgrade -on: - workflow_dispatch: - push: - branches: [main] - paths: "lib/r18gs/package.json" - -jobs: - publish: - # Don't run just after creating repo from template - # Also avoid running after merging set-up PR - if: github.event.repository.owner.login == 'react18-tools' - runs-on: ubuntu-latest - permissions: - packages: write - contents: write - id-token: write - - defaults: - run: - working-directory: ./lib/r18gs - - steps: - - uses: actions/checkout@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - - uses: actions/setup-node@v4 - with: - node-version: 20 - registry-url: https://registry.npmjs.org - - run: npm i -g pnpm && pnpm i - name: Install dependencies - # fail and not publish if any of the unit tests are failing - - name: Test - run: pnpm test - - name: publish to NPM - run: pnpm build && pnpm publish-package - continue-on-error: true - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} - TOKEN: ${{ secrets.GITHUB_TOKEN }} - OWNER: ${{ github.event.repository.owner.login }} - REPO: ${{ github.event.repository.name }} - - - name: Create GitHub release - run: | - v=$(node -p -e "require('./package.json').version") - gh release create $v --generate-notes --latest -n "$(sed '1,/^## /d;/^## /,$d' CHANGELOG.md)" --title "Release $v" - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: Publish canonical packages - continue-on-error: true - run: | - sed -i -e "s/.*name.*/\t\"name\": \"@mayank1513\/r18gs\",/" package.json - npm publish --provenance --access public - sed -i -e "s/.*name.*/\t\"name\": \"react18-global-store\",/" package.json - npm publish --provenance --access public - sed -i -e "s/.*name.*/\t\"name\": \"react18-store\",/" package.json - npm publish --provenance --access public - sed -i -e "s/.*name.*/\t\"name\": \"react19-global-store\",/" package.json - npm publish --provenance --access public - sed -i -e "s/.*name.*/\t\"name\": \"react19-store\",/" package.json - npm publish --provenance --access public - sed -i -e "s/.*name.*/\t\"name\": \"r19gs\",/" package.json - npm publish --provenance --access public - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} - - - name: Mark scoped package as deprecated - run: npm deprecate @mayank1513/r18gs "Please use https://www.npmjs.com/package/r18gs instead. We initially created scoped packages to have similarities with the GitHub Public Repository (which requires packages to be scoped). We are no longer using GPR and thus deprecating all scoped packages for which corresponding un-scoped packages exist." - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml deleted file mode 100644 index 15e4a2ba..00000000 --- a/.github/workflows/test.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: test - -on: - push: - pull_request: - schedule: - - cron: "5 */8 * * *" -jobs: - test: - runs-on: ubuntu-latest - permissions: - contents: write - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - with: - node-version: 20 - - run: npm i -g pnpm && pnpm i - name: Install dependencies - - name: Run unit tests - run: pnpm test - - name: Upload coverage reports to Codecov - continue-on-error: true - uses: codecov/codecov-action@v4 - with: - directory: ./lib/r18gs - token: ${{ secrets.CODECOV_TOKEN }} - flags: r18gs - - uses: paambaati/codeclimate-action@v5.0.0 - continue-on-error: true - env: - CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }} - with: - coverageLocations: ./lib/r18gs/coverage/*.xml:clover diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 3e6eed46..00000000 --- a/.gitignore +++ /dev/null @@ -1,39 +0,0 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - -# dependencies -node_modules -.pnp -.pnp.js - -# testing -coverage - -# next.js -.next/ -out/ -build - -# misc -.DS_Store -*.pem - -# debug -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# local env files -.env -.env.local -.env.development.local -.env.test.local -.env.production.local - -# turbo -.turbo - -# vercel -.vercel - -# lock files -*lock* diff --git a/.npmrc b/.npmrc deleted file mode 100644 index ded82e2f..00000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -auto-install-peers = true diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index a8d4ec13..00000000 --- a/.prettierignore +++ /dev/null @@ -1,5 +0,0 @@ -*lock.* - -# ignore hbs files as prettier removes all spaces and makes it ugly -*hbs -docs diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index 25fc6e9d..00000000 --- a/.prettierrc +++ /dev/null @@ -1,9 +0,0 @@ -{ - "singleQuote": false, - "printWidth": 100, - "tabWidth": 2, - "arrowParens": "avoid", - "jsxBracketSameLine": true, - "bracketSameLine": true, - "useTabs": true -} diff --git a/.tkb b/.tkb deleted file mode 100644 index 15ff7bec..00000000 --- a/.tkb +++ /dev/null @@ -1,29 +0,0 @@ -{ - "scope": "Workspace", - "tasks": { - "task-oQKhoVOKYhYaRYGvlDMj5": { - "id": "task-oQKhoVOKYhYaRYGvlDMj5", - "description": "Add support for persist and sync", - "columnId": "column-todo" - } - }, - "columns": [ - { - "id": "column-todo", - "title": "To do", - "tasksIds": [ - "task-oQKhoVOKYhYaRYGvlDMj5" - ] - }, - { - "id": "column-doing", - "title": "Doing", - "tasksIds": [] - }, - { - "id": "column-done", - "title": "Done", - "tasksIds": [] - } - ] -} \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 6315e5c1..00000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "recommendations": ["esbenp.prettier-vscode", "mayank1513.trello-kanban-task-board"] -} diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 20d656cd..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - // Formatting using Prettier by default for all languages - "editor.defaultFormatter": "esbenp.prettier-vscode", - // Formatting using Prettier for JavaScript, overrides VSCode default. - "[javascript]": { - "editor.defaultFormatter": "esbenp.prettier-vscode" - }, - - // Ensure enough terminal history is preserved when running tests. - "terminal.integrated.scrollback": 10000, - - // Configure todo-tree to exclude node_modules, dist, and compiled. - "todo-tree.filtering.excludeGlobs": ["**/node_modules", "**/dist", "**/compiled"], - // Match TODO-APP in addition to other TODOs. - "todo-tree.general.tags": ["BUG", "HACK", "FIXME", "TODO", "XXX", "[ ]", "[x]", "TODO-APP"], - - // Disable TypeScript surveys. - "typescript.surveys.enabled": false, - - "grammarly.selectors": [ - { - "language": "markdown", - "scheme": "file" - } - ], - "editor.tabSize": 2, - "editor.wordWrap": "on", - "editor.formatOnSave": true, - "editor.formatOnPaste": true, - "editor.formatOnSaveMode": "file", - "mayank1513.trello-kanban.Workspace.filePath": ".tkb" -} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 3b68e0fa..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,53 +0,0 @@ -## Code of Conduct - -### Our Pledge - -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. - -### Our Standards - -Examples of behavior that contributes to a positive environment for our community include: - -- Demonstrating empathy and kindness toward other people -- Being respectful of differing opinions, viewpoints, and experiences -- Giving and gracefully accepting constructive feedback -- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -- Focusing on what is best not just for us as individuals, but for the overall community - -Examples of unacceptable behavior include: - -- The use of sexualized language or imagery, and sexual attention or advances of any kind -- Trolling, insulting or derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others’ private information, such as a physical or email address, without their explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting - -### Enforcement Responsibilities - -Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. - -### Scope - -This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. - -### Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team responsible for enforcement at [coc@example.com](mailto:coc@example.com). All complaints will be reviewed and investigated promptly and fairly. - -All project maintainers are obligated to respect the privacy and security of the reporter of any incident. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -### Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, -available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/][version] - -[homepage]: http://contributor-covenant.org -[version]: https://www.contributor-covenant.org/version/2/1 diff --git a/LICENSE b/LICENSE deleted file mode 100644 index a612ad98..00000000 --- a/LICENSE +++ /dev/null @@ -1,373 +0,0 @@ -Mozilla Public License Version 2.0 -================================== - -1. Definitions --------------- - -1.1. "Contributor" - means each individual or legal entity that creates, contributes to - the creation of, or owns Covered Software. - -1.2. "Contributor Version" - means the combination of the Contributions of others (if any) used - by a Contributor and that particular Contributor's Contribution. - -1.3. "Contribution" - means Covered Software of a particular Contributor. - -1.4. "Covered Software" - means Source Code Form to which the initial Contributor has attached - the notice in Exhibit A, the Executable Form of such Source Code - Form, and Modifications of such Source Code Form, in each case - including portions thereof. - -1.5. "Incompatible With Secondary Licenses" - means - - (a) that the initial Contributor has attached the notice described - in Exhibit B to the Covered Software; or - - (b) that the Covered Software was made available under the terms of - version 1.1 or earlier of the License, but not also under the - terms of a Secondary License. - -1.6. "Executable Form" - means any form of the work other than Source Code Form. - -1.7. "Larger Work" - means a work that combines Covered Software with other material, in - a separate file or files, that is not Covered Software. - -1.8. "License" - means this document. - -1.9. "Licensable" - means having the right to grant, to the maximum extent possible, - whether at the time of the initial grant or subsequently, any and - all of the rights conveyed by this License. - -1.10. "Modifications" - means any of the following: - - (a) any file in Source Code Form that results from an addition to, - deletion from, or modification of the contents of Covered - Software; or - - (b) any new file in Source Code Form that contains any Covered - Software. - -1.11. "Patent Claims" of a Contributor - means any patent claim(s), including without limitation, method, - process, and apparatus claims, in any patent Licensable by such - Contributor that would be infringed, but for the grant of the - License, by the making, using, selling, offering for sale, having - made, import, or transfer of either its Contributions or its - Contributor Version. - -1.12. "Secondary License" - means either the GNU General Public License, Version 2.0, the GNU - Lesser General Public License, Version 2.1, the GNU Affero General - Public License, Version 3.0, or any later versions of those - licenses. - -1.13. "Source Code Form" - means the form of the work preferred for making modifications. - -1.14. "You" (or "Your") - means an individual or a legal entity exercising rights under this - License. For legal entities, "You" includes any entity that - controls, is controlled by, or is under common control with You. For - purposes of this definition, "control" means (a) the power, direct - or indirect, to cause the direction or management of such entity, - whether by contract or otherwise, or (b) ownership of more than - fifty percent (50%) of the outstanding shares or beneficial - ownership of such entity. - -2. License Grants and Conditions --------------------------------- - -2.1. Grants - -Each Contributor hereby grants You a world-wide, royalty-free, -non-exclusive license: - -(a) under intellectual property rights (other than patent or trademark) - Licensable by such Contributor to use, reproduce, make available, - modify, display, perform, distribute, and otherwise exploit its - Contributions, either on an unmodified basis, with Modifications, or - as part of a Larger Work; and - -(b) under Patent Claims of such Contributor to make, use, sell, offer - for sale, have made, import, and otherwise transfer either its - Contributions or its Contributor Version. - -2.2. Effective Date - -The licenses granted in Section 2.1 with respect to any Contribution -become effective for each Contribution on the date the Contributor first -distributes such Contribution. - -2.3. Limitations on Grant Scope - -The licenses granted in this Section 2 are the only rights granted under -this License. No additional rights or licenses will be implied from the -distribution or licensing of Covered Software under this License. -Notwithstanding Section 2.1(b) above, no patent license is granted by a -Contributor: - -(a) for any code that a Contributor has removed from Covered Software; - or - -(b) for infringements caused by: (i) Your and any other third party's - modifications of Covered Software, or (ii) the combination of its - Contributions with other software (except as part of its Contributor - Version); or - -(c) under Patent Claims infringed by Covered Software in the absence of - its Contributions. - -This License does not grant any rights in the trademarks, service marks, -or logos of any Contributor (except as may be necessary to comply with -the notice requirements in Section 3.4). - -2.4. Subsequent Licenses - -No Contributor makes additional grants as a result of Your choice to -distribute the Covered Software under a subsequent version of this -License (see Section 10.2) or under the terms of a Secondary License (if -permitted under the terms of Section 3.3). - -2.5. Representation - -Each Contributor represents that the Contributor believes its -Contributions are its original creation(s) or it has sufficient rights -to grant the rights to its Contributions conveyed by this License. - -2.6. Fair Use - -This License is not intended to limit any rights You have under -applicable copyright doctrines of fair use, fair dealing, or other -equivalents. - -2.7. Conditions - -Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted -in Section 2.1. - -3. Responsibilities -------------------- - -3.1. Distribution of Source Form - -All distribution of Covered Software in Source Code Form, including any -Modifications that You create or to which You contribute, must be under -the terms of this License. You must inform recipients that the Source -Code Form of the Covered Software is governed by the terms of this -License, and how they can obtain a copy of this License. You may not -attempt to alter or restrict the recipients' rights in the Source Code -Form. - -3.2. Distribution of Executable Form - -If You distribute Covered Software in Executable Form then: - -(a) such Covered Software must also be made available in Source Code - Form, as described in Section 3.1, and You must inform recipients of - the Executable Form how they can obtain a copy of such Source Code - Form by reasonable means in a timely manner, at a charge no more - than the cost of distribution to the recipient; and - -(b) You may distribute such Executable Form under the terms of this - License, or sublicense it under different terms, provided that the - license for the Executable Form does not attempt to limit or alter - the recipients' rights in the Source Code Form under this License. - -3.3. Distribution of a Larger Work - -You may create and distribute a Larger Work under terms of Your choice, -provided that You also comply with the requirements of this License for -the Covered Software. If the Larger Work is a combination of Covered -Software with a work governed by one or more Secondary Licenses, and the -Covered Software is not Incompatible With Secondary Licenses, this -License permits You to additionally distribute such Covered Software -under the terms of such Secondary License(s), so that the recipient of -the Larger Work may, at their option, further distribute the Covered -Software under the terms of either this License or such Secondary -License(s). - -3.4. Notices - -You may not remove or alter the substance of any license notices -(including copyright notices, patent notices, disclaimers of warranty, -or limitations of liability) contained within the Source Code Form of -the Covered Software, except that You may alter any license notices to -the extent required to remedy known factual inaccuracies. - -3.5. Application of Additional Terms - -You may choose to offer, and to charge a fee for, warranty, support, -indemnity or liability obligations to one or more recipients of Covered -Software. However, You may do so only on Your own behalf, and not on -behalf of any Contributor. You must make it absolutely clear that any -such warranty, support, indemnity, or liability obligation is offered by -You alone, and You hereby agree to indemnify every Contributor for any -liability incurred by such Contributor as a result of warranty, support, -indemnity or liability terms You offer. You may include additional -disclaimers of warranty and limitations of liability specific to any -jurisdiction. - -4. Inability to Comply Due to Statute or Regulation ---------------------------------------------------- - -If it is impossible for You to comply with any of the terms of this -License with respect to some or all of the Covered Software due to -statute, judicial order, or regulation then You must: (a) comply with -the terms of this License to the maximum extent possible; and (b) -describe the limitations and the code they affect. Such description must -be placed in a text file included with all distributions of the Covered -Software under this License. Except to the extent prohibited by statute -or regulation, such description must be sufficiently detailed for a -recipient of ordinary skill to be able to understand it. - -5. Termination --------------- - -5.1. The rights granted under this License will terminate automatically -if You fail to comply with any of its terms. However, if You become -compliant, then the rights granted under this License from a particular -Contributor are reinstated (a) provisionally, unless and until such -Contributor explicitly and finally terminates Your grants, and (b) on an -ongoing basis, if such Contributor fails to notify You of the -non-compliance by some reasonable means prior to 60 days after You have -come back into compliance. Moreover, Your grants from a particular -Contributor are reinstated on an ongoing basis if such Contributor -notifies You of the non-compliance by some reasonable means, this is the -first time You have received notice of non-compliance with this License -from such Contributor, and You become compliant prior to 30 days after -Your receipt of the notice. - -5.2. If You initiate litigation against any entity by asserting a patent -infringement claim (excluding declaratory judgment actions, -counter-claims, and cross-claims) alleging that a Contributor Version -directly or indirectly infringes any patent, then the rights granted to -You by any and all Contributors for the Covered Software under Section -2.1 of this License shall terminate. - -5.3. In the event of termination under Sections 5.1 or 5.2 above, all -end user license agreements (excluding distributors and resellers) which -have been validly granted by You or Your distributors under this License -prior to termination shall survive termination. - -************************************************************************ -* * -* 6. Disclaimer of Warranty * -* ------------------------- * -* * -* Covered Software is provided under this License on an "as is" * -* basis, without warranty of any kind, either expressed, implied, or * -* statutory, including, without limitation, warranties that the * -* Covered Software is free of defects, merchantable, fit for a * -* particular purpose or non-infringing. The entire risk as to the * -* quality and performance of the Covered Software is with You. * -* Should any Covered Software prove defective in any respect, You * -* (not any Contributor) assume the cost of any necessary servicing, * -* repair, or correction. This disclaimer of warranty constitutes an * -* essential part of this License. No use of any Covered Software is * -* authorized under this License except under this disclaimer. * -* * -************************************************************************ - -************************************************************************ -* * -* 7. Limitation of Liability * -* -------------------------- * -* * -* Under no circumstances and under no legal theory, whether tort * -* (including negligence), contract, or otherwise, shall any * -* Contributor, or anyone who distributes Covered Software as * -* permitted above, be liable to You for any direct, indirect, * -* special, incidental, or consequential damages of any character * -* including, without limitation, damages for lost profits, loss of * -* goodwill, work stoppage, computer failure or malfunction, or any * -* and all other commercial damages or losses, even if such party * -* shall have been informed of the possibility of such damages. This * -* limitation of liability shall not apply to liability for death or * -* personal injury resulting from such party's negligence to the * -* extent applicable law prohibits such limitation. Some * -* jurisdictions do not allow the exclusion or limitation of * -* incidental or consequential damages, so this exclusion and * -* limitation may not apply to You. * -* * -************************************************************************ - -8. Litigation -------------- - -Any litigation relating to this License may be brought only in the -courts of a jurisdiction where the defendant maintains its principal -place of business and such litigation shall be governed by laws of that -jurisdiction, without reference to its conflict-of-law provisions. -Nothing in this Section shall prevent a party's ability to bring -cross-claims or counter-claims. - -9. Miscellaneous ----------------- - -This License represents the complete agreement concerning the subject -matter hereof. If any provision of this License is held to be -unenforceable, such provision shall be reformed only to the extent -necessary to make it enforceable. Any law or regulation which provides -that the language of a contract shall be construed against the drafter -shall not be used to construe this License against a Contributor. - -10. Versions of the License ---------------------------- - -10.1. New Versions - -Mozilla Foundation is the license steward. Except as provided in Section -10.3, no one other than the license steward has the right to modify or -publish new versions of this License. Each version will be given a -distinguishing version number. - -10.2. Effect of New Versions - -You may distribute the Covered Software under the terms of the version -of the License under which You originally received the Covered Software, -or under the terms of any subsequent version published by the license -steward. - -10.3. Modified Versions - -If you create software not governed by this License, and you want to -create a new license for such software, you may create and use a -modified version of this License if you rename the license and remove -any references to the name of the license steward (except to note that -such modified license differs from this License). - -10.4. Distributing Source Code Form that is Incompatible With Secondary -Licenses - -If You choose to distribute Source Code Form that is Incompatible With -Secondary Licenses under the terms of this version of the License, the -notice described in Exhibit B of this License must be attached. - -Exhibit A - Source Code Form License Notice -------------------------------------------- - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - -If it is not possible or desirable to put the notice in a particular -file, then You may include the notice in a location (such as a LICENSE -file in a relevant directory) where a recipient would be likely to look -for such a notice. - -You may add additional accurate notices of copyright ownership. - -Exhibit B - "Incompatible With Secondary Licenses" Notice ---------------------------------------------------------- - - This Source Code Form is "Incompatible With Secondary Licenses", as - defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md deleted file mode 100644 index ddb13a72..00000000 --- a/README.md +++ /dev/null @@ -1,75 +0,0 @@ -# React18GlobalStore - -[![test](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/ec3140063acd8df82481/maintainability)](https://codeclimate.com/github/react18-tools/react18-global-store/maintainability) [![codecov](https://codecov.io/gh/react18-tools/react18-global-store/graph/badge.svg)](https://codecov.io/gh/react18-tools/react18-global-store) [![Version](https://img.shields.io/npm/v/r18gs.svg?colorB=green)](https://www.npmjs.com/package/r18gs) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/r18gs.svg)](https://www.npmjs.com/package/r18gs) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/r18gs) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) - -## Motivation - -I've developed fantastic libraries leveraging React18 features using Zustand, and they performed admirably. However, when attempting to import from specific folders for better tree-shaking, the libraries encountered issues. Each import resulted in a separate Zustand store being created, leading to increased package size. - -As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking. - -## Features - -✅ Full TypeScript Support - -✅ Unleash the full power of React18 Server components - -✅ Compatible with all build systems/tools/frameworks for React18 - -✅ Documented with [Typedoc](https://react18-tools.github.io/react18-global-store) ([Docs](https://react18-tools.github.io/react18-global-store)) - -✅ Examples for Next.js, Vite, and Remix - -## Simple Global State Shared Across Multiple Components - -Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components. - -```tsx -const [state, setState] = useRGS("counter", 1); -``` - -**_or_** - -```tsx -const [state, setState] = useRGS("counter", () => 1); -``` - -> For detailed instructions, see [Getting Started](./md-docs/1.getting-started.md) - -## Using Plugins - -Enhance the functionality of the store by leveraging either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`, enabling features such as storing to local storage, among others. - -```tsx -// store.ts -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */ - -export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]); -``` - -Now, you can utilize `useMyPersistentCounterStore` similarly to `useState` without specifying an initial value. - -```tsx -const [persistedCount, setPersistedCount] = useMyPersistentCounterStore(); -``` - -> For detailed instructions, see [Leveraging Plugins](./md-docs/2.leveraging-plugins.md) - -## Contributing - -See [contributing.md](/contributing.md) - -### 🤩 Don't forget to star [this repo](https://github.com/mayank1513/react18-global-store)! - -Interested in hands-on courses for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE) - -![Repo Stats](https://repobeats.axiom.co/api/embed/ec3e74d795ed805a0fce67c0b64c3f08872e7945.svg "Repobeats analytics image") - -## License - -Licensed under the MPL 2.0 open source license. - -
- -

with 💖 by Mayank Kumar Chaudhari

diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index a58834a4..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,23 +0,0 @@ -# Security Policy - -## Version Support - -We provide support for the latest minor version. Pull requests aimed at fixing security vulnerabilities in the version immediately preceding the latest will be considered. Support for versions prior to this relies entirely on community-driven pull requests. - -| Version | Support Status | -| ------- | ------------------ | -| 1.1.x | :white_check_mark: | -| 1.0.x | :warning: | -| < 1.0 | :x: | - -## Patching Long-Term Support (LTS) Versions - -If you rely on a previous minor version of TypeDoc and need to address security issues, kindly submit a pull request to the `lts` branch. Upon merge, your patch will automatically trigger the publication of a new version. - -Ensure to update the version field in `package.json`. - -Note: We only accept pull requests addressing security vulnerabilities. Additional functionalities and bug fixes for older versions are beyond the scope. - -## Reporting Vulnerabilities - -Kindly report vulnerabilities [here](https://github.com/react18-tools/react18-global-store/security/advisories/new). diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 87045151..00000000 --- a/contributing.md +++ /dev/null @@ -1,107 +0,0 @@ -# Contributing to r18gs - -## Contribute - -Once you have cloned the repo. `cd` to the repo directory and use following commands. - -### Build - -To build all apps and packages, run the following command: - -```bash -pnpm build -``` - -### Develop - -To develop all apps and packages, run the following command: - -```bash -pnpm dev -``` - -### Run unit tests - -To run unit tests, run the following command: - -```bash -pnpm test -``` - -### Linting and formating - -Before creating PR make sure lint is passing and also run formatter to properly format the code. - -```bash -pnpm lint -``` - -and - -```bash -pnpm format -``` - -You can also contribute by - -1. Sponsoring -2. Check out discussion for providing any feedback or sugestions. -3. Report any issues or feature requests in issues tab - -## What's inside? - -### Utilities - -This Turborepo has some additional tools already setup for you: - -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting - -### Library, Examples and Packages - -This Turborepo includes the following packages/examples: - -#### React18 Global Store library - -You will find the core library code inside lib/r18gs - -#### Examples (/examples) - -- `nextjs`: a [Next.js](https://nextjs.org/) app -- `vite`: a [Vite.js](https://vitest.dev) app -- `remix`: a [Remix](https://remix.run/) app - -#### Packages (/packages) - -- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `tsconfig`: `tsconfig.json`s used throughout the monorepo -- `shared-ui`: An internal UI package for shared UI code - -Each package/example is 100% [TypeScript](https://www.typescriptlang.org/). - -## Automatic file generation - -- just run `yarn turbo gen` and follow the propts to auto generate your new component with test file and dependency linking -- follow best practices automatically - -## Useful Links - -Learn more about Turborepo and Next.js: - -- [React and Next.js with TypeScript](https://www.udemy.com/course/react-and-next-js-with-typescript/?referralCode=7202184A1E57C3DCA8B2) - an interactive Next.js course. -- [The Game of Chess with Next.js, React and TypeScrypt](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE) -- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) -- [Caching](https://turbo.build/repo/docs/core-concepts/caching) -- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) -- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) -- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) -- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) - -> A quick tip: Delete all stale branches `git branch --merged main | grep -v '^[ *]*main$' | xargs git branch -d` - -
- -### 🤩 Don't forger to star [this repo](https://github.com/mayank1513/react18-global-store)! - -

with 💖 by Mayank Kumar Chaudhari

diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index f544099d..00000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,120 +0,0 @@ -:root { - --light-hl-0: #0000FF; - --dark-hl-0: #569CD6; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #0070C1; - --dark-hl-2: #4FC1FF; - --light-hl-3: #795E26; - --dark-hl-3: #DCDCAA; - --light-hl-4: #267F99; - --dark-hl-4: #4EC9B0; - --light-hl-5: #A31515; - --dark-hl-5: #CE9178; - --light-hl-6: #098658; - --dark-hl-6: #B5CEA8; - --light-hl-7: #008000; - --dark-hl-7: #6A9955; - --light-hl-8: #AF00DB; - --dark-hl-8: #C586C0; - --light-hl-9: #001080; - --dark-hl-9: #9CDCFE; - --light-hl-10: #800000; - --dark-hl-10: #808080; - --light-hl-11: #800000; - --dark-hl-11: #569CD6; - --light-hl-12: #E50000; - --dark-hl-12: #9CDCFE; - --light-hl-13: #000000FF; - --dark-hl-13: #D4D4D4; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js deleted file mode 100644 index b79c9e89..00000000 --- a/docs/assets/icons.js +++ /dev/null @@ -1,15 +0,0 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } - } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg deleted file mode 100644 index 7dead611..00000000 --- a/docs/assets/icons.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index d6f13886..00000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,59 +0,0 @@ -"use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js deleted file mode 100644 index ddec113b..00000000 --- a/docs/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6XWW2+bMBQH8O/ivJKtl7RTo2lS9pI9dNoWpu2hqpCBU7DiGuRLk2rad5+Cy834wtpX+PuHzzHY3P1BEo4SrdFWkRwEilCNZYnW6LHKFQXxXl9/V8pHiiK0JyxH64sIZSWhOQeG1ncdsUl+KJLtk1hiLnvpCXOC04E1yo3ly4u/Ued9Tm7hCTguCCuS71QVhAkPa4tP9PuBT1gOx2nFzeVZBeuH+IRFF9HQ6vxmdXm2GkwiBhlLLGGTSVL5rUnUY0rgG178fK4hRI6SLtFo1YNizRxay9Ky69Wo17W5fO1kattCufoNXBAhv9XNs/3WYhJ21VbrYIDrU691kpfAm0olTAJ/wJmFHQ8xnnJ17Ztpv54map1zs7bD1VWSUMt6NJdnlfuxqYth+smlJG0imQXeEiGBAe85+VzbsDZoqGc3H86vhpvRV3X69IKcjoWw3TYOSrttHGQgq3gelpqYFYtQRrEQp7EiXxKxhKMehYbbiUpFxkk6o5t91D734Utj7p5DUt8L1e/aO4fSODNDtO2cBthHQt4vTBW4re52yClolWI6em36809bXcRzomYcsIQvVbW3ffva6TOTj96EdCtClE6FMZWaL5nDa4MekjAifxNZTv4aTNIIekglYLeNZ6GTqPdoPBBZLp3n4+lu8j+HpGeeTnNhG+Q65/Qq2KofuTrmaejB38oRdvD28v4fxirZ58cKAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index 5dd85e3d..00000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA+09247bOJb/4jxsHjSKeNMl6G6gZx96F5jFzk4Wsw+ZoKByybYQW3JLclVqgvz74vBmHkqU6fRMP81TMRLPhed+SMr5uhn6l3Hz/uPXzee2e9q8p8mmq0/N5v3ml0v71IybZHMZjpv3m1P/dDk24zv1OD1Mp+Mm2WyP9Tg24+b9ZvMtMTjYFcnPD/9zabefHz5M9TBZXM/10NaPDjY0bQF3sjnXQ9NNV7YWqf3x4U/NczPU+7bbP/z5eNm33RgmujT7TtpX0m331HyZCUs+XZVVzgModpduO7V9Z5CEUDnsKQRL3J09WRj+zsFVr2B5d26GsR2nELYH/X4dq8gt3j+r+f99luu1aNtuaoZdvV3AjCHWpeJzfeWBZPQq/fG1234n6TcaNoq+hyDIztQP9b75bo4s+G9kyrFPX+1XC/U5ChtAlF6uFneZ2uPcauXTdevKqoKIK54PzTQ1w8/D/n9fz1eZTq9niw3NWGdcMbVK7MNUT83PUjohas6U+8jlQrCr7zw8TCtL8om8sdNXaHmAKyv9a328NEGR2rf3rc+J5/tj/1gf//LLh4UgrmjYGXfK8GrV26Gpp+bD5XE7tI/NsGDdipI377fSk+Z2i5ic9Bsp/Ufff75BB6b8NpNX2XPRCtSrf5KJO8jjTFszGgi6bddOkXRSPfc2sVQz9g9ZniSrMf6B3ENfMRxYeN/9+6Hu9tFcOPN/bwEY0kYI7C4hWMYDFVg7/V87HfzS0Xcbb953e+hlbP7yy4cYirOZd/qrJfnSToc/hMpBePkQUxPOoswC4wiZmrXONGIt0lhuk3ujxzfCg0vcgOulLS77ZVVpiJmXWK39AwXg03zjPrhHFC6cu+Yre5xUnGX8Rq0174je+BPjmpoFckvV1jI9PPP7CHq5boGQnfGdBJbboaWe7c1s7mqtvUL0Rk+nqF0nfS+ZcMQLxqA3SzB3OdA1+v0g26iuPv4UaCoezISH31YQuTWrm9Ac/HFFa+qwvNJyXB5Hr34NUL3O/G7i0dk7TDauWLtSd+D/KYzYisoM6PewliJkK+r6r8vk5swAq2rW76omh+TdKtKLCq/6T+04Nd1tEzXzfteVI6J3r90u7dunRMf39183zxAu+27zfkNTllabZLNrm+MTbLcq5pLNtj+dAOcn/e6vzXbqB5ihprzLNsnHLGEiJaL49Cn5aCDkC/lATiOb5CNZmgYvaMJSUrCEJSQlPOFJluYkT4T+myck5SVPioSkWZUnpX5eJVnK8zwhWZKlVcESQuSMhFA9gzAzMDiJQUryJEuLkiSkMNClIk8q9ZdmeiolegY1eKnBSw1eavBS4DbLy4QW5onhlwJiUZGEGcyMKFKMJjRlLGFMU2IGLzN4WW4GgFdQkTCFlyes0q844OWUJpzoOdxwzJl5xROS0kwkXGgBcMBc5izhhRYoNxxzwFwQkYhMvxJSFpQmgponTIMLwCwymgiDWYAsKBeJKMwAMLMyT4RRXm4w54bnnJqBkXJupJFbkwCeGSNJbqSclwaPkUZhMBfEPDHSKAzmwmAuDOYi10oqDOai1BIrQH9VWSWl0V9J9EpLmpA0r3hSGg2W3DwRSsdlbt4UWm+lEXOpLa4yeCttFxWVFEVSadeouBZ2ZfitjF1Uht/K+oeRBMkyLVKSEfvMOklmvSSzbpJZP8k0gasvU/DlrFjyZiq9maZFXki3pURIty0KKt2VlspbGWCGRVIqXZGkRV6BK5KUUQEeR1JBS/CmLK1yDp5BUuBKmj+AM1BLVjJl9VRwZfV5xpSxyydCD6TZcqJME2KJkEZPKJgmqIUr0+ScKUMECtIQmbE24CKXIaIQyrZoCbaRpVUJpqGmSouQaqeaYWkIsChpAHKO9IZKgDZJyoRRkBRKJj2kIAnJpFVQCGuZeUaIHVE7AtFkELhklCuyIiEyzKm3uWaZyEAH4iGktM8qA0stDWppyHgn8cmAp0bcvhWGZ5rbUWHf2nVQS0PGPZA+YUZVhElvZyIhMvhJCGbXwYSFyO1bS0OZgMRcmWfcrkOaAyifcCsrbmlwuw4uDBYZCasyITISSga4XQa3JEQGrl0UCRFWVMLYChGWhLAkVEQUCRF2FcKSEJaEMFZE8kybCMktidyuIrckcksit6uQ1iplm1tJyegopZzbZRRWUjJASl4Kq/HC0iisNgprVUVunxWGrvQF9czSKK1dl3YdpV1HaS235IbnUhgspcpLIiEqYjLAYmVVWllVlkZlaVSWRsV02KmsqCpLorLqqArtrqSyJCqzDCrdE9ijGbHPjMZpxuwzbkfCjnI7KuyotCNLwzo5JUYd1Do5JZYGsTSsk1NiaRBLg5Rq4ZQYSVGa2ZFdBrUkqCVhfZxSS4JaEsbHrwmBQdSnZcKyNMtylBAYqgJ5eKJ8BX5FRJInNAUmioSmGYQPAgPwZJlTigLyArzSWQBgeKZfcWYGHNAUifRv+UAWkoRAoaMHMsTmVSJdGp4IIMWrEuob/YSZATcDg1DWNxK8MIPSDCo9OTeYS6KhZPjPwNa5eUQsfSKRZ6V0Wf2oNNiprSApMwBU1pBqRO1bZp9xOxJqdNWGkHkc0KaZEEgbAqktB92wfCnh52hiIScWS/ot0MRSTiyXMJa6hChBOiVPeCoyLs2ZpVXFrzgqYB9MYE6scnFAGRzCQaBLgRxE8zQnDHcm8E4aGgQhXsGgElAMQD2jkhNLIUBD4gCrqaT6aJoXPKGsSri0TMozOwLrKkmRUE7tM6ZGDlOyJ+J8aWXynTNVFlxcLE6leKr0Ur4oL4LdlEhnBC8RqWAcT+V4qpBTFzVJsBURaUa8WpyK7YhIQxKLfaV8B/LOcxUhoCjKpQKIAOdSAypIwlMO/xbQX5a0Sqhg6plDSZqb4IuUSk0JpFbovzJAFLmmJKBqlaMKirkKNJ0VzMEvTVGIRfyVxg/plJXShGTBxlKRkURaQFrxMoG7KDzNoTAWhR2VauTU5cqYwabSrChxYY7bcUrCGqbYxKg0MbGoNopNjLIVrNjEqDSxfFHDFJsYFStYsYlRaWL54kaDfKd0ViRVwlLI1tJuKDR2OYg9h1q6tKOK6WmQ7NUzmoPjQoCl0DHDyCEPpgnV9UI0ke/+leB+1wRHS53hiNDtRJaQIiXc840SG5FMLHIrZ65Fk1lyCg1ullZMNbi8FEpnPCuVzgolfDBcKXNaCLMhUih5ghJK/UBmlayADpOmrIIGU/0t5aYKV0ItVMsI/1btITQrUlIM0pCUVF7lMiHpaVLc0J4oKQMtKrs+mAcVIZXtqpK3zJISixoxO+J2JMwo5waL7D0qCINyGWqkVuiEWpaF/Zjh8MTkdiFZLCTkOyBTllSKHv5K0UPrJcMoDCQnXOSwI0NTBtKCUicVMGKw7IJV2kJLcAFBzTwpMogS0JDpZ2VmR/ZZBZgzXsruQT2DTkGPcm5HwFORgYFUZiT1q0bEjqgdMTVyJEJXhIejMGPhmoDhKMx4uCZgOAozEU4uDEdhlofLQIYTPSvC9RfDJSMrw8GVYQ9m0kuLxaQu3zkdiTJKstiSYKPkMmdCMbEwFedMvqItjrXFV3Im97onqa1isZbgWFt8JWdyrC0utVUsVvcca4sXK1iVtuTxwnMzTM3Tf6pjho8fN5vk6+ZBnzrY45av366nC++/boh6QtUfrv6U6k+l3xX6r/z3t29APnNxwzbabewKkLiA+Q047jKg4X94d6CYOFlDoqCoD1WJ20DmsMcRIi8s2IYY7swimf4r1F+W6b9Gtuavnsf1PK5W53Kh6NeIdH6PAkm2pLpkw5zl1Q+/yrv1o7qC70jUWWOIte22GUekylUtIBNQwO3jEclW3LDQBVuot0OPueA3pLSE5OnJxcAirKl+em7H2uM/j7Co+nhES2b3c3scmvrpFVlGEZIc0vZx7BHU9ZafB+Vq6tR3e2QatIiA6hAIjyHUISXwKkowy1ZuMb7rB8SICBmHy8j5jBgJLXdFQ+fzsW2esO+WMRoacKyJsadhf5GP3WWWIatylzlircaAXKb+VE/ttj4ePfsLRXG0uue6Pfo+Q4KgDuHHn75u+0s3ffvh3SMK4au+rmEfjtdPeeztRjd5OAGdBoLdYz0e0IJXrVPD4HVWq26D4/Jj0zW7dtvWR2y9ocDkiqqZXpqmwykrGFczB/Di2VBoiUv8ImuAY7GbfG69EHHDyzBk12Neg3aAwEbsXFnIuzwgbC1FyI9dqGPreaQIBcBwENn2p3PfeXiqG3joPApaPGgdYjW0+LXEIl/jO+mTzZBO4xfE5KouZ1ie2vF8rF99LOVqYWiwdLtju8VLK1ZlZAFHrKAY+/Pk4cu5G6caFqQ+PEEsRcSpbd9Nddu1ONtC078MuspKf+pxCAivD8FdsLkFYwDxgBqUZosbudt1laFuJi/pBcsv1wr11XI36uROHK9mgdyoEC1YYvmhu5wem+Gnt38zV139fMpWYyHCBf3CT28/Nzg/BitDOuPmCUfhmHAj4Q7yYx5XjleaZtHzxKZgR8xssFpbaCE0Av3NkkueO+TLdfLXL6xcBJmDINQgSQStX6HGqOsyTv0JESQR6fWp2dWXI3aSmLbMQJ8bXObCFYTbRNvt5Ft7MKMguN2uGZpuix0sKJ6FaK+DM1pviGPigj2jjLDa2GmQvusn9eWUm24jmo0mxSGT3KhcXJ9r2umA7Q4u8Nwm2ckvDbHVRRSyTXeoPXXAFaMIuPGCe4NwTedATVtEKQ/BuJS+1KczLtGLiDZEg+FAEmEozZdzj7ceggVWuMRpvkxDvZ1w9Ah6pQO4q4+4KIQ7MDdFtGvq6TL42o8IHrvmBXdNt+Wzaz1dxGyzYens2mH0yuXV+jzZ0Hwe53e4k47J8AaRQXAZpgMWdoQ97gYcpcuYCliD6u+fEPhddR7RxRUpw8WWoVIf28lrgyKWt2+waiJq13377PV3RUifrgJVVTrssYs62ywbkgeS7B5+2wJJMYJL/RMhVyAnnWcBQgf607x3ClqrQ+3QHM+7yxGngYim8NB4Oy4R8j+0ey9l0BhN+/UZi4tzxhIXN+Kxix76F9jpQFkifku2Tb32OCKgtU9NN7U7ZPY8wjjaHa5lVsWHF9meTs1TW08N3oGCS4632T35ySYYgRbkg3wuuJ0XjsP6N1zcQuyKZMMcdS94hl8Ywa2Qa7cT2rYCKH8TiUdkOA3X/h0nx3zVo3C4v6LA+6DBc6IlXVscOGgVIV37wPDR38KWH3VOKgzTS8I7e1tiWUTN1XajFyxJcAcZSXycvKMBEuNICqz201xwBw7Bqk+UsGidro2Fmsa2e+63M5pwxB6jluf+s28TN/wf2RUuu8QNc1poabwOI3gM6Gpn+jd80hWRJrwtgKDb3dxw+9y8YuIRZeN1yxsbcESzeWwfh3rAwTXC7o/2Cz7XmpwtGR7ys2O/9UJU8NxDC8kJqsd+325xYAy6jQN2qj/jk8f7T6FPdVfvvfVGeN2p7vDWUBYRHU64AyfBDTYXpn9qd94pFNywvw14OU6t1wLS4P48AvR3KajTOm54KLedXu1u8Nvz0J+9DfeIxO5gWEAQUZzBe++8LgjlBKOu8eQbLAvC7u2fZQT3vRcSZNe/4EwTsZXQnVE/xSJCWXfxMlMVoZN+h10j5Bsr+9heThN3nEj13Vb/Co2rU6cFoSFrNJA/fsVZPItw7r7zzkVj9nZwYx2U07wi7Ycnvw+JOHiTUJ6xB288rClntnGWx1AHKG/nJCIm9S9eeROx+3mut5/rvXcIe1uH53qY2u3lWGPRZhEhF0BxoGYRYfNcexdYYixgMZTY3+BwObjGMXtZgs130xFD+hDkaXYeRILN3Ry8N7874tqZc9SuTYqFygKNxkMQVKBzkn3Wv7HiSsHJQ9RIQQSkkCxgQzfH4Mut22JYumrgNG366hedH43g5hHHNfPrJyfswDF3cmY/0enK1SnUggpR8J/epu9YunTuQoMX1Fwu/PwTccx7HppdM/hBK6IoPQ/Ns7ebFCwnEJhfQwSvtlEPKg0cY8RIRsLrnvfZK4mDh9ozBF7fQYKbgzPIJYsN7v070PIOIdLpbREPpMQ7kSxCnRII7gtM75Z4DaZOuogCNgfwfm1EiB+aevTKkvBxqQu281L1eo9joH69tENz8i9vkOCtQQQ8XQbEabBqIz6Ut1sSNF6nHJhtLDtbLHy+34tC7Ajz3A43fldubM714HUdwX0I4sL9evFP4mjQBhdyLSCYnawGW3NXUqO35R88kvB2gFfOIMZmmuXqYKtH5nBvz/UwNm03vW3SqR72zZQ+wy+0ptPQnnAGi2gXxmZaKyEivGxsptHvJcN9fbgsmklJYq1np0LUuTS8IXorloU6hPllB/j6cFWH+gKEA14P+/nVcvfGhmlq2AoXfgIO9iiubA/95ejtv0VUdf6uZrDYdw2hPbVeHU2CJxLL+mNzdLjFCleEDuDn9nyeySoibI/9ydsBj+jnxnOzbXev/t5bsKx3Qf17+DHeBjDeNkTEgf3cv2KOiuKi0eRfKQqeqvsMjal3ly9ir9P+nrnbUzr+HLoKdoXGhh33lYXppcwRsTkzXyraJQ28g0xiLhtJOE8iJNirLxw5AYLZ5agYuze/W4d3VoMuXyyAepe5nDaUzz8p8VBscWEW026p39l3k7lzuBa6fgZAXtkSbEecemWqHz2ooGRcqEONM2HwDu79H/JMB3xL5C5X9i855DH02gGHHBbR4UwH7/TmrpDjVl/T4YIxBW+YueTbk1euBUOys8c7oW9m7vsEy5NszCH+NLT7vb9BR4L3vt3lDRfvLtMqkP7ET8Niew4ePbqQ6BzGu7wdvn0VW6xNF/8IIrhTsIbl9dz8+LeNuuCLC9mIlDS9nnucjiKa1EvX/ooVEfz6KXy4dOm6Br6Q8w7igr08oj+13m59RMV9Gb0UGvRnlxS+PBe8gnHTnS+jfyIcEU0uY3N6vV7Y1vfQZ/mcBC/a+Lj8Fnb9Qic2NIPg7eImDI35uuoyNh4Hwc+4yDxuKOi3C7fxg+qfQTsX4RfwBI9fVswYo11iLmL7T2EJ3OUgTqy6dg2hTVWLcFb+hhP/beOdHbNHb1/Ar8V61wZp8A6gD4dv5wSPGgJU/+5zHUvXK33ca/5LhZ3jJHJPATdFN24U2drHx/Lj1/nOQjBoEA/YO1MIrXslr0g08/7dMUUyP10woPq/qcGNZUSMfm4Gz1Ii9hCfW/wNeYS/vdSeYMNfrzhAzXHrdcsRGfblgK+ykuDHFAtXgV5a71g6+JGTy6e/68vcQ+H7DmMAl3fQFN4BxGC9d7UseJ3fg1uMgM6pGltwwWUUbz+qAcGJKqItfa3xvnLwEzVHVK/9Bcvpe6Pta3/xzrzjwt6nZHNuz82x7ZrN+4+fvn37fwqWi7LfcAAA"; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 778b9492..00000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1412 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -.tsd-generator { - margin: 0 1em; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/functions/index.index.html b/docs/functions/index.index.html deleted file mode 100644 index d0053d87..00000000 --- a/docs/functions/index.index.html +++ /dev/null @@ -1,12 +0,0 @@ -index | React18 Global Store

Function index

  • index<T>(key, value?): [T, SetStateAction<T>]

  • Use this hook similar to useState hook. -The difference is that you need to pass a -unique key - unique across the app to make -this state accessible to all client components.

    -

    Type Parameters

    • T

    Parameters

    • key: string

      Unique key to identify the store.

      -
    • Optional value: ValueType<T>

      Initial value of the store.

      -

    Returns [T, SetStateAction<T>]

      -
    • A tuple (Ordered sequance of values) containing the state and a function to set the state.
      • -
    -

    Example

    const [state, setState] = useRGS<number>("counter", 1);
-
    -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/plugins_persist.persist.html b/docs/functions/plugins_persist.persist.html deleted file mode 100644 index 90b671dd..00000000 --- a/docs/functions/plugins_persist.persist.html +++ /dev/null @@ -1,3 +0,0 @@ -persist | React18 Global Store

Function persist

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createHook.html b/docs/functions/utils.createHook.html deleted file mode 100644 index bab931cf..00000000 --- a/docs/functions/utils.createHook.html +++ /dev/null @@ -1,2 +0,0 @@ -createHook | React18 Global Store

Function createHook

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSetter.html b/docs/functions/utils.createSetter.html deleted file mode 100644 index c01d8397..00000000 --- a/docs/functions/utils.createSetter.html +++ /dev/null @@ -1,2 +0,0 @@ -createSetter | React18 Global Store

Function createSetter

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSubcriber.html b/docs/functions/utils.createSubcriber.html deleted file mode 100644 index bb25b5c4..00000000 --- a/docs/functions/utils.createSubcriber.html +++ /dev/null @@ -1,2 +0,0 @@ -createSubcriber | React18 Global Store

Function createSubcriber

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.initWithPlugins.html b/docs/functions/utils.initWithPlugins.html deleted file mode 100644 index 6c270a27..00000000 --- a/docs/functions/utils.initWithPlugins.html +++ /dev/null @@ -1,2 +0,0 @@ -initWithPlugins | React18 Global Store

Function initWithPlugins

  • initWithPlugins<T>(key, value?, plugins?, doNotInit?): void

  • Initialize the named store when invoked for the first time.

    -

    Type Parameters

    • T

    Parameters

    • key: string
    • Optional value: ValueType<T>
    • plugins: Plugin<T>[] = []
    • doNotInit: boolean = false

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.useRGSWithPlugins.html b/docs/functions/utils.useRGSWithPlugins.html deleted file mode 100644 index 94e48cba..00000000 --- a/docs/functions/utils.useRGSWithPlugins.html +++ /dev/null @@ -1,14 +0,0 @@ -useRGSWithPlugins | React18 Global Store

Function useRGSWithPlugins

  • useRGSWithPlugins<T>(key, value?, plugins?, doNotInit?): [T, SetStateAction<T>]

  • Use this hook similar to useState hook. -The difference is that you need to pass a -unique key - unique across the app to make -this state accessible to all client components.

    -

    Type Parameters

    • T

    Parameters

    • key: string

      Unique key to identify the store.

      -
    • Optional value: ValueType<T>

      Initial value of the store.

      -
    • Optional plugins: Plugin<T>[]

      Plugins to be applied to the store.

      -
    • doNotInit: boolean = false

      Do not initialize the store. Useful when you want to initialize the store later. Note that the setter function is not available until the store is initialized.

      -

    Returns [T, SetStateAction<T>]

      -
    • A tuple (Ordered sequance of values) containing the state and a function to set the state.
      • -
    -

    Example

    const [state, setState] = useRGS<number>("counter", 1);
-
    -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.create.html b/docs/functions/with_plugins.create.html deleted file mode 100644 index 39270326..00000000 --- a/docs/functions/with_plugins.create.html +++ /dev/null @@ -1,10 +0,0 @@ -create | React18 Global Store

Function create

  • create<T>(key, value?, plugins?): (() => [T, SetStateAction<T>])

  • Creates a store with plugins.

    -

    Type Parameters

    • T

    Parameters

    • key: string

      Unique key to identify the store.

      -
    • Optional value: T

      Initial value of the store.

      -
    • Optional plugins: Plugin<T>[]

      Plugins to be applied to the store.

      -

    Returns (() => [T, SetStateAction<T>])

      -
    • A hook function that returns a tuple (Ordered sequence of values) containing the state and a function to set the state.
      • -
    -

    Example

    // in hook file, e.g., store.ts
    export const useMyRGS = create<type>(key, value, plugins);

    // in component file
    const [state, setState] = useMyRGS();
-
    -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.withPlugins.html b/docs/functions/with_plugins.withPlugins.html deleted file mode 100644 index 4878e349..00000000 --- a/docs/functions/with_plugins.withPlugins.html +++ /dev/null @@ -1,4 +0,0 @@ -withPlugins | React18 Global Store

Function withPlugins

  • withPlugins<T>(plugins): (<U>(key, value?, doNotInit?) => [U, SetStateAction<U>])

  • Creates a hook similar to useRGS, but with plugins to be applied on first invocation.

    -

    Type Parameters

    • T

    Parameters

    • plugins: Plugin<T>[]

      Plugins to be applied to the store.

      -

    Returns (<U>(key, value?, doNotInit?) => [U, SetStateAction<U>])

    A hook that automatically initializes the store (if not already initialized) with the given plugins.

    -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 7c316f02..00000000 --- a/docs/index.html +++ /dev/null @@ -1,33 +0,0 @@ -React18 Global Store

React18 Global Store

React18GlobalStore

test Maintainability codecov Version Downloads npm bundle size Gitpod ready-to-code

-

Motivation

I've developed fantastic libraries leveraging React18 features using Zustand, and they performed admirably. However, when attempting to import from specific folders for better tree-shaking, the libraries encountered issues. Each import resulted in a separate Zustand store being created, leading to increased package size.

-

As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking.

-

Features

✅ Full TypeScript Support

-

✅ Unleash the full power of React18 Server components

-

✅ Compatible with all build systems/tools/frameworks for React18

-

✅ Documented with Typedoc (Docs)

-

✅ Examples for Next.js, Vite, and Remix

-

Simple Global State Shared Across Multiple Components

Utilize this hook similarly to the useState hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components.

-
const [state, setState] = useRGS<number>("counter", 1);
-
-

or

-
const [state, setState] = useRGS<number>("counter", () => 1);
-
-
-

For detailed instructions, see Getting Started

-
-

Using Plugins

Enhance the functionality of the store by leveraging either the create function, withPlugins function, or the useRGSWithPlugins hook from r18gs/dist/with-plugins, enabling features such as storing to local storage, among others.

-
// store.ts
import { create } from "r18gs/dist/with-plugins";
import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */

export const useMyPersistentCounterStore = create<number>("persistent-counter", 0, [persist()]);
-
-

Now, you can utilize useMyPersistentCounterStore similarly to useState without specifying an initial value.

-
const [persistedCount, setPersistedCount] = useMyPersistentCounterStore();
-
-
-

For detailed instructions, see Leveraging Plugins

-
-

Contributing

See contributing.md

-

🤩 Don't forget to star this repo!

Interested in hands-on courses for getting started with Turborepo? Check out React and Next.js with TypeScript and The Game of Chess with Next.js, React and TypeScript

-

Repo Stats

-

License

Licensed under the MPL 2.0 open source license.

-
- -

with 💖 by Mayank Kumar Chaudhari

Settings

Member Visibility

Theme

On This Page

React18GlobalStore
\ No newline at end of file diff --git a/docs/interfaces/plugins_persist.PersistOptions.html b/docs/interfaces/plugins_persist.PersistOptions.html deleted file mode 100644 index 4395c940..00000000 --- a/docs/interfaces/plugins_persist.PersistOptions.html +++ /dev/null @@ -1,7 +0,0 @@ -PersistOptions | React18 Global Store

Interface PersistOptions

interface PersistOptions {
    storage?: "local" | "session" | "cookie";
    sync?: boolean;
}

Properties

storage? -sync? -

Properties

Optional storage

storage?: "local" | "session" | "cookie"

Default Value

local
-
-

Optional sync

sync?: boolean

Default Value

true
-
-

Settings

Member Visibility

Theme

On This Page

storagesync
\ No newline at end of file diff --git a/docs/md-docs/1.getting-started.md b/docs/md-docs/1.getting-started.md deleted file mode 100644 index e951f864..00000000 --- a/docs/md-docs/1.getting-started.md +++ /dev/null @@ -1,94 +0,0 @@ -# Quick Start - -Welcome to the quick guide for using this library. - -## Installation - -To get started, you can install the package via your preferred package manager. Here are a few examples: - -```bash -$ pnpm add r18gs -``` - -or - -```bash -$ npm install r18gs -``` - -or - -```bash -$ yarn add r18gs -``` - -## Usage - -Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components. - -```tsx -const [state, setState] = useRGS("counter", 1); -``` - -You can access the same state across all client-side components using a unique key. - -> It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts. - -### Initializing the state with a function - -In some cases you might want to initialize the state with a function, for example, when reading from `localStorage`. We support initializer function as well. - -```tsx -const [state, setState] = useRGS("counter", () => - typeof localStorage === "undefined" ? 1 : localStorage.getItem("counter") ?? 1, -); -``` - -### Example - -```tsx -// constants/global-states.ts -export const COUNTER = "counter"; -``` - -```tsx -// components/display.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Display() { - const [count] = useRGS(COUNTER); - return ( -
-

Client Component 2

- {count} -
- ); -} -``` - -```tsx -// components/counter.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Counter() { - const [count, setCount] = useRGS(COUNTER, 0); - return ( -
-

Client Component 1

- { - setCount(parseInt(e.target.value.trim())); - }} - type="number" - value={count} - /> -
- ); -} -``` diff --git a/docs/md-docs/2.leveraging-plugins.md b/docs/md-docs/2.leveraging-plugins.md deleted file mode 100644 index e8bd53c2..00000000 --- a/docs/md-docs/2.leveraging-plugins.md +++ /dev/null @@ -1,64 +0,0 @@ -# Leveraging Plugins - -Enhance your store's functionality by utilizing either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`. This enables features such as storing to local storage, among others. - -## Creating a Store with the `create` Function - -```tsx -// store.ts -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */ - -export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]); -``` - -Now you can utilize `useMyPersistentCounterStore` similar to `useState` without specifying an initial value. - -```tsx -// inside your component -const [persistedCount, setPersistedCount] = useMyPersistentCounterStore(); -``` - -## Utilizing the `useRGSWithPlugins` Hook - -This function is beneficial if your requirements dictate that your `key` and/or initial value will depend on some props, etc. Or for some other reason you want to initialize the store from within a component (You need to use some variables available inside the component). - -```tsx -import { useRGSWithPlugins } from "r18gs/dist/with-plugin"; - -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useRGSWithPlugins( - props.key, - props.initialVal, - props.plugins, - props.doNotInit, - ); - // ... -} -``` - -### `doNotInit` - -In some cases, you may not want to initialize the store immediately. In such cases, you can pass the fourth argument (`doNotInit`) as `true`. The default value is false. - -- When this argument is set to `true`, the store is created, but the setter function is set to null. Thus, you can access the initial value set by the first component that triggered this hook. However, it cannot be modified until the store is initialized, i.e., the hook is invoked by a component setting `doNotInit` to false (or skipping this argument). - -**Use case**: When you need that the store be used in many components, however, it should be initialized in a particular component only. - -## Creating a Custom Hook using the `withPlugins` Higher-Order Function - -This is a utility function that will be very helpful when you want to use the `useRGSWithPlugins` hook with the same plugins in multiple components. - -```ts -// custom hook file, e.g., store.ts -export const useMyRGS = withPlugins([plugin1, plugin2, ...]); -``` - -```tsx -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit); - // ... -} -``` - -You can also create your own plugins. Refer to [Creating Plugins](./3.creating-plugins.md). diff --git a/docs/md-docs/3.creating-plugins.md b/docs/md-docs/3.creating-plugins.md deleted file mode 100644 index b7d3cbd8..00000000 --- a/docs/md-docs/3.creating-plugins.md +++ /dev/null @@ -1 +0,0 @@ -# Creating Plugins diff --git a/docs/modules/Guides.html b/docs/modules/Guides.html deleted file mode 100644 index 5ebe5f18..00000000 --- a/docs/modules/Guides.html +++ /dev/null @@ -1,3 +0,0 @@ -Guides | React18 Global Store

Module Guides

Index

Variables

A_Quick_Start -B_Leveraging_Plugins -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html deleted file mode 100644 index a9afbdbc..00000000 --- a/docs/modules/index.html +++ /dev/null @@ -1,5 +0,0 @@ -index | React18 Global Store

Module index

References

Plugin -SetStateAction -SetterArgType -

Functions

index -

References

Plugin

Re-exports Plugin

SetStateAction

Re-exports SetStateAction

SetterArgType

Re-exports SetterArgType

Settings

Member Visibility

Theme

On This Page

PluginSetStateActionSetterArgType
\ No newline at end of file diff --git a/docs/modules/plugins.html b/docs/modules/plugins.html deleted file mode 100644 index 1323b11e..00000000 --- a/docs/modules/plugins.html +++ /dev/null @@ -1,3 +0,0 @@ -plugins | React18 Global Store

Module plugins

References

PersistOptions -persist -

References

PersistOptions

Re-exports PersistOptions

persist

Re-exports persist

Settings

Member Visibility

Theme

On This Page

PersistOptionspersist
\ No newline at end of file diff --git a/docs/modules/plugins_persist.html b/docs/modules/plugins_persist.html deleted file mode 100644 index bf17356d..00000000 --- a/docs/modules/plugins_persist.html +++ /dev/null @@ -1,3 +0,0 @@ -plugins/persist | React18 Global Store

Module plugins/persist

Index

Interfaces

PersistOptions -

Functions

persist -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/utils._internal_.html b/docs/modules/utils._internal_.html deleted file mode 100644 index 280615c8..00000000 --- a/docs/modules/utils._internal_.html +++ /dev/null @@ -1,6 +0,0 @@ -<internal> | React18 Global Store

Module <internal>

Index

Type Aliases

Listener -Mutate -RGS -Record -Subscriber -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html deleted file mode 100644 index 65426f1e..00000000 --- a/docs/modules/utils.html +++ /dev/null @@ -1,12 +0,0 @@ -utils | React18 Global Store

Module utils

Index

Modules

<internal> -

Type Aliases

Plugin -SetStateAction -SetterArgType -ValueType -

Variables

globalRGS -

Functions

createHook -createSetter -createSubcriber -initWithPlugins -useRGSWithPlugins -

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/with_plugins.html b/docs/modules/with_plugins.html deleted file mode 100644 index b2c95d3c..00000000 --- a/docs/modules/with_plugins.html +++ /dev/null @@ -1,4 +0,0 @@ -with-plugins | React18 Global Store

Module with-plugins

References

useRGSWithPlugins -

Functions

create -withPlugins -

References

useRGSWithPlugins

Re-exports useRGSWithPlugins

Settings

Member Visibility

Theme

On This Page

useRGSWithPlugins
\ No newline at end of file diff --git a/docs/types/utils.Plugin.html b/docs/types/utils.Plugin.html deleted file mode 100644 index 382c1451..00000000 --- a/docs/types/utils.Plugin.html +++ /dev/null @@ -1 +0,0 @@ -Plugin | React18 Global Store

Type alias Plugin<T>

Plugin<T>: {
    init?: ((key, value, mutate) => void);
    onChange?: ((key, value?) => void);
}

Type Parameters

  • T

Type declaration

  • Optional init?: ((key, value, mutate) => void)
      • (key, value, mutate): void

      • Parameters

        • key: string
        • value: T | undefined
        • mutate: Mutate<T>

        Returns void

  • Optional onChange?: ((key, value?) => void)
      • (key, value?): void

      • Parameters

        • key: string
        • Optional value: T

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetStateAction.html b/docs/types/utils.SetStateAction.html deleted file mode 100644 index 2316b84c..00000000 --- a/docs/types/utils.SetStateAction.html +++ /dev/null @@ -1 +0,0 @@ -SetStateAction | React18 Global Store

Type alias SetStateAction<T>

SetStateAction<T>: ((value) => void)

Type Parameters

  • T

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetterArgType.html b/docs/types/utils.SetterArgType.html deleted file mode 100644 index 71d660b3..00000000 --- a/docs/types/utils.SetterArgType.html +++ /dev/null @@ -1 +0,0 @@ -SetterArgType | React18 Global Store

Type alias SetterArgType<T>

SetterArgType<T>: T | ((prevState) => T)

Type Parameters

  • T

Type declaration

    • (prevState): T

    • Parameters

      • prevState: T

      Returns T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.ValueType.html b/docs/types/utils.ValueType.html deleted file mode 100644 index 6ba2b2cc..00000000 --- a/docs/types/utils.ValueType.html +++ /dev/null @@ -1 +0,0 @@ -ValueType | React18 Global Store

Type alias ValueType<T>

ValueType<T>: T | (() => T)

Type Parameters

  • T

Type declaration

    • (): T

    • Returns T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Listener.html b/docs/types/utils._internal_.Listener.html deleted file mode 100644 index a9cf6af2..00000000 --- a/docs/types/utils._internal_.Listener.html +++ /dev/null @@ -1 +0,0 @@ -Listener | React18 Global Store

Type alias Listener

Listener: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Mutate.html b/docs/types/utils._internal_.Mutate.html deleted file mode 100644 index d4ed74bf..00000000 --- a/docs/types/utils._internal_.Mutate.html +++ /dev/null @@ -1 +0,0 @@ -Mutate | React18 Global Store

Type alias Mutate<T>

Mutate<T>: ((value?) => void)

Type Parameters

  • T

Type declaration

    • (value?): void

    • Parameters

      • Optional value: T

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.RGS.html b/docs/types/utils._internal_.RGS.html deleted file mode 100644 index a7c3c544..00000000 --- a/docs/types/utils._internal_.RGS.html +++ /dev/null @@ -1 +0,0 @@ -RGS | React18 Global Store

Type alias RGS

RGS: [unknown, Listener[], SetStateAction<unknown> | null, Subscriber]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Record.html b/docs/types/utils._internal_.Record.html deleted file mode 100644 index cf6f7856..00000000 --- a/docs/types/utils._internal_.Record.html +++ /dev/null @@ -1,2 +0,0 @@ -Record | React18 Global Store

Type alias Record<K, T>

Record<K, T>: {
    [P in K]: T
}

Construct a type with a set of properties K of type T

-

Type Parameters

  • K extends keyof any
  • T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils._internal_.Subscriber.html b/docs/types/utils._internal_.Subscriber.html deleted file mode 100644 index c44ba8d6..00000000 --- a/docs/types/utils._internal_.Subscriber.html +++ /dev/null @@ -1 +0,0 @@ -Subscriber | React18 Global Store

Type alias Subscriber

Subscriber: ((l) => (() => void))

Type declaration

    • (l): (() => void)

    • Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/Guides.A_Quick_Start.html b/docs/variables/Guides.A_Quick_Start.html deleted file mode 100644 index 2a758477..00000000 --- a/docs/variables/Guides.A_Quick_Start.html +++ /dev/null @@ -1,24 +0,0 @@ -A_Quick_Start | React18 Global Store

Variable A_Quick_StartConst

A_Quick_Start: "Quick Start" = "Quick Start"

Quick Start

Welcome to the quick guide for using this library.

-

Installation

To get started, you can install the package via your preferred package manager. Here are a few examples:

-
$ pnpm add r18gs
-
-

or

-
$ npm install r18gs
-
-

or

-
$ yarn add r18gs
-
-

Usage

Utilize this hook similarly to the useState hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components.

-
const [state, setState] = useRGS<number>("counter", 1);
-
-

You can access the same state across all client-side components using a unique key.

-
-

It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts.

-
-

Example

// constants/global-states.ts
export const COUNTER = "counter";
-
-
// components/display.tsx
"use client";

import useRGS from "r18gs";
import { COUNTER } from "../constants/global-states";

export default function Display() {
    const [count] = useRGS<number>(COUNTER);
    return (
        <div>
            <h2>Client Component 2</h2>
            <b>{count}</b>
        </div>
    );
}
-
-
// components/counter.tsx
"use client";

import useRGS from "r18gs";
import { COUNTER } from "../constants/global-states";

export default function Counter() {
    const [count, setCount] = useRGS(COUNTER, 0);
    return (
        <div>
            <h2>Client Component 1</h2>
            <input
                onChange={e => {
                    setCount(parseInt(e.target.value.trim()));
                }}
                type="number"
                value={count}
            />
        </div>
    );
}
-
-

Settings

Member Visibility

Theme

On This Page

Quick Start
\ No newline at end of file diff --git a/docs/variables/Guides.B_Leveraging_Plugins.html b/docs/variables/Guides.B_Leveraging_Plugins.html deleted file mode 100644 index 4b93706e..00000000 --- a/docs/variables/Guides.B_Leveraging_Plugins.html +++ /dev/null @@ -1,21 +0,0 @@ -B_Leveraging_Plugins | React18 Global Store

Variable B_Leveraging_PluginsConst

B_Leveraging_Plugins: "Leveraging Plugins" = "Leveraging Plugins"

Leveraging Plugins

Enhance your store's functionality by utilizing either the create function, withPlugins function, or the useRGSWithPlugins hook from r18gs/dist/with-plugins. This enables features such as storing to local storage, among others.

-

Creating a Store with the create Function

// store.ts
import { create } from "r18gs/dist/with-plugins";
import { persist } from "r18gs/dist/plugins"; // You can create your own plugin or import third-party plugins

export const useMyPersistentCounterStore = create<number>("persistent-counter", 0, [persist()]);
-
-

Now you can utilize useMyPersistentCounterStore similar to useState without specifying an initial value.

-
// inside your component
const [persistedCount, setPersistedCount] = useMyPersistentCounterStore();
-
-

Utilizing the useRGSWithPlugins Hook

This function is beneficial if your requirements dictate that your key and/or initial value will depend on some props, etc. Or for some other reason you want to initialize the store from within a component (You need to use some variables available inside the component).

-
import { useRGSWithPlugins } from "r18gs/dist/with-plugin";

export function MyComponent(props: MyComponentProps) {
const [state, setState] = useRGSWithPlugins(
    props.key,
    props.initialVal,
    props.plugins,
    props.doNotInit,
);
// ...
}
-
-

doNotInit

In some cases, you may not want to initialize the store immediately. In such cases, you can pass the fourth argument (doNotInit) as true. The default value is false.

-
    -
  • When this argument is set to true, the store is created, but the setter function is set to null. Thus, you can access the initial value set by the first component that triggered this hook. However, it cannot be modified until the store is initialized, i.e., the hook is invoked by a component setting doNotInit to false (or skipping this argument).
    • -
-

Use case*: When you need that the store be used in many components, however, it should be initialized in a particular component only.

-

Creating a Custom Hook using the withPlugins Higher-Order Function

This is a utility function that will be very helpful when you want to use the useRGSWithPlugins hook with the same plugins in multiple components.

-
// custom hook file, e.g., store.ts
export const useMyRGS = withPlugins([plugin1, plugin2, ...]);
-
-
export function MyComponent(props: MyComponentProps) {
const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit);
// ...
}
-
-

You can also create your own plugins. Refer to Creating Plugins.

-

Settings

Member Visibility

Theme

On This Page

Leveraging Plugins
\ No newline at end of file diff --git a/docs/variables/utils.globalRGS.html b/docs/variables/utils.globalRGS.html deleted file mode 100644 index 7c528cf7..00000000 --- a/docs/variables/utils.globalRGS.html +++ /dev/null @@ -1 +0,0 @@ -globalRGS | React18 Global Store

Variable globalRGSConst

globalRGS: Record<string, undefined | RGS> = globalThisForBetterMinification.rgs

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/examples/nextjs/.eslintrc.js b/examples/nextjs/.eslintrc.js deleted file mode 100644 index 1d9773ea..00000000 --- a/examples/nextjs/.eslintrc.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - extends: ["custom/next"], -}; diff --git a/examples/nextjs/.gitignore b/examples/nextjs/.gitignore deleted file mode 100644 index 1437c53f..00000000 --- a/examples/nextjs/.gitignore +++ /dev/null @@ -1,34 +0,0 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - -# dependencies -/node_modules -/.pnp -.pnp.js - -# testing -/coverage - -# next.js -/.next/ -/out/ - -# production -/build - -# misc -.DS_Store -*.pem - -# debug -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# local env files -.env.local -.env.development.local -.env.test.local -.env.production.local - -# vercel -.vercel diff --git a/examples/nextjs/CHANGELOG.md b/examples/nextjs/CHANGELOG.md deleted file mode 100644 index eff4862e..00000000 --- a/examples/nextjs/CHANGELOG.md +++ /dev/null @@ -1,171 +0,0 @@ -# nextjs-example - -## 0.0.16 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.1 - - shared-ui@0.0.0 - -## 0.0.15 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.0 - - shared-ui@0.0.0 - -## 0.0.14 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.2 - - shared-ui@0.0.0 - -## 0.0.13 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.1 - - shared-ui@0.0.0 - -## 0.0.12 - -### Patch Changes - -- Updated dependencies -- Updated dependencies -- Updated dependencies -- Updated dependencies - - r18gs@1.0.0 - - shared-ui@0.0.0 - -## 0.0.11 - -### Patch Changes - -- Updated dependencies [81b9d3f] -- Updated dependencies - - r18gs@0.2.0 - - shared-ui@0.0.0 - -## 0.0.10 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.4 - - shared-ui@0.0.0 - -## 0.0.9 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.3 - - shared-ui@0.0.0 - -## 0.0.8 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.2 - - shared-ui@0.0.0 - -## 0.0.7 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.1 - - shared-ui@0.0.0 - -## 0.0.6 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.0 - - shared-ui@0.0.0 - -## 0.0.5 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.5 - - shared-ui@0.0.0 - -## 0.0.4 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.4 - - shared-ui@0.0.0 - -## 0.0.3 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.3 - - shared-ui@0.0.0 - -## 0.0.2 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.2 - - shared-ui@0.0.0 - -## 0.0.1 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.1 - - shared-ui@0.0.0 - -## 1.0.5 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@2.0.1 - - shared-ui@1.0.1 - -## 1.0.4 - -### Patch Changes - -- Support Next.js 14 -- Updated dependencies - - @mayank1513/fork-me@2.0.0 - -## 1.0.3 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@1.1.2 - -## 1.0.2 - -### Patch Changes - -- Fix CSS modules -- Updated dependencies - - @mayank1513/fork-me@1.1.1 - -## 1.0.1 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@1.1.0 diff --git a/examples/nextjs/README.md b/examples/nextjs/README.md deleted file mode 100644 index 1626d340..00000000 --- a/examples/nextjs/README.md +++ /dev/null @@ -1,28 +0,0 @@ -## Getting Started - -First, run the development server: - -```bash -yarn dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -To create [API routes](https://nextjs.org/docs/app/building-your-application/routing/router-handlers) add an `api/` directory to the `app/` directory with a `route.ts` file. For individual endpoints, create a subfolder in the `api` directory, as `api/hello/route.ts` would map to [http://localhost:3000/api/hello](http://localhost:3000/api/hello). - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API. -- [Learn Next.js](https://www.udemy.com/course/react-and-next-js-with-typescript/?referralCode=7202184A1E57C3DCA8B2) - an interactive Next.js course. - -You can check out [the Turbo Template GitHub repository](https://github.com/mayank1513/turborepo-template/) - your feedback and contributions are welcome! - -### 🤩 Don't forget to start this repo! - -
- -

with 💖 by Mayank Kumar Chaudhari

diff --git a/examples/nextjs/app/favicon.ico b/examples/nextjs/app/favicon.ico deleted file mode 100644 index 71e4bd7106d802cf01b1218c3ead532a89fe2268..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1150 zcmZ`$drZ?;7`^DMl5N;2FqwN)(8a|WA`2`gbSMgF+OEK4l!la1DqS5!&PJxmr<*`l?A=J(t@)(b1s$}ku8i;u@48gS3SQoq&Pt(J( zW*r^-<9OhwOhTAE0oKksh*KJ&VCzwmDnZzW2xP>cfUZP3EI#^5fBegvu;D2hHa_zt z=%LSo@mw^r51Ns`cM7_r-$M}705MC0%r}ZqnkvPsTVfz&WuaZBcFXglzetUXL{wM^ zA}EA}go6FL2)x8*u)=20wrdFL7!fqwPRKb%s0++^cOMV3cM9Q9>ATE|gdSn)YuLRl z0$VoI5xHqQ@)8ut-dTjVL&xDgU_?jk9_YBAK$50~>Z}P>r(`e|C~&Q=UgNOj8XAia zfwwOj%pH-4+qMe=rU1p86L31pfgcaE;fQBI^=2)k$5bfGRKZYb##Nbi!J)0q`O10W z1-m)7%v^r_+xOBF|KKoVQMx+`??>&0@=zZ<`~nP~VL+11fjUovnhXhA6)lTa)d%17 z7&JSk?zIxY9dxTl67JAurRYjh>n|N<&Zz_vG~JlN*i8pUFYG}TJ8iy6s_*~soaC}a zS$*85lt16(vG~975f65k5sa-`rB=$T+4WwWcm0n3=>@nG6=%9_w)MB{{GcyC zE?bfF54PcHa_7M;t-Nd8C}{r~&bx~knO(xry@&cwYi+B)?)%Pf4am)d_eq=g*R7(? zpC+>P_wo7g-|$Q=VtjsSdh$0M9GhJtzF7p!TAXR*lJhRnxJJ_jmWf5KX%g3l=iwZg zNAJiS+InX++Rk5y);<<6?;YwOwe20mXf+7WHhhL-m2OmgaOM$x#h!EGlvYgxNGvoNqI@> zZ+Tc*r+w+=(ry<2)EU0CaAR&o!E$@RzR$%Yclu8TU9RJXx0;I>H?GTrb=Gn6@OErK a|Nn`V)M9Qeg_o9LJ=On<|Fl0V2>Ay!D%IHl diff --git a/examples/nextjs/app/layout.tsx b/examples/nextjs/app/layout.tsx deleted file mode 100644 index 5e45229a..00000000 --- a/examples/nextjs/app/layout.tsx +++ /dev/null @@ -1,16 +0,0 @@ -import { ServerTarget } from "nthul-lite/server"; -import { Inter } from "next/font/google"; -import { SharedRootLayout } from "shared-ui"; - -const inter = Inter({ subsets: ["latin"] }); - -export default function RootLayout({ children }: { children: React.ReactNode }): JSX.Element { - return ( - - - - {children} - - - ); -} diff --git a/examples/nextjs/app/page.tsx b/examples/nextjs/app/page.tsx deleted file mode 100644 index c4377b2f..00000000 --- a/examples/nextjs/app/page.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default function Home(): JSX.Element { - return

Next.js Example

; -} diff --git a/examples/nextjs/cache/config.json b/examples/nextjs/cache/config.json deleted file mode 100644 index cb01ad90..00000000 --- a/examples/nextjs/cache/config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "telemetry": { - "notifiedAt": "1701772138754", - "enabled": false - } -} \ No newline at end of file diff --git a/examples/nextjs/next-env.d.ts b/examples/nextjs/next-env.d.ts deleted file mode 100644 index 4f11a03d..00000000 --- a/examples/nextjs/next-env.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -/// -/// - -// NOTE: This file should not be edited -// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/examples/nextjs/next.config.js b/examples/nextjs/next.config.js deleted file mode 100644 index b4b8f818..00000000 --- a/examples/nextjs/next.config.js +++ /dev/null @@ -1,4 +0,0 @@ -module.exports = { - reactStrictMode: true, - transpilePackages: [""], -}; diff --git a/examples/nextjs/package.json b/examples/nextjs/package.json deleted file mode 100644 index c2072914..00000000 --- a/examples/nextjs/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "name": "nextjs-example", - "version": "0.0.16", - "private": true, - "scripts": { - "dev": "next dev", - "build": "next build", - "start": "next start", - "lint": "next lint", - "postinstall": "next telemetry disable" - }, - "dependencies": { - "@mayank1513/fork-me": "^2.1.2", - "next": "^14.2.3", - "nthul-lite": "^0.2.3", - "r18gs": "workspace:*", - "react": "^18.3.1", - "react-dom": "^18.3.1", - "shared-ui": "workspace:*" - }, - "devDependencies": { - "@next/eslint-plugin-next": "^14.2.3", - "@types/node": "^20.14.1", - "@types/react": "^18.3.3", - "@types/react-dom": "^18.3.0", - "eslint-config-custom": "workspace:*", - "tsconfig": "workspace:*", - "typescript": "^5.4.5" - } -} diff --git a/examples/nextjs/tsconfig.json b/examples/nextjs/tsconfig.json deleted file mode 100644 index 644ee04f..00000000 --- a/examples/nextjs/tsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "tsconfig/nextjs.json", - "compilerOptions": { - "plugins": [{ "name": "next" }] - }, - "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], - "exclude": ["node_modules"] -} diff --git a/examples/remix/.eslintrc.cjs b/examples/remix/.eslintrc.cjs deleted file mode 100644 index 613caf73..00000000 --- a/examples/remix/.eslintrc.cjs +++ /dev/null @@ -1,4 +0,0 @@ -/** @type {import('eslint').Linter.Config} */ -module.exports = { - extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"], -}; diff --git a/examples/remix/.gitignore b/examples/remix/.gitignore deleted file mode 100644 index 1998c294..00000000 --- a/examples/remix/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.cache \ No newline at end of file diff --git a/examples/remix/CHANGELOG.md b/examples/remix/CHANGELOG.md deleted file mode 100644 index b90a290e..00000000 --- a/examples/remix/CHANGELOG.md +++ /dev/null @@ -1,142 +0,0 @@ -# remix-example - -## 0.0.16 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.1 - - shared-ui@0.0.0 - -## 0.0.15 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.0 - - shared-ui@0.0.0 - -## 0.0.14 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.2 - - shared-ui@0.0.0 - -## 0.0.13 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.1 - - shared-ui@0.0.0 - -## 0.0.12 - -### Patch Changes - -- Updated dependencies -- Updated dependencies -- Updated dependencies -- Updated dependencies - - r18gs@1.0.0 - - shared-ui@0.0.0 - -## 0.0.11 - -### Patch Changes - -- 81b9d3f: Make the library extensible with plugins -- Updated dependencies [81b9d3f] -- Updated dependencies - - r18gs@0.2.0 - - shared-ui@0.0.0 - -## 0.0.10 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.4 - - shared-ui@0.0.0 - -## 0.0.9 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.3 - - shared-ui@0.0.0 - -## 0.0.8 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.2 - - shared-ui@0.0.0 - -## 0.0.7 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.1 - - shared-ui@0.0.0 - -## 0.0.6 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.0 - - shared-ui@0.0.0 - -## 0.0.5 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.5 - - shared-ui@0.0.0 - -## 0.0.4 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.4 - - shared-ui@0.0.0 - -## 0.0.3 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.3 - - shared-ui@0.0.0 - -## 0.0.2 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.2 - - shared-ui@0.0.0 - -## 0.0.1 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.1 - - shared-ui@0.0.0 - -## null - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@2.0.1 - - shared-ui@1.0.1 diff --git a/examples/remix/app/root.tsx b/examples/remix/app/root.tsx deleted file mode 100644 index 4ebdb015..00000000 --- a/examples/remix/app/root.tsx +++ /dev/null @@ -1,29 +0,0 @@ -import { cssBundleHref } from "@remix-run/css-bundle"; -import type { LinksFunction } from "@remix-run/node"; -import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration } from "@remix-run/react"; -import { SharedRootLayout } from "shared-ui"; - -export const links: LinksFunction = () => [ - ...(cssBundleHref ? [{ rel: "stylesheet", href: cssBundleHref }] : []), -]; - -export default function App() { - return ( - - - - - - - - - - - - - - - - - ); -} diff --git a/examples/remix/app/routes/_index.tsx b/examples/remix/app/routes/_index.tsx deleted file mode 100644 index 7e84feff..00000000 --- a/examples/remix/app/routes/_index.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default function Home() { - return

Remix Example

; -} diff --git a/examples/remix/package.json b/examples/remix/package.json deleted file mode 100644 index bef77336..00000000 --- a/examples/remix/package.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "name": "remix-example", - "version": "0.0.16", - "private": true, - "sideEffects": false, - "type": "module", - "scripts": { - "build": "remix build", - "dev": "remix dev --manual", - "start": "remix-serve ./build/index.js", - "typecheck": "tsc" - }, - "dependencies": { - "@mayank1513/fork-me": "^2.1.2", - "@remix-run/css-bundle": "^2.9.2", - "@remix-run/node": "^2.9.2", - "@remix-run/react": "^2.9.2", - "@remix-run/serve": "^2.9.2", - "isbot": "5.1.9", - "nthul-lite": "^0.2.3", - "r18gs": "workspace:*", - "react": "^18.3.1", - "react-dom": "^18.3.1", - "shared-ui": "workspace:*" - }, - "devDependencies": { - "@remix-run/dev": "^2.9.2", - "@remix-run/eslint-config": "^2.9.2", - "@types/react": "^18.3.3", - "@types/react-dom": "^18.3.0", - "eslint": "^9.4.0", - "typescript": "^5.4.5" - }, - "engines": { - "node": ">=18.0.0" - } -} diff --git a/examples/remix/remix.config.js b/examples/remix/remix.config.js deleted file mode 100644 index 2afd6649..00000000 --- a/examples/remix/remix.config.js +++ /dev/null @@ -1,9 +0,0 @@ -/** @type {import('@remix-run/dev').AppConfig} */ -export default { - ignoredRouteFiles: ["**/.*"], - serverDependenciesToBundle: ["@mayank1513/fork-me", "shared-ui"], - // appDirectory: "app", - // assetsBuildDirectory: "public/build", - // publicPath: "/build/", - // serverBuildPath: "build/index.js", -}; diff --git a/examples/remix/remix.env.d.ts b/examples/remix/remix.env.d.ts deleted file mode 100644 index dcf8c45e..00000000 --- a/examples/remix/remix.env.d.ts +++ /dev/null @@ -1,2 +0,0 @@ -/// -/// diff --git a/examples/remix/tsconfig.json b/examples/remix/tsconfig.json deleted file mode 100644 index 28cce918..00000000 --- a/examples/remix/tsconfig.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"], - "compilerOptions": { - "lib": ["DOM", "DOM.Iterable", "ES2022"], - "isolatedModules": true, - "esModuleInterop": true, - "jsx": "react-jsx", - "moduleResolution": "Bundler", - "resolveJsonModule": true, - "target": "ES2022", - "strict": true, - "allowJs": true, - "forceConsistentCasingInFileNames": true, - "baseUrl": ".", - "paths": { - "~/*": ["./app/*"] - }, - - // Remix takes care of building everything in `remix build`. - "noEmit": true - } -} diff --git a/examples/vite/.eslintrc.cjs b/examples/vite/.eslintrc.cjs deleted file mode 100644 index f63fe7dc..00000000 --- a/examples/vite/.eslintrc.cjs +++ /dev/null @@ -1,15 +0,0 @@ -module.exports = { - root: true, - env: { browser: true, es2020: true }, - extends: [ - "eslint:recommended", - "plugin:@typescript-eslint/recommended", - "plugin:react-hooks/recommended", - ], - ignorePatterns: ["dist", ".eslintrc.cjs"], - parser: "@typescript-eslint/parser", - plugins: ["react-refresh"], - rules: { - "react-refresh/only-export-components": ["warn", { allowConstantExport: true }], - }, -}; diff --git a/examples/vite/.gitignore b/examples/vite/.gitignore deleted file mode 100644 index 5a079d55..00000000 --- a/examples/vite/.gitignore +++ /dev/null @@ -1,37 +0,0 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - -# dependencies -/node_modules -/.pnp -.pnp.js - -# testing -/coverage - -# next.js -/.next/ -/out/ - -# production -/build - -# misc -.DS_Store -*.pem - -# debug -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# local env files -.env.local -.env.development.local -.env.test.local -.env.production.local - -# vercel -.vercel - -# vite -dist diff --git a/examples/vite/CHANGELOG.md b/examples/vite/CHANGELOG.md deleted file mode 100644 index b8d10792..00000000 --- a/examples/vite/CHANGELOG.md +++ /dev/null @@ -1,170 +0,0 @@ -# vite-example - -## 0.0.16 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.1 - - shared-ui@0.0.0 - -## 0.0.15 - -### Patch Changes - -- Updated dependencies - - r18gs@1.1.0 - - shared-ui@0.0.0 - -## 0.0.14 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.2 - - shared-ui@0.0.0 - -## 0.0.13 - -### Patch Changes - -- Updated dependencies - - r18gs@1.0.1 - - shared-ui@0.0.0 - -## 0.0.12 - -### Patch Changes - -- Updated dependencies -- Updated dependencies -- Updated dependencies -- Updated dependencies - - r18gs@1.0.0 - - shared-ui@0.0.0 - -## 0.0.11 - -### Patch Changes - -- Updated dependencies [81b9d3f] -- Updated dependencies - - r18gs@0.2.0 - - shared-ui@0.0.0 - -## 0.0.10 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.4 - - shared-ui@0.0.0 - -## 0.0.9 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.3 - - shared-ui@0.0.0 - -## 0.0.8 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.2 - - shared-ui@0.0.0 - -## 0.0.7 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.1 - - shared-ui@0.0.0 - -## 0.0.6 - -### Patch Changes - -- Updated dependencies - - r18gs@0.1.0 - - shared-ui@0.0.0 - -## 0.0.5 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.5 - - shared-ui@0.0.0 - -## 0.0.4 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.4 - - shared-ui@0.0.0 - -## 0.0.3 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.3 - - shared-ui@0.0.0 - -## 0.0.2 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.2 - - shared-ui@0.0.0 - -## 0.0.1 - -### Patch Changes - -- Updated dependencies - - r18gs@0.0.1 - - shared-ui@0.0.0 - -## 0.0.5 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@2.0.1 - - shared-ui@1.0.1 - -## 0.0.4 - -### Patch Changes - -- Support Next.js 14 -- Updated dependencies - - @mayank1513/fork-me@2.0.0 - -## 0.0.3 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@1.1.2 - -## 0.0.2 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@1.1.1 - -## 0.0.1 - -### Patch Changes - -- Updated dependencies - - @mayank1513/fork-me@1.1.0 diff --git a/examples/vite/README.md b/examples/vite/README.md deleted file mode 100644 index 603a1359..00000000 --- a/examples/vite/README.md +++ /dev/null @@ -1,25 +0,0 @@ -## Getting Started - -First, run the development server: - -```bash -yarn dev -``` - -Open [http://localhost:3001](http://localhost:3001) with your browser to see the result. -Edit `src/App.tsx` and save to test HMR - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API. -- [Learn Next.js](https://www.udemy.com/course/react-and-next-js-with-typescript/?referralCode=7202184A1E57C3DCA8B2) - an interactive Next.js course. - -You can check out [the Turbo Template GitHub repository](https://github.com/mayank1513/turborepo-template/) - your feedback and contributions are welcome! - -### 🤩 Don't forget to start this repo! - -
- -

with 💖 by Mayank Kumar Chaudhari

diff --git a/examples/vite/index.html b/examples/vite/index.html deleted file mode 100644 index ef80c79b..00000000 --- a/examples/vite/index.html +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - Vite + React + TS - - -
- - - diff --git a/examples/vite/package.json b/examples/vite/package.json deleted file mode 100644 index 14a0d2cb..00000000 --- a/examples/vite/package.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "name": "vite-example", - "private": true, - "version": "0.0.16", - "type": "module", - "scripts": { - "dev": "vite --port 3001", - "build": "tsc && vite build", - "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0", - "preview": "vite preview" - }, - "dependencies": { - "@mayank1513/fork-me": "^2.1.2", - "nthul-lite": "^0.2.3", - "r18gs": "workspace:*", - "react": "^18.3.1", - "react-dom": "^18.3.1", - "shared-ui": "workspace:*" - }, - "devDependencies": { - "@types/react": "^18.3.3", - "@types/react-dom": "^18.3.0", - "@typescript-eslint/eslint-plugin": "^7.12.0", - "@typescript-eslint/parser": "^7.12.0", - "@vitejs/plugin-react-swc": "^3.7.0", - "eslint": "^9.4.0", - "eslint-plugin-react-hooks": "^4.6.2", - "eslint-plugin-react-refresh": "^0.4.7", - "typescript": "^5.4.5", - "vite": "^5.2.12" - } -} diff --git a/examples/vite/public/vite.svg b/examples/vite/public/vite.svg deleted file mode 100644 index e7b8dfb1..00000000 --- a/examples/vite/public/vite.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/examples/vite/src/App.tsx b/examples/vite/src/App.tsx deleted file mode 100644 index 21bf2947..00000000 --- a/examples/vite/src/App.tsx +++ /dev/null @@ -1,5 +0,0 @@ -function App() { - return

Vite + React + TS Example

; -} - -export default App; diff --git a/examples/vite/src/main.tsx b/examples/vite/src/main.tsx deleted file mode 100644 index 684a45aa..00000000 --- a/examples/vite/src/main.tsx +++ /dev/null @@ -1,15 +0,0 @@ -import React from "react"; -import ReactDOM from "react-dom/client"; -import App from "./App.tsx"; -import { SharedRootLayout } from "shared-ui"; - -const rootElement = document.getElementById("root"); -if (!rootElement) throw new Error("Root element not found"); - -ReactDOM.createRoot(rootElement).render( - - - - - , -); diff --git a/examples/vite/src/vite-env.d.ts b/examples/vite/src/vite-env.d.ts deleted file mode 100644 index 11f02fe2..00000000 --- a/examples/vite/src/vite-env.d.ts +++ /dev/null @@ -1 +0,0 @@ -/// diff --git a/examples/vite/tsconfig.json b/examples/vite/tsconfig.json deleted file mode 100644 index 483d7b4d..00000000 --- a/examples/vite/tsconfig.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2020", - "useDefineForClassFields": true, - "lib": ["ES2020", "DOM", "DOM.Iterable"], - "module": "ESNext", - "skipLibCheck": true, - - /* Bundler mode */ - "moduleResolution": "bundler", - "allowImportingTsExtensions": true, - "resolveJsonModule": true, - "isolatedModules": true, - "noEmit": true, - "jsx": "react-jsx", - - /* Linting */ - "strict": true, - "noUnusedParameters": true, - "noFallthroughCasesInSwitch": true - }, - "include": ["src"], - "references": [{ "path": "./tsconfig.node.json" }] -} diff --git a/examples/vite/tsconfig.node.json b/examples/vite/tsconfig.node.json deleted file mode 100644 index 42872c59..00000000 --- a/examples/vite/tsconfig.node.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "compilerOptions": { - "composite": true, - "skipLibCheck": true, - "module": "ESNext", - "moduleResolution": "bundler", - "allowSyntheticDefaultImports": true - }, - "include": ["vite.config.ts"] -} diff --git a/examples/vite/vite.config.ts b/examples/vite/vite.config.ts deleted file mode 100644 index 41114b5e..00000000 --- a/examples/vite/vite.config.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { defineConfig } from "vite"; -import react from "@vitejs/plugin-react-swc"; - -// https://vitejs.dev/config/ -export default defineConfig({ - plugins: [react()], -}); diff --git a/lib/r18gs/.eslintrc.js b/lib/r18gs/.eslintrc.js deleted file mode 100644 index 05ac2b2b..00000000 --- a/lib/r18gs/.eslintrc.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - extends: ["custom/react-internal"], -}; diff --git a/lib/r18gs/.gitignore b/lib/r18gs/.gitignore deleted file mode 100644 index 06435e20..00000000 --- a/lib/r18gs/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -# tsup build -dist diff --git a/lib/r18gs/CHANGELOG.md b/lib/r18gs/CHANGELOG.md deleted file mode 100644 index 5cb32d76..00000000 --- a/lib/r18gs/CHANGELOG.md +++ /dev/null @@ -1,110 +0,0 @@ -# r18gs - -## 1.1.1 - -### Patch Changes - -- Refactor to reduce minzip size - -## 1.1.0 - -### Minor Changes - -- Support initializer function. Now you can initialize the RGStore by supplying a function in place of constant. - -## 1.0.2 - -### Patch Changes - -- Refactor to reduce minzip size - -## 1.0.1 - -### Patch Changes - -- Fix SSR build - -## 1.0.0 - -### Major Changes - -- Removed `serverValue` field as it should always be same as `value`. For more details please check out documentation of useSyncExternalStore hook provided by react. - -### Minor Changes - -- Added persist plugin to create state that is persisted and synced between browser contexts. -- Added `useRGSWithPlugins` hook to support extending the store functionality with plugins. - -### Patch Changes - -- Refactored to reduce bundle size and improve stability and reduce likelyhood of bugs. - -## 0.2.0 - -### Minor Changes - -- 81b9d3f: Make the library extensible with plugins - -### Patch Changes - -- Add Persist and Sync plugin - -## 0.1.4 - -### Patch Changes - -- Fix ESM builds - -## 0.1.3 - -### Patch Changes - -- Quick Fix the build setup and fix library issues. - -## 0.1.2 - -### Patch Changes - -- Improve minification - -## 0.1.1 - -### Patch Changes - -- Refactor without changing the exposed APIs. Some libraries using internal APIs may face temporary issues. - -## 0.1.0 - -### Minor Changes - -- Remove client side hooks. Now this store works well with server components as well. Though, server side use is tricky and not recommended yet. - -## 0.0.5 - -### Patch Changes - -- Fix Typescript error - -## 0.0.4 - -### Patch Changes - -- Fix getServerSnapshot errors on some projects. - -## 0.0.3 - -### Patch Changes - -- Fix exports; improve examples; Update README - -## 0.0.2 - -### Patch Changes - -- Export SetStateAction and SetterArgTypes for better documentation and ease of use for other TS projects. - -## 0.0.1 - -### Patch Changes - -- Fix publish setup diff --git a/lib/r18gs/README.md b/lib/r18gs/README.md deleted file mode 100644 index ddb13a72..00000000 --- a/lib/r18gs/README.md +++ /dev/null @@ -1,75 +0,0 @@ -# React18GlobalStore - -[![test](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/ec3140063acd8df82481/maintainability)](https://codeclimate.com/github/react18-tools/react18-global-store/maintainability) [![codecov](https://codecov.io/gh/react18-tools/react18-global-store/graph/badge.svg)](https://codecov.io/gh/react18-tools/react18-global-store) [![Version](https://img.shields.io/npm/v/r18gs.svg?colorB=green)](https://www.npmjs.com/package/r18gs) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/r18gs.svg)](https://www.npmjs.com/package/r18gs) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/r18gs) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) - -## Motivation - -I've developed fantastic libraries leveraging React18 features using Zustand, and they performed admirably. However, when attempting to import from specific folders for better tree-shaking, the libraries encountered issues. Each import resulted in a separate Zustand store being created, leading to increased package size. - -As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking. - -## Features - -✅ Full TypeScript Support - -✅ Unleash the full power of React18 Server components - -✅ Compatible with all build systems/tools/frameworks for React18 - -✅ Documented with [Typedoc](https://react18-tools.github.io/react18-global-store) ([Docs](https://react18-tools.github.io/react18-global-store)) - -✅ Examples for Next.js, Vite, and Remix - -## Simple Global State Shared Across Multiple Components - -Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components. - -```tsx -const [state, setState] = useRGS("counter", 1); -``` - -**_or_** - -```tsx -const [state, setState] = useRGS("counter", () => 1); -``` - -> For detailed instructions, see [Getting Started](./md-docs/1.getting-started.md) - -## Using Plugins - -Enhance the functionality of the store by leveraging either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`, enabling features such as storing to local storage, among others. - -```tsx -// store.ts -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */ - -export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]); -``` - -Now, you can utilize `useMyPersistentCounterStore` similarly to `useState` without specifying an initial value. - -```tsx -const [persistedCount, setPersistedCount] = useMyPersistentCounterStore(); -``` - -> For detailed instructions, see [Leveraging Plugins](./md-docs/2.leveraging-plugins.md) - -## Contributing - -See [contributing.md](/contributing.md) - -### 🤩 Don't forget to star [this repo](https://github.com/mayank1513/react18-global-store)! - -Interested in hands-on courses for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE) - -![Repo Stats](https://repobeats.axiom.co/api/embed/ec3e74d795ed805a0fce67c0b64c3f08872e7945.svg "Repobeats analytics image") - -## License - -Licensed under the MPL 2.0 open source license. - -
- -

with 💖 by Mayank Kumar Chaudhari

diff --git a/lib/r18gs/package.json b/lib/r18gs/package.json deleted file mode 100644 index cc9f74a9..00000000 --- a/lib/r18gs/package.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "name": "r18gs", - "author": "Mayank Kumar Chaudhari ", - "private": false, - "version": "1.1.1", - "description": "A simple yet elegant, light weight, react18 global store to replace Zustand for better tree shaking.", - "main": "./dist/index.js", - "types": "./dist/index.d.ts", - "module": "./dist/index.mjs", - "files": [ - "dist/**" - ], - "repository": { - "type": "git", - "url": "git+https://github.com/react18-tools/react18-global-store.git" - }, - "bugs": { - "url": "https://github.com/react18-tools/react18-global-store/issues" - }, - "homepage": "https://react18-global-store.vercel.app/", - "sideEffects": false, - "license": "MPL-2.0", - "scripts": { - "test": "vitest run --coverage", - "build": "tsup src && tsc -p tsconfig-build.json", - "doc": "cp ../../README.md . && typedoc && cp -r ../../md-docs ../../docs/", - "publish-package": "cp ../../README.md . && npm publish --provenance --access public", - "lint": "eslint ." - }, - "devDependencies": { - "@testing-library/react": "^16.0.0", - "@turbo/gen": "^2.0.1", - "@types/node": "^20.14.1", - "@types/react": "^18.3.3", - "@types/react-dom": "^18.3.0", - "@vitejs/plugin-react": "^4.3.0", - "@vitest/coverage-v8": "^1.6.0", - "eslint-config-custom": "workspace:*", - "jsdom": "^24.1.0", - "octokit": "^4.0.2", - "react": "^18.3.1", - "tsconfig": "workspace:*", - "tsup": "^8.1.0", - "typedoc": "^0.25.13", - "typedoc-plugin-mdn-links": "^3.1.28", - "typedoc-plugin-missing-exports": "^2.2.0", - "typedoc-plugin-rename-defaults": "^0.7.0", - "typedoc-plugin-zod": "^1.1.2", - "typescript": "^5.4.5", - "vite-tsconfig-paths": "^4.3.2", - "vitest": "^1.6.0" - }, - "peerDependencies": { - "@types/react": "16.8 - 18", - "react": "16.8 - 18" - }, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/mayank1513" - }, - "https://pages.razorpay.com/mayank1513" - ], - "keywords": [ - "react18-global-store", - "nextjs", - "nextjs13", - "nextjs14", - "react", - "react18", - "zustand", - "zen-store", - "react-global-store", - "react-server-components", - "react-client-components", - "typescript", - "javascript", - "mayank1513", - "turborepo-trmplate" - ] -} diff --git a/lib/r18gs/src/Guides.ts b/lib/r18gs/src/Guides.ts deleted file mode 100644 index b7c4d750..00000000 --- a/lib/r18gs/src/Guides.ts +++ /dev/null @@ -1,155 +0,0 @@ -/** -# Quick Start - -Welcome to the quick guide for using this library. - -## Installation - -To get started, you can install the package via your preferred package manager. Here are a few examples: - -```bash -$ pnpm add r18gs -``` - -or - -```bash -$ npm install r18gs -``` - -or - -```bash -$ yarn add r18gs -``` - -## Usage - -Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components. - -```tsx -const [state, setState] = useRGS("counter", 1); -``` - -You can access the same state across all client-side components using a unique key. - -> It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts. - -### Example - -```tsx -// constants/global-states.ts -export const COUNTER = "counter"; -``` - -```tsx -// components/display.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Display() { - const [count] = useRGS(COUNTER); - return ( -
-

Client Component 2

- {count} -
- ); -} -``` - -```tsx -// components/counter.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Counter() { - const [count, setCount] = useRGS(COUNTER, 0); - return ( -
-

Client Component 1

- { - setCount(parseInt(e.target.value.trim())); - }} - type="number" - value={count} - /> -
- ); -} -``` - */ -export const A_Quick_Start = "Quick Start"; - -/** - * # Leveraging Plugins - -Enhance your store's functionality by utilizing either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`. This enables features such as storing to local storage, among others. - -## Creating a Store with the `create` Function - -```tsx -// store.ts -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; // You can create your own plugin or import third-party plugins - -export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]); -``` - -Now you can utilize `useMyPersistentCounterStore` similar to `useState` without specifying an initial value. - -```tsx -// inside your component -const [persistedCount, setPersistedCount] = useMyPersistentCounterStore(); -``` - -## Utilizing the `useRGSWithPlugins` Hook - -This function is beneficial if your requirements dictate that your `key` and/or initial value will depend on some props, etc. Or for some other reason you want to initialize the store from within a component (You need to use some variables available inside the component). - -```tsx -import { useRGSWithPlugins } from "r18gs/dist/with-plugin"; - -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useRGSWithPlugins( - props.key, - props.initialVal, - props.plugins, - props.doNotInit, - ); - // ... -} -``` - -### `doNotInit` - -In some cases, you may not want to initialize the store immediately. In such cases, you can pass the fourth argument (`doNotInit`) as `true`. The default value is false. - -- When this argument is set to `true`, the store is created, but the setter function is set to null. Thus, you can access the initial value set by the first component that triggered this hook. However, it cannot be modified until the store is initialized, i.e., the hook is invoked by a component setting `doNotInit` to false (or skipping this argument). - -**Use case**: When you need that the store be used in many components, however, it should be initialized in a particular component only. - -## Creating a Custom Hook using the `withPlugins` Higher-Order Function - -This is a utility function that will be very helpful when you want to use the `useRGSWithPlugins` hook with the same plugins in multiple components. - -```ts -// custom hook file, e.g., store.ts -export const useMyRGS = withPlugins([plugin1, plugin2, ...]); -``` - -```tsx -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit); - // ... -} -``` - -You can also create your own plugins. Refer to [Creating Plugins](./3.creating-plugins.md). - */ -export const B_Leveraging_Plugins = "Leveraging Plugins"; diff --git a/lib/r18gs/src/index.ts b/lib/r18gs/src/index.ts deleted file mode 100644 index 8ac4319a..00000000 --- a/lib/r18gs/src/index.ts +++ /dev/null @@ -1,35 +0,0 @@ -/* eslint-disable @typescript-eslint/non-nullable-type-assertion-style -- as ! operator is forbidden by eslint*/ -import { createHook, createSetter, createSubcriber, globalRGS } from "./utils"; - -import type { SetStateAction, ValueType } from "./utils"; - -export type { SetterArgType, SetStateAction, Plugin } from "./utils"; - -/** - * Use this hook similar to `useState` hook. - * The difference is that you need to pass a - * unique key - unique across the app to make - * this state accessible to all client components. - * - * @example - * ```tsx - * const [state, setState] = useRGS("counter", 1); - * ``` - * - * @param key - Unique key to identify the store. - * @param value - Initial value of the store. - * @returns - A tuple (Ordered sequance of values) containing the state and a function to set the state. - */ -export default (key: string, value?: ValueType): [T, SetStateAction] => { - /** Initialize the named store when invoked for the first time. */ - if (!globalRGS[key]) - globalRGS[key] = [ - // @ts-expect-error -- ok - typeof value === "function" ? value() : value, - [], - createSetter(key), - createSubcriber(key), - ]; - - return createHook(key); -}; diff --git a/lib/r18gs/src/plugins/index.ts b/lib/r18gs/src/plugins/index.ts deleted file mode 100644 index 8818f742..00000000 --- a/lib/r18gs/src/plugins/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./persist"; diff --git a/lib/r18gs/src/plugins/persist.ts b/lib/r18gs/src/plugins/persist.ts deleted file mode 100644 index 29f75477..00000000 --- a/lib/r18gs/src/plugins/persist.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { Plugin } from ".."; - -export interface PersistOptions { - /** @defaultValue true */ - sync?: boolean; - /** @defaultValue local */ - storage?: "local" | "session" | "cookie"; -} - -/** get stored item */ -const getItem = (key: string, options?: PersistOptions) => { - const cookie = document.cookie.split("; ").find(c => c.startsWith(key)); - switch (options?.storage) { - case "cookie": - return cookie?.split("=")[1]; - case "session": - return sessionStorage.getItem(key); - default: - return localStorage.getItem(key); - } -}; - -/** set item to persistant store */ -const setItem = (key: string, value: string, options?: PersistOptions) => { - switch (options?.storage) { - case "cookie": - document.cookie = `${key}=${value}; max-age=31536000; SameSite=Strict;`; - if (options.sync ?? true) sessionStorage.setItem(key, value); - return; - case "session": - sessionStorage.setItem(key, value); - return; - default: - localStorage.setItem(key, value); - } -}; -/** - * A plugin that persists and syncs RGS store between tabs. - * - * @returns A plugin that persists and syncs a value between tabs. - */ -export const persist = (options?: PersistOptions): Plugin => { - return { - init(key, _, mutate) { - if (typeof window === "undefined") return; - const persistedValue = getItem(key, options); - const newVal = JSON.parse(persistedValue || "{}").val; - if (newVal) mutate(newVal); - - if (options?.sync ?? true) { - addEventListener("storage", e => { - if (e.key === key && e.newValue) { - const newVal = JSON.parse(e.newValue).val; - if (newVal !== undefined) mutate(newVal); - } - }); - } - }, - onChange(key, value) { - if (typeof window !== "undefined") { - setItem(key, JSON.stringify({ val: value }), options); - } - }, - }; -}; diff --git a/lib/r18gs/src/utils.ts b/lib/r18gs/src/utils.ts deleted file mode 100644 index f35cd979..00000000 --- a/lib/r18gs/src/utils.ts +++ /dev/null @@ -1,138 +0,0 @@ -import { useSyncExternalStore } from "react"; - -type Listener = () => void; -type Subscriber = (l: Listener) => () => void; - -export type SetterArgType = T | ((prevState: T) => T); -export type SetStateAction = (value: SetterArgType) => void; -export type ValueType = T | (() => T); - -/** - * This is a hack to reduce lib size + readability + not encouraging direct access to globalThis - */ -const [VALUE, LISTENERS, SETTER, SUBSCRIBER] = [0, 1, 2, 3, 4]; -type RGS = [unknown, Listener[], SetStateAction | null, Subscriber]; - -declare global { - // eslint-disable-next-line no-var -- var required for global declaration. - // skipcq: JS-0102, JS-0239 - var rgs: Record; -} - -const globalThisForBetterMinification = globalThis; -globalThisForBetterMinification.rgs = {}; -export const globalRGS = globalThisForBetterMinification.rgs; - -/** trigger all listeners */ -const triggerListeners = (rgs: RGS) => - (rgs[LISTENERS] as Listener[]).forEach(listener => listener()); - -/** craete subscriber function to subscribe to the store. */ -export const createSubcriber = (key: string): Subscriber => { - return listener => { - const rgs = globalRGS[key] as RGS; - (rgs[LISTENERS] as Listener[]).push(listener); - return () => { - rgs[LISTENERS] = (rgs[LISTENERS] as Listener[]).filter(l => l !== listener); - }; - }; -}; - -/** setter function to set the state. */ -export const createSetter = (key: string): SetStateAction => { - return val => { - const rgs = globalRGS[key] as RGS; - rgs[VALUE] = typeof val === "function" ? val(rgs[VALUE] as T) : val; - (rgs[LISTENERS] as Listener[]).forEach(listener => listener()); - }; -}; - -/** Extract coomon create hook logic to utils */ -export const createHook = (key: string): [T, SetStateAction] => { - const rgs = globalRGS[key] as RGS; - /** This function is called by react to get the current stored value. */ - const getSnapshot = () => rgs[VALUE] as T; - const val = useSyncExternalStore(rgs[SUBSCRIBER] as Subscriber, getSnapshot, getSnapshot); - return [val, rgs[SETTER] as SetStateAction]; -}; - -type Mutate = (value?: T) => void; - -export type Plugin = { - init?: (key: string, value: T | undefined, mutate: Mutate) => void; - onChange?: (key: string, value?: T) => void; -}; - -let allExtentionsInitialized = false; -/** Initialize extestions - wait for previous plugins's promise to be resolved before processing next */ -const initPlugins = async (key: string, plugins: Plugin[]) => { - const rgs = globalRGS[key] as RGS; - /** Mutate function to update the value */ - const mutate: Mutate = newValue => { - rgs[VALUE] = newValue; - triggerListeners(rgs); - }; - for (const plugin of plugins) { - /** Next plugins initializer will get the new value if updated by previous one */ - await plugin.init?.(key, rgs[VALUE] as T, mutate); - } - allExtentionsInitialized = true; -}; - -/** Initialize the named store when invoked for the first time. */ -export const initWithPlugins = ( - key: string, - value?: ValueType, - plugins: Plugin[] = [], - doNotInit = false, -) => { - value = value instanceof Function ? value() : value; - if (doNotInit) { - /** You will not have access to the setter until initialized */ - globalRGS[key] = [value, [], null, createSubcriber(key)]; - return; - } - /** setter function to set the state. */ - const setterWithPlugins: SetStateAction = val => { - /** Do not allow mutating the store before all extentions are initialized */ - if (!allExtentionsInitialized) return; - const rgs = globalRGS[key] as RGS; - rgs[VALUE] = val instanceof Function ? val(rgs[VALUE] as T) : val; - triggerListeners(rgs); - plugins.forEach(plugin => plugin.onChange?.(key, rgs[VALUE] as T)); - }; - - const rgs = globalRGS[key]; - if (rgs) { - rgs[VALUE] = value; - rgs[SETTER] = setterWithPlugins; - } else globalRGS[key] = [value, [], setterWithPlugins, createSubcriber(key)]; - initPlugins(key, plugins); -}; - -/** - * Use this hook similar to `useState` hook. - * The difference is that you need to pass a - * unique key - unique across the app to make - * this state accessible to all client components. - * - * @example - * ```tsx - * const [state, setState] = useRGS("counter", 1); - * ``` - * - * @param key - Unique key to identify the store. - * @param value - Initial value of the store. - * @param plugins - Plugins to be applied to the store. - * @param doNotInit - Do not initialize the store. Useful when you want to initialize the store later. Note that the setter function is not available until the store is initialized. - * @returns - A tuple (Ordered sequance of values) containing the state and a function to set the state. - */ -export const useRGSWithPlugins = ( - key: string, - value?: ValueType, - plugins?: Plugin[], - doNotInit = false, -): [T, SetStateAction] => { - if (!globalRGS[key]?.[SETTER]) initWithPlugins(key, value, plugins, doNotInit); - return createHook(key); -}; diff --git a/lib/r18gs/src/with-plugins.ts b/lib/r18gs/src/with-plugins.ts deleted file mode 100644 index 804a293a..00000000 --- a/lib/r18gs/src/with-plugins.ts +++ /dev/null @@ -1,58 +0,0 @@ -/* eslint-disable @typescript-eslint/non-nullable-type-assertion-style -- as ! operator is forbidden by eslint*/ -import { useRGSWithPlugins } from "./utils"; - -import type { Plugin, SetStateAction } from "./utils"; - -/** - * Creates a store with plugins. - * @example - * - * ```tsx - * // in hook file, e.g., store.ts - * export const useMyRGS = create(key, value, plugins); - * - * // in component file - * const [state, setState] = useMyRGS(); - * ``` - * - * @param key - Unique key to identify the store. - * @param value - Initial value of the store. - * @param plugins - Plugins to be applied to the store. - * @returns - A hook function that returns a tuple (Ordered sequence of values) containing the state and a function to set the state. - */ -export const create = ( - key: string, - value?: T, - plugins?: Plugin[], -): (() => [T, SetStateAction]) => { - return () => useRGSWithPlugins(key, value, plugins); -}; - -/** - * Creates a hook similar to useRGS, but with plugins to be applied on first invocation. - * - * @param plugins - Plugins to be applied to the store. - * @returns A hook that automatically initializes the store (if not already initialized) with the given plugins. - */ -export const withPlugins = ( - plugins: Plugin[], -): ((key: string, value?: U, doNotInit?: boolean) => [U, SetStateAction]) => { - /** - * Creates a hook similar to useRGS, with plugins applied on first invocation. - * - * @param key - Unique key to identify the store. - * @param value - Initial value of the store. - * @param doNotInit - If true, the store won't be initialized immediately. Defaults to false. Useful when you want to initialize the store later. Note that the setter function is not available until the store is initialized. - * @returns A tuple containing the state value and its setter function. - */ - const hookWithPlugins = ( - key: string, - value?: U, - doNotInit = false, - ): [U, SetStateAction] => - useRGSWithPlugins(key, value, plugins as unknown as Plugin[], doNotInit); - - return hookWithPlugins; -}; - -export { useRGSWithPlugins }; diff --git a/lib/r18gs/tests/create.test.tsx b/lib/r18gs/tests/create.test.tsx deleted file mode 100644 index cfa5d77e..00000000 --- a/lib/r18gs/tests/create.test.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import { describe, test } from "vitest"; -import { act, fireEvent, render, screen } from "@testing-library/react"; -import { create, withPlugins } from "../src/with-plugins"; -import { persist } from "../src/plugins/persist"; -import { ChangeEvent, useCallback } from "react"; - -const COUNTER_RGS_KEY = "counter"; -const TESTID_INPUT = "in1"; -const TESTID_DISPLAY = "d1"; - -const COUNTER2_RGS_KEY = "counter-2"; -const TESTID_INPUT2 = "in2"; -const TESTID_DISPLAY2 = "d2"; - -const useMyRGS = create(COUNTER_RGS_KEY, 0, [persist({ storage: "cookie" })]); - -const useMyRGS2 = withPlugins([persist()]); - -function Component1() { - const [count, setCount] = useMyRGS(); - const [count2, setCount2] = useMyRGS2(COUNTER2_RGS_KEY, 0); - const handleChange = useCallback( - (e: ChangeEvent) => { - setCount(parseInt(e.target.value)); - }, - [setCount], - ); - const handleChange2 = useCallback( - (e: ChangeEvent) => { - setCount2(parseInt(e.target.value)); - }, - [setCount2], - ); - return ( -
- - -
- ); -} - -function Component2() { - const [count] = useMyRGS(); - const [count2] = useMyRGS2(COUNTER2_RGS_KEY, 10, true); - return ( - <> -

{count}

-

{count2}

- - ); -} - -describe("React18GlobalStore", () => { - test("check state update to multiple components", async ({ expect }) => { - render(); - render(); - /** Await and allow for the state to update from localStorate */ - await new Promise(resolve => setTimeout(resolve, 100)); - await act(() => fireEvent.input(screen.getByTestId(TESTID_INPUT), { target: { value: 5 } })); - expect(screen.getByTestId(TESTID_DISPLAY).textContent).toBe("5"); - expect(JSON.parse(sessionStorage.getItem(COUNTER_RGS_KEY) ?? "{}").val).toBe(5); - }); - - test("check state update to multiple components for withPlugins", async ({ expect }) => { - render(); - render(); - /** Await and allow for the state to update from localStorate */ - await new Promise(resolve => setTimeout(resolve, 100)); - await act(() => fireEvent.input(screen.getByTestId(TESTID_INPUT2), { target: { value: 5 } })); - expect(screen.getByTestId(TESTID_DISPLAY2).textContent).toBe("5"); - expect(JSON.parse(localStorage.getItem(COUNTER2_RGS_KEY) ?? "{}").val).toBe(5); - }); - - test("storage event", async ({ expect }) => { - render(); - render(); - /** Await and allow for the state to update from localStorate */ - await new Promise(resolve => setTimeout(resolve, 100)); - await act(() => - window.dispatchEvent( - new StorageEvent("storage", { - key: COUNTER_RGS_KEY, - newValue: JSON.stringify({ val: 15 }), - }), - ), - ); - expect(screen.getByTestId(TESTID_DISPLAY).textContent).toBe("15"); - }); -}); diff --git a/lib/r18gs/tests/plugins/persist.test.tsx b/lib/r18gs/tests/plugins/persist.test.tsx deleted file mode 100644 index 3fceadb5..00000000 --- a/lib/r18gs/tests/plugins/persist.test.tsx +++ /dev/null @@ -1,79 +0,0 @@ -import { describe, test } from "vitest"; -import { act, fireEvent, render, screen } from "@testing-library/react"; -import { create } from "../../src/with-plugins"; -import { PersistOptions, persist } from "../../src/plugins"; -import { ChangeEvent, useCallback } from "react"; - -const TESTID_INPUT = "in1"; -const TESTID_DISPLAY = "d1"; - -const persistOptions: PersistOptions[] = [ - {}, - { storage: "local" }, - { storage: "session" }, - { storage: "cookie" }, - { sync: false }, -]; - -describe("React18GlobalStore", () => { - persistOptions.forEach((options, i) => { - const COUNTER_RGS_KEY = `count-${i}`; - const useMyRGS = create(COUNTER_RGS_KEY, 0, [persist(options)]); - - function Component1() { - const [count, setCount] = useMyRGS(); - const handleChange = useCallback( - (e: ChangeEvent) => { - setCount(parseInt(e.target.value)); - }, - [setCount], - ); - return ( -
- -
- ); - } - - function Component2() { - const [count] = useMyRGS(); - return

{count}

; - } - - test(`check state update to multiple components: ${JSON.stringify(options)}`, async ({ - expect, - }) => { - render(); - render(); - /** Await and allow for the state to update from localStorate */ - await new Promise(resolve => setTimeout(resolve, 100)); - await act(() => fireEvent.input(screen.getByTestId(TESTID_INPUT), { target: { value: 5 } })); - expect(screen.getByTestId(TESTID_DISPLAY).textContent).toBe("5"); - expect( - JSON.parse( - ((options.storage ?? "local") === "local" ? localStorage : sessionStorage).getItem( - COUNTER_RGS_KEY, - ) ?? "{}", - ).val, - ).toBe(5); - }); - - if (options.sync ?? true) { - test("storage event", async ({ expect }) => { - render(); - render(); - /** Await and allow for the state to update from localStorate */ - await new Promise(resolve => setTimeout(resolve, 100)); - await act(() => - window.dispatchEvent( - new StorageEvent("storage", { - key: COUNTER_RGS_KEY, - newValue: JSON.stringify({ val: 15 }), - }), - ), - ); - expect(screen.getByTestId(TESTID_DISPLAY).textContent).toBe("15"); - }); - } - }); -}); diff --git a/lib/r18gs/tests/use-rgs.test.tsx b/lib/r18gs/tests/use-rgs.test.tsx deleted file mode 100644 index ceec4e18..00000000 --- a/lib/r18gs/tests/use-rgs.test.tsx +++ /dev/null @@ -1,37 +0,0 @@ -import { describe, test } from "vitest"; -import { act, fireEvent, render, screen } from "@testing-library/react"; -import useRGS from "../src"; -import { ChangeEvent, useCallback } from "react"; - -const COUNT_RGS_KEY = "count"; -const TESTID_INPUT = "in1"; -const TESTID_DISPLAY = "d1"; - -function Component1() { - const [count, setCount] = useRGS(COUNT_RGS_KEY, 0); - const handleChange = useCallback( - (e: ChangeEvent) => { - setCount(parseInt(e.target.value)); - }, - [setCount], - ); - return ( -
- -
- ); -} - -function Component2() { - const [count] = useRGS(COUNT_RGS_KEY); - return

{count}

; -} - -describe("React18GlobalStore", () => { - test("check state update to multiple components", async ({ expect }) => { - render(); - render(); - await act(() => fireEvent.input(screen.getByTestId(TESTID_INPUT), { target: { value: 5 } })); - expect(screen.getByTestId(TESTID_DISPLAY).textContent).toBe("5"); - }); -}); diff --git a/lib/r18gs/tsconfig-build.json b/lib/r18gs/tsconfig-build.json deleted file mode 100644 index fd87a4f2..00000000 --- a/lib/r18gs/tsconfig-build.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "extends": "tsconfig/react-library.json", - "compilerOptions": { - "outDir": "dist", - "emitDeclarationOnly": true, - "declarationMap": false - }, - "include": ["src"], - "exclude": ["dist", "build", "node_modules", "**/*.test.*", "**/*.spec.*"] -} diff --git a/lib/r18gs/tsconfig.json b/lib/r18gs/tsconfig.json deleted file mode 100644 index fd5dc9fa..00000000 --- a/lib/r18gs/tsconfig.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "extends": "tsconfig/react-library.json", - "include": ["."], - "exclude": ["dist", "build", "node_modules"] -} diff --git a/lib/r18gs/tsup.config.ts b/lib/r18gs/tsup.config.ts deleted file mode 100644 index ba544fb6..00000000 --- a/lib/r18gs/tsup.config.ts +++ /dev/null @@ -1,45 +0,0 @@ -import { defineConfig } from "tsup"; -import fs from "node:fs"; - -export default defineConfig(options => ({ - format: ["cjs", "esm"], - target: "es2015", - sourcemap: false, - clean: true, - bundle: true, - minify: !options.watch, - esbuildPlugins: [ - { - name: "improve-minify", - setup(build) { - build.onLoad({ filter: /Guides.ts/ }, () => ({ contents: " ", loader: "ts" })); - - build.onLoad({ filter: /utils.ts/ }, args => { - let contents = fs.readFileSync(args.path, "utf8"); - const lines = contents.split("\n"); - const hackLine = lines.find(line => line.startsWith("const [VALUE,")); - - if (!hackLine) return { contents, loader: "ts" }; - /** remove hackLine */ - contents = contents.replace(hackLine, ""); - - /** clean up */ - const tokens = hackLine - .replace("const", "") - .split("=")[0] - .trim() - .replace(/\]|\[/g, "") - .split(",") - .map((t, i) => ({ token: t.trim(), i })); - - tokens.sort((a, b) => b.token.length - a.token.length); - - for (const t of tokens) { - contents = contents.replace(new RegExp(`${t.token}`, "g"), t.i + ""); - } - return { contents, loader: "ts" }; - }); - }, - }, - ], -})); diff --git a/lib/r18gs/typedoc.config.js b/lib/r18gs/typedoc.config.js deleted file mode 100644 index 7ed20189..00000000 --- a/lib/r18gs/typedoc.config.js +++ /dev/null @@ -1,21 +0,0 @@ -/** @type {import('typedoc').TypeDocOptions} */ -module.exports = { - name: "React18 Global Store", - entryPoints: ["./src"], - exclude: ["**/*.test.tsx"], - entryPointStrategy: "Expand", - out: "../../docs", - commentStyle: "all", - searchInComments: true, - hideGenerator: true, - githubPages: false, - navigationLinks: { - GitHub: "https://github.com/react18-tools/react18-global-store", - }, - plugin: [ - "typedoc-plugin-mdn-links", - "typedoc-plugin-rename-defaults", - "typedoc-plugin-missing-exports", - "typedoc-plugin-zod", - ], -}; diff --git a/lib/r18gs/vitest.config.ts b/lib/r18gs/vitest.config.ts deleted file mode 100644 index 2d58bcf9..00000000 --- a/lib/r18gs/vitest.config.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { defineConfig } from "vitest/config"; -import react from "@vitejs/plugin-react"; -import tsconfigPaths from "vite-tsconfig-paths"; - -// https://vitejs.dev/config/ -export default defineConfig({ - plugins: [react(), tsconfigPaths()], - test: { - environment: "jsdom", - globals: true, - setupFiles: [], - coverage: { - include: ["src/**"], - exclude: ["src/Guides.ts"], - reporter: ["text", "json", "clover", "html"], - }, - }, -}); diff --git a/md-docs/1.getting-started.md b/md-docs/1.getting-started.md deleted file mode 100644 index e951f864..00000000 --- a/md-docs/1.getting-started.md +++ /dev/null @@ -1,94 +0,0 @@ -# Quick Start - -Welcome to the quick guide for using this library. - -## Installation - -To get started, you can install the package via your preferred package manager. Here are a few examples: - -```bash -$ pnpm add r18gs -``` - -or - -```bash -$ npm install r18gs -``` - -or - -```bash -$ yarn add r18gs -``` - -## Usage - -Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components. - -```tsx -const [state, setState] = useRGS("counter", 1); -``` - -You can access the same state across all client-side components using a unique key. - -> It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts. - -### Initializing the state with a function - -In some cases you might want to initialize the state with a function, for example, when reading from `localStorage`. We support initializer function as well. - -```tsx -const [state, setState] = useRGS("counter", () => - typeof localStorage === "undefined" ? 1 : localStorage.getItem("counter") ?? 1, -); -``` - -### Example - -```tsx -// constants/global-states.ts -export const COUNTER = "counter"; -``` - -```tsx -// components/display.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Display() { - const [count] = useRGS(COUNTER); - return ( -
-

Client Component 2

- {count} -
- ); -} -``` - -```tsx -// components/counter.tsx -"use client"; - -import useRGS from "r18gs"; -import { COUNTER } from "../constants/global-states"; - -export default function Counter() { - const [count, setCount] = useRGS(COUNTER, 0); - return ( -
-

Client Component 1

- { - setCount(parseInt(e.target.value.trim())); - }} - type="number" - value={count} - /> -
- ); -} -``` diff --git a/md-docs/2.leveraging-plugins.md b/md-docs/2.leveraging-plugins.md deleted file mode 100644 index e8bd53c2..00000000 --- a/md-docs/2.leveraging-plugins.md +++ /dev/null @@ -1,64 +0,0 @@ -# Leveraging Plugins - -Enhance your store's functionality by utilizing either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`. This enables features such as storing to local storage, among others. - -## Creating a Store with the `create` Function - -```tsx -// store.ts -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */ - -export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]); -``` - -Now you can utilize `useMyPersistentCounterStore` similar to `useState` without specifying an initial value. - -```tsx -// inside your component -const [persistedCount, setPersistedCount] = useMyPersistentCounterStore(); -``` - -## Utilizing the `useRGSWithPlugins` Hook - -This function is beneficial if your requirements dictate that your `key` and/or initial value will depend on some props, etc. Or for some other reason you want to initialize the store from within a component (You need to use some variables available inside the component). - -```tsx -import { useRGSWithPlugins } from "r18gs/dist/with-plugin"; - -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useRGSWithPlugins( - props.key, - props.initialVal, - props.plugins, - props.doNotInit, - ); - // ... -} -``` - -### `doNotInit` - -In some cases, you may not want to initialize the store immediately. In such cases, you can pass the fourth argument (`doNotInit`) as `true`. The default value is false. - -- When this argument is set to `true`, the store is created, but the setter function is set to null. Thus, you can access the initial value set by the first component that triggered this hook. However, it cannot be modified until the store is initialized, i.e., the hook is invoked by a component setting `doNotInit` to false (or skipping this argument). - -**Use case**: When you need that the store be used in many components, however, it should be initialized in a particular component only. - -## Creating a Custom Hook using the `withPlugins` Higher-Order Function - -This is a utility function that will be very helpful when you want to use the `useRGSWithPlugins` hook with the same plugins in multiple components. - -```ts -// custom hook file, e.g., store.ts -export const useMyRGS = withPlugins([plugin1, plugin2, ...]); -``` - -```tsx -export function MyComponent(props: MyComponentProps) { - const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit); - // ... -} -``` - -You can also create your own plugins. Refer to [Creating Plugins](./3.creating-plugins.md). diff --git a/md-docs/3.creating-plugins.md b/md-docs/3.creating-plugins.md deleted file mode 100644 index b7d3cbd8..00000000 --- a/md-docs/3.creating-plugins.md +++ /dev/null @@ -1 +0,0 @@ -# Creating Plugins diff --git a/package.json b/package.json deleted file mode 100644 index c59a0579..00000000 --- a/package.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "private": true, - "scripts": { - "build": "turbo run build", - "dev": "turbo run dev", - "test": "turbo run test", - "doc": "turbo run doc", - "lint": "turbo run lint", - "format": "prettier --write \"**/*.{ts,tsx,js,jsx,md,css,scss}\"" - }, - "devDependencies": { - "@changesets/cli": "^2.27.5", - "eslint": "^9.5.0", - "prettier": "^3.3.2", - "tsconfig": "workspace:*", - "turbo": "^2.0.4" - }, - "name": "r18gs", - "packageManager": "pnpm@9.1.4" -} diff --git a/packages/eslint-config-custom/CHANGELOG.md b/packages/eslint-config-custom/CHANGELOG.md deleted file mode 100644 index 08f8a0f2..00000000 --- a/packages/eslint-config-custom/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# eslint-config-custom - -## 0.0.1 - -### Patch Changes - -- Support Next.js 14 diff --git a/packages/eslint-config-custom/README.md b/packages/eslint-config-custom/README.md deleted file mode 100644 index 8b42d901..00000000 --- a/packages/eslint-config-custom/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# `@turbo/eslint-config` - -Collection of internal eslint configurations. diff --git a/packages/eslint-config-custom/library.js b/packages/eslint-config-custom/library.js deleted file mode 100644 index db32ca2c..00000000 --- a/packages/eslint-config-custom/library.js +++ /dev/null @@ -1,33 +0,0 @@ -const { resolve } = require("node:path"); - -const project = resolve(process.cwd(), "tsconfig.json"); - -/* - * This is a custom ESLint configuration for use with - * typescript packages. - * - * This config extends the Vercel Engineering Style Guide. - * For more information, see https://github.com/vercel/style-guide - * - */ - -module.exports = { - extends: ["@vercel/style-guide/eslint/node", "@vercel/style-guide/eslint/typescript"].map( - require.resolve, - ), - parserOptions: { - project, - }, - globals: { - React: true, - JSX: true, - }, - settings: { - "import/resolver": { - typescript: { - project, - }, - }, - }, - ignorePatterns: ["node_modules/", "dist/"], -}; diff --git a/packages/eslint-config-custom/next.js b/packages/eslint-config-custom/next.js deleted file mode 100644 index 3cee3392..00000000 --- a/packages/eslint-config-custom/next.js +++ /dev/null @@ -1,43 +0,0 @@ -const { resolve } = require("node:path"); - -const project = resolve(process.cwd(), "tsconfig.json"); - -/* - * This is a custom ESLint configuration for use with - * Next.js apps. - * - * This config extends the Vercel Engineering Style Guide. - * For more information, see https://github.com/vercel/style-guide - * - */ - -module.exports = { - extends: [ - "@vercel/style-guide/eslint/node", - "@vercel/style-guide/eslint/typescript", - "@vercel/style-guide/eslint/browser", - "@vercel/style-guide/eslint/react", - "@vercel/style-guide/eslint/next", - "eslint-config-turbo", - ].map(require.resolve), - parserOptions: { - project, - }, - globals: { - React: true, - JSX: true, - }, - settings: { - "import/resolver": { - typescript: { - project, - }, - }, - }, - ignorePatterns: ["node_modules/", "dist/"], - // add rules configurations here - rules: { - "import/no-default-export": "off", - "unicorn/filename-case": "off", - }, -}; diff --git a/packages/eslint-config-custom/package.json b/packages/eslint-config-custom/package.json deleted file mode 100644 index 4d338ef8..00000000 --- a/packages/eslint-config-custom/package.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "name": "eslint-config-custom", - "license": "MIT", - "version": "0.0.1", - "private": true, - "devDependencies": { - "@vercel/style-guide": "^6.0.0", - "eslint-config-turbo": "^2.0.1" - } -} diff --git a/packages/eslint-config-custom/react-internal.js b/packages/eslint-config-custom/react-internal.js deleted file mode 100644 index d944fe95..00000000 --- a/packages/eslint-config-custom/react-internal.js +++ /dev/null @@ -1,40 +0,0 @@ -const { resolve } = require("node:path"); - -const project = resolve(process.cwd(), "tsconfig.json"); - -/* - * This is a custom ESLint configuration for use with - * internal (bundled by their consumer) libraries - * that utilize React. - * - * This config extends the Vercel Engineering Style Guide. - * For more information, see https://github.com/vercel/style-guide - * - */ - -module.exports = { - extends: [ - "@vercel/style-guide/eslint/browser", - "@vercel/style-guide/eslint/typescript", - "@vercel/style-guide/eslint/react", - ].map(require.resolve), - parserOptions: { - project, - }, - globals: { - JSX: true, - }, - settings: { - "import/resolver": { - typescript: { - project, - }, - }, - }, - ignorePatterns: ["node_modules/", "dist/", ".eslintrc.js"], - // add rules configurations here - rules: { - "import/no-default-export": "off", - "@typescript-eslint/explicit-function-return-type": "off", - }, -}; diff --git a/packages/shared-ui/.eslintrc.js b/packages/shared-ui/.eslintrc.js deleted file mode 100644 index 05ac2b2b..00000000 --- a/packages/shared-ui/.eslintrc.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - extends: ["custom/react-internal"], -}; diff --git a/packages/shared-ui/hooks/use-persistant-counter.ts b/packages/shared-ui/hooks/use-persistant-counter.ts deleted file mode 100644 index 18fdf006..00000000 --- a/packages/shared-ui/hooks/use-persistant-counter.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { create } from "r18gs/dist/with-plugins"; -import { persist } from "r18gs/dist/plugins"; - -export const useMyPersistentCounterStore = create("persistent-counter", 1, [persist()]); diff --git a/packages/shared-ui/index.ts b/packages/shared-ui/index.ts deleted file mode 100644 index 3bd16e17..00000000 --- a/packages/shared-ui/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./src"; diff --git a/packages/shared-ui/package.json b/packages/shared-ui/package.json deleted file mode 100644 index 298eb621..00000000 --- a/packages/shared-ui/package.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "name": "shared-ui", - "author": "Mayank Kumar Chaudhari ", - "private": true, - "version": "0.0.0", - "description": "Shared UI Package", - "main": "./index.ts", - "types": "./index.ts", - "scripts": { - "lint": "eslint ." - }, - "devDependencies": { - "@mayank1513/fork-me": "^2.1.2", - "@types/node": "^20.14.1", - "@types/react": "^18.3.3", - "@types/react-dom": "^18.3.0", - "eslint-config-custom": "workspace:*", - "next": "^14.2.3", - "r18gs": "workspace:*", - "react": "^18.3.1", - "tsconfig": "workspace:*", - "typescript": "5.4.5" - }, - "dependencies": { - "eslint": "^9.4.0", - "nthul-lite": "^0.2.3" - } -} diff --git a/packages/shared-ui/src/cards/card.tsx b/packages/shared-ui/src/cards/card.tsx deleted file mode 100644 index ac1b091b..00000000 --- a/packages/shared-ui/src/cards/card.tsx +++ /dev/null @@ -1,18 +0,0 @@ -import styles from "./cards.module.css"; - -interface CardProps { - href: string; - title: string; - description: string; -} - -export function Card({ href, title, description }: CardProps) { - return ( - -

- {title} -> -

-

{description}

- - ); -} diff --git a/packages/shared-ui/src/cards/cards.module.css b/packages/shared-ui/src/cards/cards.module.css deleted file mode 100644 index 050430d1..00000000 --- a/packages/shared-ui/src/cards/cards.module.css +++ /dev/null @@ -1,75 +0,0 @@ -.cards { - display: flex; - justify-content: space-evenly; - flex-wrap: wrap; - gap: 25px; - width: var(--max-width); - max-width: 95vw; -} - -.card { - all: unset; - display: flex; - flex-direction: column; - padding: 1rem 1.2rem; - border-radius: var(--border-radius); - background: rgba(var(--card-rgb), 0); - border: 1px solid rgba(var(--card-border-rgb), 0.1); - cursor: pointer; - transition: - background 200ms, - border 200ms; -} - -.card span { - display: inline-block; - transition: transform 200ms; -} - -.card h2 { - font-weight: 600; - margin-top: 0; - text-align: start; -} - -.card p { - margin: 0; - opacity: 0.6; - font-size: 0.9rem; - line-height: 1.5; - width: 34ch; - text-align: start; -} - -.card nav { - display: flex; - gap: 15px; - padding-top: 10px; -} - -.card nav select { - flex-grow: 1; -} - -/* Enable hover only on non-touch devices */ -@media (hover: hover) and (pointer: fine) { - .card:hover { - background: rgba(var(--card-rgb), 0.1); - border: 1px solid rgba(var(--card-border-rgb), 0.15); - } - - .card:hover span { - transform: translateX(4px); - } -} - -/* Mobile and Tablet */ -@media (max-width: 1023px) { - .card { - padding: 1rem 2.5rem; - } - - .card h2 { - margin-bottom: 0.5rem; - } -} diff --git a/packages/shared-ui/src/cards/index.tsx b/packages/shared-ui/src/cards/index.tsx deleted file mode 100644 index c2a91604..00000000 --- a/packages/shared-ui/src/cards/index.tsx +++ /dev/null @@ -1,27 +0,0 @@ -import styles from "./cards.module.css"; -import { StarMeCard } from "./star-me-card"; -import { Card } from "./card"; - -const cards = [ - { - href: "https://react18-tools.github.io/r18gs/", - title: "Docs", - description: "Explore the official docs.", - }, - { - href: "https://github.com/react18-tools/r18gs", - title: "More Examples", - description: "Explore more examples on official GitHub Repo.", - }, -]; - -export function Cards() { - return ( -
- {cards.map(card => ( - - ))} - -
- ); -} diff --git a/packages/shared-ui/src/cards/star-me-card.tsx b/packages/shared-ui/src/cards/star-me-card.tsx deleted file mode 100644 index e4c68510..00000000 --- a/packages/shared-ui/src/cards/star-me-card.tsx +++ /dev/null @@ -1,13 +0,0 @@ -import { StarMe } from "@mayank1513/fork-me"; -import styles from "./cards.module.css"; - -export function StarMeCard() { - return ( - -

- Star this repo -> -

-

Star this repo for your new library!

- - ); -} diff --git a/packages/shared-ui/src/common/logo.tsx b/packages/shared-ui/src/common/logo.tsx deleted file mode 100644 index 9a336de6..00000000 --- a/packages/shared-ui/src/common/logo.tsx +++ /dev/null @@ -1,5 +0,0 @@ -import type { HTMLProps } from "react"; - -export function Logo(props: HTMLProps) { - return r18gs; -} diff --git a/packages/shared-ui/src/common/select.tsx b/packages/shared-ui/src/common/select.tsx deleted file mode 100644 index bbacd8fb..00000000 --- a/packages/shared-ui/src/common/select.tsx +++ /dev/null @@ -1,25 +0,0 @@ -import type { HTMLProps, ReactNode } from "react"; - -export interface SelectOptionsProps { - value: string; - children: ReactNode; -} - -interface SelectProps extends HTMLProps { - options: string[] | SelectOptionsProps[]; -} - -export function Select({ options, ...props }: SelectProps) { - const renderOptions = options.map(option => - typeof option === "string" ? { value: option, children: option } : option, - ); - return ( - - ); -} diff --git a/packages/shared-ui/src/constants/global-states.ts b/packages/shared-ui/src/constants/global-states.ts deleted file mode 100644 index 6c534d24..00000000 --- a/packages/shared-ui/src/constants/global-states.ts +++ /dev/null @@ -1 +0,0 @@ -export const COUNTER = "counter"; diff --git a/packages/shared-ui/src/declaration.d.ts b/packages/shared-ui/src/declaration.d.ts deleted file mode 100644 index a1421d73..00000000 --- a/packages/shared-ui/src/declaration.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -declare module "*.module.css" { - const classNames: Record; - export = classNames; -} diff --git a/packages/shared-ui/src/globals.css b/packages/shared-ui/src/globals.css deleted file mode 100644 index a88be8e2..00000000 --- a/packages/shared-ui/src/globals.css +++ /dev/null @@ -1,115 +0,0 @@ -* { - box-sizing: border-box; -} - -:root { - --max-width: 1100px; - --border-radius: 12px; - --font-mono: ui-monospace, Menlo, Monaco, "Cascadia Mono", "Segoe UI Mono", "Roboto Mono", - "Oxygen Mono", "Ubuntu Monospace", "Source Code Pro", "Fira Mono", "Droid Sans Mono", - "Courier New", monospace; - --bg-color: #fff; - --text-color: #000; - - --primary-glow: conic-gradient( - from 180deg at 50% 50%, - #16abff33 0deg, - #0885ff33 55deg, - #54d6ff33 120deg, - #0071ff33 160deg, - transparent 360deg - ); - --secondary-glow: radial-gradient(rgba(255, 255, 255, 1), rgba(255, 255, 255, 0)); - - --callout-rgb: 238, 240, 241; - --callout-border-rgb: 172, 175, 176; - --card-rgb: 180, 185, 188; - --card-border-rgb: 131, 134, 135; - --tile-border: conic-gradient( - #00000080, - #00000040, - #00000030, - #00000020, - #00000010, - #00000010, - #00000080 - ); -} - -/* dark themes */ -.dark, -.dark ~ * { - --bg-color: #000; - --text-color: #fff; -} - -.dark, -.dark ~ * { - --primary-glow: radial-gradient(rgba(1, 65, 255, 0.4), rgba(1, 65, 255, 0)); - --secondary-glow: linear-gradient( - to bottom right, - rgba(1, 65, 255, 0), - rgba(1, 65, 255, 0), - rgba(1, 65, 255, 0.3) - ); - - --callout-rgb: 20, 20, 20; - --callout-border-rgb: 108, 108, 108; - --card-rgb: 100, 100, 100; - --card-border-rgb: 200, 200, 200; - --tile-border: conic-gradient( - #ffffff80, - #ffffff40, - #ffffff30, - #ffffff20, - #ffffff10, - #ffffff10, - #ffffff80 - ); -} - -/* light themes */ - -.light, -.light ~ * { - --bg-color: #fff; - --text-color: #000; -} - -html { - padding: 0; - margin: 0; -} - -body, -#root { - padding: 0; - margin: 0; - min-height: 100vh; - display: flex; - flex-direction: column; -} - -main, -footer { - background: var(--bg-color); - color: var(--text-color); -} - -main { - flex-grow: 1; -} - -footer { - text-align: center; - padding: 10px; -} - -a { - color: inherit; - text-decoration: none; -} - -.grow { - flex-grow: 1; -} diff --git a/packages/shared-ui/src/index.ts b/packages/shared-ui/src/index.ts deleted file mode 100644 index 1c2c847f..00000000 --- a/packages/shared-ui/src/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./root-layout"; diff --git a/packages/shared-ui/src/root-layout.module.css b/packages/shared-ui/src/root-layout.module.css deleted file mode 100644 index d2eb0df6..00000000 --- a/packages/shared-ui/src/root-layout.module.css +++ /dev/null @@ -1,153 +0,0 @@ -.main { - display: flex; - flex-direction: column; - justify-content: space-between; - align-items: center; - padding: 3rem 0; - min-height: calc(100vh - 55px); -} - -.description { - display: flex; - justify-content: space-between; - align-items: center; - flex-wrap: nowrap !important; - font-size: 0.85rem; - max-width: var(--max-width); - width: 100%; - z-index: 2; - font-family: var(--font-mono); - padding: 10px; - padding-right: 100px; - position: sticky; - top: 0; - backdrop-filter: blur(3px); -} - -.description a { - display: flex; - align-items: center; - justify-content: center; - gap: 0.5rem; -} - -.description p { - position: relative; - margin: 0; - padding: 1rem; - background-color: rgba(var(--callout-rgb), 0.5); - border: 1px solid rgba(var(--callout-border-rgb), 0.3); - border-radius: var(--border-radius); -} - -.code { - font-weight: 700; - font-family: var(--font-mono); -} - -.center { - display: flex; - justify-content: center; - align-items: center; - position: relative; - flex-wrap: wrap; - padding: 3rem; - gap: 20px 50px; -} - -.center > div { - position: relative; -} - -.center::before { - background: var(--secondary-glow); - border-radius: 50%; - width: 480px; - height: 360px; - margin-left: -400px; - pointer-events: none; -} - -.center::after { - background: var(--primary-glow); - width: 240px; - height: 180px; - z-index: -1; -} - -.center::before, -.center::after { - content: ""; - left: 50%; - position: absolute; - filter: blur(45px); - transform: translateZ(0); -} - -.logo { - position: relative; - display: flex; - justify-content: center; - align-items: center; - margin-left: 16px; - transform: translateZ(0); - border-radius: var(--border-radius); - overflow: hidden; - box-shadow: 0px 2px 8px -1px #0000001a; - padding: 2px; -} -.logo p { - background: var(--bg-color); -} -.logo::before, -.logo::after { - content: " "; - position: absolute; - z-index: -1; -} - -/* Conic Gradient Animation */ -.logo::before { - animation: 3s rotate infinite linear; - width: 800%; - height: 800%; - background: var(--tile-border); -} - -/* Inner Square */ -.logo::after { - inset: 0; - padding: 1px; - border-radius: var(--border-radius); - background: linear-gradient( - to bottom right, - rgba(var(--tile-start-rgb), 1), - rgba(var(--tile-end-rgb), 1) - ); - background-clip: content-box; -} - -.by { - display: flex; - gap: 20px; -} - -/* Mobile and Tablet */ -@media (max-width: 800px) { - .center { - padding: 4rem; - } - .description { - padding: 30px; - padding-right: 100px; - } -} - -@keyframes rotate { - from { - transform: rotate(360deg); - } - to { - transform: rotate(0deg); - } -} diff --git a/packages/shared-ui/src/root-layout.tsx b/packages/shared-ui/src/root-layout.tsx deleted file mode 100644 index 171001ae..00000000 --- a/packages/shared-ui/src/root-layout.tsx +++ /dev/null @@ -1,32 +0,0 @@ -import "./globals.css"; -import "nthul-lite/styles.css"; -import { ThemeSwitcher } from "nthul-lite/client/theme-switcher"; -import { ForkMe } from "@mayank1513/fork-me/server"; -import type { HTMLProps } from "react"; -import styles from "./root-layout.module.css"; -import { Cards } from "./cards"; -import { Description } from "./root/description"; -import { Hero } from "./root/hero"; -import { Footer } from "./root/footer"; - -export type SharedRootLayoutProps = HTMLProps; - -export function SharedRootLayout({ children, className = "", ...props }: SharedRootLayoutProps) { - return ( - <> - -
- - {children} - - -
-