@trakit/react 0.0.11 → 0.0.12

package/context/{connectionContext.d.ts → apiContext.d.ts}

@@ -1,16 +1,20 @@
 import { guid, Machine, nothing, url, User } from '@trakit/objects';
-import { TrakitSyncCommander } from '@trakit/sync';
+import { TrakitAuditCommander, TrakitSyncCommander } from '@trakit/sync';
 import { ReactNode } from 'react';
 /**
  * The result of the `useConnection` hook, providing the synchronizer instance and connection state.
  */
-export type ConnectionContextType = {
+export type ApiContextType = {
     /**
      * The synchronizer instance used for commands.
      */
     readonly synchronizer: TrakitSyncCommander;
     /**
-     * Indicates whether the connection is ready for use.
+     * The auditor instance used for history.
+     */
+    readonly auditor: TrakitAuditCommander;
+    /**
+     * Indicates whether the APIs are 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.
@@ -35,30 +39,31 @@ export type ConnectionContextType = {
 };
 /**
  * Provider component that wraps the application with CookiesProvider.
- * Required for the `useConnection` hook to work properly.
+ * Required for the `useApi` hook to work properly.
  *
  * @example
  * ```tsx
- * import { ConnectionProvider, useConnection } from '@trakit/react';
+ * import { ApiProvider, useApi } from '@trakit/react';
  *
  * function App() {
  *   return (
- *     <ConnectionProvider>
+ *     <ApiProvider>
  *       <YourComponent />
- *     </ConnectionProvider>
+ *     </ApiProvider>
  *   );
  * }
  * ```
  */
-export declare function ConnectionProvider({ children, restAddress, socketAddress }: {
+export declare function ApiProvider({ children, restAddress, socketAddress, auditAddress, }: {
     children: ReactNode;
     restAddress?: URL | url | nothing;
     socketAddress?: URL | url | nothing;
+    auditAddress?: URL | url | nothing;
 }): import("react").JSX.Element;
 /**
- * A React hook that manages the connection to the Trak-iT synchronization service.
+ * A React hook that manages the connection to the Trak-iT synchronization service and APIs.
  * It initializes the synchronizer, listens for connection and account events,
- * and provides the current connection state and user/machine information.
+ * and provides the current connection state, API instances, and user/machine information.
  */
-export declare function useConnection(): ConnectionContextType;
-//# sourceMappingURL=connectionContext.d.ts.map
+export declare function useApi(): ApiContextType;
+//# sourceMappingURL=apiContext.d.ts.map

package/index.d.ts

@@ -4,20 +4,19 @@
  * Last updated on Thu June 11 2026 15:43:01
  * @copyright Trak-iT Wireless Inc. 2026
  */
-import { ConnectionProvider, useConnection, type ConnectionContextType } from "./context/connectionContext";
-import { useAudit } from "./hooks/useAudit";
+import { ApiProvider, useApi, type ApiContextType } from "./context/apiContext";
 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.11";
+export declare const version = "0.0.12";
 /**
  * Hooks
  */
-export { useAudit, useConnection, useIsOnline, useSingle, useSync, type UseSyncMultiple, type UseSyncResult, type UseSyncSingle };
+export { useApi, useIsOnline, useSingle, useSync, type UseSyncMultiple, type UseSyncResult, type UseSyncSingle };
 /**
- * Context provider for connection state and synchronizer instance.
+ * Context provider for connection state and API instances.
  */
-export { ConnectionProvider, type ConnectionContextType };
+export { ApiProvider, type ApiContextType };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trakit/react",
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "main": "./trakit-react.min.js",
   "types": "./index.d.ts",
   "scripts": {
@@ -35,7 +35,7 @@
     "vitest": "^4.0.7"
   },
   "dependencies": {
-    "@trakit/commands": "^0.1.7",
+    "@trakit/commands": "^0.1.8",
     "@trakit/objects": "^0.1.5",
     "@trakit/sync": "^0.1.10",
     "@types/react": "^19.2.17"

package/trakit-react.min.js

@@ -1,7 +1,7 @@
-function n({children:n,restAddress:t,socketAddress:r}){return d(I,{children:d(e,{restAddress:t,socketAddress:r,children:n})})}function e({children:n,restAddress:e,socketAddress:t}){function r(n){f(n.online)}function o(n){const{account:e}=n;e.user?.login&&e.expiry>new Date?(c(v,e.ghostId,{...C,expires:e.expiry}),g(e.ghostId||"")):u(v,C),b(e.user||null),e.machine?.key&&e.expiry>new Date?(c(D,e.machine.key,{...C,expires:e.expiry}),c(z,e.machine.secret,{...C,expires:e.expiry})):(u(D,C),u(z,C)),S(e.machine||null)}const i=y(new m(null,e||p.URI_PROD,t||w.URI_PROD)),[s,c,u]=j([v,D,z]),[l,f]=k(i.current.socketOnline),[h,g]=k(s[v]||""),[A,b]=k(i.current.account.user||null),[I,S]=k(i.current.account.machine||s[D]&&new a({key:s[D],secret:s[z]})||null),E=!(!h&&!I)==!(!i.current.account.user&&!i.current.account.machine);return x(()=>{i.current.on("open",r),i.current.on("error",r),i.current.on("close",r),i.current.on("account",o),(h||I)&&i.current.setAuth({ghostId:h,machine:I?.toJSON()})},[]),d(N,{value:{synchronizer:i.current,ready:E,ghostId:h,online:l,user:A,machine:I},children:n})}function t(){const n=A(N);if(!n)throw new Error("useConnection must be used within ConnectionProvider");return n}function r(n,e){const t=y(new h(null,e||h.URI_PROD)),r=!(!t.current.account.user&&!t.current.account.machine);return x(()=>t.current.setAuth(n),[n?.machine?.key||n?.user?.login||n?.key||n?.ghostId||n||null]),{auditor:t.current,ready:r}}function o(n){return window.addEventListener("online",n),window.addEventListener("offline",n),()=>{window.removeEventListener("online",n),window.removeEventListener("offline",n)}}function i(){return navigator.onLine}function s(){return!0}function c(){return b(o,i,s)}function u(n,e){const r=y(null),o=y(0),[i,s]=k(null),[c,u]=k({}),{synchronizer:l,ready:d,online:a,user:m,machine:p}=t();return x(()=>{function t(t,r){0!==o.current&&e===r&&n.includes(t)&&u(n=>({...n,[t]:[...f[t].values().filter(n=>n.companyId===e)]}))}function c(n){const{kind:e,companyId:r}=n;t(e,r)}function a(n){const{name:e,body:r}=n;t(w.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",a)}r.current=null}function p(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",a),r.current=r.current||l.sync(e,n),r.current.then(p,p),r.current.finally(m),()=>{o.current--,r.current||m()}},[e=e??m?.companyId??p?.companyId,n.sort().join(",")]),{loading:!(d&&a&&i&&!r.current),replies:i??[],...c}}function l(n,e){const{loading:t,replies:r,[n]:o}=u([n],e);return{loading:t,replies:r,objects:o??[]}}
+function n({children:n,restAddress:t,socketAddress:r,auditAddress:i}){return d(b,{children:d(e,{restAddress:t,socketAddress:r,auditAddress:i,children:n})})}function e({children:n,restAddress:e,socketAddress:t,auditAddress:r}){function i(n){x(n.online)}function o(n){const{account:e}=n;e.user?.login&&e.expiry>new Date?(a(j,e.ghostId,{...z,expires:e.expiry}),S(e.ghostId||"")):h(j,z),K(e.user||null),e.machine?.key&&e.expiry>new Date?(a(v,e.machine.key,{...z,expires:e.expiry}),a(D,e.machine.secret,{...z,expires:e.expiry})):(h(v,z),h(D,z)),q(e.machine||null),c.current.setAuth(e)}const s=A(new f(null,e||m.URI_PROD,t||p.URI_PROD)),c=A(new w(null,r||w.URI_PROD)),[u,a,h]=I([j,v,D]),[y,x]=g(s.current.socketOnline),[b,S]=g(u[j]||""),[E,K]=g(s.current.account.user||null),[P,q]=g(s.current.account.machine||u[v]&&new l({key:u[v],secret:u[D]})||null),B=!(!b&&!P)==!(!s.current.account.user&&!s.current.account.machine);return k(()=>{s.current.on("open",i),s.current.on("error",i),s.current.on("close",i),s.current.on("account",o),(b||P)&&s.current.setAuth({ghostId:b,machine:P?.toJSON()})},[]),d(N,{value:{synchronizer:s.current,auditor:c.current,ready:B,ghostId:b,online:y,user:E,machine:P},children:n})}function t(){const n=y(N);if(!n)throw new Error("useApi must be used within ApiProvider");return n}function r(n){return window.addEventListener("online",n),window.addEventListener("offline",n),()=>{window.removeEventListener("online",n),window.removeEventListener("offline",n)}}function i(){return navigator.onLine}function o(){return!0}function s(){return x(r,i,o)}function c(n,e){const r=A(null),i=A(0),[o,s]=g(null),[c,u]=g({}),{synchronizer:d,ready:l,online:f,user:m,machine:w}=t();return k(()=>{function t(t,r){0!==i.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===i.current){const n=o?.map(n=>n.syncName).filter(n=>!!n);n?.length&&d.desync(e,n),d.off("list",c),d.off("update",c),d.off("delete",c),d.off("message",f)}r.current=null}function w(r){s(r),n.forEach(n=>t(n,e))}if(l&&n?.length&&!isNaN(e))return i.current++,d.on("list",c),d.on("update",c),d.on("delete",c),d.on("message",f),r.current=r.current||d.sync(e,n),r.current.then(w,w),r.current.finally(m),()=>{i.current--,r.current||m()}},[e=e??m?.companyId??w?.companyId,n.sort().join(",")]),{loading:!(l&&f&&o&&!r.current),replies:o??[],...c}}function u(n,e){const{loading:t,replies:r,[n]:i}=c([n],e);return{loading:t,replies:r,objects:i??[]}}
 /**
  * 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{jsx as d}from"react/jsx-runtime";import{Machine as a,storage as f}from"@trakit/objects";import{TrakitSyncCommander as m,TrakitRestfulCommander as p,TrakitSocketCommander as w,TrakitAuditCommander as h}from"@trakit/sync";import{createContext as g,useRef as y,useState as k,useEffect as x,useContext as A,useSyncExternalStore as b}from"react";import{CookiesProvider as I,useCookies as j}from"react-cookie";const v="ghostId",D="aK",z="aS",C={path:"/",secure:!0,sameSite:"strict",expires:new Date(0)},N=g(null),S="0.0.11";export{n as ConnectionProvider,r as useAudit,t as useConnection,c as useIsOnline,l as useSingle,u as useSync,S as version};
+ */import{jsx as d}from"react/jsx-runtime";import{Machine as l,storage as a}from"@trakit/objects";import{TrakitSyncCommander as f,TrakitRestfulCommander as m,TrakitSocketCommander as p,TrakitAuditCommander as w}from"@trakit/sync";import{createContext as h,useRef as A,useState as g,useEffect as k,useContext as y,useSyncExternalStore as x}from"react";import{CookiesProvider as b,useCookies as I}from"react-cookie";const j="ghostId",v="aK",D="aS",z={path:"/",secure:!0,sameSite:"strict",expires:new Date(0)},N=h(null),S="0.0.12";export{n as ApiProvider,t as useApi,s as useIsOnline,u as useSingle,c as useSync,S as version};

package/hooks/useAudit.d.ts

@@ -1,22 +0,0 @@
-import { RepSelfGet } from '@trakit/commands';
-import { guid, Machine, nothing, url } from '@trakit/objects';
-import { TrakitAuditCommander } from '@trakit/sync';
-/**
- *
- * @param account The account information used for authentication.
- * @param baseAddress The base address of the audit service.
- * @returns An object containing the auditor instance and its readiness state.
- */
-export declare function useAudit(account?: RepSelfGet | {
-    machine: {
-        key: string;
-    };
-} | Machine | {
-    key: string;
-} | {
-    ghostId: guid;
-} | guid | nothing, baseAddress?: URL | url | nothing): {
-    auditor: TrakitAuditCommander;
-    ready: boolean;
-};
-//# sourceMappingURL=useAudit.d.ts.map

package/hooks/useConnection.d.ts

@@ -1,41 +0,0 @@
-import { guid, Machine, nothing, url, User } from '@trakit/objects';
-import { TrakitSyncCommander } from '@trakit/sync';
-/**
- * The result of the `useConnection` hook, providing the synchronizer instance and connection state.
- */
-export type UseConnectionResult = {
-    /**
-     * 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;
-};
-/**
- * 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(restAddress?: URL | url | nothing, socketAddress?: URL | url | nothing): UseConnectionResult;
-//# sourceMappingURL=useConnection.d.ts.map

package/hooks/useStateRef.d.ts

@@ -1,2 +0,0 @@
-export declare function useStateRef<T>(initial: T): readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>, import("react").RefObject<T>];
-//# sourceMappingURL=useStateRef.d.ts.map