@trakit/react 0.0.5 → 0.0.6

package/context/connectionContext.d.ts

@@ -0,0 +1,64 @@
+import { guid, Machine, nothing, url, User } from '@trakit/objects';
+import { TrakitSyncCommander } from '@trakit/sync';
+import { ReactNode } from 'react';
+/**
+ * The result of the `useConnection` hook, providing the synchronizer instance and connection state.
+ */
+export type ConnectionContextType = {
+    /**
+     * The synchronizer instance used for commands.
+     */
+    readonly synchronizer: TrakitSyncCommander;
+    /**
+     * Indicates whether the connection is ready for use.
+     * Will be `true` if there is {@link User|user session} or {@link Machine|API credentials}
+     * available and the underlying WebSocket connection has been established,
+     * or if there is no authentication details given.
+     */
+    ready: boolean;
+    /**
+     * The session ID taken from a login command.
+     */
+    ghostId: guid;
+    /**
+     * Indicates whether the WebSocket connection is currently online.
+     */
+    online: boolean;
+    /**
+     * The {@link User} information associated with the current session, if available.
+     */
+    user: User | null;
+    /**
+     * The {@link Machine|API credentials} associated with the current session, if available.
+     */
+    machine: Machine | null;
+};
+/**
+ * Provider component that wraps the application with CookiesProvider.
+ * Required for the `useConnection` hook to work properly.
+ *
+ * @example
+ * ```tsx
+ * import { ConnectionProvider, useConnection } from '@trakit/react';
+ *
+ * function App() {
+ *   return (
+ *     <ConnectionProvider>
+ *       <YourComponent />
+ *     </ConnectionProvider>
+ *   );
+ * }
+ * ```
+ */
+export declare function ConnectionProvider({ children, restAddress, socketAddress }: {
+    children: ReactNode;
+    restAddress?: URL | url | nothing;
+    socketAddress?: URL | url | nothing;
+}): import("react").JSX.Element;
+/**
+ * A React hook that manages the connection to the Trak-iT synchronization service.
+ * It initializes the synchronizer, listens for connection and account events,
+ * and provides the current connection state and user/machine information.
+ */
+export declare function useConnection(): ConnectionContextType;
+//# sourceMappingURL=connectionContext.d.ts.map

package/index.d.ts

@@ -4,15 +4,19 @@
  * Last updated on Thu June 11 2026 15:43:01
  * @copyright Trak-iT Wireless Inc. 2026
  */
-import { useConnection, UseConnectionResult } from "./hooks/useConnection";
+import { ConnectionProvider, useConnection, type ConnectionContextType } from "./context/connectionContext";
 import useIsOnline from "./hooks/useIsOnline";
 import { useSingle, useSync, UseSyncMultiple, UseSyncResult, UseSyncSingle } from "./hooks/useSync";
 /**
  * Version number for this release.
  */
-export declare const version = "0.0.5";
+export declare const version = "0.0.6";
 /**
  * Hooks
  */
-export { useConnection, useIsOnline, useSingle, useSync, type UseConnectionResult, type UseSyncMultiple, type UseSyncResult, type UseSyncSingle };
+export { useConnection, useIsOnline, useSingle, useSync, type UseSyncMultiple, type UseSyncResult, type UseSyncSingle, };
+/**
+ * Context provider for connection state and synchronizer instance.
+ */
+export { ConnectionProvider, type ConnectionContextType, };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trakit/react",
   "type": "module",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "main": "./trakit-react.min.js",
   "types": "./index.d.ts",
   "scripts": {
@@ -38,7 +38,9 @@
     "@trakit/commands": "^0.1.2",
     "@trakit/objects": "^0.1.2",
     "@trakit/sync": "^0.1.2",
-    "@types/react": "^19.2.17",
+    "@types/react": "^19.2.17"
+  },
+  "peerDependencies": {
     "react": "19.2.3",
     "react-cookie": "^8.0.1",
     "react-dom": "19.2.3"

package/trakit-react.min.js

@@ -1,7 +1,7 @@
-function n(n,e){function t(n){b(n.online)}function o(n){const{account:e}=n;e.user?.login&&e.expiry>new Date?(c(h,e.ghostId,{...x,expires:e.expiry}),j(e.ghostId||"")):u(h,x),z(e.user||null),e.machine?.key&&e.expiry>new Date?(c(y,e.machine.key,{...x,expires:e.expiry}),c(k,e.machine.secret,{...x,expires:e.expiry})):(u(y,x),u(k,x)),S(e.machine||null)}const i=d(new l(null,n||a.URI_PROD,e||f.URI_PROD)),[r,c,u]=g([h,y,k]),[w,b]=p(i.current.socketOnline),[I,j]=p(r[h]||""),[D,z]=p(i.current.account.user||null),[N,S]=p(i.current.account.machine||r[y]&&new s({key:r[y],secret:r[k]})||null),v=!(!I&&!N)==!(!i.current.account.user&&!i.current.account.machine);return m(()=>{i.current.on("open",t),i.current.on("error",t),i.current.on("close",t),i.current.on("account",o),(I||N)&&i.current.setAuth({ghostId:I,machine:N?.toJSON()})},[]),{synchronizer:i.current,ready:v,ghostId:I,online:w,user:D,machine:N}}function e(n){return window.addEventListener("online",n),window.addEventListener("offline",n),()=>{window.removeEventListener("online",n),window.removeEventListener("offline",n)}}function t(){return navigator.onLine}function o(){return!0}function i(){return w(e,t,o)}function r(e,t){const o=d(null),i=d(0),[r,c]=p(null),[s,l]=p({}),{synchronizer:a,ready:w,online:g,user:h,machine:y}=n();return m(()=>{function n(n,o){0!==i.current&&t===o&&e.includes(n)&&l(e=>({...e,[n]:[...u[n].values().filter(n=>n.companyId===t)]}))}function s(e){const{kind:t,companyId:o}=e;n(t,o)}function d(e){const{name:t,body:o}=e;n(f.msgNameToSyncName(t),o.company)}function p(){if(0===i.current){const n=r?.map(n=>n.syncName).filter(n=>!!n);n?.length&&a.desync(t,n),a.off("list",s),a.off("update",s),a.off("delete",s),a.off("message",d)}o.current=null}function m(o){c(o),e.forEach(e=>n(e,t))}if(w&&e?.length&&!isNaN(t))return i.current++,a.on("list",s),a.on("update",s),a.on("delete",s),a.on("message",d),o.current=a.sync(t,e),o.current.then(m,m),o.current.finally(p),()=>{i.current--,o.current||p()}},[t=t??h?.companyId??y?.companyId,e.sort().join(",")]),{loading:!(w&&g&&Object.keys(s).length&&!o.current),replies:r??[],...s}}function c(n,e){const{loading:t,replies:o,[n]:i}=r([n],e);return{loading:t,replies:o,objects:i??[]}}
+function n({children:n,restAddress:t,socketAddress:r}){return l(A,{children:l(e,{restAddress:t,socketAddress:r,children:n})})}function e({children:n,restAddress:e,socketAddress:t}){function r(n){h(n.online)}function o(n){const{account:e}=n;e.user?.login&&e.expiry>new Date?(c(j,e.ghostId,{...D,expires:e.expiry}),x(e.ghostId||"")):u(j,D),C(e.user||null),e.machine?.key&&e.expiry>new Date?(c(I,e.machine.key,{...D,expires:e.expiry}),c(v,e.machine.secret,{...D,expires:e.expiry})):(u(I,D),u(v,D)),S(e.machine||null)}const i=w(new f(null,e||m.URI_PROD,t||p.URI_PROD)),[s,c,u]=b([j,I,v]),[a,h]=g(i.current.socketOnline),[y,x]=g(s[j]||""),[A,C]=g(i.current.account.user||null),[N,S]=g(i.current.account.machine||s[I]&&new d({key:s[I],secret:s[v]})||null),E=!(!y&&!N)==!(!i.current.account.user&&!i.current.account.machine);return k(()=>{i.current.on("open",r),i.current.on("error",r),i.current.on("close",r),i.current.on("account",o),(y||N)&&i.current.setAuth({ghostId:y,machine:N?.toJSON()})},[]),l(z,{value:{synchronizer:i.current,ready:E,ghostId:y,online:a,user:A,machine:N},children:n})}function t(){const n=y(z);if(!n)throw new Error("useConnection must be used within ConnectionProvider");return n}function r(n){return window.addEventListener("online",n),window.addEventListener("offline",n),()=>{window.removeEventListener("online",n),window.removeEventListener("offline",n)}}function o(){return navigator.onLine}function i(){return!0}function s(){return x(r,o,i)}function c(n,e){const r=w(null),o=w(0),[i,s]=g(null),[c,u]=g({}),{synchronizer:l,ready:d,online:f,user:m,machine:h}=t();return k(()=>{function t(t,r){0!==o.current&&e===r&&n.includes(t)&&u(n=>({...n,[t]:[...a[t].values().filter(n=>n.companyId===e)]}))}function c(n){const{kind:e,companyId:r}=n;t(e,r)}function f(n){const{name:e,body:r}=n;t(p.msgNameToSyncName(e),r.company)}function m(){if(0===o.current){const n=i?.map(n=>n.syncName).filter(n=>!!n);n?.length&&l.desync(e,n),l.off("list",c),l.off("update",c),l.off("delete",c),l.off("message",f)}r.current=null}function h(r){s(r),n.forEach(n=>t(n,e))}if(d&&n?.length&&!isNaN(e))return o.current++,l.on("list",c),l.on("update",c),l.on("delete",c),l.on("message",f),r.current=l.sync(e,n),r.current.then(h,h),r.current.finally(m),()=>{o.current--,r.current||m()}},[e=e??m?.companyId??h?.companyId,n.sort().join(",")]),{loading:!(d&&f&&Object.keys(c).length&&!r.current),replies:i??[],...c}}function u(n,e){const{loading:t,replies:r,[n]:o}=c([n],e);return{loading:t,replies:r,objects:o??[]}}
 /**
  * ReactJS library.
  * {@link https://github.com/trakitwireless/trakit-ts-react|ReactJS controls.}
  * Last updated on Thu June 11 2026 15:43:01
  * @copyright Trak-iT Wireless Inc. 2026
- */import{Machine as s,storage as u}from"@trakit/objects";import{TrakitSyncCommander as l,TrakitRestfulCommander as a,TrakitSocketCommander as f}from"@trakit/sync";import{useRef as d,useState as p,useEffect as m,useSyncExternalStore as w}from"react";import{useCookies as g}from"react-cookie";const h="ghostId",y="aK",k="aS",x={path:"/",secure:!0,sameSite:"strict",expires:new Date(0)},b="0.0.5";export{n as useConnection,i as useIsOnline,c as useSingle,r as useSync,b as version};
+ */import{jsx as l}from"react/jsx-runtime";import{Machine as d,storage as a}from"@trakit/objects";import{TrakitSyncCommander as f,TrakitRestfulCommander as m,TrakitSocketCommander as p}from"@trakit/sync";import{createContext as h,useRef as w,useState as g,useEffect as k,useContext as y,useSyncExternalStore as x}from"react";import{CookiesProvider as A,useCookies as b}from"react-cookie";const j="ghostId",I="aK",v="aS",D={path:"/",secure:!0,sameSite:"strict",expires:new Date(0)},z=h(null),C="0.0.6";export{n as ConnectionProvider,t as useConnection,s as useIsOnline,u as useSingle,c as useSync,C as version};