@agrid/agrid-react-native 4.12.11

package/dist/AgridProvider.d.ts

@@ -0,0 +1,86 @@
+import React from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+import { Agrid, AgridOptions } from './agrid-rn';
+import { AgridAutocaptureOptions } from './types';
+/**
+ * Props for the AgridProvider component.
+ *
+ * @public
+ */
+export interface AgridProviderProps {
+    /** The child components to render within the Agrid context */
+    children: React.ReactNode;
+    /** Agrid configuration options */
+    options?: AgridOptions;
+    /** Your Agrid API key */
+    apiKey?: string;
+    /** An existing Agrid client instance */
+    client?: Agrid;
+    /** Autocapture configuration - can be a boolean or detailed options */
+    autocapture?: boolean | AgridAutocaptureOptions;
+    /** Enable debug mode for additional logging */
+    debug?: boolean;
+    /** Custom styles for the provider wrapper View */
+    style?: StyleProp<ViewStyle>;
+}
+/**
+ * AgridProvider is a React component that provides Agrid functionality to your React Native app. You can find all configuration options in the [React Native SDK docs](https://agrid.com/docs/libraries/react-native#configuration-options).
+ *
+ * Autocapturing navigation requires further configuration. See the [React Native SDK navigation docs](https://agrid.com/docs/libraries/react-native#capturing-screen-views)
+ * for more information about autocapturing navigation.
+ *
+ * This is the recommended way to set up Agrid for React Native. This utilizes the Context API to pass the Agrid client around, enable autocapture.
+ *
+ * {@label Initialization}
+ *
+ * @example
+ * ```jsx
+ * // Add to App.(js|ts)
+ * import { useAgrid, AgridProvider } from 'agrid-react-native'
+ *
+ * export function MyApp() {
+ *     return (
+ *         <AgridProvider apiKey="<ph_project_api_key>" options={{
+ *             host: '<ph_client_api_host>',
+ *         }}>
+ *             <MyComponent />
+ *         </AgridProvider>
+ *     )
+ * }
+ *
+ * // And access the Agrid client via the useAgrid hook
+ * import { useAgrid } from 'agrid-react-native'
+ *
+ * const MyComponent = () => {
+ *     const agrid = useAgrid()
+ *
+ *     useEffect(() => {
+ *         agrid.capture("event_name")
+ *     }, [agrid])
+ * }
+ *
+ * ```
+ *
+ * @example
+ * ```jsx
+ * // Using with existing client
+ * import { Agrid } from 'agrid-react-native'
+ *
+ * const agrid = new Agrid('<ph_project_api_key>', {
+ *     host: '<ph_client_api_host>'
+ * })
+ *
+ * export function MyApp() {
+ *     return (
+ *         <AgridProvider client={agrid}>
+ *             <MyComponent />
+ *         </AgridProvider>
+ *     )
+ * }
+ * ```
+ *
+ * @public
+ *
+ * @param props - The AgridProvider props
+ */
+export declare const AgridProvider: ({ children, client, options, apiKey, autocapture, style, debug, }: AgridProviderProps) => JSX.Element | null;

package/dist/AgridProvider.js

@@ -0,0 +1 @@
+"use strict";var _interopRequireDefault=require("@babel/runtime/helpers/interopRequireDefault");var _typeof=require("@babel/runtime/helpers/typeof");Object.defineProperty(exports,"__esModule",{value:true});exports.AgridProvider=void 0;var _defineProperty2=_interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));var _react=_interopRequireWildcard(require("react"));var _reactNative=require("react-native");var _agridRn=require("./agrid-rn");var _autocapture=require("./autocapture");var _useNavigationTracker=require("./hooks/useNavigationTracker");var _AgridContext=require("./AgridContext");var _jsxRuntime=require("react/jsx-runtime");var _this=void 0,_jsxFileName="/Users/hieu/Downloads/agrid-react-native-main/dist/AgridProvider.js";function _interopRequireWildcard(e,t){if("function"==typeof WeakMap)var r=new WeakMap(),n=new WeakMap();return(_interopRequireWildcard=function _interopRequireWildcard(e,t){if(!t&&e&&e.__esModule)return e;var o,i,f={__proto__:null,"default":e};if(null===e||"object"!=_typeof(e)&&"function"!=typeof e)return f;if(o=t?n:r){if(o.has(e))return o.get(e);o.set(e,f);}for(var _t2 in e)"default"!==_t2&&{}.hasOwnProperty.call(e,_t2)&&((i=(o=Object.defineProperty)&&Object.getOwnPropertyDescriptor(e,_t2))&&(i.get||i.set)?o(f,_t2,i):f[_t2]=e[_t2]);return f;})(e,t);}function ownKeys(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);r&&(o=o.filter(function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable;})),t.push.apply(t,o);}return t;}function _objectSpread(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?ownKeys(Object(t),!0).forEach(function(r){(0,_defineProperty2["default"])(e,r,t[r]);}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):ownKeys(Object(t)).forEach(function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r));});}return e;}function AgridNavigationHook(_ref){var options=_ref.options,client=_ref.client;(0,_useNavigationTracker.useNavigationTracker)(options===null||options===void 0?void 0:options.navigation,options===null||options===void 0?void 0:options.navigationRef,client);return null;}var AgridProvider=exports.AgridProvider=function AgridProvider(_ref2){var children=_ref2.children,client=_ref2.client,options=_ref2.options,apiKey=_ref2.apiKey,autocapture=_ref2.autocapture,style=_ref2.style,_ref2$debug=_ref2.debug,debug=_ref2$debug===void 0?false:_ref2$debug;var _a;if(!client&&!apiKey){throw new Error('Either a Agrid client or an apiKey is required. If you want to use the AgridProvider without a client, please provide an apiKey and the options={ disabled: true }.');}var captureAll=autocapture===true;var captureNone=autocapture===false;var agrid=(0,_react.useMemo)(function(){if(client&&apiKey){console.warn('You have provided both a client and an apiKey to AgridProvider. The apiKey will be ignored in favour of the client.');}if(client){return client;}var parsedOptions=_objectSpread(_objectSpread({},options),{},{captureAppLifecycleEvents:(options===null||options===void 0?void 0:options.captureAppLifecycleEvents)!==undefined?options.captureAppLifecycleEvents:!captureNone&&captureAll});return new _agridRn.Agrid(apiKey!==null&&apiKey!==void 0?apiKey:'',parsedOptions);},[client,apiKey]);var autocaptureOptions=(0,_react.useMemo)(function(){return autocapture&&typeof autocapture!=='boolean'?autocapture:{};},[autocapture]);var captureTouches=!captureNone&&agrid&&(captureAll||(autocaptureOptions===null||autocaptureOptions===void 0?void 0:autocaptureOptions.captureTouches));var captureScreens=!captureNone&&agrid&&(captureAll||((_a=autocaptureOptions===null||autocaptureOptions===void 0?void 0:autocaptureOptions.captureScreens)!==null&&_a!==void 0?_a:true));var phLabelProp=(autocaptureOptions===null||autocaptureOptions===void 0?void 0:autocaptureOptions.customLabelProp)||_autocapture.defaultAgridLabelProp;(0,_react.useEffect)(function(){agrid.debug(debug);},[debug,agrid]);var onTouch=(0,_react.useCallback)(function(type,e){if(!captureTouches){return;}if(type==='end'){(0,_autocapture.autocaptureFromTouchEvent)(e,agrid,autocaptureOptions);}},[captureTouches,agrid,autocaptureOptions]);return(0,_jsxRuntime.jsx)(_reactNative.View,_objectSpread(_objectSpread({},(0,_defineProperty2["default"])({},phLabelProp,'AgridProvider')),{},{style:style||{flex:1},onTouchEndCapture:captureTouches?function(e){return onTouch('end',e);}:undefined,children:(0,_jsxRuntime.jsxs)(_AgridContext.AgridContext.Provider,{value:{client:agrid},children:[captureScreens&&(0,_jsxRuntime.jsx)(AgridNavigationHook,{options:autocaptureOptions,client:agrid}),children]})}));};

package/dist/AgridProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgridProvider.js","sourceRoot":"","sources":["../src/AgridProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAC9D,OAAO,EAAoC,IAAI,EAAa,MAAM,cAAc,CAAA;AAChF,OAAO,EAAE,KAAK,EAAgB,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAwBrD,SAAS,mBAAmB,CAAC,EAC3B,OAAO,EACP,MAAM,GAIP;IACC,oBAAoB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,EAAE,MAAM,CAAC,CAAA;IACzE,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAC5B,QAAQ,EACR,MAAM,EACN,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,KAAK,GAAG,KAAK,GACM,EAAsB,EAAE;;IAC3C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,qKAAqK,CACtK,CAAA;IACH,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,KAAK,IAAI,CAAA;IACvC,MAAM,WAAW,GAAG,WAAW,KAAK,KAAK,CAAA;IAEzC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE;QACzB,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CACV,qHAAqH,CACtH,CAAA;QACH,CAAC;QAED,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAA;QACf,CAAC;QAED,MAAM,aAAa,GAAG;YACpB,GAAG,OAAO;YACV,yBAAyB,EACvB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,yBAAyB,MAAK,SAAS;gBAC9C,CAAC,CAAC,OAAO,CAAC,yBAAyB;gBACnC,CAAC,CAAC,CAAC,WAAW,IAAI,UAAU;SACjC,CAAA;QAED,OAAO,IAAI,KAAK,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,EAAE,aAAa,CAAC,CAAA;IAC/C,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA,CAAC,kDAAkD;IAEvE,MAAM,kBAAkB,GAAG,OAAO,CAChC,GAAG,EAAE,CAAC,CAAC,WAAW,IAAI,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAC1E,CAAC,WAAW,CAAC,CACd,CAAA;IAED,MAAM,cAAc,GAAG,CAAC,WAAW,IAAI,KAAK,IAAI,CAAC,UAAU,KAAI,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,CAAA,CAAC,CAAA;IAClG,MAAM,cAAc,GAAG,CAAC,WAAW,IAAI,KAAK,IAAI,CAAC,UAAU,IAAI,CAAC,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,mCAAI,IAAI,CAAC,CAAC,CAAA,CAAC,6BAA6B;IAC1I,MAAM,WAAW,GAAG,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,eAAe,KAAI,qBAAqB,CAAA;IAEhF,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAA;IAElB,MAAM,OAAO,GAAG,WAAW,CACzB,CAAC,IAA8B,EAAE,CAAwB,EAAE,EAAE;QAC3D,+FAA+F;QAC/F,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QAED,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,yBAAyB,CAAC,CAAC,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAA;QACzD,CAAC;IACH,CAAC,EACD,CAAC,cAAc,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAC5C,CAAA;IAED,OAAO,CACL,CAAC,IAAI,CACH,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC,0DAA0D;KAClG,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAC5B,iBAAiB,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAEzE;MAAA,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC9C;QAAA,CAAC,cAAc,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,EAAG,CACtF;QAAA,CAAC,QAAQ,CACX;MAAA,EAAE,YAAY,CAAC,QAAQ,CACzB;IAAA,EAAE,IAAI,CAAC,CACR,CAAA;AACH,CAAC,CAAA"}