@actschurch/ccms-sdk 0.0.1 → 0.0.3

package/README.html

@@ -218,11 +218,11 @@ strong {
 
 <h2>Installation</h2>
 
-<pre><code class="language-bash">npm install @ccms/sdk
+<pre><code class="language-bash">npm install @actschurch/ccms-sdk
 <h1>or</h1>
-<p>yarn add @ccms/sdk</p>
+<p>yarn add @actschurch/ccms-sdk</p>
 <h1>or</h1>
-<p>pnpm add @ccms/sdk</code></pre></p>
+<p>pnpm add @actschurch/ccms-sdk</code></pre></p>
 
 <h3>Peer Dependencies</h3>
 
@@ -235,7 +235,7 @@ strong {
 
 <h3>Basic Setup (Vanilla JavaScript/TypeScript)</h3>
 
-<pre><code class="language-typescript">import { HttpClient, AuthManager, LocalStorageAdapter } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { HttpClient, AuthManager, LocalStorageAdapter } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Create HTTP client
 const http = new HttpClient({
@@ -262,7 +262,7 @@ const response = await http.get(&#039;/api/members&#039;);</code></pre></p>
 
 <h3>React Setup</h3>
 
-<pre><code class="language-tsx">import { CCMSProvider, useCCMS, useAuth } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { CCMSProvider, useCCMS, useAuth } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Wrap your app with CCMSProvider
 function App() {
@@ -303,7 +303,7 @@ function Dashboard() {
 
 <p>The <code>HttpClient</code> is the foundation for all API communication. It handles request/response interceptors, authentication headers, and error handling.</p>
 
-<pre><code class="language-typescript">import { HttpClient } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { HttpClient } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>const http = new HttpClient({
   baseUrl: &#039;https://api.yourccms.com&#039;,
@@ -369,7 +369,7 @@ http.interceptors.response.use(
 
 <p>The <code>AuthManager</code> handles the complete authentication flow including login, logout, token refresh, and session persistence.</p>
 
-<pre><code class="language-typescript">import { AuthManager, LocalStorageAdapter, MemoryStorageAdapter } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { AuthManager, LocalStorageAdapter, MemoryStorageAdapter } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Create auth manager
 const authManager = new AuthManager(http, {
@@ -441,7 +441,7 @@ authManager.destroy();</code></pre></p>
   SecureStorageAdapter,     // React Native - secure storage
   CookieStorageAdapter,     // SSR/universal apps
   GenericStorageAuthAdapter, // Custom storage
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>// React Native with AsyncStorage
 import AsyncStorage from &#039;@react-native-async-storage/async-storage&#039;;
@@ -460,7 +460,7 @@ const storage = new LocalStorageAdapter(&#039;my<em>app</em>auth&#039;);</code><
 
 <p>The <code>PermissionManager</code> handles feature-based access control using roles and permissions.</p>
 
-<pre><code class="language-typescript">import { PermissionManager, defineFeature, requires } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { PermissionManager, defineFeature, requires } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Create permission manager
 const permissions = new PermissionManager({
@@ -557,7 +557,7 @@ permissions.onDenied((event) =&gt; {
 
 <p><strong>Available Statuses:</strong> <code>Online</code>, <code>Away</code>, <code>Busy</code>, <code>Offline</code></p>
 
-<pre><code class="language-tsx">import { PresenceProvider, usePresence, useUserPresence, useOnlineUsers, usePresenceStatus, PresenceStatus } from &#039;@ccms/sdk/realtime/presence&#039;;
+<pre><code class="language-tsx">import { PresenceProvider, usePresence, useUserPresence, useOnlineUsers, usePresenceStatus, PresenceStatus } from &#039;@actschurch/ccms-sdk/realtime/presence&#039;;
 
 <p>// Setup in your app root with auto-connection management
 function App() {
@@ -645,7 +645,7 @@ function OnlineUsersList() {
   useApiLogs,
   useQueryLogs,
   useDashboard,
-} from &#039;@ccms/sdk/realtime/logs&#039;;</p>
+} from &#039;@actschurch/ccms-sdk/realtime/logs&#039;;</p>
 
 <p>// Application logs with filtering and event handling
 function LogsViewer() {
@@ -840,12 +840,12 @@ function PerformanceDashboard() {
 <p>The old <code>RealtimeClient</code> is deprecated. Migrate to the new SignalR-based modules:</p>
 
 <pre><code class="language-typescript">// Old (deprecated)
-<p>import { RealtimeClient } from &#039;@ccms/sdk&#039;;
+<p>import { RealtimeClient } from &#039;@actschurch/ccms-sdk&#039;;
 const realtime = new RealtimeClient(config);
 realtime.updatePresence(&#039;Online&#039;);</p>
 
 <p>// New (recommended)
-import { usePresence } from &#039;@ccms/sdk/realtime/presence&#039;;
+import { usePresence } from &#039;@actschurch/ccms-sdk/realtime/presence&#039;;
 const { updateStatus } = usePresence();
 updateStatus(PresenceStatus.Online);</code></pre></p>
 
@@ -855,7 +855,7 @@ updateStatus(PresenceStatus.Online);</code></pre></p>
 
 <p>The SDK provides comprehensive error handling utilities.</p>
 
-<pre><code class="language-typescript">import { ErrorHandler, CCMSError } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { ErrorHandler, CCMSError } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Create error handler
 const errorHandler = new ErrorHandler({
@@ -888,7 +888,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 
 <p>Wrap your application with <code>CCMSProvider</code>:</p>
 
-<pre><code class="language-tsx">import { CCMSProvider } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { CCMSProvider } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>function App() {
   return (
@@ -918,7 +918,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
   useHttpClient,
   useRealtime,
   usePermissions,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>function MyComponent() {
   // Access full SDK context
@@ -932,7 +932,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 
 <h4>Authentication Hooks</h4>
 
-<pre><code class="language-tsx">import { useAuth, useIsAuthenticated, useUser, useHasRole, useHasRight } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { useAuth, useIsAuthenticated, useUser, useHasRole, useHasRight } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>function Profile() {
   const { user, isAuthenticated, isLoading, login, logout } = useAuth();</p>
@@ -957,7 +957,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 
 <h4>API Hooks</h4>
 
-<pre><code class="language-tsx">import { useQuery, useMutation, useInfiniteQuery, usePrefetch } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { useQuery, useMutation, useInfiniteQuery, usePrefetch } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>function MemberList() {
   // Fetch data
@@ -1011,7 +1011,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
   usePresenceStatus,
   useOnlineUsers,
   useUserPresence,
-} from &#039;@ccms/sdk/realtime/presence&#039;;</p>
+} from &#039;@actschurch/ccms-sdk/realtime/presence&#039;;</p>
 
 <p>function ChatRoom() {
   // Main presence hook
@@ -1047,7 +1047,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
   useApiLogs,
   useQueryLogs,
   useDashboard,
-} from &#039;@ccms/sdk/realtime/logs&#039;;</p>
+} from &#039;@actschurch/ccms-sdk/realtime/logs&#039;;</p>
 
 <p>function LogMonitor() {
   // Application logs
@@ -1087,7 +1087,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 <pre><code class="language-tsx">// ⚠️ DEPRECATED: These hooks are deprecated and will be removed in v2.0.0
 <p>// Use the new hooks above instead</p>
 
-<p>import { useRealtimeEvent, useConnectionState } from &#039;@ccms/sdk&#039;;</p>
+<p>import { useRealtimeEvent, useConnectionState } from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>function OldComponent() {
   const connectionState = useConnectionState(); // Use usePresence() instead
@@ -1112,7 +1112,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
   useClipboard,
   useClickOutside,
   useKeyPress,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>function SearchComponent() {
   const [search, setSearch] = useState(&#039;&#039;);
@@ -1150,7 +1150,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 
 <h4>Permission Components</h4>
 
-<pre><code class="language-tsx">import { Can, RequireAuth, RequireRole, RequireRight } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { Can, RequireAuth, RequireRole, RequireRight } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>function App() {
   return (
@@ -1188,7 +1188,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 
 <h4>Error Boundary</h4>
 
-<pre><code class="language-tsx">import { ErrorBoundary } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-tsx">import { ErrorBoundary } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>function App() {
   return (
@@ -1215,7 +1215,7 @@ throw new CCMSError(&#039;Something went wrong&#039;, {
 <pre><code class="language-typescript">// In your app entry point (App.tsx or index.js)
 <p>import AsyncStorage from &#039;@react-native-async-storage/async-storage&#039;;
 import NetInfo from &#039;@react-native-community/netinfo&#039;;
-import { setGlobalStorage, setGlobalNetworkStatus } from &#039;@ccms/sdk&#039;;</p>
+import { setGlobalStorage, setGlobalNetworkStatus } from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>// Configure storage (do this before using any SDK features)
 setGlobalStorage(AsyncStorage);</p>
@@ -1236,7 +1236,7 @@ setGlobalNetworkStatus({
 <h3>Use with Expo SecureStore</h3>
 
 <pre><code class="language-typescript">import * as SecureStore from &#039;expo-secure-store&#039;;
-<p>import { SecureStorageAdapter, AuthManager } from &#039;@ccms/sdk&#039;;</p>
+<p>import { SecureStorageAdapter, AuthManager } from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>const authManager = new AuthManager(http, {
   storage: new SecureStorageAdapter(SecureStore),
@@ -1359,7 +1359,7 @@ setGlobalNetworkStatus({
 
 <h3>Using Services</h3>
 
-<pre><code class="language-typescript">import { MemberService, TaskService } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { MemberService, TaskService } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>// Initialize services with HTTP client
 const memberService = new MemberService(http);
@@ -1419,7 +1419,7 @@ await taskService.addComment(&#039;task-789&#039;, &#039;Completed the follow-up
   useFeedbackServices,
   useSystemServices,
   useGeneratorsServices,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>function TaskList() {
   const { task, taskStatus, taskPriority } = useTaskServices();
@@ -1469,7 +1469,7 @@ function MeetingScheduler() {
 
 <p>You can create custom services by extending the base service class:</p>
 
-<pre><code class="language-typescript">import { BaseService } from &#039;@ccms/sdk&#039;;
+<pre><code class="language-typescript">import { BaseService } from &#039;@actschurch/ccms-sdk&#039;;
 
 <p>class CustomService extends BaseService {
   constructor(http: HttpClient) {
@@ -1567,7 +1567,7 @@ await memberService.deleteMany([&#039;member-3&#039;, &#039;member-4&#039;]);</c
   getInitials,
   pluralize,
   similarity,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>capitalize(&#039;hello world&#039;); // &quot;Hello world&quot;
 toCamelCase(&#039;hello-world&#039;); // &quot;helloWorld&quot;
@@ -1591,7 +1591,7 @@ similarity(&#039;hello&#039;, &#039;hallo&#039;); // 0.8</code></pre></p>
   toOrdinal,
   formatFileSize,
   formatDurationFromSeconds,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>formatCurrency(1234.56, &#039;USD&#039;); // &quot;$1,234.56&quot;
 formatNumber(1234567); // &quot;1,234,567&quot;
@@ -1618,7 +1618,7 @@ formatDurationFromSeconds(3661); // &quot;1:01:01&quot;</code></pre></p>
   fromNow,
   toUnix,
   fromUnix,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>formatDate(new Date(), &#039;YYYY-MM-DD&#039;); // &quot;2024-01-15&quot;
 addDays(new Date(), 7); // Date 7 days from now
@@ -1642,7 +1642,7 @@ isWeekend(new Date()); // true/false</code></pre></p>
   union,
   flatten,
   moveItem,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>unique([1, 2, 2, 3]); // [1, 2, 3]
 uniqueBy(users, &#039;email&#039;); // Remove duplicates by email
@@ -1669,7 +1669,7 @@ sample(items, 3); // Random 3 items</code></pre></p>
   isEmpty,
   mapValues,
   filterObject,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>deepClone(complexObject);
 deepMerge(defaults, userConfig);
@@ -1698,7 +1698,7 @@ diff(original, modified); // { changed: &#039;fields&#039; }</code></pre></p>
   validatePassword,
   validateUsername,
   validateAll,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>isEmail(&#039;test@example.com&#039;); // true
 isPhoneNumber(&#039;+1-555-123-4567&#039;); // true
@@ -1730,7 +1730,7 @@ validateAll([
   isLightColor,
   mix,
   generatePalette,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>hexToRgb(&#039;#ff5500&#039;); // { r: 255, g: 85, b: 0 }
 rgbToHex(255, 85, 0); // &quot;#ff5500&quot;
@@ -1754,7 +1754,7 @@ generatePalette(&#039;#ff5500&#039;, 5); // { light: [...], dark: [...] }</code>
   isIOS,
   isAndroid,
   getBrowserInfo,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>if (isProduction()) {
   // Production-only code
@@ -1788,7 +1788,7 @@ generatePalette(&#039;#ff5500&#039;, 5); // { light: [...], dark: [...] }</code>
   getCurrentBreakpoint,
   isAtLeast,
   isAtMost,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>const screen = getScreenInfo(); // { width, height, pixelRatio, orientation }
 const device = getDeviceType(); // &#039;phone&#039; | &#039;tablet&#039; | &#039;desktop&#039;
@@ -1819,7 +1819,7 @@ if (isAtLeast(&#039;md&#039;)) {
   fetchWithRetry,
   createQueryString,
   buildUrl,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>// Create responses
 const success = createSuccessResponse(data, &#039;Operation successful&#039;);
@@ -1862,7 +1862,7 @@ const url = buildUrl(&#039;https://api.example.com&#039;, &#039;/users&#039;, {
   ValidationError,
   NetworkError,
   TimeoutError,
-} from &#039;@ccms/sdk&#039;;</p>
+} from &#039;@actschurch/ccms-sdk&#039;;</p>
 
 <p>// Safe execution with fallback
 const result = safeTry(() =&gt; JSON.parse(input), {});</p>
@@ -1926,7 +1926,7 @@ const message = formatErrorForUser(error);
   Address,</p>
 
 <p>  // And many more...
-} from &#039;@ccms/sdk&#039;;</code></pre></p>
+} from &#039;@actschurch/ccms-sdk&#039;;</code></pre></p>
 
 <hr>
 
@@ -1942,7 +1942,7 @@ const message = formatErrorForUser(error);
   createMockUser,
   createMockPagedResult,
   TestProvider,
-} from &#039;@ccms/sdk/testing&#039;;</p>
+} from &#039;@actschurch/ccms-sdk/testing&#039;;</p>
 
 <p>// In your tests
 describe(&#039;MyComponent&#039;, () =&gt; {
@@ -2424,22 +2424,22 @@ const mockUser = createMockUser({
 <tr>
 <td><code>RealtimeClient</code></td>
 <td><code>PresenceClient</code>, <code>ApplicationLogsClient</code>, etc.</td>
-<td><code>@ccms/sdk/realtime/*</code></td>
+<td><code>@actschurch/ccms-sdk/realtime/*</code></td>
 </tr>
 <tr>
 <td><code>useConnectionState()</code></td>
 <td><code>usePresence().state</code></td>
-<td><code>@ccms/sdk/realtime/presence</code></td>
+<td><code>@actschurch/ccms-sdk/realtime/presence</code></td>
 </tr>
 <tr>
 <td><code>usePresence()</code></td>
 <td><code>usePresence()</code> (new API)</td>
-<td><code>@ccms/sdk/realtime/presence</code></td>
+<td><code>@actschurch/ccms-sdk/realtime/presence</code></td>
 </tr>
 <tr>
 <td><code>useRealtimeEvent()</code></td>
 <td><code>useApplicationLogs()</code>, <code>useApiLogs()</code>, etc.</td>
-<td><code>@ccms/sdk/realtime/logs</code></td>
+<td><code>@actschurch/ccms-sdk/realtime/logs</code></td>
 </tr>
 </tbody>
 </table>For detailed migration instructions, see the <a href="src/realtime/README.md#migration-guide">Realtime Module Documentation</a>.</p>