@apvee/spfx-react-toolkit 1.0.0

package/lib/hooks/useSPFxContext.d.ts

@@ -0,0 +1,14 @@
+import { useSPFxContext } from '../core/context.internal';
+/**
+ * Internal hook to access SPFx context
+ *
+ * Returns:
+ * - instanceId: Unique identifier for this SPFx instance
+ * - spfxContext: The SPFx context object (WebPartContext, etc.)
+ * - kind: Type of host component ('WebPart', 'AppCustomizer', etc.)
+ *
+ * @throws Error if used outside SPFxProvider
+ * @internal - Not exported in public API
+ */
+export { useSPFxContext };
+//# sourceMappingURL=useSPFxContext.d.ts.map

package/lib/hooks/useSPFxContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useSPFxContext.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/lib/hooks/useSPFxContext.js

@@ -0,0 +1,16 @@
+// useSPFxContext.ts
+// Internal hook to access SPFx context metadata
+import { useSPFxContext } from '../core/context.internal';
+/**
+ * Internal hook to access SPFx context
+ *
+ * Returns:
+ * - instanceId: Unique identifier for this SPFx instance
+ * - spfxContext: The SPFx context object (WebPartContext, etc.)
+ * - kind: Type of host component ('WebPart', 'AppCustomizer', etc.)
+ *
+ * @throws Error if used outside SPFxProvider
+ * @internal - Not exported in public API
+ */
+export { useSPFxContext };
+//# sourceMappingURL=useSPFxContext.js.map

package/lib/hooks/useSPFxContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxContext.js","sourceRoot":"","sources":["../../src/hooks/useSPFxContext.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,gDAAgD;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/lib/hooks/useSPFxCorrelationInfo.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Return type for useSPFxCorrelationInfo hook
+ */
+export interface SPFxCorrelationInfo {
+    /** Correlation ID for tracking requests across services */
+    readonly correlationId: string | undefined;
+    /** Azure AD Tenant ID */
+    readonly tenantId: string | undefined;
+}
+/**
+ * Hook for correlation and tenant ID extraction
+ *
+ * Provides diagnostic IDs for tracking and monitoring:
+ * - Correlation ID: Tracks requests across SPFx → SharePoint → Microsoft Graph
+ * - Tenant ID: Azure AD tenant identifier
+ *
+ * These IDs are essential for:
+ * - Distributed tracing
+ * - Log correlation
+ * - Support tickets
+ * - Diagnostic troubleshooting
+ * - Security auditing
+ *
+ * Useful for:
+ * - Structured logging
+ * - Error tracking (Application Insights, etc.)
+ * - Support requests
+ * - Performance monitoring
+ *
+ * @returns Correlation and tenant identifiers
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { correlationId, tenantId } = useSPFxCorrelationInfo();
+ *
+ *   const logError = (error: Error) => {
+ *     console.error('Error occurred', {
+ *       message: error.message,
+ *       correlationId,
+ *       tenantId,
+ *       timestamp: new Date().toISOString()
+ *     });
+ *   };
+ *
+ *   return <div>Tenant: {tenantId}</div>;
+ * }
+ * ```
+ */
+export declare function useSPFxCorrelationInfo(): SPFxCorrelationInfo;
+//# sourceMappingURL=useSPFxCorrelationInfo.d.ts.map

package/lib/hooks/useSPFxCorrelationInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxCorrelationInfo.d.ts","sourceRoot":"","sources":["../../src/hooks/useSPFxCorrelationInfo.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C,yBAAyB;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,sBAAsB,IAAI,mBAAmB,CAgB5D"}

package/lib/hooks/useSPFxCorrelationInfo.js

@@ -0,0 +1,58 @@
+// useSPFxCorrelationInfo.ts
+// Hook for correlation and tenant ID extraction
+import { useSPFxPageContext } from './useSPFxPageContext';
+/**
+ * Hook for correlation and tenant ID extraction
+ *
+ * Provides diagnostic IDs for tracking and monitoring:
+ * - Correlation ID: Tracks requests across SPFx → SharePoint → Microsoft Graph
+ * - Tenant ID: Azure AD tenant identifier
+ *
+ * These IDs are essential for:
+ * - Distributed tracing
+ * - Log correlation
+ * - Support tickets
+ * - Diagnostic troubleshooting
+ * - Security auditing
+ *
+ * Useful for:
+ * - Structured logging
+ * - Error tracking (Application Insights, etc.)
+ * - Support requests
+ * - Performance monitoring
+ *
+ * @returns Correlation and tenant identifiers
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { correlationId, tenantId } = useSPFxCorrelationInfo();
+ *
+ *   const logError = (error: Error) => {
+ *     console.error('Error occurred', {
+ *       message: error.message,
+ *       correlationId,
+ *       tenantId,
+ *       timestamp: new Date().toISOString()
+ *     });
+ *   };
+ *
+ *   return <div>Tenant: {tenantId}</div>;
+ * }
+ * ```
+ */
+export function useSPFxCorrelationInfo() {
+    var _a, _b, _c;
+    var pageContext = useSPFxPageContext();
+    // correlationId is in pageContext.site (SPSite type - public API)
+    var correlationId = (_b = (_a = pageContext.site) === null || _a === void 0 ? void 0 : _a.correlationId) === null || _b === void 0 ? void 0 : _b.toString();
+    // tenantId is in pageContext.aadInfo (AzureActiveDirectoryInfo - internal type)
+    // Casting required because AzureActiveDirectoryInfo is not exposed in public types
+    var aadInfo = pageContext.aadInfo;
+    var tenantId = (_c = aadInfo === null || aadInfo === void 0 ? void 0 : aadInfo.tenantId) === null || _c === void 0 ? void 0 : _c.toString();
+    return {
+        correlationId: correlationId,
+        tenantId: tenantId,
+    };
+}
+//# sourceMappingURL=useSPFxCorrelationInfo.js.map

package/lib/hooks/useSPFxCorrelationInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxCorrelationInfo.js","sourceRoot":"","sources":["../../src/hooks/useSPFxCorrelationInfo.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,gDAAgD;AAEhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAa1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,UAAU,sBAAsB;;IACpC,IAAM,WAAW,GAAG,kBAAkB,EAAE,CAAC;IAEzC,kEAAkE;IAClE,IAAM,aAAa,GAAG,MAAA,MAAA,WAAW,CAAC,IAAI,0CAAE,aAAa,0CAAE,QAAQ,EAAE,CAAC;IAElE,gFAAgF;IAChF,mFAAmF;IACnF,IAAM,OAAO,GAAG,WAAW,CAAC,OACuB,CAAC;IACpD,IAAM,QAAQ,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,0CAAE,QAAQ,EAAE,CAAC;IAE/C,OAAO;QACL,aAAa,eAAA;QACb,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC"}

package/lib/hooks/useSPFxCrossSitePermissions.d.ts

@@ -0,0 +1,81 @@
+import { SPPermission } from '@microsoft/sp-page-context';
+/**
+ * Options for cross-site permissions retrieval
+ */
+export interface SPFxCrossSitePermissionsOptions {
+    /**
+     * Optional web URL within the site (e.g., '/sites/mysite/subweb')
+     */
+    webUrl?: string;
+    /**
+     * Optional list ID to retrieve list-level permissions
+     */
+    listId?: string;
+}
+/**
+ * Information about cross-site permissions
+ */
+export interface SPFxCrossSitePermissionsInfo {
+    /**
+     * Site-level permissions
+     */
+    sitePermissions?: SPPermission;
+    /**
+     * Web-level permissions
+     */
+    webPermissions?: SPPermission;
+    /**
+     * List-level permissions (if listId provided)
+     */
+    listPermissions?: SPPermission;
+    /**
+     * Check if user has specific web permission
+     */
+    hasWebPermission: (permission: SPPermission) => boolean;
+    /**
+     * Check if user has specific site permission
+     */
+    hasSitePermission: (permission: SPPermission) => boolean;
+    /**
+     * Check if user has specific list permission
+     */
+    hasListPermission: (permission: SPPermission) => boolean;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error state
+     */
+    error?: Error;
+}
+/**
+ * Hook to retrieve permissions for a different site/web/list
+ *
+ * @param siteUrl - The target site URL (optional - no fetch if undefined/empty)
+ * @param options - Optional configuration (webUrl, listId)
+ * @returns Permissions information with helper methods
+ *
+ * @example
+ * ```tsx
+ * // Lazy loading - no fetch until URL is set
+ * const [targetUrl, setTargetUrl] = useState<string | undefined>(undefined);
+ * const {
+ *   sitePermissions,
+ *   webPermissions,
+ *   hasWebPermission,
+ *   isLoading
+ * } = useSPFxCrossSitePermissions(targetUrl, {
+ *   webUrl: 'https://contoso.sharepoint.com/sites/target/subweb'
+ * });
+ *
+ * // Set URL when ready - triggers fetch
+ * setTargetUrl('https://contoso.sharepoint.com/sites/target');
+ *
+ * if (!isLoading && hasWebPermission(SPPermission.addListItems)) {
+ *   // User can add items
+ * }
+ * ```
+ */
+export declare function useSPFxCrossSitePermissions(siteUrl?: string, options?: SPFxCrossSitePermissionsOptions): SPFxCrossSitePermissionsInfo;
+//# sourceMappingURL=useSPFxCrossSitePermissions.d.ts.map

package/lib/hooks/useSPFxCrossSitePermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxCrossSitePermissions.d.ts","sourceRoot":"","sources":["../../src/hooks/useSPFxCrossSitePermissions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAI1D;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,YAAY,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,gBAAgB,EAAE,CAAC,UAAU,EAAE,YAAY,KAAK,OAAO,CAAC;IAExD;;OAEG;IACH,iBAAiB,EAAE,CAAC,UAAU,EAAE,YAAY,KAAK,OAAO,CAAC;IAEzD;;OAEG;IACH,iBAAiB,EAAE,CAAC,UAAU,EAAE,YAAY,KAAK,OAAO,CAAC;IAEzD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,+BAA+B,GACxC,4BAA4B,CA6H9B"}

package/lib/hooks/useSPFxCrossSitePermissions.js

@@ -0,0 +1,132 @@
+import { useState, useEffect, useCallback } from 'react';
+import { SPPermission } from '@microsoft/sp-page-context';
+import { SPHttpClient } from '@microsoft/sp-http';
+import { useSPFxSPHttpClient } from './useSPFxSPHttpClient';
+/**
+ * Hook to retrieve permissions for a different site/web/list
+ *
+ * @param siteUrl - The target site URL (optional - no fetch if undefined/empty)
+ * @param options - Optional configuration (webUrl, listId)
+ * @returns Permissions information with helper methods
+ *
+ * @example
+ * ```tsx
+ * // Lazy loading - no fetch until URL is set
+ * const [targetUrl, setTargetUrl] = useState<string | undefined>(undefined);
+ * const {
+ *   sitePermissions,
+ *   webPermissions,
+ *   hasWebPermission,
+ *   isLoading
+ * } = useSPFxCrossSitePermissions(targetUrl, {
+ *   webUrl: 'https://contoso.sharepoint.com/sites/target/subweb'
+ * });
+ *
+ * // Set URL when ready - triggers fetch
+ * setTargetUrl('https://contoso.sharepoint.com/sites/target');
+ *
+ * if (!isLoading && hasWebPermission(SPPermission.addListItems)) {
+ *   // User can add items
+ * }
+ * ```
+ */
+export function useSPFxCrossSitePermissions(siteUrl, options) {
+    var invoke = useSPFxSPHttpClient().invoke;
+    var _a = useState(), sitePermissions = _a[0], setSitePermissions = _a[1];
+    var _b = useState(), webPermissions = _b[0], setWebPermissions = _b[1];
+    var _c = useState(), listPermissions = _c[0], setListPermissions = _c[1];
+    var _d = useState(false), isLoading = _d[0], setIsLoading = _d[1];
+    var _e = useState(), error = _e[0], setError = _e[1];
+    // Helper: Convert EffectiveBasePermissions to SPPermission
+    var convertToSPPermission = useCallback(function (data) {
+        return new SPPermission(data);
+    }, []);
+    // Fetch permissions when inputs change
+    useEffect(function () {
+        // Skip fetch if siteUrl is not provided or empty
+        if (!siteUrl || siteUrl.trim() === '') {
+            // Reset to idle state (no loading, no error)
+            setIsLoading(false);
+            setError(undefined);
+            setSitePermissions(undefined);
+            setWebPermissions(undefined);
+            setListPermissions(undefined);
+            return;
+        }
+        setIsLoading(true);
+        setError(undefined);
+        var targetWebUrl = (options === null || options === void 0 ? void 0 : options.webUrl) || siteUrl;
+        // Fetch site permissions
+        var fetchSitePermissions = invoke(function (client) {
+            return client.get("".concat(siteUrl, "/_api/site/effectivebasepermissions"), SPHttpClient.configurations.v1)
+                .then(function (res) { return res.json(); })
+                .then(function (data) {
+                if (data.EffectiveBasePermissions) {
+                    return convertToSPPermission(data.EffectiveBasePermissions);
+                }
+                return undefined;
+            });
+        });
+        // Fetch web permissions
+        var fetchWebPermissions = invoke(function (client) {
+            return client.get("".concat(targetWebUrl, "/_api/web/effectivebasepermissions"), SPHttpClient.configurations.v1)
+                .then(function (res) { return res.json(); })
+                .then(function (data) {
+                if (data.EffectiveBasePermissions) {
+                    return convertToSPPermission(data.EffectiveBasePermissions);
+                }
+                return undefined;
+            });
+        });
+        // Fetch list permissions if listId provided
+        var fetchListPermissions = (options === null || options === void 0 ? void 0 : options.listId)
+            ? invoke(function (client) {
+                return client.get("".concat(targetWebUrl, "/_api/web/lists(guid'").concat(options.listId, "')/effectivebasepermissions"), SPHttpClient.configurations.v1)
+                    .then(function (res) { return res.json(); })
+                    .then(function (data) {
+                    if (data.EffectiveBasePermissions) {
+                        return convertToSPPermission(data.EffectiveBasePermissions);
+                    }
+                    return undefined;
+                });
+            })
+            : Promise.resolve(undefined);
+        // Execute all fetches in parallel
+        Promise.all([fetchSitePermissions, fetchWebPermissions, fetchListPermissions])
+            .then(function (_a) {
+            var site = _a[0], web = _a[1], list = _a[2];
+            setSitePermissions(site);
+            setWebPermissions(web);
+            setListPermissions(list);
+            setIsLoading(false);
+        })
+            .catch(function (err) {
+            setError(err instanceof Error ? err : new Error(String(err)));
+            setIsLoading(false);
+        });
+    }, [siteUrl, options === null || options === void 0 ? void 0 : options.webUrl, options === null || options === void 0 ? void 0 : options.listId, invoke, convertToSPPermission]);
+    // Helper methods
+    var hasWebPermission = useCallback(function (permission) {
+        var _a;
+        return (_a = webPermissions === null || webPermissions === void 0 ? void 0 : webPermissions.hasPermission(permission)) !== null && _a !== void 0 ? _a : false;
+    }, [webPermissions]);
+    var hasSitePermission = useCallback(function (permission) {
+        var _a;
+        return (_a = sitePermissions === null || sitePermissions === void 0 ? void 0 : sitePermissions.hasPermission(permission)) !== null && _a !== void 0 ? _a : false;
+    }, [sitePermissions]);
+    var hasListPermission = useCallback(function (permission) {
+        var _a;
+        return (_a = listPermissions === null || listPermissions === void 0 ? void 0 : listPermissions.hasPermission(permission)) !== null && _a !== void 0 ? _a : false;
+    }, [listPermissions]);
+    return {
+        sitePermissions: sitePermissions,
+        webPermissions: webPermissions,
+        listPermissions: listPermissions,
+        hasWebPermission: hasWebPermission,
+        hasSitePermission: hasSitePermission,
+        hasListPermission: hasListPermission,
+        isLoading: isLoading,
+        error: error,
+    };
+}
+//# sourceMappingURL=useSPFxCrossSitePermissions.js.map

package/lib/hooks/useSPFxCrossSitePermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxCrossSitePermissions.js","sourceRoot":"","sources":["../../src/hooks/useSPFxCrossSitePermissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AA8D5D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAAgB,EAChB,OAAyC;IAEjC,IAAA,MAAM,GAAK,mBAAmB,EAAE,OAA1B,CAA2B;IAEnC,IAAA,KAAwC,QAAQ,EAA4B,EAA3E,eAAe,QAAA,EAAE,kBAAkB,QAAwC,CAAC;IAC7E,IAAA,KAAsC,QAAQ,EAA4B,EAAzE,cAAc,QAAA,EAAE,iBAAiB,QAAwC,CAAC;IAC3E,IAAA,KAAwC,QAAQ,EAA4B,EAA3E,eAAe,QAAA,EAAE,kBAAkB,QAAwC,CAAC;IAC7E,IAAA,KAA4B,QAAQ,CAAU,KAAK,CAAC,EAAnD,SAAS,QAAA,EAAE,YAAY,QAA4B,CAAC;IACrD,IAAA,KAAoB,QAAQ,EAAqB,EAAhD,KAAK,QAAA,EAAE,QAAQ,QAAiC,CAAC;IAExD,2DAA2D;IAC3D,IAAM,qBAAqB,GAAG,WAAW,CAAC,UAAC,IAAmC;QAC5E,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,uCAAuC;IACvC,SAAS,CAAC;QACR,iDAAiD;QACjD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACtC,6CAA6C;YAC7C,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpB,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9B,iBAAiB,CAAC,SAAS,CAAC,CAAC;YAC7B,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,YAAY,CAAC,IAAI,CAAC,CAAC;QACnB,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEpB,IAAM,YAAY,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,OAAO,CAAC;QAEhD,yBAAyB;QACzB,IAAM,oBAAoB,GAAG,MAAM,CAAC,UAAA,MAAM;YACxC,OAAA,MAAM,CAAC,GAAG,CACR,UAAG,OAAO,wCAAqC,EAC/C,YAAY,CAAC,cAAc,CAAC,EAAE,CAC/B;iBACA,IAAI,CAAC,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAE,EAAV,CAAU,CAAC;iBACvB,IAAI,CAAC,UAAC,IAAkE;gBACvE,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;oBAClC,OAAO,qBAAqB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;QAVF,CAUE,CACH,CAAC;QAEF,wBAAwB;QACxB,IAAM,mBAAmB,GAAG,MAAM,CAAC,UAAA,MAAM;YACvC,OAAA,MAAM,CAAC,GAAG,CACR,UAAG,YAAY,uCAAoC,EACnD,YAAY,CAAC,cAAc,CAAC,EAAE,CAC/B;iBACA,IAAI,CAAC,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAE,EAAV,CAAU,CAAC;iBACvB,IAAI,CAAC,UAAC,IAAkE;gBACvE,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;oBAClC,OAAO,qBAAqB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;QAVF,CAUE,CACH,CAAC;QAEF,4CAA4C;QAC5C,IAAM,oBAAoB,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YAC1C,CAAC,CAAC,MAAM,CAAC,UAAA,MAAM;gBACX,OAAA,MAAM,CAAC,GAAG,CACR,UAAG,YAAY,kCAAwB,OAAO,CAAC,MAAM,gCAA6B,EAClF,YAAY,CAAC,cAAc,CAAC,EAAE,CAC/B;qBACA,IAAI,CAAC,UAAA,GAAG,IAAI,OAAA,GAAG,CAAC,IAAI,EAAE,EAAV,CAAU,CAAC;qBACvB,IAAI,CAAC,UAAC,IAAkE;oBACvE,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;wBAClC,OAAO,qBAAqB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;oBAC9D,CAAC;oBACD,OAAO,SAAS,CAAC;gBACnB,CAAC,CAAC;YAVF,CAUE,CACH;YACH,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE/B,kCAAkC;QAClC,OAAO,CAAC,GAAG,CAAC,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,oBAAoB,CAAC,CAAC;aAC3E,IAAI,CAAC,UAAC,EAAiB;gBAAhB,IAAI,QAAA,EAAE,GAAG,QAAA,EAAE,IAAI,QAAA;YACrB,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACvB,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC;aACD,KAAK,CAAC,UAAA,GAAG;YACR,QAAQ,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9D,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACP,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAE/E,iBAAiB;IACjB,IAAM,gBAAgB,GAAG,WAAW,CAClC,UAAC,UAAwB;;QACvB,OAAO,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,aAAa,CAAC,UAAU,CAAC,mCAAI,KAAK,CAAC;IAC5D,CAAC,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,IAAM,iBAAiB,GAAG,WAAW,CACnC,UAAC,UAAwB;;QACvB,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,aAAa,CAAC,UAAU,CAAC,mCAAI,KAAK,CAAC;IAC7D,CAAC,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;IAEF,IAAM,iBAAiB,GAAG,WAAW,CACnC,UAAC,UAAwB;;QACvB,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,aAAa,CAAC,UAAU,CAAC,mCAAI,KAAK,CAAC;IAC7D,CAAC,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;IAEF,OAAO;QACL,eAAe,iBAAA;QACf,cAAc,gBAAA;QACd,eAAe,iBAAA;QACf,gBAAgB,kBAAA;QAChB,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,SAAS,WAAA;QACT,KAAK,OAAA;KACN,CAAC;AACJ,CAAC"}

package/lib/hooks/useSPFxDisplayMode.d.ts

@@ -0,0 +1,61 @@
+import { DisplayMode } from '@microsoft/sp-core-library';
+/**
+ * Return type for useSPFxDisplayMode hook
+ */
+export interface SPFxDisplayModeInfo {
+    /** Current display mode (Read/Edit) */
+    readonly mode: DisplayMode;
+    /** Whether currently in Edit mode */
+    readonly isEdit: boolean;
+    /** Whether currently in Read mode */
+    readonly isRead: boolean;
+}
+/**
+ * Hook to access SPFx display mode (readonly)
+ *
+ * Display mode controls whether the WebPart/Extension is in:
+ * - Read mode (DisplayMode.Read): Normal viewing mode
+ * - Edit mode (DisplayMode.Edit): Editing/configuration mode
+ *
+ * Note: displayMode is readonly in SPFx and controlled by SharePoint.
+ * It changes when the user clicks the Edit button in the page.
+ *
+ * Useful for:
+ * - Showing/hiding edit controls
+ * - Conditional rendering based on mode
+ * - Different layouts for read vs edit
+ *
+ * @returns Display mode information
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { mode, isEdit } = useSPFxDisplayMode();
+ *
+ *   return (
+ *     <div>
+ *       <p>Mode: {isEdit ? 'Editing' : 'Reading'}</p>
+ *       {isEdit && <EditControls />}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function useSPFxDisplayMode(): SPFxDisplayModeInfo;
+/**
+ * Hook to check if currently in Edit mode
+ * Shortcut for useSPFxDisplayMode().isEdit
+ *
+ * @returns true if in Edit mode, false otherwise
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const isEdit = useSPFxIsEdit();
+ *
+ *   return isEdit ? <EditView /> : <ReadView />;
+ * }
+ * ```
+ */
+export declare function useSPFxIsEdit(): boolean;
+//# sourceMappingURL=useSPFxDisplayMode.d.ts.map

package/lib/hooks/useSPFxDisplayMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxDisplayMode.d.ts","sourceRoot":"","sources":["../../src/hooks/useSPFxDisplayMode.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAGzD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAexD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAGvC"}

package/lib/hooks/useSPFxDisplayMode.js

@@ -0,0 +1,69 @@
+// useSPFxDisplayMode.ts
+// Hook to access display mode (Read/Edit)
+import { useAtomValue } from 'jotai';
+import { DisplayMode } from '@microsoft/sp-core-library';
+import { spfxAtoms } from './../core/atoms.internal';
+/**
+ * Hook to access SPFx display mode (readonly)
+ *
+ * Display mode controls whether the WebPart/Extension is in:
+ * - Read mode (DisplayMode.Read): Normal viewing mode
+ * - Edit mode (DisplayMode.Edit): Editing/configuration mode
+ *
+ * Note: displayMode is readonly in SPFx and controlled by SharePoint.
+ * It changes when the user clicks the Edit button in the page.
+ *
+ * Useful for:
+ * - Showing/hiding edit controls
+ * - Conditional rendering based on mode
+ * - Different layouts for read vs edit
+ *
+ * @returns Display mode information
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { mode, isEdit } = useSPFxDisplayMode();
+ *
+ *   return (
+ *     <div>
+ *       <p>Mode: {isEdit ? 'Editing' : 'Reading'}</p>
+ *       {isEdit && <EditControls />}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export function useSPFxDisplayMode() {
+    // Read current mode directly from atom (readonly)
+    var modeValue = useAtomValue(spfxAtoms.displayMode);
+    // Default to Read mode if not set
+    var mode = modeValue !== null && modeValue !== void 0 ? modeValue : DisplayMode.Read;
+    var isEdit = mode === DisplayMode.Edit;
+    var isRead = mode === DisplayMode.Read;
+    return {
+        mode: mode,
+        isEdit: isEdit,
+        isRead: isRead,
+    };
+}
+/**
+ * Hook to check if currently in Edit mode
+ * Shortcut for useSPFxDisplayMode().isEdit
+ *
+ * @returns true if in Edit mode, false otherwise
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const isEdit = useSPFxIsEdit();
+ *
+ *   return isEdit ? <EditView /> : <ReadView />;
+ * }
+ * ```
+ */
+export function useSPFxIsEdit() {
+    var isEdit = useSPFxDisplayMode().isEdit;
+    return isEdit;
+}
+//# sourceMappingURL=useSPFxDisplayMode.js.map

package/lib/hooks/useSPFxDisplayMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxDisplayMode.js","sourceRoot":"","sources":["../../src/hooks/useSPFxDisplayMode.ts"],"names":[],"mappings":"AAAA,wBAAwB;AACxB,0CAA0C;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,kBAAkB;IAChC,kDAAkD;IAClD,IAAM,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAEtD,kCAAkC;IAClC,IAAM,IAAI,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,WAAW,CAAC,IAAI,CAAC;IAE3C,IAAM,MAAM,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC;IACzC,IAAM,MAAM,GAAG,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC;IAEzC,OAAO;QACL,IAAI,MAAA;QACJ,MAAM,QAAA;QACN,MAAM,QAAA;KACP,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,aAAa;IACnB,IAAA,MAAM,GAAK,kBAAkB,EAAE,OAAzB,CAA0B;IACxC,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/hooks/useSPFxEnvironmentInfo.d.ts

@@ -0,0 +1,63 @@
+/**
+ * SPFx environment types
+ */
+export type SPFxEnvironmentType = 'Local' | 'SharePoint' | 'SharePointOnPrem' | 'Teams' | 'Office' | 'Outlook';
+/**
+ * Return type for useSPFxEnvironmentInfo hook
+ */
+export interface SPFxEnvironmentInfo {
+    /** Current environment type */
+    readonly type: SPFxEnvironmentType;
+    /** Whether running in local workbench */
+    readonly isLocal: boolean;
+    /** Whether running in SharePoint workbench (hosted or local) */
+    readonly isWorkbench: boolean;
+    /** Whether running in SharePoint Online */
+    readonly isSharePoint: boolean;
+    /** Whether running in SharePoint On-Premises */
+    readonly isSharePointOnPrem: boolean;
+    /** Whether running in Microsoft Teams */
+    readonly isTeams: boolean;
+    /** Whether running in Office application */
+    readonly isOffice: boolean;
+    /** Whether running in Outlook */
+    readonly isOutlook: boolean;
+}
+/**
+ * Hook to access SPFx environment type information
+ *
+ * Detects the current host environment:
+ * - Local: Local workbench (localhost)
+ * - SharePoint: SharePoint Online
+ * - SharePointOnPrem: SharePoint On-Premises
+ * - Teams: Microsoft Teams
+ * - Office: Office applications
+ * - Outlook: Outlook
+ *
+ * Useful for:
+ * - Environment-specific rendering
+ * - Feature availability checks
+ * - API endpoint selection
+ * - Debugging information
+ *
+ * @returns Environment information
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { type, isTeams, isLocal } = useSPFxEnvironmentInfo();
+ *
+ *   if (isLocal) {
+ *     return <div>Development Mode</div>;
+ *   }
+ *
+ *   if (isTeams) {
+ *     return <TeamsSpecificUI />;
+ *   }
+ *
+ *   return <SharePointUI />;
+ * }
+ * ```
+ */
+export declare function useSPFxEnvironmentInfo(): SPFxEnvironmentInfo;
+//# sourceMappingURL=useSPFxEnvironmentInfo.d.ts.map

package/lib/hooks/useSPFxEnvironmentInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSPFxEnvironmentInfo.d.ts","sourceRoot":"","sources":["../../src/hooks/useSPFxEnvironmentInfo.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,OAAO,GACP,YAAY,GACZ,kBAAkB,GAClB,OAAO,GACP,QAAQ,GACR,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IAEnC,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,gEAAgE;IAChE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAE9B,2CAA2C;IAC3C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAE/B,gDAAgD;IAChD,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAErC,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,iCAAiC;IACjC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,sBAAsB,IAAI,mBAAmB,CAgE5D"}