Types for configurator

Author: slowcheetah

packages/core-js-types/src/base/configurator-custom.d.ts

@@ -0,0 +1,3 @@
+declare namespace CoreJS {
+  export function Configurator(options: Record<PropertyKey, any>): void;
+}

packages/core-js-types/src/base/configurator.d.ts

@@ -1,5 +1,5 @@
 import { features, proposals } from './entries-definitions.mjs';
-import { $namespace, $path, $proposal, $typeDummy } from './templates.mjs';
+import { $functionWithCustomType, $path, $proposal, $typeDummy } from './templates.mjs';
 import { modules as AllModules } from '@core-js/compat/src/data.mjs';
 import { getModulesMetadata } from './get-dependencies.mjs';
 import { expandModules, modulesToStage } from './helpers.mjs';
@@ -42,7 +42,9 @@ function addType(tsVersion, subset, template, options) {
 
 function addEntryTypes(tsVersion, template, options) {
   addType(tsVersion, 'index', template, { ...options, packageName: PACKAGE_NAME });
-  addType(tsVersion, 'pure', template, { ...options, packageName: PACKAGE_NAME_PURE, prefix: TYPE_PREFIX });
+  if (!options.noPure) {
+    addType(tsVersion, 'pure', template, { ...options, packageName: PACKAGE_NAME_PURE, prefix: TYPE_PREFIX });
+  }
   if (options.exportForSubset) {
     addType(tsVersion, options.subset, template, { ...options, packageName: PACKAGE_NAME });
   }
@@ -54,6 +56,7 @@ async function buildType(entry, options) {
     subset = entryFromNamespace ?? 'full',
     typeDummy = false,
     globalType = true,
+    noPure = false,
     template, templateStable, templateActual, templateFull, filter, modules, enforceEntryCreation,
     customType, tsVersion, proposal, types, ownEntryPoint,
   } = options;
@@ -84,10 +87,13 @@ async function buildType(entry, options) {
   const level = entry.split('/').length - 1;
 
   if (!types) {
-    if (!enforceEntryCreation && !expandModules(modules[0], filter, AllModules).length) return;
-    modules = expandModules(modules, filter, AllModules);
-    const { types: typePaths } = await getModulesMetadata(modules);
-    types = typePaths;
+    types = [];
+    if (!customType) {
+      if (!enforceEntryCreation && !expandModules(modules[0], filter, AllModules).length) return;
+      modules = expandModules(modules, filter, AllModules);
+      const { types: typePaths } = await getModulesMetadata(modules);
+      types = typePaths;
+    }
   }
 
   if (typesFilter) {
@@ -99,17 +105,17 @@ async function buildType(entry, options) {
       imports.index.add(type);
       imports[subset].add(type);
     }
-    imports.pure.add(path.join('pure', type));
+    if (!noPure) imports.pure.add(path.join('pure', type));
   });
 
   if (customType) {
     if (globalType) {
       imports.index.add(customType);
       imports[subset].add(customType);
     }
-    imports.pure.add(path.join('pure', customType));
+    if (!noPure) imports.pure.add(path.join('pure', customType));
   }
-  options = { ...options, modules, level, entry, types, subset };
+  options = { ...options, modules, level, entry, types, subset, noPure };
 
   addEntryTypes(tsVersion, template, options);
   if (!entry.endsWith('/')) { // add alias with .js ending
@@ -231,13 +237,14 @@ async function buildTypesForTSVersion(tsVersion) {
   await buildType('index', { template: $path, modules: ActualModules, tsVersion });
 
   await buildType('configurator', {
+    customType: 'configurator-custom',
     entryFromNamespace: 'configurator',
-    template: $namespace,
+    template: $functionWithCustomType,
     modules: ['configurator'],
     name: 'configurator',
     tsVersion,
-    types: ['configurator'],
     exportForSubset: true,
+    noPure: true,
   });
 
   await prependImports(tsVersion);

scripts/build-entries-and-types/build-types.mjs

@@ -492,3 +492,13 @@ export const $typeDummy = p => ({
     }
   `,
 });
+
+export const $functionWithCustomType = p => ({
+  entry: '',
+  types: dedent`
+    declare module '${ buildModulePath(p) }' {
+      const resultFunction: typeof ${ buildCoreJSTypeName('', p.name) };
+      export = resultFunction;
+    }
+  `,
+});

scripts/build-entries-and-types/templates.mjs

@@ -1,3 +1,4 @@
 import '@core-js/types/configurator';
+import configurator from 'core-js/configurator';
 
 configurator({ something: 'value' });

…ries/configurator/import/configurator.ts …initions/entries/configurator/entries.tstests/type-definitions/entries/configurator/import/configurator.ts renamed to tests/type-definitions/entries/configurator/entries.ts tests/type-definitions/entries/configurator/import/configurator.ts renamed to tests/type-definitions/entries/configurator/entries.ts

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["./entries.ts"]
+}

tests/type-definitions/entries/configurator/global/configurator.ts

@@ -166,8 +166,7 @@ tasks.push(
   { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/proposals/tsconfig.json'] },
   { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/global/tsconfig.json'] },
   { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/pure/tsconfig.json'] },
-  { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/configurator/global/tsconfig.json'] },
-  { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/configurator/import/tsconfig.json'] },
+  { args: ['-p', 'typescript@5.9', 'tsc', '-p', 'entries/configurator/tsconfig.json'] },
 );
 
 let envs;