{"_id":"@superfrete/capacitor-firebase-functions","_rev":"54-0bc0356d16db9c0bab8b7c44e15ea6df","name":"@superfrete/capacitor-firebase-functions","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@superfrete/capacitor-firebase-functions","version":"0.1.0","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","_id":"@superfrete/capacitor-firebase-functions@0.1.0","maintainers":[{"name":"carlos.silva.super","email":"carlos.silva@superfrete.com"},{"name":"marcus.goncalves","email":"marcus.goncalves@superfrete.com"},{"name":"dougianitsky","email":"douglas@superfrete.com"}],"homepage":"https://capawesome.io/","bugs":{"url":"https://github.com/capawesome-team/capacitor-firebase/issues"},"dist":{"shasum":"df9494fd083c3acabbfe8db2783bf09d4fa303ab","tarball":"https://registry.npmjs.org/@superfrete/capacitor-firebase-functions/-/capacitor-firebase-functions-0.1.0.tgz","fileCount":28,"integrity":"sha512-4daSg7LAKVDEfMvOg8pD1LAD/pD2G9nqZAY4EEFStZSRwuog0xg8fsnzOOqG4tZwoan8BI/qsvBD2WbP7F0xsQ==","signatures":[{"sig":"MEUCIA32KkiDnF0zzcdkt6a8lvmQGyY5pHTYiNpI7rJOFutGAiEA/8eOuhlaXmbuEkGzh7XHNL6VUt34o26f9IfF5dBorR4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37210},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"8836dde90f02c896a2e9e959e1b0ac487a559030","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 FirebaseFunctionsPlugin --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","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 ..","ios:pod:install":"cd ios && pod install --repo-update && cd .."},"_npmUser":{"name":"dougianitsky","email":"douglas@superfrete.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/capawesome-team/capacitor-firebase.git","type":"git"},"_npmVersion":"10.2.4","description":"Capacitor plugin for Firebase Functions.","directories":{},"_nodeVersion":"18.19.1","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"7.32.0","rimraf":"3.0.2","rollup":"2.77.2","firebase":"9.20.0","prettier":"2.3.2","swiftlint":"1.0.1","typescript":"5.4.2","@capacitor/cli":"5.0.0","@capacitor/ios":"5.0.0","@capacitor/core":"5.0.0","@capacitor/docgen":"0.2.1","@capacitor/android":"5.0.0","@ionic/eslint-config":"0.3.0","prettier-plugin-java":"1.0.2","@ionic/swiftlint-config":"1.1.2"},"peerDependencies":{"firebase":"^9.0.0 || ^10.0.0","@capacitor/core":"^5.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-functions_0.1.0_1710796366767_0.6278052958532598","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-03-18T21:12:46.655Z","modified":"2026-09-15T15:25:21.811Z","0.1.0":"2024-03-18T21:12:46.964Z"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-firebase/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"Apache-2.0","homepage":"https://capawesome.io/","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/capawesome-team/capacitor-firebase.git","type":"git"},"description":"Capacitor plugin for Firebase Functions.","maintainers":[{"email":"marcos.lessa@superfrete.com","name":"marcoslessa"},{"email":"jonathan.ramos@superfrete.com","name":"jonathan.ramos"},{"email":"marcus.goncalves@superfrete.com","name":"marcus.goncalves"},{"email":"vitor.pires@superfrete.com","name":"vitordpires"},{"email":"douglas@superfrete.com","name":"dougianitsky"},{"email":"fernando.antunes@superfrete.com","name":"fehantunes"},{"email":"gabriel.butarelo@superfrete.com","name":"gabriel-butarelo"},{"email":"gustavo.canavesi@superfrete.com","name":"gustavo-canavesi"},{"email":"igor.buzato@superfrete.com","name":"buzato_super_frete"},{"email":"andre.abadesso@superfrete.com","name":"abadessosf"},{"email":"geovanne.calil@superfrete.com","name":"gcalil"},{"email":"tales.luna@superfrete.com","name":"trflunsf"},{"email":"bruno.azisaka@superfrete.com","name":"super.zisa"},{"email":"allan.alexandre@superfrete.com","name":"superfrete.allanalexandre"},{"email":"victor.calazans@superfrete.com","name":"folfxr"},{"email":"rafael.mattos@superfrete.com","name":"mattos"},{"email":"jefferson.machado@superfrete.com","name":"jefferson-super-frete"},{"email":"alessandro.souza@superfrete.com","name":"alessandro.superfrete"},{"email":"afonso.inocente@superfrete.com","name":"afonsoinocente"},{"email":"yan.doro@superfrete.com","name":"ydoro1"},{"email":"mateus.herculano@superfrete.com","name":"mateusherculano"},{"email":"adriel.mendes@superfrete.com","name":"adriel.mendes"},{"email":"giovana.carvalho@superfrete.com","name":"giovanagamadecarvalho"},{"email":"matheus.nascimento@superfrete.com","name":"matheussn.superfrete"},{"email":"felipe.anjos@superfrete.com","name":"felipe-dos-anjos"},{"email":"joao.scheffel@superfrete.com","name":"super-joao-schefel"},{"email":"leticia.metta@superfrete.com","name":"leticiametta"}],"readme":"# @capacitor-firebase/functions\n\nUnofficial Capacitor plugin for [Firebase Functions](https://firebase.google.com/docs/functions).[^1]\n\n## Installation\n\n```bash\nnpm install @capacitor-firebase/functions firebase\nnpx cap sync\n```\n\nAdd Firebase to your project if you haven't already ([Android](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) / [iOS](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) / [Web](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)).\n\n### Android\n\n#### Variables\n\nThis plugin will use the following project variables (defined in your app’s `variables.gradle` file):\n\n- `$firebaseFunctionsVersion` version of `com.google.firebase:firebase-functions` (default: `21.2.2`)\n\n### iOS\n\nAdd the `CapacitorFirebaseFunctions/Functions` pod to your `Podfile` (usually `ios/App/Podfile`):\n\n```diff\ntarget 'App' do\ncapacitor_pods\n# Add your Pods here\n+  pod 'CapacitorFirebaseFunctions/Functions', :path => '../../node_modules/@capacitor-firebase/functions'\nend\n```\n\n**Attention**: Do not add the pod in the section `def capacitor_pods`, but under the comment `# Add your Pods here` ([example](https://github.com/robingenz/capacitor-firebase-plugin-demo/blob/e1684a0af6871442ed0a87dceeeba6fd9ce0185d/ios/App/Podfile#L30)).\n\n#### Disable Functions data collection\n\nSee [Disable Functions data collection](https://firebase.google.com/docs/functions/configure-data-collection?platform=ios#disable_data_collection) if you want to disable Functions data collection.\n\n#### Disable IDFA collection\n\nIf you want to install Firebase without any IDFA collection capability, use the `CapacitorFirebaseFunctions/FunctionsWithoutAdIdSupport` pod in place of the `CapacitorFirebaseFunctions/Functions` pod:\n\n```diff\ntarget 'App' do\ncapacitor_pods\n# Add your Pods here\n-  pod 'CapacitorFirebaseFunctions/Functions', :path => '../../node_modules/@capacitor-firebase/functions'\n+  pod 'CapacitorFirebaseFunctions/FunctionsWithoutAdIdSupport', :path => '../../node_modules/@capacitor-firebase/functions'\nend\n```\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Demo\n\nA working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)\n\n## Usage\n\n```typescript\nimport { FirebaseFunctions } from '@capacitor-firebase/functions';\n\nconst setUserId = async () => {\n  await FirebaseFunctions.setUserId({\n    userId: '123',\n  });\n};\n\nconst setUserProperty = async () => {\n  await FirebaseFunctions.setUserProperty({\n    key: 'language',\n    value: 'en',\n  });\n};\n\nconst setCurrentScreen = async () => {\n  await FirebaseFunctions.setCurrentScreen({\n    screenName: 'Login',\n    screenClassOverride: 'LoginPage',\n  });\n};\n\nconst logEvent = async () => {\n  await FirebaseFunctions.logEvent({\n    name: 'sign_up',\n    params: { method: 'password' },\n  });\n};\n\nconst setSessionTimeoutDuration = async () => {\n  await FirebaseFunctions.setSessionTimeoutDuration({\n    duration: '120',\n  });\n};\n\nconst setEnabled = async () => {\n  await FirebaseFunctions.setEnabled({\n    enabled: true,\n  });\n};\n\nconst isEnabled = async () => {\n  const { enabled } = await FirebaseFunctions.isEnabled();\n  return enabled;\n};\n\nconst resetFunctionsData = async () => {\n  await FirebaseFunctions.resetFunctionsData();\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`httpsCallable(...)`](#httpscallable)\n* [Interfaces](#interfaces)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### httpsCallable(...)\n\n```typescript\nhttpsCallable(options: httpsCallableOptions) => Promise<HttpsCallableResult>\n```\n\nCall a callable function.\n\n| Param         | Type                                                                  |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#httpscallableoptions\">httpsCallableOptions</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#httpscallableresult\">HttpsCallableResult</a>&gt;</code>\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### HttpsCallableResult\n\n| Prop       | Type             | Description                  | Since |\n| ---------- | ---------------- | ---------------------------- | ----- |\n| **`data`** | <code>any</code> | Result of the function call. | 0.1.0 |\n\n\n#### httpsCallableOptions\n\n| Prop       | Type                | Description                      | Since |\n| ---------- | ------------------- | -------------------------------- | ----- |\n| **`name`** | <code>string</code> | The function bname.              | 0.1.0 |\n| **`data`** | <code>object</code> | The data passed to the function. | 0.1.0 |\n\n</docgen-api>\n\n## Test your implementation\n\n[Here](https://firebase.google.com/docs/functions/debugview) you can find more information on how to test the Firebase Functions implementation using the **DebugView**.\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.\n","readmeFilename":"README.md"}