@carbon/ibm-products/lib/settings.js

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2020, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */

'use strict';

var packageSettings = require('./global/js/package-settings.js');
var React = require('react');
require('@carbon/themes');
var pconsole = require('./global/js/utils/pconsole.js');
var Canary = require('./components/_Canary/Canary.js');

const carbon = {
  prefix: 'cds'
};
const componentDeprecatedWarning = (name, details) => `Carbon for IBM Products (WARNING): Component "${name}" is deprecated. ${details}`;
packageSettings.default.logDeprecated = (component, name) => {
  if (component?.deprecated) {
    const {
      level,
      details
    } = component.deprecated;
    const logUsing = pconsole.default?.[level] ?? pconsole.default.error;
    logUsing(componentDeprecatedWarning(name || component.displayName, details));
  }
};

// Check that a component is enabled. This function returns a stub which checks
// the component status on first use and then renders as the component or as
// a Canary placeholder initialized with the name of the replaced component.
// Note that the returned stub carries any other properties which had already
// been assigned (eg propTypes, displayName, etc).
packageSettings.default.checkComponentEnabled = (component, name) => {
  if (component.render) {
    // The component is a forward-ref, so make a stub forward-ref.
    const forward = /*#__PURE__*/React.forwardRef((props, ref) => {
      packageSettings.default.logDeprecated(component, name); // may log don't care about result
      // Replace the stub's render fn so this test only happens once.
      return (forward.render = packageSettings.default.isComponentEnabled(name) || !packageSettings.default.isComponentPublic(name) ?
      // If the component is enabled, or if it's not a public component,
      // replace the stub's render fn with the component's render fn.
      component.render :
      // Note that Canary is a direct render fn (not a forward-ref) and
      // will ignore the passed props and ref (if any)
      Canary.Canary.bind(undefined, {
        componentName: name
      }))(
      // Call it now (after this it will be directly called).
      props, ref);
    });

    // Transfer object properties already assigned (eg propTypes, displayName)
    // then merge in the stub forward-ref which checks the component status
    // when first used.
    // NOTE: React 18 = displayName not iterable on render function
    return Object.assign({}, component, {
      displayName: component.displayName
    }, forward);
  } else {
    // The component is a direct render fn, so make a stub render fn.
    let render = props => {
      packageSettings.default.logDeprecated(component, name); // may log don't care about result
      // Replace the stub render fn so this test only happens once.
      return (render = packageSettings.default.isComponentEnabled(name) || !packageSettings.default.isComponentPublic(name) ?
      // If the component is enabled, or if it's not a public component,
      // replace the stub render fn with the component render fn.
      component :
      // Replace the stub render fn with the Canary render fn, which will
      // ignore the passed props.
      Canary.Canary.bind(undefined, {
        componentName: name
      }))(
      // Call it now (after this it will be directly called).
      props);
    };

    // Transfer object properties already assigned (eg propTypes, displayName)
    // to a function which calls the stub render fn which checks the component
    // status when first used.
    return Object.assign(props => render(props), component, {
      displayName: component.displayName
    });
  }
};
const pkg = packageSettings.default;

exports.carbon = carbon;
exports.pkg = pkg;