@n8n/frontend-module-type-availability-policies 0.1.0

package/LICENSE.md

@@ -0,0 +1,88 @@
+# License
+
+Portions of this software are licensed as follows:
+
+- Content of branches other than the main branch (i.e. "master") are not licensed.
+- Source code files that contain ".ee." in their filename or ".ee" in their dirname are NOT licensed under
+  the Sustainable Use License.
+  To use source code files that contain ".ee." in their filename or ".ee" in their dirname you must hold a
+	valid n8n Enterprise License specifically allowing you access to such source code files and as defined
+	in "LICENSE_EE.md".
+- All third party components incorporated into the n8n Software are licensed under the original license
+  provided by the owner of the applicable component.
+- Content outside of the above mentioned files or restrictions is available under the "Sustainable Use
+  License" as defined below.
+
+## Sustainable Use License
+
+Version 1.0
+
+### Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+### Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license
+to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject
+to the limitations below.
+
+### Limitations
+
+You may use or modify the software only for your own internal business purposes or for non-commercial or
+personal use. You may distribute the software or provide it to others only if you do so free of charge for
+non-commercial purposes. You may not alter, remove, or obscure any licensing, copyright, or other notices of
+the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+### Patents
+
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to
+license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case
+subject to the limitations and conditions in this license. This license does not cover any patent claims that
+you cause to be infringed by modifications or additions to the software. If you or your company make any
+written claim that the software infringes or contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If your company makes such a claim, your patent
+license ends immediately for work on behalf of your company.
+
+### Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these
+terms. If you modify the software, you must include in any modified copies of the software a prominent notice
+stating that you have modified the software.
+
+### No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+### Termination
+
+If you use the software in violation of these terms, such use is not licensed, and your license will
+automatically terminate. If the licensor provides you with a notice of your violation, and you cease all
+violation of this license no later than 30 days after you receive that notice, your license will be reinstated
+retroactively. However, if you violate these terms after such reinstatement, any additional violation of these
+terms will cause your license to terminate automatically and permanently.
+
+### No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will
+not be liable to you for any damages arising out of these terms or the use or nature of the software, under
+any kind of legal claim.
+
+### Definitions
+
+The “licensor” is the entity offering these terms.
+
+The “software” is the software the licensor makes available under these terms, including any portion of it.
+
+“You” refers to the individual or entity agreeing to these terms.
+
+“Your company” is any legal entity, sole proprietorship, or other kind of organization that you work for, plus
+all organizations that have control over, are under the control of, or are under common control with that
+organization. Control means ownership of substantially all the assets of an entity, or the power to direct its
+management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+“Your license” is the license granted to you for the software under these terms.
+
+“Use” means anything you do with the software requiring your license.
+
+“Trademark” means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,21 @@
+# @n8n/frontend-module-type-availability-policies
+
+Frontend module for node type availability policies. The editor-ui shell consumes it from
+source through `src/app/modules.manifest.ts`, so there is no build step and no `dist`.
+
+The descriptor `id` must match the backend module id
+(`packages/cli/src/modules/type-availability-policies`). Both `settings.activeModules` and
+`/rest/module-settings` are keyed by that string, and a mismatch fails silently.
+
+The module is license-gated on `feat:nodeTypePolicies` and is not a default module. Enable it
+in a dev instance with `N8N_ENABLED_MODULES=type-availability-policies`.
+
+```bash
+pnpm turbo typecheck lint test --filter=@n8n/frontend-module-type-availability-policies
+```
+
+Use turbo and not `pnpm --filter`: this package reads its platform dependencies from source,
+and on a cold tree turbo builds them first.
+
+`packages/@n8n/module-cli/frontend-module-guide.md` holds the descriptor contract, the
+registration points, the import boundaries and the setup a module needs to render UI.

package/biome.jsonc

@@ -0,0 +1,4 @@
+{
+	"$schema": "../../../../node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../../../biome.jsonc"]
+}

package/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { defineConfig } from 'eslint/config';
+import { frontendConfig } from '@n8n/eslint-config/frontend';
+
+export default defineConfig(frontendConfig);

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@n8n/frontend-module-type-availability-policies",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@n8n/frontend-module-sdk": "0.10.0"
+  },
+  "devDependencies": {
+    "@n8n/eslint-config": "0.0.1",
+    "@n8n/frontend-test-utils": "0.1.0",
+    "@n8n/frontend-vite-config": "0.1.0",
+    "@n8n/playwright-janitor": "0.1.0",
+    "@n8n/typescript-config": "1.12.0",
+    "@n8n/vitest-config": "1.22.0",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/vue": "^8.1.0",
+    "@vitejs/plugin-vue": "^6.0.8",
+    "eslint": "9.29.0",
+    "typescript": "6.0.2",
+    "unplugin-icons": "^23.0.1",
+    "vite": "^8.0.2",
+    "vitest": "^4.1.9",
+    "vue-tsc": "^2.2.8"
+  },
+  "license": "LicenseRef-n8n-sustainable-use",
+  "scripts": {
+    "clean": "rimraf .turbo",
+    "typecheck": "vue-tsc --noEmit",
+    "test": "vitest run",
+    "test:changed": "janitor test-scoped",
+    "test:dev": "vitest",
+    "lint": "eslint src --quiet",
+    "lint:fix": "eslint src --fix",
+    "format": "biome format --write . && prettier --write . --ignore-path ../../../../.prettierignore",
+    "format:check": "biome ci . && prettier --check . --ignore-path ../../../../.prettierignore"
+  }
+}

package/src/__tests__/setup.ts

@@ -0,0 +1,4 @@
+// The shared frontend test harness: the jsdom environment, english messages, and a fresh pinia
+// per test. It lives in `@n8n/frontend-test-utils` rather than in `@n8n/vitest-config`, because
+// `@n8n/i18n` devDepends on the latter and importing i18n there closes a cycle in the turbo graph.
+import '@n8n/frontend-test-utils/setup';

package/src/index.ts

@@ -0,0 +1 @@
+export { TypeAvailabilityPoliciesModule } from './type-availability-policies.module';

package/src/type-availability-policies.constants.ts

@@ -0,0 +1,2 @@
+/** Must stay the same as the backend module id: `settings.activeModules` is keyed by it. */
+export const TYPE_AVAILABILITY_POLICIES_MODULE_ID = 'type-availability-policies';

package/src/type-availability-policies.module.test.ts

@@ -0,0 +1,9 @@
+import { TypeAvailabilityPoliciesModule } from './type-availability-policies.module';
+
+describe('TypeAvailabilityPoliciesModule', () => {
+	it('keeps the id the backend module publishes in `activeModules`', () => {
+		// A mismatch is silent: `isModuleActive` compares strings, so the module would
+		// never report active. The twin is `packages/cli/src/modules/type-availability-policies`.
+		expect(TypeAvailabilityPoliciesModule.id).toBe('type-availability-policies');
+	});
+});

package/src/type-availability-policies.module.ts

@@ -0,0 +1,11 @@
+import { defineFrontendModule } from '@n8n/frontend-module-sdk';
+
+import { TYPE_AVAILABILITY_POLICIES_MODULE_ID } from './type-availability-policies.constants';
+
+/** Keep this file import-light: the shell runs every descriptor body before Pinia starts. */
+export const TypeAvailabilityPoliciesModule = defineFrontendModule({
+	id: TYPE_AVAILABILITY_POLICIES_MODULE_ID,
+	name: 'Type Availability Policies',
+	description: 'Reports which node types a project can use, and why a type is unavailable',
+	icon: 'shield',
+});

package/vite.config.ts

@@ -0,0 +1,23 @@
+import vue from '@vitejs/plugin-vue';
+import { fileURLToPath } from 'node:url';
+import { resolve } from 'node:path';
+import { defineConfig, mergeConfig } from 'vite';
+import { frontendAliases } from '@n8n/frontend-vite-config';
+import { vitestConfig } from '@n8n/vitest-config/frontend';
+
+const packageDir = fileURLToPath(new URL('.', import.meta.url));
+const packagesDir = resolve(packageDir, '..', '..', '..');
+
+export default mergeConfig(
+	defineConfig({
+		plugins: [vue()],
+		resolve: {
+			// The same platform mapping the editor-ui dev server uses, so a test resolves
+			// `@n8n/stores/...` from source rather than from a stale `dist` — the two disagreeing is
+			// what put 1,111 specifiers on the wrong side of the src/dist line. Sibling modules are
+			// deliberately absent: nothing here should make a cross-module import resolve.
+			alias: frontendAliases(packagesDir),
+		},
+	}),
+	vitestConfig,
+);