@lynx-js/type-config 0.0.0 → 3.6.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## 3.6.0
+
+### Patch Changes
+
+- Add all Lynx Config and CompilerOptions types on this packages.

package/README.md

@@ -0,0 +1,21 @@
+# Introduction
+
+Type definitions for Lynx Config(aka PageConfig) provided by the Lynx team, used to optimize the configuration experience of Lynx Config.
+
+# Usage
+
+## For Framework Developers
+
+```json
+"peerDependencies": {
+  "@lynx-js/type-config": "latest"
+}
+```
+
+## For Product Developers
+
+```json
+"devDependencies": {
+  "@lynx-js/type-config": "latest"
+}
+```

package/config-keys.js

@@ -0,0 +1,160 @@
+// Copyright 2025 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+const compilerOptionsKeys = [
+  'debugInfoOutside',
+  'defaultDisplayLinear',
+  'defaultOverflowVisible',
+  'disableMultipleCascadeCSS',
+  'enableComponentConfig',
+  'enableCSSAsyncDecode',
+  'enableCSSClassMerge',
+  'enableCSSEngine',
+  'enableCSSExternalClass',
+  'enableCSSInvalidation',
+  'enableCSSLazyDecode',
+  'enableCSSSelector',
+  'enableCSSStrictMode',
+  'enableCSSVariable',
+  'enableEventRefactor',
+  'enableFiberArch',
+  'enableFlexibleTemplate',
+  'enableKeepPageData',
+  'enableRemoveCSSScope',
+  'enableSimpleStyling',
+  'experimental_encodeQuickjsBytecode',
+  'forceCalcNewStyle',
+  'implicitAnimation',
+  'removeCSSParserLog',
+  'targetSdkVersion',
+  'templateDebugUrl',
+];
+
+const configKeys = [
+  'absoluteInContentBound',
+  'asyncRedirect',
+  'autoExpose',
+  'CSSAlignWithLegacyW3C',
+  'customCSSInheritanceList',
+  'dataStrictMode',
+  'disableLongpressAfterScroll',
+  'disableQuickTracingGC',
+  'enableA11y',
+  'enableAccessibilityElement',
+  'enableAsyncInitVideoEngine',
+  'enableAsyncRequestImage',
+  'enableAsyncResolveSubtree',
+  'enableCheckExposureOptimize',
+  'enableCheckLocalImage',
+  'enableCircularDataCheck',
+  'enableComponentAsyncDecode',
+  'enableComponentNullProp',
+  'enableCreateViewAsync',
+  'enableCSSInheritance',
+  'enableCSSInlineVariables',
+  'enableCSSLazyImport',
+  'enableDisexposureWhenLynxHidden',
+  'enableEndGestureAtLastFingerUp',
+  'enableEventHandleRefactor',
+  'enableEventThrough',
+  'enableExposureUIMargin',
+  'enableExposureWhenLayout',
+  'enableExposureWhenReload',
+  'enableFixedNew',
+  'enableHarmonyNewOverlay',
+  'enableHarmonyVisibleAreaChangeForExposure',
+  'enableICU',
+  'enableImageDownsampling',
+  'enableJsBindingApiThrowException',
+  'enableJSDataProcessor',
+  'enableListMoveOperation',
+  'enableListNewArchitecture',
+  'enableListPlug',
+  'enableLynxScrollFluency',
+  'enableMicrotaskPromisePolyfill',
+  'enableMultiTouch',
+  'enableMultiTouchParamsCompatible',
+  'enableNativeList',
+  'enableNewAnimator',
+  'enableNewClipMode',
+  'enableNewGesture',
+  'enableNewImage',
+  'enableNewIntersectionObserver',
+  'enableNewListContainer',
+  'enableNewTransformOrigin',
+  'enablePlatformGesture',
+  'enablePropertyBasedSimpleStyle',
+  'enableQueryComponentSync',
+  'enableReactOnlyPropsId',
+  'enableReduceInitDataCopy',
+  'enableReloadLifecycle',
+  'enableRemoveComponentExtraData',
+  'enableReuseLoadScriptExports',
+  'enableSignalAPI',
+  'enableSimultaneousTap',
+  'enableTextBoringLayout',
+  'enableTextGradientOpt',
+  'enableTextLanguageAlignment',
+  'enableTextLayerRender',
+  'enableTextLayoutCache',
+  'enableTextNonContiguousLayout',
+  'enableTextOverflow',
+  'enableTextRefactor',
+  'enableTouchRefactor',
+  'enableUIOperationOptimize',
+  'enableUnifiedPipeline',
+  'enableUseContextPool',
+  'enableUseMapBuffer',
+  'enableViewReceiveTouch',
+  'enableVsyncAlignedFlush',
+  'enableXTextLayoutReused',
+  'extendedLayoutOnlyOpt',
+  'extraInfo',
+  'flatten',
+  'fontScaleEffectiveOnlyOnSp',
+  'implicit',
+  'includeFontPadding',
+  'keyboardCallbackPassRelativeHeight',
+  'longPressDuration',
+  'observerFrameRate',
+  'pipelineSchedulerConfig',
+  'preferredFps',
+  'quirksMode',
+  'removeDescendantSelectorScope',
+  'strictPropType',
+  'tapSlop',
+  'trailNewImage',
+  'unifyVWVHBehavior',
+  'useImagePostProcessor',
+  'useNewSwiper',
+  'autoResumeAnimation',
+  'cli',
+  'compileRender',
+  'customData',
+  'enableA11yIDMutationObserver',
+  'enableAsyncDisplay',
+  'enableBackgroundShapeLayer',
+  'enableCascadePseudo',
+  'enableCheckDataWhenUpdatePage',
+  'enableComponentLayoutOnly',
+  'enableGlobalComponentMap',
+  'enableNativeScheduleCreateViewAsync',
+  'enableNewAccessibility',
+  'enableNewLayoutOnly',
+  'enableOptPushStyleToBundle',
+  'enableOverlapForAccessibilityElement',
+  'fixCSSImportRuleOrder',
+  'forceCalcNewStyle',
+  'reactVersion',
+  'redBoxImageSizeWarningThreshold',
+  'removeComponentElement',
+  'syncImageAttach',
+  'useNewImage',
+  'version',
+];
+
+module.exports = {
+  compilerOptionsKeys,
+  configKeys,
+};

package/index.d.ts

@@ -0,0 +1,15 @@
+export * from './types';
+import { CompilerOptions, Config } from './types';
+
+// Copyied from https://github.com/type-challenges/type-challenges/issues/737#issuecomment-3486953045
+type UnionToIntersection<U> = (U extends unknown ? (arg: U) => unknown : never) extends (arg: infer I) => void ? I : never;
+
+type LastInUnion<T> = UnionToIntersection<T extends unknown ? () => T : never> extends () => infer R ? R : never;
+
+type UnionToTuple<U, T extends unknown[] = []> = [U] extends [T[number]] ? T : UnionToTuple<U, [...T, LastInUnion<Exclude<U, T[number]>>]>;
+
+export type CompilerOptionsKeys = UnionToTuple<keyof CompilerOptions>;
+export type ConfigKeys = UnionToTuple<keyof Config>;
+
+export const compilerOptionsKeys: CompilerOptionsKeys;
+export const configKeys: ConfigKeys;

package/index.js

@@ -1 +1,6 @@
-export {}
+const { compilerOptionsKeys, configKeys } = require('./config-keys');
+
+module.exports = {
+  compilerOptionsKeys,
+  configKeys,
+};

package/package.json

@@ -1,9 +1,34 @@
 {
   "name": "@lynx-js/type-config",
-  "version": "0.0.0",
+  "version": "3.6.0",
   "description": "Type definitions for Lynx Config(aka PageConfig) provided by the Lynx team, used to optimize the configuration experience of Lynx Config.",
-  "keywords": [],
+  "keywords": [
+    "lynx-config",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lynx-family/lynx.git",
+    "directory": "js_libraries/type-config"
+  },
   "license": "Apache-2.0",
-  "type": "module",
-  "main": "index.js"
+  "author": "Lynx Authors",
+  "types": "index.d.ts",
+  "main": "index.js",
+  "scripts": {
+    "test": "vitest --run && tsc --noEmit"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "config-keys.js",
+    "types/",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "5.8.3",
+    "tsd": "0.30.4",
+    "vitest": "2.1.9"
+  }
 }

package/types/compiler-options.d.ts

@@ -0,0 +1,323 @@
+// Copyright 2025 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+/**
+ * The Lynx compiler options to set.
+ *
+ * @public
+ */
+
+export interface CompilerOptions {
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  debugInfoOutside?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue true
+   *
+   */
+  defaultDisplayLinear?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue true
+   *
+   */
+  defaultOverflowVisible?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  disableMultipleCascadeCSS?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableComponentConfig?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue undefined
+   *
+   */
+  enableCSSAsyncDecode?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableCSSClassMerge?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue true
+   *
+   */
+  enableCSSEngine?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue true
+   *
+   */
+  enableCSSExternalClass?: boolean;
+
+  /**
+   * If enable CSS invalidation we use RuleInvalidationSet to gather the selector invalidation.
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableCSSInvalidation?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue undefined
+   *
+   */
+  enableCSSLazyDecode?: boolean;
+
+  /**
+   * This switch will enable the css module in blink standard mode.
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableCSSSelector?: boolean;
+
+  /**
+   * CSS Length should be <number> follows a unit. Under strict mode, invalid <length> values are dropped.
+   *
+   * Supported platform: Android, HarmonyOS, iOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableCSSStrictMode?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue true
+   *
+   */
+  enableCSSVariable?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue undefined
+   *
+   */
+  enableEventRefactor?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableFiberArch?: boolean;
+
+  /**
+   * If enable this value, the template will be encoded as flexible template.
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableFlexibleTemplate?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableKeepPageData?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  enableRemoveCSSScope?: boolean;
+
+  /**
+   * Using the simplified styling module.
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.3
+   *
+   * @defaultValue false
+   *
+   */
+  enableSimpleStyling?: boolean;
+
+  /**
+   * Allow encoding quickjs bytecode instead of source code in template.
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  experimental_encodeQuickjsBytecode?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue undefined
+   *
+   */
+  forceCalcNewStyle?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  implicitAnimation?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue false
+   *
+   */
+  removeCSSParserLog?: boolean;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue ""
+   *
+   */
+  targetSdkVersion?: string;
+
+  /**
+   * NA
+   *
+   * Supported platform: Android, iOS, HarmonyOS
+   *
+   * Since: LynxSDK 3.2
+   *
+   * @defaultValue ""
+   *
+   */
+  templateDebugUrl?: string;
+}