{"_id":"@carv_admin/carv-id-tg-sdk","_rev":"5-dfb5e69a71baa02241fc43629a4ec3bf","name":"@carv_admin/carv-id-tg-sdk","dist-tags":{"latest":"0.0.5"},"versions":{"0.0.0":{"name":"@carv_admin/carv-id-tg-sdk","version":"0.0.0","license":"MIT","_id":"@carv_admin/carv-id-tg-sdk@0.0.0","maintainers":[{"name":"carv_admin","email":"infra@carv.io"}],"homepage":"https://github.com/carv-protocol/carv-id-sdk/blob/main/README.md","dist":{"shasum":"29e6873279ea2cea94e64004e06c34176e0c970e","tarball":"https://registry.npmjs.org/@carv_admin/carv-id-tg-sdk/-/carv-id-tg-sdk-0.0.0.tgz","fileCount":7,"integrity":"sha512-08dn0NrC/OCe3uFggPCmGGxzxJCyS/OB91xo4FPxF4u8S1jyYTJk1ExpaF3aPpQE8DeJErc7DfUyclWLQMybRQ==","signatures":[{"sig":"MEQCIFrJ7AnSJ9IIzywt8wpCqfx1WQs+hK8Did+YUMo+JbBiAiBlfLGfXqdtymdA9SB8drvPO/Fpsg2ScknCT0pwMYgmPA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":164687},"main":"./dist/carv-id-tg-sdk.cjs","type":"module","types":"./dist/carv-id-tg-sdk.d.ts","module":"./dist/carv-id-tg-sdk.mjs","gitHead":"de1e8db49ceff406777fc9b1256313fd74f15f44","scripts":{"dev":"tsup --watch","lint":"eslint \"**/*.ts\"","build":"tsup --dts","publish":"tsup --dts && npm publish"},"_npmUser":{"name":"carv_admin","email":"infra@carv.io"},"_npmVersion":"10.8.2","directories":{},"_nodeVersion":"20.18.0","dependencies":{"draggabilly":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","typescript":"^5.3.3","@carvid/utils":"workspace:*","@types/draggabilly":"^2.1.6","@carvid/eslint-config":"workspace:*","@carvid/typescript-config":"workspace:*"},"_npmOperationalInternal":{"tmp":"tmp/carv-id-tg-sdk_0.0.0_1733748348940_0.7591883275176359","host":"s3://npm-registry-packages-npm-production"}},"0.0.1":{"name":"@carv_admin/carv-id-tg-sdk","version":"0.0.1","license":"MIT","_id":"@carv_admin/carv-id-tg-sdk@0.0.1","maintainers":[{"name":"carv_admin","email":"infra@carv.io"}],"homepage":"https://github.com/carv-protocol/carv-id-sdk/blob/main/README.md","dist":{"shasum":"159f0ba800690704c8a4e0596929c156061eb9f0","tarball":"https://registry.npmjs.org/@carv_admin/carv-id-tg-sdk/-/carv-id-tg-sdk-0.0.1.tgz","fileCount":7,"integrity":"sha512-eSIYOtxO2ZFcUY4itms0l7yvV/DRdveHqKcbaioBURXIOBxJ5SohF2rTheKnEfH8LCbt3eyCi6CexALdMCKjDA==","signatures":[{"sig":"MEQCICIeeKCmbVNtACwFpXd32wqVGG9CZbxnto3OHTtpeneOAiAdFfL9h4w8p4KbH45h52LcaIB/YRviXRt0telyHLjpvQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":99619},"main":"./dist/carv-id-tg-sdk.cjs","type":"module","types":"./dist/carv-id-tg-sdk.d.ts","module":"./dist/carv-id-tg-sdk.mjs","gitHead":"3992655e9aebda81ab411754511ee8fe3447a3c3","scripts":{"dev":"tsup --watch","lint":"eslint \"**/*.ts\"","build":"tsup --dts","publish":"tsup --dts && npm publish --access=public"},"_npmUser":{"name":"carv_admin","email":"infra@carv.io"},"_npmVersion":"10.8.2","directories":{},"_nodeVersion":"20.18.0","dependencies":{"draggabilly":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","typescript":"^5.3.3","@carvid/utils":"workspace:*","@types/draggabilly":"^2.1.6","@carvid/eslint-config":"workspace:*","@carvid/typescript-config":"workspace:*"},"_npmOperationalInternal":{"tmp":"tmp/carv-id-tg-sdk_0.0.1_1733749114470_0.7244453814030332","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@carv_admin/carv-id-tg-sdk","version":"0.0.2","keywords":["carv","carv id","carv id sdk","carv oauth","telegram","sdk"],"license":"MIT","_id":"@carv_admin/carv-id-tg-sdk@0.0.2","maintainers":[{"name":"carv_admin","email":"infra@carv.io"}],"dist":{"shasum":"76589312cee8a1a7d1a3639da0c8c4ba8709d61b","tarball":"https://registry.npmjs.org/@carv_admin/carv-id-tg-sdk/-/carv-id-tg-sdk-0.0.2.tgz","fileCount":8,"integrity":"sha512-DvUU+ZylnT16EStW3y0qACrwWx/7Z+NgC4PkmhnLyXsGTY81wRyKbnU1+w8OxO0WLciag+v8lBlrLzUJDSF34w==","signatures":[{"sig":"MEQCIB3LjhjwHAjRGwvvAhUv0ncxELHbi2MUgHUq/HRPBo6rAiAO/jUPAY4A30WO2WYK98t8IRdD+A8qCoMxKyF1Cz9jYQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":106998},"main":"./dist/carv-id-tg-sdk.cjs","type":"module","types":"./dist/carv-id-tg-sdk.d.ts","module":"./dist/carv-id-tg-sdk.mjs","gitHead":"eee69f0b9ac23e4ec983403a09837d80bdc99954","scripts":{"dev":"tsup --watch","lint":"eslint \"**/*.ts\"","build":"tsup --dts","publish":"tsup --dts && npm publish --access=public"},"_npmUser":{"name":"carv_admin","email":"infra@carv.io"},"_npmVersion":"10.8.2","description":"

\"CARV

CARV ID SDK

","directories":{},"_nodeVersion":"20.18.0","dependencies":{"draggabilly":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","typescript":"^5.3.3","@carvid/utils":"workspace:*","@types/draggabilly":"^2.1.6","@carvid/eslint-config":"workspace:*","@carvid/typescript-config":"workspace:*"},"_npmOperationalInternal":{"tmp":"tmp/carv-id-tg-sdk_0.0.2_1733750984758_0.8117654307865048","host":"s3://npm-registry-packages-npm-production"}},"0.0.3":{"name":"@carv_admin/carv-id-tg-sdk","version":"0.0.3","keywords":["carv","carv id","carv id sdk","carv oauth","telegram","sdk"],"license":"MIT","_id":"@carv_admin/carv-id-tg-sdk@0.0.3","maintainers":[{"name":"carv_admin","email":"infra@carv.io"}],"dist":{"shasum":"cefeeea3525888e6a83176df47bf78ba2e463975","tarball":"https://registry.npmjs.org/@carv_admin/carv-id-tg-sdk/-/carv-id-tg-sdk-0.0.3.tgz","fileCount":8,"integrity":"sha512-iIiK425n+k7BnfBxUhRvWNAaI4a/NC2XXmp817Clpl8D2SP5P/Bz0v+gRVmLZBd8Rm0U7vtnYtxYv+Vqml7xpg==","signatures":[{"sig":"MEUCIQCN3zn9cJ71sUXrBMQFOi4g9OYzUR8xPpgWxBujiuBC2wIgWz8srydIzQLRds+iZyt4xpTAjRmnhjfheyjmwiEhBns=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":107015},"main":"./dist/carv-id-tg-sdk.cjs","type":"module","types":"./dist/carv-id-tg-sdk.d.ts","module":"./dist/carv-id-tg-sdk.mjs","gitHead":"7215b1c6ce1135014d965ea5f3ab2423787f05ea","scripts":{"dev":"tsup --watch","lint":"eslint \"**/*.ts\"","build":"tsup --dts","publish":"tsup --dts && npm publish --access=public"},"_npmUser":{"name":"carv_admin","email":"infra@carv.io"},"_npmVersion":"10.8.2","description":"

\"CARV

CARV ID SDK

","directories":{},"_nodeVersion":"20.18.0","dependencies":{"draggabilly":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","typescript":"^5.3.3","@carvid/utils":"workspace:*","@types/draggabilly":"^2.1.6","@carvid/eslint-config":"workspace:*","@carvid/typescript-config":"workspace:*"},"_npmOperationalInternal":{"tmp":"tmp/carv-id-tg-sdk_0.0.3_1733751171795_0.04861401160628165","host":"s3://npm-registry-packages-npm-production"}},"0.0.4":{"name":"@carv_admin/carv-id-tg-sdk","version":"0.0.4","keywords":["carv","carv id","carv id sdk","carv oauth","telegram","sdk"],"license":"MIT","_id":"@carv_admin/carv-id-tg-sdk@0.0.4","maintainers":[{"name":"carv_admin","email":"infra@carv.io"}],"homepage":"https://carv-id-test.carv.io","bugs":{"url":"https://github.com/carv-protocol/carv-id-sdk/issues"},"dist":{"shasum":"5c11b1bb921570877f9e9cfef50bddac35a0810b","tarball":"https://registry.npmjs.org/@carv_admin/carv-id-tg-sdk/-/carv-id-tg-sdk-0.0.4.tgz","fileCount":8,"integrity":"sha512-wHq0r5oKsiQqo/HESPPVweOgcob9J1sYnPOtfkn86Q2/XqotTbGd3twePYFCjvkD4bcLIJ+8HRkUVOe/M16yaA==","signatures":[{"sig":"MEUCIQCpGM93Yt8N2iN9DavhHL0KdR1Y+bnjyw2TBqdMRVNZbgIgU4iUHdRhxSKz6SFmgh5LCU8/CGPUgKnCBan12NuimMc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":107633},"main":"./dist/carv-id-tg-sdk.cjs","type":"module","types":"./dist/carv-id-tg-sdk.d.ts","module":"./dist/carv-id-tg-sdk.mjs","gitHead":"42289d7c5c8fc07a08a4a1ce81bf6d530be13657","scripts":{"dev":"tsup --watch","lint":"eslint \"**/*.ts\"","build":"tsup --dts","publish":"tsup --dts && npm publish --access=public"},"_npmUser":{"name":"carv_admin","email":"infra@carv.io"},"repository":{"url":"git+https://github.com/carv-protocol/carv-id-sdk.git","type":"git"},"_npmVersion":"10.8.2","description":"

\n \"CARV\n

\n

CARV ID SDK

\n\n\nThe SDK for CARV ID ecosystem. (Only Telegram is supported.)\n\n- CARV ID SDK\n- CARV ID SDK Widget\n\n## 🎾 Demo\n\n - [CARV ID SDK Demo](https://carv-id-test.carv.io/)\n\n
\n\n## 📒 Memo\n\n- carv-id-demo（Telegram demo）: [https://t.me/BabyChinBot/carv_id_demo](https://t.me/BabyChinBot/carv_id_demo)\n- carv-id-dev (carv-id-app@dev): [https://t.me/carv_identity_dev_bot/carv_id](https://t.me/carv_identity_dev_bot/carv_id)\n- carv-id（carv-id-app@prod）: [https://t.me/carv_identity_bot/carv_id](https://t.me/carv_identity_bot/carv_id)\n\n
\n\n## 💊 Usage\n\n#### 1、UMD\n\n```html\n\n\n\n```\n\n#### 2、ES Module\n\n```bash\npnpm add @carv_admin/carv-id-tg-sdk\n```\n\n```typescript\nimport {\n CarvId,\n Enum_Env,\n Enum_CarvIdTheme,\n Enum_CarvIdIconPlacement,\n} from \"@carv_admin/carv-id-tg-sdk\";\n\nwindow.onload = function() => {\n const CarvIdInstance = new CarvId({\n env: Enum_Env.DEV,\n theme: Enum_CarvIdTheme.LIGHT,\n showWidget: true,\n widgetOptions: {\n size: \"60px\",\n placement: Enum_CarvIdIconPlacement.BOTTOM_RIGHT\n },\n onLoad: (data) => {\n console.log(\"onLoad\", data);\n },\n onAuthSuccess: (data) => {\n console.log(\"onAuthSuccess\", data);\n },\n onAuthFailed: (data) => {\n console.log(\"onAuthFailed\", data);\n }\n });\n console.log(CarvIdInstance, \"CARV ID SDK initialized\");\n}\n```\n\n
\n\n## 🧩 Methods\n\n```typescript\n// Initialize\nconst carvIdInstance = new CarvId(Options: I_CarvIdOptions)\n```\n\n#### 🔹 authenticateUser: () => void\n\n```ts\n// Start authorization process\ncarvIdInstance.authenticateUser();\n```\n\n#### 🔹 openIdentityPage: () => void\n\n```ts\n// Open CARV ID identity page\ncarvIdInstance.openIdentityPage();\n```\n#### 🔹 handleAuthCallback: Promise\n\n```ts\n// Callback triggered after authorization\nCarvIdInstance.handleAuthCallback().then((res: I_AuthenticateResponse) => {\n // {code: string, state: string}\n console.log(res, \"handleAuthCallback\");\n if (res.code) {\n console.log(\"Authorize success\", res.code);\n }\n});\n```\n\n
\n\n## 🛠️ Options\n\n#### 🔸 I_CarvIdOptions\n\n```typescript\ninterface I_CarvIdOptions {\n env?: Enum_Env;\n theme?: Enum_CarvIdTheme;\n showWidget?: boolean;\n widgetOptions?: I_CarvIdWidgetOptions;\n authorizeConfig: I_CarvIdAuthorizeConfig;\n onLoad?: (data: CarvId) => void;\n onAuthSuccess?: (data: I_AuthenticateResponse) => void;\n onAuthFailed?: (data: I_AuthenticateResponse) => void;\n}\n```\n\n| Field | Description | Type | Default |\n| ---------------- | ------------------------------------------------------ | -------------------------------------- | ---------------------- |\n| env | Environment | Enum_Env | Enum_Env.PROD |\n| theme | Theme mode | Enum_CarvIdTheme | Enum_CarvIdTheme.LIGHT |\n| showWidget | Show widget icon | Boolean | false |\n| widgetOptions | Widget options | I_CarvIdWidgetOptions | undefined |\n| authorizeConfig | Configuration for authorization | I_CarvIdAuthorizeConfig | undefined |\n| onLoad | Callback that triggered after SDK initialized | (data: CarvId) => void | undefined |\n| onAuthSuccess | Callback that triggered after authorization successful | (data: I_AuthenticateResponse) => void | undefined |\n| onAuthFailed | Callback that triggered after authorization failed | (data: I_AuthenticateResponse) => void | undefined |\n\n#### 🔸 I_CarvIdWidgetOptions\n\n``` typescript\ninterface I_CarvIdWidgetOptions {\n theme?: Enum_CarvIdTheme;\n size?: string;\n className?: string;\n draggable?: boolean;\n watchResize?: boolean;\n rememberPosition?: boolean;\n placement?: Enum_CarvIdIconPlacement;\n offset?: I_CarvIdIconPlacementOffset;\n}\n```\n\n| Field | Description | Type | Default |\n| ---------------- | ------------------------------- | --------------------------- | -------------------------------------------- |\n| theme | Theme mode | Enum_CarvIdTheme | Enum_CarvIdTheme.LIGHT |\n| size | Icon size | String | \"48px\" |\n| placement | Icon placement | Enum_CarvIdIconPlacement | Enum_CarvIdIconPlacement.BOTTOM_RIGHT |\n| offset | The offset config for placement | I_CarvIdIconPlacementOffset | { left: 20, right: 20, top: 40, bottom: 60 } |\n| className | The class name of widget | String | \"\" |\n| draggable | Enable drag interaction | Boolean | true |\n| watchResize | Watch the resize event | Boolean | true |\n| rememberPosition | Remember icon position | Boolean | true |\n\n
\n\n## 🧿 Turborepo\n\nThis project generated from a [Turborepo](https://turbo.build/repo/docs) starter. Run the following command to init a new project:\n\n```bash\nnpx create-turbo@latest -e with-vite\n```\n\nAnd this project includes the following packages and apps:\n\n#### - Apps\n\n- `carv-id-sdk-demo`: used for testing SDK\n\n#### - Packages\n\n- `docs`: a vanilla [vite](https://vitejs.dev) ts app\n- `web`: another vanilla [vite](https://vitejs.dev) ts app\n- `@carvid/carv-id-tg-sdk`: a CARV ID core component\n- `@carvid/utils`: a stub utility library shared by all applications\n- `@carvid/eslint-config`: shared `eslint` configurations\n- `@carvid/typescript-config`: `tsconfig.json`s used throughout the monorepo\n\n
\n\n## 🦴 Utils\n\nThis Turborepo has some additional tools already setup for you:\n\n- [TypeScript](https://www.typescriptlang.org/) for static type checking\n- [ESLint](https://eslint.org/) for code linting\n- [Prettier](https://prettier.io) for code formatting\n\n
\n","readmeFilename":"README.md"}