{"_id":"@andriiderevianko/facebook-login","_rev":"1-a1490f038917475953ca1ca1252ce247","name":"@andriiderevianko/facebook-login","description":"A native plugin for Facebook Login","dist-tags":{"latest":"6.0.1"},"versions":{"6.0.0":{"name":"@andriiderevianko/facebook-login","version":"6.0.0","keywords":["capacitor","plugin","native"],"author":{"name":"Masahiko Sakakibara","email":"sakakibara@rdlabo.jp"},"license":"MIT","_id":"@andriiderevianko/facebook-login@6.0.0","maintainers":[{"name":"andriiderevianko","email":"derevyanko.andrew2004@gmail.com"}],"homepage":"https://github.com/capacitor-community/facebook-login#readme","dist":{"shasum":"ac331999b0b8dd2df8d12e8e8e9c36f87ef17d7e","tarball":"https://registry.npmjs.org/@andriiderevianko/facebook-login/-/facebook-login-6.0.0.tgz","fileCount":29,"integrity":"sha512-G/oscw+/LH9SnrcawTCKjT9cRtayI1I/y1xt+MZGv0qekLQJSGAAlo0GxD85C1RtANJre5ieRGHT48pfa9EmIA==","signatures":[{"sig":"MEUCIA0CAnRbG4qjiY3LwHtRn9zpP0bXL8lPzKUaAvSP+eVOAiEAsp8ZDKklMfqWN10EFzLkXJPyFyPmRfns0EpQVF8Rflo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":89072},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","engines":{"node":">=18.0.0"},"gitHead":"e2940032398a9b6dc91848b2710b56e00940130f","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FacebookLoginPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","release":"np --no-tests","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"andriiderevianko","email":"derevyanko.andrew2004@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+ssh://git@github.com/capacitor-community/facebook-login.git","type":"git"},"_npmVersion":"9.5.1","description":"A native plugin for Facebook Login","directories":{},"_nodeVersion":"18.16.1","dependencies":{"@capacitor/core":"^6.0.0"},"eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"np":"^8.0.4","eslint":"^7.26.0","rimraf":"^3.0.2","rollup":"^2.48.0","prettier":"^2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/cli":"^6.0.0","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.16","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.3.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"_npmOperationalInternal":{"tmp":"tmp/facebook-login_6.0.0_1718703598080_0.27058320492686216","host":"s3://npm-registry-packages"}},"6.0.1":{"name":"@andriiderevianko/facebook-login","version":"6.0.1","description":"A native plugin for Facebook Login","engines":{"node":">=18.0.0"},"main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Masahiko Sakakibara","email":"sakakibara@rdlabo.jp"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/capacitor-community/facebook-login.git"},"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api FacebookLoginPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","release":"np --no-tests"},"devDependencies":{"@capacitor/android":"^6.0.0","@capacitor/cli":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.16","@capacitor/ios":"^6.0.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.26.0","np":"^8.0.4","prettier":"^2.3.0","prettier-plugin-java":"~1.0.2","rimraf":"^3.0.2","rollup":"^2.48.0","swiftlint":"^1.0.1","typescript":"~4.1.5"},"dependencies":{"@capacitor/core":"^6.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"keywords":["capacitor","plugin","native"],"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"e2940032398a9b6dc91848b2710b56e00940130f","homepage":"https://github.com/capacitor-community/facebook-login#readme","_id":"@andriiderevianko/facebook-login@6.0.1","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-JnOow0zYk9cQ59fU271HEHb3OX1mbARr69MIjjS4U7G86mDcTlUx3fP2Aa8MJbEl6L25xyIixpbb1yacvFYKqg==","shasum":"eca1d11d0ce78d1193d4e953121a3c68780e4496","tarball":"https://registry.npmjs.org/@andriiderevianko/facebook-login/-/facebook-login-6.0.1.tgz","fileCount":29,"unpackedSize":89068,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD5SqQOmyym/MAP7IwmaigxIYUYEKEaM7P2dtO+GromIAIhAPGlq3gMjBeR69p7Fv3aU1QnOdDDO8SgT4kgvTm0HVkm"}]},"_npmUser":{"name":"andriiderevianko","email":"derevyanko.andrew2004@gmail.com"},"directories":{},"maintainers":[{"name":"andriiderevianko","email":"derevyanko.andrew2004@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/facebook-login_6.0.1_1718709119179_0.48937115085374705"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-18T09:39:57.987Z","modified":"2024-06-18T11:11:59.518Z","6.0.0":"2024-06-18T09:39:58.282Z","6.0.1":"2024-06-18T11:11:59.353Z"},"maintainers":[{"name":"andriiderevianko","email":"derevyanko.andrew2004@gmail.com"}],"author":{"name":"Masahiko Sakakibara","email":"sakakibara@rdlabo.jp"},"repository":{"type":"git","url":"git+ssh://git@github.com/capacitor-community/facebook-login.git"},"keywords":["capacitor","plugin","native"],"license":"MIT","homepage":"https://github.com/capacitor-community/facebook-login#readme","readme":"


\n

Facebook Login

\n

@capacitor-community/facebook-login

\n

\n Capacitor community plugin for native Facebook Login.\n

\n\n

\n \n \n \n
\n \n \n

\n\n## Maintainers\n\n| Maintainer | GitHub | Social | Sponsoring Company |\n| ------------------- | --------------------------------------- | ----------------------------------------- | ---------------------------------------------- |\n| Masahiko Sakakibara | [rdlabo](https://github.com/rdlabo) | [@rdlabo](https://twitter.com/rdlabo) | RELATION DESIGN LABO, GENERAL INC. ASSOCIATION |\n\n## Contributors ✨\n\n\n \n\n\nMade with [contributors-img](https://contrib.rocks).\n\n## Demo\n\n[Demo code is here.](https://github.com/capacitor-community/facebook-login/tree/master/demo/angular)\n\n## Dependency version\n\nIf you want to know facebook library version, you should check:\n\n- [iOS](https://github.com/capacitor-community/facebook-login/blob/master/CapacitorCommunityFacebookLogin.podspec#L18-L19)\n- [Android](https://github.com/capacitor-community/facebook-login/blob/master/android/build.gradle#L52)\n\n## Installation\n\n```bash\n% npm i --save @capacitor-community/facebook-login\n% npx cap update\n```\n\n### Versions\n\nUsers of Capacitor v5 should use version v5 of the Plugin.\n\n```bash\n% npm install @capacitor-community/facebook-login@5\n```\n\n### Android configuration\n\nIn file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `` :\n\n```xml\n\n\n```\n\nIn file `android/app/src/main/res/values/strings.xml` add the following lines :\n\n```xml\n[APP_ID]\n[CLIENT_TOKEN]\n```\n\nDon't forget to replace `[APP_ID]` and `[CLIENT_TOKEN]` by your Facebook application Id.\n\nMore information can be found here: https://developers.facebook.com/docs/android/getting-started\n\n#### If you have trouble.\n\nPlease restart Android Studio, and do clean build.\n\n### iOS configuration\n\nIn file `ios/App/App/AppDelegate.swift` add or replace the following:\n\n```swift\nimport UIKit\nimport Capacitor\nimport FBSDKCoreKit\n\n@UIApplicationMain\nclass AppDelegate: UIResponder, UIApplicationDelegate {\n\n var window: UIWindow?\n\n func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {\n // Override point for customization after application launch.\n FBSDKCoreKit.ApplicationDelegate.shared.application(\n application,\n didFinishLaunchingWithOptions: launchOptions\n )\n\n return true\n }\n\n ...\n\n func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {\n // Called when the app was launched with a url. Feel free to add additional processing here,\n // but if you want the App API to support tracking app url opens, make sure to keep this call\n if (FBSDKCoreKit.ApplicationDelegate.shared.application(\n app,\n open: url,\n sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,\n annotation: options[UIApplication.OpenURLOptionsKey.annotation]\n )) {\n return true;\n } else {\n return ApplicationDelegateProxy.shared.application(app, open: url, options: options)\n }\n }\n}\n```\n\nAdd the following in the `ios/App/App/info.plist` file inside of the outermost ``:\n\n```xml\n\nCFBundleURLTypes\n\n \n CFBundleURLSchemes\n \n fb[APP_ID]\n \n \n\nFacebookAppID\n[APP_ID]\nFacebookClientToken\n[CLIENT_TOKEN]\nFacebookDisplayName\n[APP_NAME]\nLSApplicationQueriesSchemes\n\n fbapi\n fbapi20130214\n fbapi20130410\n fbapi20130702\n fbapi20131010\n fbapi20131219\n fbapi20140410\n fbapi20140116\n fbapi20150313\n fbapi20150629\n fbapi20160328\n fbauth\n fb-messenger-share-api\n fbauth2\n fbshareextension\n\n```\n\nMore information can be found here: https://developers.facebook.com/docs/facebook-login/ios\n\n### Web configuration\n\n```typescript\nimport { FacebookLogin } from '@capacitor-community/facebook-login';\n\n// use hook after platform dom ready\nawait FacebookLogin.initialize({ appId: '105890006170720' });\n```\n\nMore information can be found here: https://developers.facebook.com/docs/facebook-login/web\nAnd you must confirm return type at https://github.com/rdlabo/capacitor-facebook-login/blob/master/src/web.ts#L55-L57\nnot same type for default web facebook login!\n\n## Example\n\n### Login\n\n```ts\nimport {\n FacebookLogin,\n FacebookLoginResponse,\n} from '@capacitor-community/facebook-login';\n\nconst FACEBOOK_PERMISSIONS = [\n 'email',\n 'user_birthday',\n 'user_photos',\n 'user_gender',\n];\nconst result = await ((\n FacebookLogin.login({ permissions: FACEBOOK_PERMISSIONS })\n));\n\nif (result.accessToken) {\n // Login successful.\n console.log(`Facebook access token is ${result.accessToken.token}`);\n}\n```\n\n### Logout\n\n```ts\nimport { FacebookLogin } from '@capacitor-community/facebook-login';\n\nawait FacebookLogin.logout();\n```\n\n### CurrentAccessToken\n\n```ts\nimport {\n FacebookLogin,\n FacebookLoginResponse,\n} from '@capacitor-community/facebook-login';\n\nconst result = await ((\n FacebookLogin.getCurrentAccessToken()\n));\n\nif (result.accessToken) {\n console.log(`Facebook access token is ${result.accessToken.token}`);\n}\n```\n\n### getProfile\n\n```ts\nimport {\n FacebookLogin,\n FacebookLoginResponse,\n} from '@capacitor-community/facebook-login';\n\nconst result = await FacebookLogin.getProfile<{\n email: string;\n}>({ fields: ['email'] });\n\nconsole.log(`Facebook user's email is ${result.email}`);\n```\n\n## API\n\n\n\n* [`initialize(...)`](#initialize)\n* [`login(...)`](#login)\n* [`limitedLogin(...)`](#limitedlogin)\n* [`logout()`](#logout)\n* [`reauthorize()`](#reauthorize)\n* [`getCurrentAccessToken()`](#getcurrentaccesstoken)\n* [`getProfile(...)`](#getprofile)\n* [`logEvent(...)`](#logevent)\n* [`setAutoLogAppEventsEnabled(...)`](#setautologappeventsenabled)\n* [`setAdvertiserTrackingEnabled(...)`](#setadvertisertrackingenabled)\n* [`setAdvertiserIDCollectionEnabled(...)`](#setadvertiseridcollectionenabled)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\n\n\n\n\n### initialize(...)\n\n```typescript\ninitialize(options: Partial) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------------------------- |\n| **`options`** | Partial<FacebookConfiguration> |\n\n--------------------\n\n\n### login(...)\n\n```typescript\nlogin(options: { permissions: string[]; }) => Promise\n```\n\n| Param | Type |\n| ------------- | --------------------------------------- |\n| **`options`** | { permissions: string[]; } |\n\n**Returns:** Promise<FacebookLoginResponse>\n\n--------------------\n\n\n### limitedLogin(...)\n\n```typescript\nlimitedLogin(options: { permissions: string[]; tracking?: 'limited' | 'enabled'; nonce?: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------------------------ |\n| **`options`** | { permissions: string[]; tracking?: 'limited' \\| 'enabled'; nonce?: string; } |\n\n**Returns:** Promise<LimitedFacebookLoginResponse>\n\n--------------------\n\n\n### logout()\n\n```typescript\nlogout() => Promise\n```\n\n--------------------\n\n\n### reauthorize()\n\n```typescript\nreauthorize() => Promise\n```\n\n**Returns:** Promise<FacebookLoginResponse>\n\n--------------------\n\n\n### getCurrentAccessToken()\n\n```typescript\ngetCurrentAccessToken() => Promise\n```\n\n**Returns:** Promise<FacebookCurrentAccessTokenResponse>\n\n--------------------\n\n\n### getProfile(...)\n\n```typescript\ngetProfile>(options: { fields: readonly string[]; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ------------------------------------------- |\n| **`options`** | { fields: readonly string[]; } |\n\n**Returns:** Promise<T>\n\n--------------------\n\n\n### logEvent(...)\n\n```typescript\nlogEvent(options: { eventName: string; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ----------------------------------- |\n| **`options`** | { eventName: string; } |\n\n--------------------\n\n\n### setAutoLogAppEventsEnabled(...)\n\n```typescript\nsetAutoLogAppEventsEnabled(options: { enabled: boolean; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ---------------------------------- |\n| **`options`** | { enabled: boolean; } |\n\n--------------------\n\n\n### setAdvertiserTrackingEnabled(...)\n\n```typescript\nsetAdvertiserTrackingEnabled(options: { enabled: boolean; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ---------------------------------- |\n| **`options`** | { enabled: boolean; } |\n\n--------------------\n\n\n### setAdvertiserIDCollectionEnabled(...)\n\n```typescript\nsetAdvertiserIDCollectionEnabled(options: { enabled: boolean; }) => Promise\n```\n\n| Param | Type |\n| ------------- | ---------------------------------- |\n| **`options`** | { enabled: boolean; } |\n\n--------------------\n\n\n### Interfaces\n\n\n#### FacebookConfiguration\n\n| Prop | Type |\n| ---------------------- | -------------------- |\n| **`appId`** | string |\n| **`autoLogAppEvents`** | boolean |\n| **`xfbml`** | boolean |\n| **`version`** | string |\n| **`locale`** | string |\n\n\n#### FacebookLoginResponse\n\n| Prop | Type |\n| -------------------------------- | ----------------------------------------------------------- |\n| **`accessToken`** | AccessToken \\| null |\n| **`recentlyGrantedPermissions`** | string[] |\n| **`recentlyDeniedPermissions`** | string[] |\n\n\n#### AccessToken\n\n| Prop | Type |\n| ------------------------- | --------------------- |\n| **`applicationId`** | string |\n| **`declinedPermissions`** | string[] |\n| **`expires`** | string |\n| **`isExpired`** | boolean |\n| **`lastRefresh`** | string |\n| **`permissions`** | string[] |\n| **`token`** | string |\n| **`userId`** | string |\n\n\n#### LimitedFacebookLoginResponse\n\n| Prop | Type |\n| ------------------------- | ------------------------------------------------------------------------------- |\n| **`authenticationToken`** | { token: string; userId?: string; name?: string; email?: string; } |\n\n\n#### FacebookCurrentAccessTokenResponse\n\n| Prop | Type |\n| ----------------- | ----------------------------------------------------------- |\n| **`accessToken`** | AccessToken \\| null |\n\n\n### Type Aliases\n\n\n#### Partial\n\nMake all properties in T optional\n\n{\r [P in keyof T]?: T[P];\r }\n\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n{\r [P in K]: T;\r }\n\n\n","readmeFilename":"README.md"}