@microsoft/power-apps-native-host 0.2.25 → 0.3.3

package/lib/commonjs/offline/createOfflineHostActivationCallbacks.js

@@ -0,0 +1,61 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createHostQueryClient = createHostQueryClient;
+exports.createOfflineHostActivationCallbacks = createOfflineHostActivationCallbacks;
+exports.resolveSdkMountDecision = resolveSdkMountDecision;
+var _reactQuery = require("@tanstack/react-query");
+function setNetworkMode(queryClient, networkMode) {
+  const current = queryClient.getDefaultOptions();
+  queryClient.setDefaultOptions({
+    ...current,
+    queries: {
+      ...current.queries,
+      staleTime: 60_000,
+      retry: 2,
+      networkMode
+    },
+    mutations: {
+      ...current.mutations,
+      retry: 0,
+      networkMode
+    }
+  });
+}
+function createHostQueryClient() {
+  return new _reactQuery.QueryClient({
+    defaultOptions: {
+      queries: {
+        staleTime: 60_000,
+        retry: 2
+      },
+      mutations: {
+        retry: 0
+      }
+    }
+  });
+}
+function createOfflineHostActivationCallbacks(queryClient) {
+  return {
+    prepareForOfflineActivation: () => queryClient.cancelQueries(),
+    completeOfflineActivation: async () => {
+      setNetworkMode(queryClient, 'always');
+      await queryClient.invalidateQueries();
+    },
+    rollbackOfflineActivation: async () => {
+      setNetworkMode(queryClient, undefined);
+      await queryClient.invalidateQueries();
+    }
+  };
+}
+function resolveSdkMountDecision(value) {
+  return typeof value === 'boolean' ? {
+    shouldMountChildren: value,
+    contractSupported: true
+  } : {
+    shouldMountChildren: true,
+    contractSupported: false
+  };
+}

package/lib/commonjs/offline/useOfflineIntegrationWithStartupGate.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useOfflineIntegrationWithStartupGate = useOfflineIntegrationWithStartupGate;
+var _react = require("react");
+var _reactQuery = require("@tanstack/react-query");
+var _powerAppsNativeCommon = require("@microsoft/power-apps-native-common");
+var _DataverseGlobalDiscoveryApi = require("../platform/DataverseGlobalDiscoveryApi.js");
+var _DataverseDataSources = require("../platform/DataverseDataSources.js");
+var _index = require("../telemetry/index.js");
+var _createOfflineHostActivationCallbacks = require("./createOfflineHostActivationCallbacks.js");
+var _useOfflineIntegration = require("./useOfflineIntegration");
+function useOfflineIntegrationWithStartupGate({
+  powerConfig,
+  offlineProfile,
+  acquireToken,
+  hasRealAccount,
+  isAuthReady
+}) {
+  const queryClient = (0, _reactQuery.useQueryClient)();
+  const hasDataverse = (0, _DataverseDataSources.hasDataverseDatabaseReferences)(powerConfig.databaseReferences);
+  const resolveInstanceUrl = (0, _react.useCallback)(async (environmentId, region, acqToken) => hasDataverse ? (await (0, _DataverseGlobalDiscoveryApi.fetchInstanceUrl)(environmentId, region, acqToken)) ?? null : null, [hasDataverse]);
+  const hostActivationCallbacks = (0, _react.useMemo)(() => (0, _createOfflineHostActivationCallbacks.createOfflineHostActivationCallbacks)(queryClient), [queryClient]);
+  const offline = (0, _useOfflineIntegration.useOfflineIntegration)({
+    powerConfig,
+    offlineProfile,
+    acquireToken,
+    isSignedIn: hasRealAccount,
+    authState: isAuthReady ? hasRealAccount ? 'authenticated' : 'signed-out' : 'hydrating',
+    fetchInstanceUrl: resolveInstanceUrl,
+    hostActivationCallbacks
+  });
+  const mountDecision = (0, _createOfflineHostActivationCallbacks.resolveSdkMountDecision)(offline.shouldMountChildren);
+  (0, _react.useEffect)(() => {
+    if (!mountDecision.contractSupported) {
+      (0, _powerAppsNativeCommon.getAppLogger)().trackErrorEvent(_index.HostOperationNames.OfflineRoutingContractUnsupported, {
+        fallbackRoute: 'online'
+      });
+    }
+  }, [mountDecision.contractSupported]);
+  return {
+    isEnabled: offline.isEnabled,
+    StatusOverlay: offline.StatusOverlay,
+    shouldMountChildren: mountDecision.shouldMountChildren
+  };
+}

package/lib/commonjs/offline/useOfflineIntegrationWithStartupGate.web.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useOfflineIntegrationWithStartupGate = useOfflineIntegrationWithStartupGate;
+function useOfflineIntegrationWithStartupGate(_options) {
+  return {
+    isEnabled: false,
+    StatusOverlay: null,
+    shouldMountChildren: true
+  };
+}

package/lib/commonjs/platform/DataverseDataSources.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildCdsDataSources = buildCdsDataSources;
+exports.hasDataverseDatabaseReferences = hasDataverseDatabaseReferences;
+function hasDataverseDatabaseReferences(databaseReferences) {
+  return Object.keys(databaseReferences ?? {}).length > 0;
+}
+function buildCdsDataSources(databaseReferences, dataverseOrgUrl) {
+  return Object.values(databaseReferences).flatMap(databaseReference => Object.values(databaseReference.dataSources ?? {}).map(dataSource => ({
+    runtimeUrl: dataverseOrgUrl ? `${dataverseOrgUrl}/api/data/v9.0/` : '',
+    entitySetName: dataSource.entitySetName ?? '',
+    logicalName: dataSource.logicalName ?? '',
+    version: '9.2'
+  })));
+}

package/lib/commonjs/platform/DataverseGlobalDiscoveryApi.js

@@ -0,0 +1,94 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fetchInstanceUrl = fetchInstanceUrl;
+var _http = require("@microsoft/power-apps-native-common/http");
+var SecureStore = _interopRequireWildcard(require("expo-secure-store"));
+var _index = require("../telemetry/index.js");
+var _GlobalDiscovery = require("./GlobalDiscovery.js");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (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 (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+const INSTANCE_URL_CACHE_KEY_PREFIX = 'microsoft.power-apps-native-host.instance-url.v1';
+const INSTANCE_URL_CACHE_TTL_MS = 30 * 24 * 60 * 60 * 1000;
+function getInstanceUrlCacheKey(environmentId, region) {
+  return `${INSTANCE_URL_CACHE_KEY_PREFIX}.${region.toLowerCase()}.${environmentId.toLowerCase()}`;
+}
+async function getCachedInstanceUrl(environmentId, region) {
+  try {
+    const cachedValue = await SecureStore.getItemAsync(getInstanceUrlCacheKey(environmentId, region));
+    if (!cachedValue) {
+      return null;
+    }
+    const entry = JSON.parse(cachedValue);
+    if (typeof entry.instanceUrl !== 'string' || typeof entry.expiresAt !== 'number' || entry.expiresAt <= Date.now()) {
+      return null;
+    }
+    return entry.instanceUrl;
+  } catch {
+    return null;
+  }
+}
+async function cacheInstanceUrl(environmentId, region, instanceUrl) {
+  try {
+    const entry = {
+      instanceUrl,
+      expiresAt: Date.now() + INSTANCE_URL_CACHE_TTL_MS
+    };
+    await SecureStore.setItemAsync(getInstanceUrlCacheKey(environmentId, region), JSON.stringify(entry));
+  } catch {
+    // SecureStore may be unavailable (for example, on web); discovery still succeeds.
+  }
+}
+function getSafeErrorName(error) {
+  return error instanceof Error ? error.constructor.name : typeof error;
+}
+
+/** Fetch the Dataverse instance URL from the Dataverse Global Discovery Service. */
+async function fetchInstanceUrl(environmentId, region, acquireToken, _bearerToken) {
+  const scenario = (0, _index.getAppLogger)().trackScenario(_index.HostOperationNames.PlatformFetchInstanceUrl, {
+    environmentId,
+    region
+  });
+  try {
+    const cachedInstanceUrl = await getCachedInstanceUrl(environmentId, region);
+    if (cachedInstanceUrl) {
+      scenario.complete({
+        hasInstanceUrl: true,
+        cacheHit: true
+      });
+      return cachedInstanceUrl;
+    }
+    const url = (0, _GlobalDiscovery.buildGlobalDiscoveryUrl)(environmentId, region);
+    const token = await acquireToken([(0, _GlobalDiscovery.globalDiscoveryScope)(region)]);
+    if (!token) {
+      throw new Error('fetchInstanceUrl: failed to acquire Dataverse Global Discovery token');
+    }
+    const response = await _index.platformHttpClient.request(url, {
+      method: 'GET',
+      headers: {
+        Authorization: `Bearer ${token}`,
+        'Content-Type': 'application/json'
+      }
+    });
+    if (!response.ok) {
+      throw new Error(`fetchInstanceUrl: Global Discovery returned ${response.status} ${response.statusText}`);
+    }
+    const result = await response.json();
+    const instanceUrl = result.value?.find(instance => instance.EnvironmentId?.toLowerCase() === environmentId.toLowerCase())?.ApiUrl;
+    if (instanceUrl) {
+      await cacheInstanceUrl(environmentId, region, instanceUrl);
+    }
+    scenario.complete({
+      hasInstanceUrl: instanceUrl !== undefined,
+      cacheHit: false,
+      ...(0, _http.getHttpCorrelationProperties)(response.headers)
+    });
+    return instanceUrl;
+  } catch (error) {
+    scenario.fail(undefined, {
+      errorName: getSafeErrorName(error)
+    });
+    throw error;
+  }
+}

package/lib/commonjs/platform/GlobalDiscovery.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildGlobalDiscoveryUrl = buildGlobalDiscoveryUrl;
+exports.globalDiscoveryEndpoint = globalDiscoveryEndpoint;
+exports.globalDiscoveryScope = globalDiscoveryScope;
+const GLOBAL_DISCOVERY_HOST = {
+  prod: 'globaldisco.crm.dynamics.com',
+  gcc: 'globaldisco.crm9.dynamics.com',
+  usg: 'globaldisco.crm.microsoftdynamics.us',
+  dod: 'globaldisco.crm.appsplatform.us',
+  china: 'globaldisco.crm.dynamics.cn'
+};
+const REGION_DISCOVERY_CLOUD = {
+  dev: 'prod',
+  test: 'prod',
+  preprod: 'prod',
+  preview: 'prod',
+  firstrelease: 'prod',
+  prod: 'prod',
+  gccmoderate: 'gcc',
+  gov: 'gcc',
+  gcchigh: 'usg',
+  high: 'usg',
+  dod: 'dod',
+  mooncake: 'china'
+};
+const ENVIRONMENT_ID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+function globalDiscoveryEndpoint(region) {
+  const cloud = REGION_DISCOVERY_CLOUD[region];
+  if (!cloud) {
+    throw new Error(`Dataverse Global Discovery is not available for Power Platform region "${region}"`);
+  }
+  return `https://${GLOBAL_DISCOVERY_HOST[cloud]}`;
+}
+function globalDiscoveryScope(region) {
+  return `${globalDiscoveryEndpoint(region)}/user_impersonation`;
+}
+function buildGlobalDiscoveryUrl(environmentId, region) {
+  if (!ENVIRONMENT_ID_PATTERN.test(environmentId)) {
+    throw new Error(`Invalid Power Platform environment ID: "${environmentId}"`);
+  }
+  const normalizedEnvironmentId = environmentId.toLowerCase();
+  const query = new URLSearchParams({
+    '$select': 'ApiUrl,EnvironmentId',
+    '$filter': `EnvironmentId eq '${normalizedEnvironmentId}'`
+  });
+  return `${globalDiscoveryEndpoint(region)}/api/discovery/v2.0/Instances?${query.toString()}`;
+}

package/lib/commonjs/platform/PowerPlatformEnvironmentApi.js

@@ -4,22 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.POWER_PLATFORM_API_SCOPE = void 0;
-exports.buildCdsDataSources = buildCdsDataSources;
 exports.buildEnvironmentEndpoint = buildEnvironmentEndpoint;
-exports.fetchInstanceUrl = fetchInstanceUrl;
+exports.connectionUserConsentScope = connectionUserConsentScope;
 exports.powerPlatformScope = powerPlatformScope;
-var _index = require("../telemetry/index.js");
 /*!
  * power-apps-native-host — PowerPlatformEnvironmentApi
  *
- * Mirrors the Host SDK's DefaultAppMetadataProvider.fetchAppMetadataFromPowerConfig
- * pattern: resolves the Power Platform environment-scoped API endpoint from the
- * environment GUID and region, then fetches linkedEnvironmentMetadata to obtain
- * the Dataverse instanceUrl.
- *
- * Reference (Host SDK):
- *   packages/power-apps-host/src/providers/defaults/DefaultAppMetadataProvider.ts
- *   packages/power-apps-common/src/services/PowerPlatformApiDiscovery.ts
+ * Resolves Power Platform RP endpoints and scopes.
  */
 
 // ---------------------------------------------------------------------------
@@ -78,10 +69,6 @@ function buildEnvironmentEndpoint(environmentId, region) {
   return `https://${hexPrefix}.${hexSuffix}.environment.${hostNameSuffix}`;
 }
 
-// ---------------------------------------------------------------------------
-// Public API
-// ---------------------------------------------------------------------------
-
 /**
  * Token scope for the Power Platform management API (prod cluster).
  * Non-prod clusters (test, gov, high, dev, mooncake, etc.) host the management
@@ -99,96 +86,9 @@ function powerPlatformScope(region) {
   const host = HOST_NAME_SUFFIX[region] ?? HOST_NAME_SUFFIX['prod'];
   return `https://${host}/.default`;
 }
-function getSafeErrorName(error) {
-  return error instanceof Error ? error.constructor.name : typeof error;
-}
 
-/**
- * Fetch the Dataverse instanceUrl for a Power Platform environment by calling
- * the environment-scoped Power Platform management API — the same call that
- * the Host SDK's DefaultAppMetadataProvider makes to populate
- * `databaseReferences[*].databaseDetails.linkedEnvironmentMetadata`.
- *
- * @param environmentId - Environment GUID (from power.config.json `environmentId`).
- * @param region        - Cluster region string (from power.config.json `region`, default "prod").
- * @param acquireToken  - Callback to obtain a bearer token for the given scopes.
- *                        Scope will be {@link powerPlatformScope}`(region)`.
- * @param bearerToken   - Optional pre-fetched bearer token for {@link powerPlatformScope}`(region)`.
- *                        Pass this to avoid a redundant `acquireToken` round-trip when the
- *                        caller has already obtained a token for the same audience.
- * @returns The Dataverse org URL (e.g. "https://org12345.crm.dynamics.com"), or
- *          `undefined` if the environment has no linked CDS database.
- */
-async function fetchInstanceUrl(environmentId, region, acquireToken, bearerToken) {
-  const scenario = (0, _index.getAppLogger)().trackScenario(_index.HostOperationNames.PlatformFetchInstanceUrl, {
-    environmentId,
-    region
-  });
-  try {
-    const baseUrl = buildEnvironmentEndpoint(environmentId, region);
-    const url = `${baseUrl}/powerapps/environment?api-version=1&%24filter=name+eq+%27${encodeURIComponent(environmentId)}%27`;
-    const token = bearerToken ?? (await acquireToken([powerPlatformScope(region)]));
-    if (!token) {
-      throw new Error('fetchInstanceUrl: failed to acquire Power Platform API token');
-    }
-    const response = await fetch(url, {
-      method: 'GET',
-      headers: {
-        Authorization: `Bearer ${token}`,
-        'Content-Type': 'application/json'
-      }
-    });
-    if (!response.ok) {
-      throw new Error(`fetchInstanceUrl: environment API returned ${response.status} ${response.statusText}`);
-    }
-    const env = await response.json();
-    const instanceUrl = env.properties?.linkedEnvironmentMetadata?.instanceUrl;
-    scenario.complete({
-      hasInstanceUrl: instanceUrl !== undefined
-    });
-    return instanceUrl;
-  } catch (e) {
-    scenario.fail(undefined, {
-      errorName: getSafeErrorName(e)
-    });
-    throw e;
-  }
-}
-
-// ---------------------------------------------------------------------------
-// buildCdsDataSources
-// ---------------------------------------------------------------------------
-
-/**
- * Shape of a single Dataverse table entry inside power.config.json
- * `databaseReferences[*].dataSources[*]`.
- */
-
-/**
- * Shape of a single database reference entry inside power.config.json
- * `databaseReferences`.
- */
-
-/**
- * Build the CDS data source config array that the SDK reads via
- * AppPowerAppsClientPlugin.getAppCdsDataSourceConfigsAsync.
- *
- * Pass the resolved Dataverse org URL (from useConnectionRefs) and the
- * databaseReferences map from power.config.json.  The resulting array is
- * passed directly to <PowerAppsHostProvider dataSources={...} />.
- *
- * @param databaseReferences - The `databaseReferences` map from power.config.json.
- * @param dataverseOrgUrl    - The resolved Dataverse org URL
- *                             (connectionRefs['commondataserviceforapps']?.datasetName).
- *                             Pass an empty string before the org URL is known;
- *                             the host provider will receive empty runtimeUrl entries
- *                             and the SDK will not attempt Dataverse calls.
- */
-function buildCdsDataSources(databaseReferences, dataverseOrgUrl) {
-  return Object.values(databaseReferences).flatMap(dbRef => Object.values(dbRef.dataSources ?? {}).map(ds => ({
-    runtimeUrl: dataverseOrgUrl ? `${dataverseOrgUrl}/api/data/v9.0/` : '',
-    entitySetName: ds.entitySetName ?? '',
-    logicalName: ds.logicalName ?? '',
-    version: '9.2'
-  })));
+/** Delegated permission required by the connection user-consent endpoint. */
+function connectionUserConsentScope(region) {
+  const host = HOST_NAME_SUFFIX[region] ?? HOST_NAME_SUFFIX['prod'];
+  return `https://${host}/Connectivity.Connections.UserConsent`;
 }