Skip to content

Commit

Permalink
feat([13023]): rename @nfid/identity-kit to @nfid/identitykit
Browse files Browse the repository at this point in the history
  • Loading branch information
olekid committed Jun 18, 2024
1 parent 79bf26f commit cc2b55a
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ packages/vaults/* @olsemeno @dmitriiIdentityLabs
# @nfid/postmessage-rpc SDK owners
packages/postmessage-rpc/* @olekid @dmitriiIdentityLabs @chorniy8pavlo

# @nfid/identity-kit SDK owners
# @nfid/identitykit SDK owners
packages/identity-kit/* @olekid @dmitriiIdentityLabs @chorniy8pavlo

# identity-kit examples owners
Expand Down
2 changes: 1 addition & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
auto-install-peers = true
auto-install-peers = true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This repo includes the following packages/apps:

### Packages

#### `packages/identity-kit`: source code deployed to [@nfid/identity-kit](https://www.npmjs.com/package/@nfid/identity-kit)
#### `packages/identity-kit`: source code deployed to [@nfid/identitykit](https://www.npmjs.com/package/@nfid/identitykit)

### Config

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"title": "@nfid/embed"
},
"identity-kit": {
"title": "@nfid/identity-kit"
"title": "@nfid/identitykit"
},
"blog": {
"title": "Blog",
Expand All @@ -26,4 +26,4 @@
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "The ICP Wallet Standards Series - Overview"
description:
"With DFINITY's support, the NFID team will release the open-source tool `@nfid/identity-kit`, to
"With DFINITY's support, the NFID team will release the open-source tool `@nfid/identitykit`, to
resolve the wallet compatibility challenges. This package will enable developers to incorporate a
broad spectrum of functionalities, paving the way for a more interconnected and efficient
application environment."
Expand All @@ -28,7 +28,7 @@ Plug, Stoic, Me, etc). This difficulty primarily arises from the need to adapt t
unique interfaces for user authentication, token transfers, and other identity-related interactions,
leading to compatibility issues and delays in development.

With DFINITY's support, the NFID team will release the open-source tool `@nfid/identity-kit`, to
With DFINITY's support, the NFID team will release the open-source tool `@nfid/identitykit`, to
resolve those challenges. This package will enable developers to incorporate a broad spectrum of
functionalities, paving the way for a more interconnected and efficient application environment.

Expand Down Expand Up @@ -96,4 +96,4 @@ which meets publicly every two weeks, foundational work by Papers/AirGap, and pr

- [Identity and Wallet Standard Working Group](https://github.com/dfinity/wg-identity-authentication)
- [Identity & Authentication DFINITY Forum](https://forum.dfinity.org/t/technical-working-group-identity-authentication)
- [Source Code for `@nfid/identity-kit`](https://github.com/internet-identity-labs/nfid)
- [Source Code for `@nfid/identitykit`](https://github.com/internet-identity-labs/nfid)
10 changes: 5 additions & 5 deletions docs/pages/identity-kit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,25 @@ authentication, signatures, and transfers.

The following packages are included in this repository:

- `@nfid/identity-kit` - A library to integrate compatible ICP wallets into your application.
- `@nfid/identity-kit/react` - A library containing react specific components for integrating
- `@nfid/identitykit` - A library to integrate compatible ICP wallets into your application.
- `@nfid/identitykit/react` - A library containing react specific components for integrating
compatible ICP wallets into your application.

## Usage

<Steps>
### Install

To use a **@nfid/identity-kit**, install the necessary dependencies with the following command:
To use a **@nfid/identitykit**, install the necessary dependencies with the following command:

```sh npm2yarn
npm i @nfid/identity-kit
npm i @nfid/identitykit
```

### Import the library

```typescript
import { ConnectButton, ConnectModal } from "@nfid/identity-kit"
import { ConnectButton, ConnectModal } from "@nfid/identitykit"
```

</Steps>
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ and signers. It specifies a set of messages to facilitate this interaction, ensu
secure exchange of information. ICRC-25 aims to create a uniform language for dApps and signers,
enhancing interoperability and simplifying the development process.

We invite the community to contribute adapters for other signers to `@nfid/identity-kit`, but you
can also use custom adapters from your own or other external packages.
We invite the community to contribute adapters for other signers to `@nfid/identitykit`, but you can
also use custom adapters from your own or other external packages.

```typescript filename="Import and configure Signer"
import * as IdentityKit from "@nfid/identity-kit"
import * as IdentityKit from "@nfid/identitykit"

// adapter contributed to this open source package
import { NFID, II } from "@nfid/identity-kit/adapter"
import { NFID, II } from "@nfid/identitykit/adapter"

// bring your own adapter
import { CUSTOM } from "@your-package/icrc-25-compatible-signer"
Expand Down
2 changes: 1 addition & 1 deletion examples/react-dapp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
},
"dependencies": {
"@codemirror/lang-json": "^6.0.1",
"@nfid/identity-kit": "*",
"@nfid/identitykit": "*",
"@radix-ui/themes": "^3.0.5",
"@uiw/codemirror-extensions-langs": "^4.22.1",
"@uiw/codemirror-theme-basic": "^4.22.1",
Expand Down
2 changes: 1 addition & 1 deletion examples/react-dapp/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { SectionContainer } from "./ui/organisms/section-container"
import { icrc29StatusSection } from "./data/icrc29_status"
import { icrc34SGetDelegationSection } from "./data/icrc34_get_delegation"
import { icrc49CallCanisterSection } from "./data/icrc49_call_canister"
import { IdentityKitProvider, IdentityKitTheme } from "@nfid/identity-kit/react"
import { IdentityKitProvider, IdentityKitTheme } from "@nfid/identitykit/react"
import { MockedSigner, NFID } from "./signers"
import { useTheme } from "next-themes"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ICRC25Methods } from "@nfid/identity-kit"
import { ICRC25Methods } from "@nfid/identitykit"
import { Method } from "../ui/atoms/method.js"
import { ISection } from "../ui/organisms/section.js"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ICRC25Methods } from "@nfid/identity-kit"
import { ICRC25Methods } from "@nfid/identitykit"
import { Link } from "../ui/atoms/link.js"
import { Method } from "../ui/atoms/method.js"
import { ISection } from "../ui/organisms/section.js"
Expand Down
2 changes: 1 addition & 1 deletion examples/react-dapp/src/data/icrc25_revoke_permissions.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ICRC25Methods } from "@nfid/identity-kit"
import { ICRC25Methods } from "@nfid/identitykit"
import { ISection } from "../ui/organisms/section.js"

export const basicRequest = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ICRC25Methods } from "@nfid/identity-kit"
import { ICRC25Methods } from "@nfid/identitykit"
import { Method } from "../ui/atoms/method.js"
import { ISection } from "../ui/organisms/section.js"

Expand Down
2 changes: 1 addition & 1 deletion examples/react-dapp/src/signers.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { SignerConfig } from "@nfid/identity-kit"
import { SignerConfig } from "@nfid/identitykit"

const mockedProviderUrl = import.meta.env.VITE_MOCKED_SIGNER_PROVIDER_URL

Expand Down
2 changes: 1 addition & 1 deletion examples/react-dapp/src/ui/organisms/section.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { toast } from "react-toastify"
import { isValidJSON } from "../../utils/json"
import { Button } from "../atoms/button"
import { CodeSection } from "../molecules/code-section"
import { useIdentityKit } from "@nfid/identity-kit/react"
import { useIdentityKit } from "@nfid/identitykit/react"
import { Actor } from "@dfinity/agent"
import { Principal } from "@dfinity/principal"
import { getRequestObject } from "../../utils/requests"
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions packages/identity-kit/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nfid/identity-kit",
"version": "0.0.0-alpha.2",
"name": "@nfid/identitykit",
"version": "0.0.0-alpha.0",
"license": "MIT",
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
Expand Down

0 comments on commit cc2b55a

Please sign in to comment.