@stylexjs/babel-plugin 0.11.1 → 0.13.0

package/lib/index.js.flow

@@ -9,6 +9,7 @@
 
 import type { PluginObj } from '../flow_modules/@babel/core';
 import type { StyleXOptions } from './utils/state-manager';
+
 export type Options = StyleXOptions;
 
 /**
@@ -34,7 +35,16 @@ declare function stylexPluginWithOptions(
  *
  * End-users can choose to not use this function and use their own logic instead.
  */
-export type Rule = [string, { ltr: string, rtl?: null | string }, number];
+export type Rule = [
+  string,
+  {
+    ltr: string,
+    rtl?: null | string,
+    constKey?: string,
+    constVal?: string | number,
+  },
+  number,
+];
 declare function processStylexRules(
   rules: Array<Rule>,
   useLayers: boolean,

package/lib/shared/common-types.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+export type TRawValue = number | string | ReadonlyArray<number | string>;
+export type TStyleValue = null | TRawValue;
+export type TNestableStyleValue = TStyleValue | PrimitiveRawStyles;
+export type RawStyles = Readonly<{ [$$Key$$: string]: TNestableStyleValue }>;
+export type PrimitiveRawStyles = Readonly<{
+  [$$Key$$: string]: TNestableStyleValue;
+}>;
+export type InjectableStyle = {
+  readonly priority: number;
+  readonly ltr: string;
+  readonly rtl: null | string;
+};
+export type InjectableConstStyle = {
+  readonly priority: number;
+  readonly ltr: string;
+  readonly rtl: null | string;
+  readonly constKey: string;
+  readonly constVal: string | number;
+};
+export type StyleRule = [string, string, InjectableStyle];
+export type CompiledStyles = Readonly<{
+  [$$Key$$: string]:
+    | null
+    | string
+    | Readonly<{ [$$Key$$: string]: null | string }>;
+}>;
+export type FlatCompiledStyles = Readonly<{
+  [$$Key$$: string]: string | null;
+  $$css: true | string;
+}>;
+export type StyleXOptions = Readonly<{
+  classNamePrefix: string;
+  debug: null | undefined | boolean;
+  definedStylexCSSVariables?: { [key: string]: unknown };
+  dev: boolean;
+  enableDebugClassNames?: null | undefined | boolean;
+  enableDebugDataProp?: null | undefined | boolean;
+  enableDevClassNames?: null | undefined | boolean;
+  enableFontSizePxToRem?: null | undefined | boolean;
+  enableMinifiedKeys?: null | undefined | boolean;
+  styleResolution:
+    | 'application-order'
+    | 'property-specificity'
+    | 'legacy-expand-shorthands';
+  test: boolean;
+}>;
+export type MutableCompiledNamespaces = { [key: string]: FlatCompiledStyles };
+export type CompiledNamespaces = Readonly<MutableCompiledNamespaces>;

package/lib/shared/common-types.js.flow

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+export type TRawValue = number | string | $ReadOnlyArray<number | string>;
+export type TStyleValue = null | TRawValue;
+export type TNestableStyleValue = TStyleValue | PrimitiveRawStyles;
+
+export type RawStyles = $ReadOnly<{
+  [string]: TNestableStyleValue,
+}>;
+export type PrimitiveRawStyles = $ReadOnly<{
+  [string]: TNestableStyleValue,
+}>;
+
+export type InjectableStyle = {
+  +priority: number,
+  +ltr: string,
+  +rtl: null | string,
+};
+
+export type InjectableConstStyle = {
+  +priority: number,
+  +ltr: string,
+  +rtl: null | string,
+  +constKey: string,
+  +constVal: string | number,
+};
+
+export type StyleRule = [string, string, InjectableStyle];
+
+export type CompiledStyles = $ReadOnly<{
+  [string]: null | string | $ReadOnly<{ [string]: null | string }>,
+}>;
+
+export type FlatCompiledStyles = $ReadOnly<{
+  [string]: string | null,
+  $$css: true | string,
+}>;
+
+export type StyleXOptions = $ReadOnly<{
+  classNamePrefix: string,
+  debug: ?boolean,
+  definedStylexCSSVariables?: { [key: string]: mixed },
+  dev: boolean,
+  enableDebugClassNames?: ?boolean,
+  enableDebugDataProp?: ?boolean,
+  enableDevClassNames?: ?boolean,
+  enableFontSizePxToRem?: ?boolean,
+  enableMinifiedKeys?: ?boolean,
+  styleResolution:
+    | 'application-order' // The last style applied wins.
+    // More specific styles will win over less specific styles. (margin-top wins over margin)
+    | 'property-specificity'
+    // Legacy behavior, that expands shorthand properties into their longhand counterparts at compile-time.
+    // This is not recommended, and will be removed in a future version.
+    | 'legacy-expand-shorthands',
+  test: boolean,
+  ...
+}>;
+
+export type MutableCompiledNamespaces = {
+  [key: string]: FlatCompiledStyles,
+};
+
+export type CompiledNamespaces = $ReadOnly<MutableCompiledNamespaces>;

package/lib/shared/hash.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+declare const $$EXPORT_DEFAULT_DECLARATION$$: (str: string) => string;
+export default $$EXPORT_DEFAULT_DECLARATION$$;
+export declare const createShortHash: (str: string) => string;

package/lib/shared/hash.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+declare export default (str: string) => string;
+
+declare export const createShortHash: (str: string) => string;

package/lib/shared/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+import type {
+  InjectableStyle as _InjectableStyle,
+  CompiledNamespaces as _CompiledNamespaces,
+  MutableCompiledNamespaces as _MutableCompiledNamespaces,
+  StyleXOptions as _StyleXOptions,
+} from './common-types';
+export type {
+  RawStyles,
+  StyleRule,
+  TNestableStyleValue,
+  TRawValue,
+  TStyleValue,
+} from './common-types';
+import styleXCreateSet from './stylex-create';
+import styleXDefineVars from './stylex-define-vars';
+import styleXDefineConsts from './stylex-define-consts';
+import styleXCreateTheme from './stylex-create-theme';
+import stylexKeyframes from './stylex-keyframes';
+import stylexPositionTry from './stylex-position-try';
+import stylexFirstThatWorks from './stylex-first-that-works';
+import hash from './hash';
+import genFileBasedIdentifier from './utils/file-based-identifier';
+import * as m from './messages';
+export * as types from './types';
+import {
+  PSEUDO_CLASS_PRIORITIES as _PSEUDO_CLASS_PRIORITIES,
+  AT_RULE_PRIORITIES as _AT_RULE_PRIORITIES,
+  PSEUDO_ELEMENT_PRIORITY as _PSEUDO_ELEMENT_PRIORITY,
+} from './utils/property-priorities';
+export declare const create: typeof styleXCreateSet;
+export declare const defineVars: typeof styleXDefineVars;
+export declare const defineConsts: typeof styleXDefineConsts;
+export declare const createTheme: typeof styleXCreateTheme;
+export declare const keyframes: typeof stylexKeyframes;
+export declare const positionTry: typeof stylexPositionTry;
+export declare const utils: {
+  hash: typeof hash;
+  genFileBasedIdentifier: typeof genFileBasedIdentifier;
+};
+export declare const messages: typeof m;
+export declare const firstThatWorks: typeof stylexFirstThatWorks;
+export declare const PSEUDO_CLASS_PRIORITIES: typeof _PSEUDO_CLASS_PRIORITIES;
+export declare const AT_RULE_PRIORITIES: typeof _AT_RULE_PRIORITIES;
+export declare const PSEUDO_ELEMENT_PRIORITY: typeof _PSEUDO_ELEMENT_PRIORITY;
+export type InjectableStyle = _InjectableStyle;
+export type CompiledNamespaces = _CompiledNamespaces;
+export type MutableCompiledNamespaces = _MutableCompiledNamespaces;
+export type StyleXOptions = _StyleXOptions;

package/lib/shared/index.js.flow

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type {
+  InjectableStyle as _InjectableStyle,
+  CompiledNamespaces as _CompiledNamespaces,
+  MutableCompiledNamespaces as _MutableCompiledNamespaces,
+  StyleXOptions as _StyleXOptions,
+} from './common-types';
+
+export type {
+  RawStyles,
+  StyleRule,
+  TNestableStyleValue,
+  TRawValue,
+  TStyleValue,
+} from './common-types';
+
+// All functions exposed from `stylex` are defined in a way that can be run
+// entirely in the browser.
+
+// These are the implementations of those functions.
+
+import styleXCreateSet from './stylex-create';
+import styleXDefineVars from './stylex-define-vars';
+import styleXDefineConsts from './stylex-define-consts';
+import styleXCreateTheme from './stylex-create-theme';
+import stylexKeyframes from './stylex-keyframes';
+import stylexPositionTry from './stylex-position-try';
+import stylexFirstThatWorks from './stylex-first-that-works';
+import hash from './hash';
+import genFileBasedIdentifier from './utils/file-based-identifier';
+import * as m from './messages';
+export * as types from './types';
+import {
+  PSEUDO_CLASS_PRIORITIES as _PSEUDO_CLASS_PRIORITIES,
+  AT_RULE_PRIORITIES as _AT_RULE_PRIORITIES,
+  PSEUDO_ELEMENT_PRIORITY as _PSEUDO_ELEMENT_PRIORITY,
+} from './utils/property-priorities';
+
+declare export const create: typeof styleXCreateSet;
+declare export const defineVars: typeof styleXDefineVars;
+declare export const defineConsts: typeof styleXDefineConsts;
+declare export const createTheme: typeof styleXCreateTheme;
+declare export const keyframes: typeof stylexKeyframes;
+declare export const positionTry: typeof stylexPositionTry;
+declare export const utils: {
+  hash: typeof hash,
+  genFileBasedIdentifier: typeof genFileBasedIdentifier,
+};
+declare export const messages: typeof m;
+declare export const firstThatWorks: typeof stylexFirstThatWorks;
+declare export const PSEUDO_CLASS_PRIORITIES: typeof _PSEUDO_CLASS_PRIORITIES;
+declare export const AT_RULE_PRIORITIES: typeof _AT_RULE_PRIORITIES;
+declare export const PSEUDO_ELEMENT_PRIORITY: typeof _PSEUDO_ELEMENT_PRIORITY;
+
+export type InjectableStyle = _InjectableStyle;
+export type CompiledNamespaces = _CompiledNamespaces;
+export type MutableCompiledNamespaces = _MutableCompiledNamespaces;
+export type StyleXOptions = _StyleXOptions;

package/lib/shared/messages.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+export declare const illegalArgumentLength: (
+  fn: string,
+  argLength: number,
+) => string;
+export declare const nonStaticValue: (fn: string) => string;
+export declare const nonStyleObject: (fn: string) => string;
+export declare const nonExportNamedDeclaration: (fn: string) => string;
+export declare const unboundCallValue: (fn: string) => string;
+export declare const DUPLICATE_CONDITIONAL: 'The same pseudo selector or at-rule cannot be used more than once.';
+export declare const ESCAPED_STYLEX_VALUE: 'Escaping a create() value is not allowed.';
+export declare const ILLEGAL_NESTED_PSEUDO: "Pseudo objects can't be nested more than one level deep.";
+export declare const ILLEGAL_PROP_VALUE: 'A style value can only contain an array, string or number.';
+export declare const ILLEGAL_PROP_ARRAY_VALUE: 'A style array value can only contain strings or numbers.';
+export declare const ILLEGAL_NAMESPACE_VALUE: 'A StyleX namespace must be an object.';
+export declare const INVALID_CONST_KEY: 'Keys in defineConsts() cannot start with "--".';
+export declare const INVALID_PSEUDO: 'Invalid pseudo selector, not on the whitelist.';
+export declare const INVALID_PSEUDO_OR_AT_RULE: 'Invalid pseudo or at-rule.';
+export declare const LINT_UNCLOSED_FUNCTION: 'Rule contains an unclosed function';
+export declare const LOCAL_ONLY: 'The return value of create() should not be exported.';
+export declare const NON_OBJECT_KEYFRAME: 'Every frame within a keyframes() call must be an object.';
+export declare const NON_CONTIGUOUS_VARS: 'All variables passed to firstThatWorks() must be contiguous.';
+export declare const NO_OBJECT_SPREADS: 'Object spreads are not allowed in create() calls.';
+export declare const ONLY_NAMED_PARAMETERS_IN_DYNAMIC_STYLE_FUNCTIONS: 'Only named parameters are allowed in Dynamic Style functions. Destructuring, spreading or default values are not allowed.';
+export declare const ONLY_TOP_LEVEL: 'create() is only allowed at the root of a program.';
+export declare const UNKNOWN_PROP_KEY: 'Unknown property key';
+export declare const POSITION_TRY_INVALID_PROPERTY: 'Invalid property in `positionTry()` call. It may only contain, positionAnchor, positionArea, inset properties (top, left, insetInline etc.), margin properties, size properties (height, inlineSize, etc.), and self-alignment properties (alignSelf, justifySelf, placeSelf)';

package/lib/shared/messages.js.flow

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+// This file contains constants to be used within Error messages.
+// The URLs within will eventually be replaced by links to the documentation website for Stylex.
+
+declare export const illegalArgumentLength: (
+  fn: string,
+  argLength: number,
+) => string;
+declare export const nonStaticValue: (fn: string) => string;
+declare export const nonStyleObject: (fn: string) => string;
+declare export const nonExportNamedDeclaration: (fn: string) => string;
+declare export const unboundCallValue: (fn: string) => string;
+
+declare export const DUPLICATE_CONDITIONAL: 'The same pseudo selector or at-rule cannot be used more than once.';
+declare export const ESCAPED_STYLEX_VALUE: 'Escaping a create() value is not allowed.';
+declare export const ILLEGAL_NESTED_PSEUDO: "Pseudo objects can't be nested more than one level deep.";
+declare export const ILLEGAL_PROP_VALUE: 'A style value can only contain an array, string or number.';
+declare export const ILLEGAL_PROP_ARRAY_VALUE: 'A style array value can only contain strings or numbers.';
+declare export const ILLEGAL_NAMESPACE_VALUE: 'A StyleX namespace must be an object.';
+declare export const INVALID_CONST_KEY: 'Keys in defineConsts() cannot start with "--".';
+declare export const INVALID_PSEUDO: 'Invalid pseudo selector, not on the whitelist.';
+declare export const INVALID_PSEUDO_OR_AT_RULE: 'Invalid pseudo or at-rule.';
+declare export const LINT_UNCLOSED_FUNCTION: 'Rule contains an unclosed function';
+declare export const LOCAL_ONLY: 'The return value of create() should not be exported.';
+declare export const NON_OBJECT_KEYFRAME: 'Every frame within a keyframes() call must be an object.';
+declare export const NON_CONTIGUOUS_VARS: 'All variables passed to firstThatWorks() must be contiguous.';
+declare export const NO_OBJECT_SPREADS: 'Object spreads are not allowed in create() calls.';
+declare export const ONLY_NAMED_PARAMETERS_IN_DYNAMIC_STYLE_FUNCTIONS: 'Only named parameters are allowed in Dynamic Style functions. Destructuring, spreading or default values are not allowed.';
+declare export const ONLY_TOP_LEVEL: 'create() is only allowed at the root of a program.';
+declare export const UNKNOWN_PROP_KEY: 'Unknown property key';
+
+declare export const POSITION_TRY_INVALID_PROPERTY: 'Invalid property in `positionTry()` call. It may only contain, positionAnchor, positionArea, inset properties (top, left, insetInline etc.), margin properties, size properties (height, inlineSize, etc.), and self-alignment properties (alignSelf, justifySelf, placeSelf)';

package/lib/shared/physical-rtl/generate-ltr.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+declare function generateLTR(
+  pair: Readonly<[string, string]>,
+): Readonly<[string, string]>;
+export default generateLTR;

package/lib/shared/physical-rtl/generate-ltr.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+declare export default function generateLTR(
+  pair: $ReadOnly<[string, string]>,
+): $ReadOnly<[string, string]>;

package/lib/shared/physical-rtl/generate-rtl.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+declare function generateRTL(
+  $$PARAM_0$$: Readonly<[string, string]>,
+): null | undefined | Readonly<[string, string]>;
+export default generateRTL;

package/lib/shared/physical-rtl/generate-rtl.js.flow

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+declare export default function generateRTL(
+  $ReadOnly<[string, string]>,
+): ?$ReadOnly<[string, string]>;

package/lib/shared/preprocess-rules/PreRule.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ */
+
+import type { InjectableStyle, StyleXOptions } from '../common-types';
+export type ClassesToOriginalPaths = {
+  readonly [className: string]: ReadonlyArray<string>;
+};
+export type ComputedStyle = null | Readonly<
+  [string, InjectableStyle, ClassesToOriginalPaths]
+>;
+export interface IPreRule {
+  compiled(options: StyleXOptions): ReadonlyArray<ComputedStyle>;
+  equals(other: IPreRule): boolean;
+}
+export type AnyPreRule = NullPreRule | PreRule | PreRuleSet;
+export declare class NullPreRule implements IPreRule {
+  compiled(_options: StyleXOptions): [null];
+  equals(other: IPreRule): boolean;
+}
+export declare class PreRule implements IPreRule {
+  readonly property: string;
+  readonly value: string | number | ReadonlyArray<string | number>;
+  readonly keyPath: ReadonlyArray<string>;
+  constructor(
+    property: string,
+    value: string | number | ReadonlyArray<string | number>,
+    keyPath?: ReadonlyArray<string>,
+  );
+  get pseudos(): ReadonlyArray<string>;
+  get atRules(): ReadonlyArray<string>;
+  get constRules(): ReadonlyArray<string>;
+  compiled(
+    options: StyleXOptions,
+  ): ReadonlyArray<[string, InjectableStyle, ClassesToOriginalPaths]>;
+  equals(other: IPreRule): boolean;
+}
+export declare class PreRuleSet implements IPreRule {
+  readonly rules: ReadonlyArray<PreRule | NullPreRule>;
+  constructor(rules: ReadonlyArray<PreRule | NullPreRule>);
+  static create(
+    rules: ReadonlyArray<PreRule | NullPreRule | PreRuleSet>,
+  ): AnyPreRule;
+  compiled(options: StyleXOptions): ReadonlyArray<ComputedStyle>;
+  equals(other: IPreRule): boolean;
+}

package/lib/shared/preprocess-rules/PreRule.js.flow

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ */
+
+import type { InjectableStyle, StyleXOptions } from '../common-types';
+
+export type ClassesToOriginalPaths = {
+  +[className: string]: $ReadOnlyArray<string>,
+};
+
+export type ComputedStyle = null | $ReadOnly<
+  [string, InjectableStyle, ClassesToOriginalPaths],
+>;
+
+// The classes in this file are used to represent objects that
+// can be compiled into one or CSS rules.
+//
+// These are thin wrappers around the "values" in Raw Style Objects
+// with all the metadata needed to compile them into CSS.
+export interface IPreRule {
+  compiled(options: StyleXOptions): $ReadOnlyArray<ComputedStyle>;
+  equals(other: IPreRule): boolean;
+}
+
+export type AnyPreRule = NullPreRule | PreRule | PreRuleSet;
+
+declare export class NullPreRule implements IPreRule {
+  compiled(_options: StyleXOptions): [null];
+  equals(other: IPreRule): boolean;
+}
+
+declare export class PreRule implements IPreRule {
+  +property: string;
+  +value: string | number | $ReadOnlyArray<string | number>;
+  +keyPath: $ReadOnlyArray<string>;
+  constructor(
+    property: string,
+    value: string | number | $ReadOnlyArray<string | number>,
+    keyPath?: $ReadOnlyArray<string>,
+  ): void;
+  get pseudos(): $ReadOnlyArray<string>;
+  get atRules(): $ReadOnlyArray<string>;
+  get constRules(): $ReadOnlyArray<string>;
+  compiled(
+    options: StyleXOptions,
+  ): $ReadOnlyArray<[string, InjectableStyle, ClassesToOriginalPaths]>;
+  equals(other: IPreRule): boolean;
+}
+
+declare export class PreRuleSet implements IPreRule {
+  +rules: $ReadOnlyArray<PreRule | NullPreRule>;
+  constructor(rules: $ReadOnlyArray<PreRule | NullPreRule>): void;
+  static create(
+    rules: $ReadOnlyArray<PreRule | NullPreRule | PreRuleSet>,
+  ): AnyPreRule;
+  compiled(options: StyleXOptions): $ReadOnlyArray<ComputedStyle>;
+  equals(other: IPreRule): boolean;
+}