use __platform

Author: raju-opti

ESLINT_TROUBLESHOOTING.md

@@ -8,8 +8,8 @@ The `require-platform-declaration` rule **is** working correctly from the comman
 $ npx eslint lib/core/custom_attribute_condition_evaluator/index.ts
 
 lib/core/custom_attribute_condition_evaluator/index.ts
-  16:1  error  File must export __supportedPlatforms to declare which platforms 
-                it supports. Example: export const __supportedPlatforms = ['__universal__'] as const;
+  16:1  error  File must export __platforms to declare which platforms 
+                it supports. Example: export const __platforms = ['__universal__'] as const;
 ```
 
 ## VSCode Not Showing Errors?
@@ -71,14 +71,14 @@ npx eslint lib/service.ts
 npx eslint lib/**/*.ts --quiet
 ```
 
-## Adding __supportedPlatforms
+## Adding __platforms
 
 To fix the error, add this export to your file (after imports):
 
 ```typescript
 // Universal file (all platforms)
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __platforms = ['__universal__'] as const;
 
 // OR platform-specific file
-export const __supportedPlatforms = ['browser', 'node'] as const;
+export const __platforms = ['browser', 'node'] as const;
 ```

docs/PLATFORM_ISOLATION.md

@@ -18,11 +18,11 @@ For files specific to a single platform, use a suffix pattern:
 
 ### 2. Export Declaration (Multiple Platforms)
 
-For files that support multiple platforms but not all (e.g., Browser + React Native, but not Node.js), export a `__supportedPlatforms` array:
+For files that support multiple platforms but not all (e.g., Browser + React Native, but not Node.js), export a `__platforms` array:
 
 ```typescript
 // lib/utils/web-features.ts
-export const __supportedPlatforms = ['browser', 'react_native'];
+export const __platforms = ['browser', 'react_native'];
 
 // Your code that works on both browser and react_native
 export function getWindowSize() {
@@ -34,7 +34,7 @@ Valid platform identifiers: `'browser'`, `'node'`, `'react_native'`
 
 ### Priority
 
-If a file has both a platform suffix in its name AND a `__supportedPlatforms` export, the `__supportedPlatforms` export **takes priority**. This allows you to keep the `.browser.ts` naming convention while expanding support to additional platforms like React Native.
+If a file has both a platform suffix in its name AND a `__platforms` export, the `__platforms` export **takes priority**. This allows you to keep the `.browser.ts` naming convention while expanding support to additional platforms like React Native.
 
 ## Import Rules
 
@@ -51,11 +51,11 @@ A file is compatible if:
 
 ### Compatibility Examples
 
-**Single Platform File (`.browser.ts` or `__supportedPlatforms = ['browser']`)**
+**Single Platform File (`.browser.ts` or `__platforms = ['browser']`)**
 - ✅ Can import from: universal files, `.browser.ts` files, files with `['browser']` or `['browser', 'react_native']`
 - ❌ Cannot import from: `.node.ts` files, files with `['node']` or `['react_native']` only
 
-**Multi-Platform File (`__supportedPlatforms = ['browser', 'react_native']`)**
+**Multi-Platform File (`__platforms = ['browser', 'react_native']`)**
 - ✅ Can import from: universal files, files with exactly `['browser', 'react_native']`
 - ❌ Cannot import from: `.browser.ts` (browser only), `.react_native.ts` (react_native only), `.node.ts`
 - **Why?** A file supporting both platforms needs imports that work in BOTH environments
@@ -81,17 +81,17 @@ import { NodeRequestHandler } from './utils/http_request_handler/request_handler
 // In lib/index.react_native.ts (React Native platform only)
 import { Config } from './shared_types';  // ✅ Universal file
 
-// If web-features.ts has: __supportedPlatforms = ['browser', 'react_native']
+// If web-features.ts has: __platforms = ['browser', 'react_native']
 import { getWindowSize } from './utils/web-features'; // ✅ Compatible (supports react_native)
 ```
 
 ```typescript
 // In lib/utils/web-api.ts
-// export const __supportedPlatforms = ['browser', 'react_native'];
+// export const __platforms = ['browser', 'react_native'];
 
 import { Config } from './shared_types';  // ✅ Universal file
 
-// If dom-helpers.ts has: __supportedPlatforms = ['browser', 'react_native']
+// If dom-helpers.ts has: __platforms = ['browser', 'react_native']
 import { helpers } from './dom-helpers'; // ✅ Compatible (supports BOTH browser and react_native)
 ```
 
@@ -104,15 +104,15 @@ import { NodeRequestHandler } from './utils/http_request_handler/request_handler
 
 ```typescript
 // In lib/index.node.ts (Node platform only)
-// If web-features.ts has: __supportedPlatforms = ['browser', 'react_native']
+// If web-features.ts has: __platforms = ['browser', 'react_native']
 import { getWindowSize } from './utils/web-features'; // ❌ Not compatible with Node
 ```
 
 ```typescript
 // In lib/utils/web-api.ts  
-// export const __supportedPlatforms = ['browser', 'react_native'];
+// export const __platforms = ['browser', 'react_native'];
 
-// If helper.browser.ts is browser-only (no __supportedPlatforms export)
+// If helper.browser.ts is browser-only (no __platforms export)
 import { helper } from './helper.browser'; // ❌ Browser-only, doesn't support react_native
 
 // This file needs imports that work in BOTH browser AND react_native
@@ -203,13 +203,13 @@ export const createMyFeature = () => new NodeMyFeature();
 
 ### Multiple Platforms (But Not All)
 
-For code that works on multiple platforms but not all, use the `__supportedPlatforms` export:
+For code that works on multiple platforms but not all, use the `__platforms` export:
 
 **Example: Browser + React Native only**
 
 ```typescript
 // lib/utils/dom-helpers.ts
-export const __supportedPlatforms = ['browser', 'react_native'];
+export const __platforms = ['browser', 'react_native'];
 
 // This code works on both browser and react_native, but not node
 export function getElementById(id: string): Element | null {
@@ -225,7 +225,7 @@ export function getElementById(id: string): Element | null {
 
 ```typescript
 // lib/utils/native-crypto.ts
-export const __supportedPlatforms = ['node', 'react_native'];
+export const __platforms = ['node', 'react_native'];
 
 import crypto from 'crypto'; // Available in both Node and React Native
 

eslint-local-rules/README.md

@@ -6,7 +6,7 @@ This directory contains custom ESLint rules specific to this project.
 
 ### `require-platform-declaration`
 
-**Purpose:** Ensures all source files (except tests) export `__supportedPlatforms` to declare which platforms they support.
+**Purpose:** Ensures all source files (except tests) export `__platforms` to declare which platforms they support.
 
 **Why:** This enforces platform isolation at the linting level, catching missing declarations before build time.
 
@@ -19,20 +19,20 @@ This directory contains custom ESLint rules specific to this project.
 
 ```typescript
 // Universal file (all platforms)
-export const __supportedPlatforms = ['__universal__'] as const;
+export const __platforms = ['__universal__'] as const;
 
 // Platform-specific file
-export const __supportedPlatforms = ['browser', 'node'] as const;
+export const __platforms = ['browser', 'node'] as const;
 
 // With type annotation
-export const __supportedPlatforms: Platform[] = ['react_native'] as const;
+export const __platforms: Platform[] = ['react_native'] as const;
 ```
 
 **Invalid:**
 
 ```typescript
-// Missing __supportedPlatforms export
-// ESLint Error: File must export __supportedPlatforms to declare which platforms it supports
+// Missing __platforms export
+// ESLint Error: File must export __platforms to declare which platforms it supports
 ```
 
 ## Configuration

eslint-local-rules/require-platform-declaration.js

@@ -1,15 +1,15 @@
 /**
  * ESLint Rule: require-platform-declaration
  * 
- * Ensures that all non-test source files export __supportedPlatforms with valid platform values
+ * Ensures that all non-test source files export __platforms with valid platform values
  * 
  * Valid:
- *   export const __supportedPlatforms = ['browser'];
- *   export const __supportedPlatforms = ['__universal__'];
- *   export const __supportedPlatforms = ['browser', 'node'];
+ *   export const __platforms = ['browser'];
+ *   export const __platforms = ['__universal__'];
+ *   export const __platforms = ['browser', 'node'];
  * 
  * Invalid:
- *   // Missing __supportedPlatforms export
+ *   // Missing __platforms export
  *   // Invalid platform values (must match Platform type definition in platform_support.ts)
  *   // Not exported as const array
  */
@@ -83,15 +83,15 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Require __supportedPlatforms export with valid platform values in all source files',
+      description: 'Require __platforms export with valid platform values in all source files',
       category: 'Best Practices',
       recommended: true,
     },
     messages: {
-      missingPlatformDeclaration: 'File must export __supportedPlatforms to declare which platforms it supports. Example: export const __supportedPlatforms = [\'__universal__\'];',
-      invalidPlatformDeclaration: '__supportedPlatforms must be exported as a const array. Example: export const __supportedPlatforms = [\'browser\', \'node\'];',
-      invalidPlatformValue: '__supportedPlatforms contains invalid platform value "{{value}}". Valid platforms are: {{validPlatforms}}',
-      emptyPlatformArray: '__supportedPlatforms array cannot be empty. Specify at least one platform or use [\'__universal__\']',
+      missingPlatformDeclaration: 'File must export __platforms to declare which platforms it supports. Example: export const __platforms = [\'__universal__\'];',
+      invalidPlatformDeclaration: '__platforms must be exported as a const array. Example: export const __platforms = [\'browser\', \'node\'];',
+      invalidPlatformValue: '__platforms contains invalid platform value "{{value}}". Valid platforms are: {{validPlatforms}}',
+      emptyPlatformArray: '__platforms array cannot be empty. Specify at least one platform or use [\'__universal__\']',
     },
     schema: [],
   },
@@ -123,13 +123,13 @@ module.exports = {
 
     return {
       ExportNamedDeclaration(node) {
-        // Check for: export const __supportedPlatforms = [...]
+        // Check for: export const __platforms = [...]
         if (node.declaration && 
             node.declaration.type === 'VariableDeclaration') {
 
           for (const declarator of node.declaration.declarations) {
             if (declarator.id.type === 'Identifier' &&
-                declarator.id.name === '__supportedPlatforms') {
+                declarator.id.name === '__platforms') {
 
               hasPlatformExport = true;
 
@@ -199,7 +199,7 @@ module.exports = {
       },
 
       'Program:exit'(node) {
-        // At the end of the file, check if __supportedPlatforms was exported
+        // At the end of the file, check if __platforms was exported
         if (!hasPlatformExport) {
           context.report({
             node,

lib/client_factory.ts

@@ -29,7 +29,7 @@ import { InMemoryLruCache } from "./utils/cache/in_memory_lru_cache";
 import { transformCache, CacheWithRemove } from "./utils/cache/cache";
 import { ConstantBackoff } from "./utils/repeater/repeater";
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 export type OptimizelyFactoryConfig = Config & {
   requestHandler: RequestHandler;

lib/common_exports.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 export { createStaticProjectConfigManager } from './project_config/config_manager_factory';
 

lib/core/audience_evaluator/index.ts

@@ -21,7 +21,7 @@ import { CONDITION_EVALUATOR_ERROR, UNKNOWN_CONDITION_TYPE } from 'error_message
 import { AUDIENCE_EVALUATION_RESULT, EVALUATING_AUDIENCE} from 'log_message';
 import { LoggerFacade } from '../../logging/logger';
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 export class AudienceEvaluator {
   private logger?: LoggerFacade;

lib/core/audience_evaluator/odp_segment_condition_evaluator/index.ts

@@ -17,7 +17,7 @@ import { UNKNOWN_MATCH_TYPE } from 'error_message';
 import { LoggerFacade } from '../../../logging/logger';
 import { Condition, OptimizelyUserContext } from '../../../shared_types';
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 const QUALIFIED_MATCH_TYPE = 'qualified';
 

lib/core/bucketer/bucket_value_generator.ts

@@ -17,7 +17,7 @@ import murmurhash from 'murmurhash';
 import { INVALID_BUCKETING_ID } from 'error_message';
 import { OptimizelyError } from '../../error/optimizly_error';
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 const HASH_SEED = 1;
 const MAX_HASH_VALUE = Math.pow(2, 32);

lib/core/bucketer/index.ts

@@ -29,7 +29,7 @@ import { OptimizelyError } from '../../error/optimizly_error';
 import { generateBucketValue } from './bucket_value_generator';
 import { DecisionReason } from '../decision_service';
 
-export const __supportedPlatforms = ['__universal__'];
+export const __platforms = ['__universal__'];
 
 export const USER_NOT_IN_ANY_EXPERIMENT = 'User %s is not in any experiment of group %s.';
 export const USER_NOT_BUCKETED_INTO_EXPERIMENT_IN_GROUP = 'User %s is not in experiment %s of group %s.';