npm publishing interfaces #388

locnguyen1986 · 2026-01-02T13:41:40Z

Describe Your Changes

Fixes Issues

Closes #
Closes #

Self Checklist

Added relevant comments, esp in complex areas
Updated docs (for bug fixes / features)
Created issues for follow-up changes or refactoring needed

Copilot

Pull request overview

This PR sets up npm publishing infrastructure for the @janhq/interfaces package, making it available as a standalone npm package. The changes prepare the package for distribution by configuring build settings, publishing workflow, and adjusting internal import paths.

Key changes:

Added TypeScript build configuration and npm publishing workflow
Configured package.json with metadata, exports, and build scripts for npm distribution
Fixed import path in sonner.tsx to use relative path instead of alias, and added ThemeProvider implementation

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`packages/interfaces/tsconfig.build.json`	New TypeScript build configuration for compiling the package with declaration files
`packages/interfaces/package.json`	Updated with publishing metadata, version 0.1.0, exports configuration, and build scripts
`packages/interfaces/src/ui/sonner.tsx`	Fixed import path from alias to relative path for theme provider
`packages/interfaces/src/providers/theme-provider.tsx`	Added ThemeProvider component for theme management
`package.json`	Added build script shortcut for building interfaces package
`.github/workflows/publish-interfaces.yml`	New GitHub Actions workflow for automated npm publishing on tagged releases

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-02T13:45:07Z

.github/workflows/publish-interfaces.yml

+on:
+  push:
+    tags: ['v[0-9]+.[0-9]+.[0-9]+-interfaces']
+    paths: ['packages/interfaces/**', '.github/workflows/publish-interfaces.yml']


The paths filter in the workflow trigger will not work correctly with tags. The paths filter is only valid for push and pull_request events on branches, not on tag pushes. This means the paths filter will be ignored when a tag is pushed.

Suggested change

paths: ['packages/interfaces/**', '.github/workflows/publish-interfaces.yml']

Copilot · 2026-01-02T13:45:07Z

.github/workflows/publish-interfaces.yml

+
+      - name: Extract tag name without v prefix
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV && echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"


The set-output command is deprecated and will be disabled in the future. Use environment files instead by writing to $GITHUB_OUTPUT. Additionally, the VERSION environment variable is already being set, making the set-output redundant.

Suggested change

run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV && echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"

run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV

Copilot · 2026-01-02T13:45:07Z

packages/interfaces/package.json

+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",


The package specifies main as ./dist/index.js and types as ./dist/index.d.ts, but there appears to be no src/index.ts file in the source directory. When the package is built, TypeScript will not generate these files. Either create an src/index.ts entry point file, or remove the main and types fields if this package is intended to be used exclusively through the subpath exports.

Suggested change

"main": "./dist/index.js",

"types": "./dist/index.d.ts",

Copilot · 2026-01-02T13:45:08Z

packages/interfaces/src/providers/theme-provider.tsx

+    () => (localStorage.getItem(storageKey) as Theme) || defaultTheme,
+  );
+
+  useEffect(() => {
+    const root = window.document.documentElement;
+
+    root.classList.remove("light", "dark");
+
+    if (theme === "system") {
+      const systemTheme = window.matchMedia("(prefers-color-scheme: dark)")
+        .matches
+        ? "dark"
+        : "light";
+
+      root.classList.add(systemTheme);
+      return;
+    }
+
+    root.classList.add(theme);
+  }, [theme]);
+
+  const value = {
+    theme,
+    setTheme: (theme: Theme) => {
+      localStorage.setItem(storageKey, theme);


The ThemeProvider directly accesses localStorage and window without checking if they exist. This will cause the component to fail in server-side rendering (SSR) environments like Next.js. Consider adding checks like typeof window !== 'undefined' before accessing browser APIs, or wrap these calls in a way that's safe for SSR.

Copilot · 2026-01-02T13:45:08Z

.github/workflows/publish-interfaces.yml

+          new_version=$(echo $tag | sed -n 's/-interfaces//p')
+          echo $new_version


The sed command with -n flag and s///p will only print lines that match and substitute. If the tag doesn't contain "-interfaces", this will result in an empty new_version. This could cause the package.json to have an empty version field. Consider using a simpler approach like sed 's/-interfaces//' without the -n and p flags, or add validation to ensure the version is not empty before updating package.json.

Suggested change

new_version=$(echo $tag | sed -n 's/-interfaces//p')

echo $new_version

new_version=$(echo "$tag" | sed 's/-interfaces$//')

if [ -z "$new_version" ]; then

echo "Error: Derived version is empty. Original tag: '$tag'" >&2

exit 1

fi

echo "$new_version"

Copilot · 2026-01-02T13:45:08Z

packages/interfaces/tsconfig.build.json

+    "allowImportingTsExtensions": false,
+    "moduleResolution": "node"


The tsconfig.build.json sets moduleResolution to "node", but the base tsconfig.json uses "bundler". For a published npm package, "node" or "node16"/"nodenext" is more appropriate. However, the base config also has allowImportingTsExtensions: true which conflicts with emitting files (building). The build config correctly sets this to false, but consider aligning the module resolution strategy between configs or ensuring the build output is compatible with Node.js module resolution.

Suggested change

"allowImportingTsExtensions": false,

"moduleResolution": "node"

"allowImportingTsExtensions": false

Copilot · 2026-01-02T13:45:09Z

.github/workflows/publish-interfaces.yml

+        run: npm install
+        working-directory: packages/interfaces


Installing dependencies only in the packages/interfaces directory may fail if the package has workspace dependencies or if the monorepo uses workspace features. Consider running npm install from the root directory first to ensure all workspace dependencies are properly linked, or use npm ci for a clean install based on the lockfile.

Suggested change

run: npm install

working-directory: packages/interfaces

run: npm ci

Copilot · 2026-01-02T13:45:09Z

packages/interfaces/src/providers/theme-provider.tsx

+  useEffect(() => {
+    const root = window.document.documentElement;
+
+    root.classList.remove("light", "dark");
+
+    if (theme === "system") {
+      const systemTheme = window.matchMedia("(prefers-color-scheme: dark)")
+        .matches
+        ? "dark"
+        : "light";
+
+      root.classList.add(systemTheme);
+      return;
+    }
+
+    root.classList.add(theme);
+  }, [theme]);


The useEffect accesses window.document and window.matchMedia without checking if window is defined. This will cause errors in SSR environments. Wrap the useEffect content in a check like if (typeof window === 'undefined') return; or ensure this component only runs on the client side.

Copilot · 2026-01-02T13:45:09Z

packages/interfaces/package.json

+    "./providers/*": {
+      "types": "./src/providers/*.tsx",
+      "default": "./src/providers/*.tsx"
+    },
+    "./providers/theme-provider": {
+      "types": "./src/providers/theme-provider.tsx",
+      "default": "./src/providers/theme-provider.tsx"
+    },


The wildcard export pattern ./providers/* with source file paths won't work correctly when the package is published with compiled files. Additionally, having both a wildcard pattern (./providers/*) and a specific export (./providers/theme-provider) is redundant - the wildcard should already cover the specific case. Consider removing the redundant specific export or restructuring the exports to point to compiled files in the dist directory.

Copilot AI review requested due to automatic review settings January 2, 2026 13:41

github-project-automation bot added this to Jan Jan 2, 2026

Copilot started reviewing on behalf of locnguyen1986 January 2, 2026 13:42 View session

Copilot AI reviewed Jan 2, 2026

View reviewed changes

louis-jan previously approved these changes Jan 2, 2026

View reviewed changes

Minh141120 dismissed louis-jan’s stale review via 4354cc2 January 2, 2026 16:21

Minh141120 force-pushed the feat/npm-publishing-interfaces branch from c63b2dd to 3de4277 Compare January 6, 2026 08:49

Minh141120 requested a review from Vanalite January 6, 2026 08:50

Minh141120 force-pushed the feat/npm-publishing-interfaces branch from 3de4277 to 62a7f1c Compare January 6, 2026 09:12

Vanalite approved these changes Jan 6, 2026

View reviewed changes

locnguyen1986 and others added 5 commits January 8, 2026 12:17

npm publishing interfaces

eae328c

chore: update packge version and publish info

d0ff740

chore: update export entrypoints for interfaces package

57aa4b8

chore: update exports for interfaces and update package version

b456da9

chre: use janhq interfaces from npmjs

e71d47a

Minh141120 force-pushed the feat/npm-publishing-interfaces branch from 62a7f1c to e71d47a Compare January 8, 2026 05:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

npm publishing interfaces #388

npm publishing interfaces #388

Uh oh!

locnguyen1986 commented Jan 2, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV && echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"
	run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV

		new_version=$(echo $tag \| sed -n 's/-interfaces//p')
		echo $new_version

-          new_version=$(echo $tag | sed -n 's/-interfaces//p')
-          echo $new_version
+          new_version=$(echo "$tag" | sed 's/-interfaces$//')
+          if [ -z "$new_version" ]; then
+            echo "Error: Derived version is empty. Original tag: '$tag'" >&2
+            exit 1
+          fi
+          echo "$new_version"

		"allowImportingTsExtensions": false,
		"moduleResolution": "node"

	"allowImportingTsExtensions": false,
	"moduleResolution": "node"
	"allowImportingTsExtensions": false

	run: npm install
	working-directory: packages/interfaces
	run: npm ci

npm publishing interfaces #388

Are you sure you want to change the base?

npm publishing interfaces #388

Uh oh!

Conversation

locnguyen1986 commented Jan 2, 2026

Describe Your Changes

Fixes Issues

Self Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants