fix: Alter entry points to support older TypeScript versions, maintain deprecated JSDocs in stabilized ['~unstable'] APIs (#2212)

Author: iwoplaza

.github/workflows/pkg-pr.yml

@@ -41,7 +41,7 @@ jobs:
         run: pnpm nightly-build
 
       - name: Publish (pkg.pr.new)
-        run: npx pkg-pr-new publish './packages/typegpu/dist' './packages/typegpu-noise/dist' './packages/unplugin-typegpu/dist' --json output.json --comment=off
+        run: npx pkg-pr-new publish './packages/typegpu/dist' './packages/typegpu-noise/dist' './packages/unplugin-typegpu/dist' --json output.json --comment=off --pnpm
       - name: Post or update comment
         uses: actions/github-script@v6
         with:

packages/typegpu/package.json

@@ -7,7 +7,10 @@
   "type": "module",
   "exports": {
     "./package.json": "./package.json",
-    ".": "./src/index.ts",
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
     "./data": "./src/data/index.ts",
     "./std": "./src/std/index.ts",
     "./common": "./src/common/index.ts"

packages/typegpu/src/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @module typegpu
+ */
+
+// NOTE: This is a barrel file, internal files should not import things from this file
+
+export declare const tgpu: {
+  const: typeof import('./core/constant/tgpuConstant.ts').constant;
+  fn: typeof import('./core/function/tgpuFn.ts').fn;
+  comptime: typeof import('./core/function/comptime.ts').comptime;
+  resolve: typeof import('./core/resolve/tgpuResolve.ts').resolve;
+  resolveWithContext:
+    typeof import('./core/resolve/tgpuResolve.ts').resolveWithContext;
+  init: typeof import('./core/root/init.ts').init;
+  initFromDevice: typeof import('./core/root/init.ts').initFromDevice;
+  slot: typeof import('./core/slot/slot.ts').slot;
+  lazy: typeof import('./core/slot/lazy.ts').lazy;
+  accessor: typeof import('./core/slot/accessor.ts').accessor;
+  mutableAccessor: typeof import('./core/slot/accessor.ts').mutableAccessor;
+  privateVar: typeof import('./core/variable/tgpuVariable.ts').privateVar;
+  workgroupVar: typeof import('./core/variable/tgpuVariable.ts').workgroupVar;
+  vertexLayout:
+    typeof import('./core/vertexLayout/vertexLayout.ts').vertexLayout;
+  bindGroupLayout: typeof import('./tgpuBindGroupLayout.ts').bindGroupLayout;
+  computeFn: typeof import('./core/function/tgpuComputeFn.ts').computeFn;
+  fragmentFn: typeof import('./core/function/tgpuFragmentFn.ts').fragmentFn;
+  vertexFn: typeof import('./core/function/tgpuVertexFn.ts').vertexFn;
+  unroll: typeof import('./core/unroll/tgpuUnroll.ts').unroll;
+
+  '~unstable': typeof import('./tgpuUnstable.ts');
+};
+
+export default tgpu;
+
+export * from './indexNamedExports.ts';

packages/typegpu/src/index.js

@@ -0,0 +1,11 @@
+/**
+ * @module typegpu
+ */
+
+// NOTE: This is a barrel file, internal files should not import things from this file
+
+import * as tgpu from './tgpu.ts';
+export * as tgpu from './tgpu.ts';
+export default tgpu;
+
+export * from './indexNamedExports.ts';

packages/typegpu/src/index.ts packages/typegpu/src/indexNamedExports.tspackages/typegpu/src/index.ts renamed to packages/typegpu/src/indexNamedExports.ts

@@ -1,13 +1,5 @@
-/**
- * @module typegpu
- */
-
 // NOTE: This is a barrel file, internal files should not import things from this file
 
-import * as tgpu from './tgpu.ts';
-export * as tgpu from './tgpu.ts';
-export default tgpu;
-
 export * as d from './data/index.ts';
 export * as std from './std/index.ts';
 export * as common from './common/index.ts';

packages/typegpu/src/tgpuUnstable.ts

@@ -1,54 +1,63 @@
 // NOTE: This is a barrel file, internal files should not import things from this file
 
-export {
-  /** @deprecated This feature is now stable, use tgpu.const. */
-  constant as const,
-} from './core/constant/tgpuConstant.ts';
 export { declare } from './core/declare/tgpuDeclare.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.comptime. */
-  comptime,
-} from './core/function/comptime.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.computeFn. */
-  computeFn,
-} from './core/function/tgpuComputeFn.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.fn. */
-  fn,
-} from './core/function/tgpuFn.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.fragmentFn. */
-  fragmentFn,
-} from './core/function/tgpuFragmentFn.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.vertexFn. */
-  vertexFn,
-} from './core/function/tgpuVertexFn.ts';
 export { rawCodeSnippet } from './core/rawCodeSnippet/tgpuRawCodeSnippet.ts';
 export { namespace } from './core/resolve/namespace.ts';
 export { simulate } from './core/simulate/tgpuSimulate.ts';
+
+// DEPRECATED
+
+import { constant } from './core/constant/tgpuConstant.ts';
+import { comptime } from './core/function/comptime.ts';
+import { computeFn } from './core/function/tgpuComputeFn.ts';
+import { fn } from './core/function/tgpuFn.ts';
+import { fragmentFn } from './core/function/tgpuFragmentFn.ts';
+import { vertexFn } from './core/function/tgpuVertexFn.ts';
+import { accessor, mutableAccessor } from './core/slot/accessor.ts';
+import { lazy } from './core/slot/lazy.ts';
+import { slot } from './core/slot/slot.ts';
+import { privateVar, workgroupVar } from './core/variable/tgpuVariable.ts';
+import { vertexLayout } from './core/vertexLayout/vertexLayout.ts';
+
+/** @deprecated This feature is now stable, use tgpu.const. */
+const _constant = constant;
+/** @deprecated This feature is now stable, use tgpu.comptime. */
+const _comptime = comptime;
+/** @deprecated This feature is now stable, use tgpu.computeFn. */
+const _computeFn = computeFn;
+/** @deprecated This feature is now stable, use tgpu.fn. */
+const _fn = fn;
+/** @deprecated This feature is now stable, use tgpu.fragmentFn. */
+const _fragmentFn = fragmentFn;
+/** @deprecated This feature is now stable, use tgpu.vertexFn. */
+const _vertexFn = vertexFn;
+/** @deprecated This feature is now stable, use tgpu.accessor. */
+const _accessor = accessor;
+/** @deprecated This feature is now stable, use tgpu.mutableAccessor. */
+const _mutableAccessor = mutableAccessor;
+/** @deprecated This feature is now stable, use tgpu.lazy. */
+const _lazy = lazy;
+/** @deprecated This feature is now stable, use tgpu.slot. */
+const _slot = slot;
+/** @deprecated This feature is now stable, use tgpu.privateVar. */
+const _privateVar = privateVar;
+/** @deprecated This feature is now stable, use tgpu.workgroupVar. */
+const _workgroupVar = workgroupVar;
+/** @deprecated This feature is now stable, use tgpu.vertexLayout. */
+const _vertexLayout = vertexLayout;
+
 export {
-  /** @deprecated This feature is now stable, use tgpu.accessor. */
-  accessor,
-  /** @deprecated This feature is now stable, use tgpu.mutableAccessor. */
-  mutableAccessor,
-} from './core/slot/accessor.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.lazy. */
-  lazy as derived,
-} from './core/slot/lazy.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.slot. */
-  slot,
-} from './core/slot/slot.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.privateVar. */
-  privateVar,
-  /** @deprecated This feature is now stable, use tgpu.workgroupVar. */
-  workgroupVar,
-} from './core/variable/tgpuVariable.ts';
-export {
-  /** @deprecated This feature is now stable, use tgpu.vertexLayout. */
-  vertexLayout,
-} from './core/vertexLayout/vertexLayout.ts';
+  _accessor as accessor,
+  _comptime as comptime,
+  _computeFn as computeFn,
+  _constant as const,
+  _fn as fn,
+  _fragmentFn as fragmentFn,
+  _lazy as derived,
+  _mutableAccessor as mutableAccessor,
+  _privateVar as privateVar,
+  _slot as slot,
+  _vertexFn as vertexFn,
+  _vertexLayout as vertexLayout,
+  _workgroupVar as workgroupVar,
+};

packages/typegpu/tests/accessor.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, expectTypeOf } from 'vitest';
-import tgpu, { d, std, type TgpuAccessor } from '../src/index.ts';
+import tgpu, { d, std, type TgpuAccessor } from '../src/index.js';
 import { it } from './utils/extendedIt.ts';
 
 const RED = d.vec3f(1, 0, 0);

packages/typegpu/tests/align.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
-import { d, tgpu } from '../src/index.ts';
+import { d, tgpu } from '../src/index.js';
 
 describe('d.align', () => {
   it('adds @align attribute for custom aligned struct members', () => {

packages/typegpu/tests/array.test.ts

@@ -2,7 +2,7 @@ import { attest } from '@ark/attest';
 import { BufferReader, BufferWriter } from 'typed-binary';
 import { describe, expect, expectTypeOf, it } from 'vitest';
 import { readData, writeData } from '../src/data/dataIO.ts';
-import { d, tgpu } from '../src/index.ts';
+import { d, tgpu } from '../src/index.js';
 import { namespace } from '../src/core/resolve/namespace.ts';
 import { resolve } from '../src/resolutionCtx.ts';
 import type { Infer } from '../src/shared/repr.ts';

packages/typegpu/tests/attributes.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, expectTypeOf, it } from 'vitest';
-import { d, tgpu } from '../src/index.ts';
+import { d, tgpu } from '../src/index.js';
 
 describe('attributes', () => {
   it('adds attributes in the correct order', () => {