chore: initial commit for creating a passkey package

.changeset/README.md

@@ -0,0 +1,8 @@
+# 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)

.changeset/config.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "onlyUpdatePeerDependentsWhenOutOfRange": true
+  },
+  "ignore": []
+}

.github/ISSUE_TEMPLATE/1_general_issue.yml

@@ -0,0 +1,26 @@
+name: 💡 General Inquiry & Suggestions
+description: Share general questions or suggestions that don't fit other categories
+title: "[GENERAL] "
+labels: ["question", "enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: "Got a question or suggestion? We're all ears!"
+  - type: textarea
+    attributes:
+      label: Inquiry or Suggestion
+      description: What would you like to share with us?
+      placeholder: "I'm wondering about..."
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Relevant Links or References
+      description: Optionally, add any relevant links or references.
+      placeholder: "e.g., https://github.com/example"
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/2_bug_report.yml

@@ -0,0 +1,71 @@
+name: 🐛 Bug Report & Test Failures
+description: Report unexpected behaviors or failing tests
+title: "[BUG] "
+labels: ["bug", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! The more info you provide, the more we can help you.
+
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+
+  - type: input
+    attributes:
+      label: Package Version
+      description: What version of the SDK are you using?
+      placeholder: 4.1.0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps or code snippets to reproduce the behavior.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Package.json (or lockfile) content
+      description: Packages used in your project. This will help us understand the environment you are working in, and check if there are dependencies that might be causing the issue.
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)
+      description: |
+        [Please provide by forking this project](https://stackblitz.com/~/github.com/bcnmy/sdk-examples) and making relevant changes to the boilerplate. This makes investigating issues and helping you out significantly easier! For most issues, you will likely get asked to provide one so why not add one now :)
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Browser info? Screenshots? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3_feature_request.yml

@@ -0,0 +1,53 @@
+name: ✨ Feature Requests & Performance Improvements
+description: Suggest a new feature or performance enhancement
+title: "[FEATURE] "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: "Your suggestions inspire us to improve. Share your ideas below!"
+
+  - type: markdown
+    attributes:
+      value: "## What"
+
+  - type: input
+    attributes:
+      label: Feature or Improvement Description
+      description: Briefly describe the feature or improvement you're suggesting.
+      placeholder: "e.g., Add support for platform Z."
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "## Why"
+
+  - type: textarea
+    attributes:
+      label: Benefits & Outcomes
+      description: Explain the benefits of your suggestion and the expected outcomes.
+      placeholder: "This improvement will improve performance by 30%..."
+
+  - type: markdown
+    attributes:
+      value: "## How"
+
+  - type: textarea
+    attributes:
+      label: Implementation Ideas
+      description: Share any thoughts on how this feature could be implemented.
+      placeholder: "We could approach this by..."
+
+  - type: input
+    attributes:
+      label: Any References?
+      description: Provide links or references to similar features or standards.
+      placeholder: "EIP-1234, https://github.com/example"
+
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/4_security_report.yml

@@ -0,0 +1,31 @@
+name: 🔒 Security Pre-Screening
+description: Pre-screening for security-related reports
+title: "[SECURITY PRE-SCREEN] "
+labels: ["security", "triage needed"]
+body:
+  - type: markdown
+    attributes:
+      value: "Security is our top priority. If you've discovered a potential security issue please proceed."
+  - type: checkboxes
+    attributes:
+      label: Security Level Acknowledgement
+      options:
+        - label: "I understand this issue will be public. It is NOT critical or high risk and does not endanger deployed contracts. If it is please email: [email protected]"
+          required: true
+  - type: input
+    attributes:
+      label: Overview
+      description: Provide a summary of the non-critical security concern or question.
+      placeholder: "e.g., Questions about the audit process."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Details
+      description: Offer more detail on your concern or question.
+      placeholder: "Provide any additional context..."
+  - type: input
+    attributes:
+      label: Suggestions for Mitigation
+      description: (Optional) Suggest ways to address the concern.
+      placeholder: "Potential mitigation steps include..."

.github/ISSUE_TEMPLATE/5_document_improvement.yml

@@ -0,0 +1,33 @@
+name: 📚 Documentation Improvement
+description: Propose improvements or report issues with documentation
+title: "[DOCS] "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: "Help us enhance our documentation for everyone."
+  - type: input
+    attributes:
+      label: Documentation Page/Section
+      description: Which page or section are you referring to?
+      placeholder: "e.g., README.md, TSDoc guidelines."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Suggested Improvements
+      description: Detail the improvements or corrections needed.
+      placeholder: "The section on XYZ could clarify..."
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Additional Comments
+      description: Any other comments or suggestions?
+      placeholder: "Consider adding examples for..."
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/ISSUE_TEMPLATE/6_build_deployment_issue.yml

@@ -0,0 +1,33 @@
+name: 🛠 Build & Deployment Issues
+description: Report issues
+title: "[BUILD/DEPLOY] "
+labels: ["bug", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: "Help us identify build or deployment problems to improve our processes."
+  - type: input
+    attributes:
+      label: Issue Summary
+      description: Briefly describe the issue encountered.
+      placeholder: "e.g., Failed to deploy contract due to..."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Error Logs & Messages
+      description: Provide any error logs or messages seen.
+      placeholder: "Error: Failed to..."
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Environment & Tools
+      description: Mention the tools and environment where the issue occurred.
+      placeholder: "e.g., Truffle v5.3, Rinkeby testnet"
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: I agree to follow this project's Code of Conduct.
+          required: true

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,22 @@
+## Pull Request for SDK Improvement
+
+**Describe your changes:**
+
+<!-- Briefly describe what you're changing or fixing. -->
+
+**Link any related issues:**
+
+<!-- Link any related issues here. -->
+
+**Testing:**
+
+<!-- Describe how the changes were tested. Include steps if applicable. -->
+
+**Note:** Please ensure all tests and lint checks pass before requesting a review. If there are any errors, fix them prior to submission.
+
+**Checklist:**
+
+- [ ] I have performed a self-review of my own code.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have made corresponding changes to the documentation, if applicable.
+- [ ] My changes generate no new warnings or errors.

.github/actions/build/action.yml

@@ -0,0 +1,16 @@
+name: "Build"
+description: "Prepare repository, all dependencies and build"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v1
+
+    - name: Install dependencies
+      shell: bash
+      run: bun install --frozen-lockfile
+
+    - name: Build
+      shell: bash
+      run: bun run build

.github/actions/install-dependencies/action.yml

@@ -0,0 +1,13 @@
+name: "Install dependencies"
+description: "Prepare repository and all dependencies"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v1
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        bun install --frozen-lockfile

.github/workflows/build.yml

@@ -0,0 +1,14 @@
+name: build
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build
+        uses: ./.github/actions/build

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: deploy docs
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: git config --global user.email "[email protected]"
+      - run: git config --global user.name "gh-runner"
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Set remote url
+        run: git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/bcnmy/sdk.git
+
+      - name: Run the tests
+        run: bun run docs:deploy
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: ./docs

.github/workflows/pr-lint.yml

@@ -0,0 +1,19 @@
+name: pr lint
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review, edited]
+jobs:
+  enforce_title:
+    name: pr lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Use commitlint to check PR title
+        run: echo "${{ github.event.pull_request.title }}" | bun commitlint