@nocobase/portal-template-default 1.0.9 → 1.0.10

package/registry.config.json

@@ -1,302 +0,0 @@
-{
-  "name": "nocobase-ai",
-  "homepage": "https://www.nocobase.com",
-  "items": [
-    {
-      "name": "route-surfaces",
-      "type": "registry:lib",
-      "title": "NocoBase Route Surfaces",
-      "description": "URL-backed drawer, dialog, and page containers with nested drawer stacking and a shared close lifecycle.",
-      "dependencies": [
-        "@base-ui/react@^1.6.0",
-        "@refinedev/core@^5.0.8",
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "registryDependencies": [
-        "alert-dialog",
-        "badge",
-        "button",
-        "card",
-        "input",
-        "label",
-        "select",
-        "textarea"
-      ],
-      "docs": "Provides presentation containers plus an integrated Demo and Prompt generator. Route definitions, ACL guards, data fetching, and business content remain application-owned.",
-      "source": {
-        "root": "registry/nocobase-route-surfaces",
-        "target": "src/extensions/nocobase-route-surfaces",
-        "include": ["."]
-      }
-    },
-    {
-      "name": "i18n",
-      "type": "registry:block",
-      "title": "NocoBase i18n",
-      "description": "Optional NocoBase server-language resources, user preference persistence, reusable language controls, and an integrated showcase for the Starter's built-in i18n runtime.",
-      "dependencies": [
-        "@refinedev/core@^5.0.8",
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "registryDependencies": [
-        "badge",
-        "button",
-        "card",
-        "dropdown-menu",
-        "input",
-        "label",
-        "select",
-        "textarea"
-      ],
-      "docs": "Requires a compatible NocoBase Starter with the built-in i18n provider, shared System Settings bootstrap, and AppExtension Provider/UserMenuItems host fields. The Registry reuses systemSettings:get data and calls app:getLang only for registered dynamic namespaces such as lm-collections.",
-      "source": {
-        "root": "registry/nocobase-i18n",
-        "target": "src/extensions/nocobase-i18n",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-oidc",
-      "type": "registry:block",
-      "title": "NocoBase OIDC Authentication",
-      "description": "Dynamic OIDC sign-in adapter, headless sign-in hook, and integrated component demo.",
-      "dependencies": [
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "docs": "Requires the Starter authentication runtime and an enabled OIDC authenticator in NocoBase. The default UI is discovered automatically and can be replaced per authentication type or authenticator instance from the application login page.",
-      "source": {
-        "root": "registry/nocobase-auth-oidc",
-        "target": "src/extensions/nocobase-auth-oidc",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-saml",
-      "type": "registry:block",
-      "title": "NocoBase SAML Authentication",
-      "description": "Dynamic SAML sign-in adapter, automatic redirect provider, headless hook, and integrated demo.",
-      "dependencies": [
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "docs": "Requires the Starter authentication runtime and an enabled SAML authenticator in NocoBase.",
-      "source": {
-        "root": "registry/nocobase-auth-saml",
-        "target": "src/extensions/nocobase-auth-saml",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-cas",
-      "type": "registry:block",
-      "title": "NocoBase CAS Authentication",
-      "description": "Dynamic CAS sign-in adapter, headless sign-in hook, and integrated component demo.",
-      "dependencies": [
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "docs": "Requires the Starter authentication runtime and an enabled CAS authenticator in NocoBase.",
-      "source": {
-        "root": "registry/nocobase-auth-cas",
-        "target": "src/extensions/nocobase-auth-cas",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-ldap",
-      "type": "registry:block",
-      "title": "NocoBase LDAP Authentication",
-      "description": "Dynamic LDAP account/password form, headless sign-in hook, and integrated component demo.",
-      "docs": "Requires the Starter authentication runtime and an enabled LDAP authenticator in NocoBase.",
-      "source": {
-        "root": "registry/nocobase-auth-ldap",
-        "target": "src/extensions/nocobase-auth-ldap",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-sms",
-      "type": "registry:block",
-      "title": "NocoBase SMS Authentication",
-      "description": "Dynamic SMS verification-code form, delivery countdown, headless hook, and integrated demo.",
-      "docs": "Requires the Starter authentication runtime, an enabled SMS authenticator, and a configured public SMS verifier in NocoBase.",
-      "source": {
-        "root": "registry/nocobase-auth-sms",
-        "target": "src/extensions/nocobase-auth-sms",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-wecom",
-      "type": "registry:block",
-      "title": "NocoBase WeCom Authentication",
-      "description": "Dynamic WeCom sign-in adapter, browser automatic login, headless hook, and integrated demo.",
-      "dependencies": [
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "docs": "Requires the Starter authentication runtime and an enabled WeCom authenticator in NocoBase.",
-      "source": {
-        "root": "registry/nocobase-auth-wecom",
-        "target": "src/extensions/nocobase-auth-wecom",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "auth-dingtalk",
-      "type": "registry:block",
-      "title": "NocoBase DingTalk Authentication",
-      "description": "Dynamic DingTalk sign-in adapter, automatic login, headless hook, and integrated demo.",
-      "dependencies": [
-        "dingtalk-jsapi@3.1.1",
-        "lucide-react@^0.487.0",
-        "react-router@^7.0.2"
-      ],
-      "docs": "Requires the Starter authentication runtime and an enabled DingTalk authenticator in NocoBase. DingTalk JSAPI is loaded lazily for internal micro-app login.",
-      "source": {
-        "root": "registry/nocobase-auth-dingtalk",
-        "target": "src/extensions/nocobase-auth-dingtalk",
-        "install": false,
-        "include": ["."]
-      }
-    },
-    {
-      "name": "ai-runtime",
-      "type": "registry:lib",
-      "title": "NocoBase AI Runtime",
-      "description": "NocoBase AI services, providers, transports, controllers, and avatars.",
-      "dependencies": [
-        "@ai-sdk/react@2.0.0",
-        "ai@5.0.0",
-        "@dicebear/core@^9.4.3",
-        "@nocobase/ai-employee-avatars@^1.0.2",
-        "eventsource-parser@3.1.0"
-      ],
-      "source": {
-        "root": "registry/nocobase-ai",
-        "target": "src/extensions/nocobase-ai",
-        "include": ["providers", "services"]
-      }
-    },
-    {
-      "name": "ai-chat",
-      "type": "registry:block",
-      "title": "NocoBase AI Chat Components",
-      "description": "Reusable NocoBase AI chat window, containers, floating trigger, and employee shortcut.",
-      "dependencies": [
-        "echarts@^5.5.0",
-        "echarts-for-react@3.0.2",
-        "lucide-react@^0.487.0",
-        "next-themes@^0.4.6",
-        "react-markdown@^10.1.0",
-        "remark-gfm@^4.0.1"
-      ],
-      "registryDependencies": [
-        "@nocobase/ai-runtime",
-        "badge",
-        "button",
-        "collapsible",
-        "dialog",
-        "dropdown-menu",
-        "hover-card",
-        "input",
-        "input-group",
-        "label",
-        "popover",
-        "select",
-        "tabs",
-        "textarea",
-        "tooltip"
-      ],
-      "source": {
-        "root": "registry/nocobase-ai",
-        "target": "src/extensions/nocobase-ai",
-        "include": ["components", "assets", "index.ts", "README.md"]
-      }
-    },
-    {
-      "name": "ai-react-hook-form",
-      "type": "registry:lib",
-      "title": "NocoBase AI React Hook Form Adapter",
-      "description": "Optional React Hook Form adapter for the built-in AI Form filler.",
-      "dependencies": ["react-hook-form@^7.57.0"],
-      "registryDependencies": ["@nocobase/ai-chat"],
-      "source": {
-        "root": "registry/nocobase-ai",
-        "target": "src/extensions/nocobase-ai",
-        "include": ["adapters/react-hook-form.ts"]
-      }
-    },
-    {
-      "name": "ai",
-      "type": "registry:block",
-      "title": "NocoBase AI Components and Demo",
-      "description": "Complete NocoBase AI component runtime with application resources, routes, and component showcase pages.",
-      "dependencies": ["@refinedev/core@^5.0.8", "react-router@^7.0.2"],
-      "registryDependencies": [
-        "@nocobase/ai-chat",
-        "@nocobase/ai-react-hook-form",
-        "accordion",
-        "alert",
-        "badge",
-        "card",
-        "checkbox",
-        "input",
-        "switch",
-        "table",
-        "textarea"
-      ],
-      "docs": "This item includes the AI extension integration and Demo pages. It is designed for a compatible starter with the AppExtension host enabled. After installation, src/extensions/nocobase-ai/extension.tsx is discovered automatically and contributes its application resources and routes without AI-specific App.tsx edits.",
-      "source": {
-        "root": "registry/nocobase-ai",
-        "target": "src/extensions/nocobase-ai",
-        "include": ["demo", "extension.tsx", "global-ai-chat.tsx"]
-      }
-    },
-    {
-      "name": "acl-ui",
-      "type": "registry:block",
-      "title": "NocoBase ACL UI",
-      "description": "Page, region, field, and role-switching components backed by the Starter's NocoBase accessControlProvider.",
-      "dependencies": ["@refinedev/core@^5.0.8", "lucide-react@^0.487.0"],
-      "registryDependencies": ["badge", "select"],
-      "docs": "Requires a compatible NocoBase Starter with the built-in accessControlProvider and ACL store.",
-      "source": {
-        "root": "registry/nocobase-acl",
-        "target": "src/extensions/nocobase-acl",
-        "include": ["components", "index.ts", "README.md"]
-      }
-    },
-    {
-      "name": "acl",
-      "type": "registry:block",
-      "title": "NocoBase ACL Components and Demo",
-      "description": "Complete ACL composition demo with live role switching, action matrix, multi-collection regions, and field permissions.",
-      "dependencies": ["@refinedev/core@^5.0.8", "react-router@^7.0.2"],
-      "registryDependencies": [
-        "@nocobase/acl-ui",
-        "button",
-        "card",
-        "input",
-        "label",
-        "table",
-        "textarea"
-      ],
-      "source": {
-        "root": "registry/nocobase-acl",
-        "target": "src/extensions/nocobase-acl",
-        "include": ["demo", "extension.tsx"]
-      }
-    }
-  ]
-}

package/scripts/registry.mjs

@@ -1,164 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-const projectRoot = path.resolve(
-  path.dirname(fileURLToPath(import.meta.url)),
-  ".."
-);
-const configPath = path.join(projectRoot, "registry.config.json");
-const outputPath = path.join(projectRoot, "registry.json");
-const action = process.argv[2];
-
-if (!new Set(["build", "install-missing", "preview"]).has(action)) {
-  throw new Error(
-    "Usage: node scripts/registry.mjs <build|install-missing|preview>"
-  );
-}
-
-function toPosix(value) {
-  return value.split(path.sep).join("/");
-}
-
-function walkFiles(directory, root = directory) {
-  return fs
-    .readdirSync(directory, { withFileTypes: true })
-    .flatMap((entry) => {
-      const entryPath = path.join(directory, entry.name);
-      return entry.isDirectory()
-        ? walkFiles(entryPath, root)
-        : [toPosix(path.relative(root, entryPath))];
-    })
-    .sort((left, right) => left.localeCompare(right));
-}
-
-function isIncluded(file, include) {
-  return include.some((entry) => {
-    const normalized = entry.replace(/^\.\//, "").replace(/\/$/, "");
-    return (
-      normalized === "." ||
-      file === normalized ||
-      file.startsWith(`${normalized}/`)
-    );
-  });
-}
-
-function assertSafePath(value, prefix, label) {
-  if (!value.startsWith(prefix) || value.includes("..")) {
-    throw new Error(`Unsafe ${label} path: ${value}`);
-  }
-}
-
-const sourceConfig = JSON.parse(fs.readFileSync(configPath, "utf8"));
-const sourceFiles = new Map();
-const sourceMappings = new Map();
-const itemNames = new Set();
-
-const items = sourceConfig.items.map((item) => {
-  if (!item.name || itemNames.has(item.name)) {
-    throw new Error(`Registry item name must be unique: ${item.name}`);
-  }
-  itemNames.add(item.name);
-  const source = item.source;
-  if (!source) {
-    throw new Error(`Registry item ${item.name} is missing its source mapping`);
-  }
-
-  assertSafePath(source.root, "registry/", "source");
-  assertSafePath(source.target, "src/extensions/", "target");
-
-  const sourceRoot = path.join(projectRoot, source.root);
-  if (!fs.existsSync(sourceRoot)) {
-    throw new Error(`Registry source does not exist: ${source.root}`);
-  }
-
-  if (!Array.isArray(source.include) || !source.include.length) {
-    throw new Error(`Registry item ${item.name} must include at least one path`);
-  }
-
-  const mappingKey = `${source.root}\0${source.target}`;
-  const mapping = sourceMappings.get(mappingKey) ?? {
-    root: source.root,
-    target: source.target,
-    include: new Set(),
-    install: source.install !== false,
-  };
-  source.include.forEach((entry) => mapping.include.add(entry));
-  mapping.install = mapping.install || source.install !== false;
-  sourceMappings.set(mappingKey, mapping);
-
-  const allFiles = sourceFiles.get(source.root) ?? walkFiles(sourceRoot);
-  sourceFiles.set(source.root, allFiles);
-  const includedFiles = allFiles.filter((file) =>
-    isIncluded(file, source.include)
-  );
-  if (!includedFiles.length) {
-    throw new Error(
-      `Registry item ${item.name} include paths did not match any files`
-    );
-  }
-
-  if (action !== "build") return item;
-  const { source: _source, ...registryItem } = item;
-
-  return {
-    ...registryItem,
-    files: includedFiles.map((file) => ({
-      path: path.posix.join(source.root, file),
-      type: "registry:file",
-      target: path.posix.join(source.target, file),
-    })),
-  };
-});
-
-function copySource(source, overwrite) {
-  const sourcePath = path.join(projectRoot, source.root);
-  const targetPath = path.join(projectRoot, source.target);
-
-  if (fs.existsSync(targetPath) && !overwrite) {
-    console.log(`${source.target}: already installed, preserved`);
-    return;
-  }
-
-  fs.mkdirSync(path.dirname(targetPath), { recursive: true });
-  const temporaryRoot = fs.mkdtempSync(
-    path.join(path.dirname(targetPath), `.${path.basename(targetPath)}-install-`)
-  );
-  const temporaryTarget = path.join(temporaryRoot, path.basename(targetPath));
-
-  try {
-    const includedFiles = walkFiles(sourcePath).filter((file) =>
-      isIncluded(file, [...source.include])
-    );
-    for (const file of includedFiles) {
-      const sourceFile = path.join(sourcePath, file);
-      const targetFile = path.join(temporaryTarget, file);
-      fs.mkdirSync(path.dirname(targetFile), { recursive: true });
-      fs.copyFileSync(sourceFile, targetFile);
-    }
-    if (overwrite) fs.rmSync(targetPath, { recursive: true, force: true });
-    fs.renameSync(temporaryTarget, targetPath);
-    console.log(
-      `${source.target}: ${overwrite ? "preview refreshed" : "installed"}`
-    );
-  } finally {
-    fs.rmSync(temporaryRoot, { recursive: true, force: true });
-  }
-}
-
-if (action === "build") {
-  const registry = {
-    $schema: "https://ui.shadcn.com/schema/registry.json",
-    ...sourceConfig,
-    items,
-  };
-  fs.writeFileSync(outputPath, `${JSON.stringify(registry, null, 2)}\n`);
-  for (const item of items) {
-    console.log(`${item.name}: ${item.files.length} files`);
-  }
-} else {
-  for (const source of sourceMappings.values()) {
-    if (action === "install-missing" && !source.install) continue;
-    copySource(source, action === "preview");
-  }
-}

package/src/components/access-control/resource-access-guard.tsx

@@ -1,21 +0,0 @@
-import { CanAccess } from "@refinedev/core";
-import type { PropsWithChildren, ReactNode } from "react";
-
-import { AccessDenied } from "./access-denied";
-
-export function ResourceAccessGuard({
-  resource,
-  action,
-  children,
-  fallback = <AccessDenied />,
-}: PropsWithChildren<{
-  resource: string;
-  action: string;
-  fallback?: ReactNode;
-}>) {
-  return (
-    <CanAccess resource={resource} action={action} fallback={fallback}>
-      {children}
-    </CanAccess>
-  );
-}

package/src/components/access-control/use-acl-runtime.ts

@@ -1,28 +0,0 @@
-import { useQueryClient } from "@tanstack/react-query";
-import { useEffect, useRef } from "react";
-
-import { loadAcl, useAclSnapshot } from "@/lib/nocobase/acl";
-
-export function useAclRuntime() {
-  const snapshot = useAclSnapshot();
-  const queryClient = useQueryClient();
-  const lastReadyVersion = useRef<number | undefined>(undefined);
-
-  useEffect(() => {
-    if (snapshot.status === "idle") {
-      void loadAcl().catch(() => undefined);
-    }
-  }, [snapshot.status]);
-
-  useEffect(() => {
-    if (snapshot.status !== "ready") return;
-    if (lastReadyVersion.current === undefined) {
-      lastReadyVersion.current = snapshot.version;
-      return;
-    }
-    if (lastReadyVersion.current === snapshot.version) return;
-
-    lastReadyVersion.current = snapshot.version;
-    void queryClient.invalidateQueries({ queryKey: ["access"] });
-  }, [queryClient, snapshot.status, snapshot.version]);
-}

package/src/lib/nocobase/acl/action.ts

@@ -1,147 +0,0 @@
-import type {
-  AclActionParams,
-  AclCanParams,
-  AclRoleData,
-  AclSnapshot,
-  ResourceAcl,
-} from "./types";
-import ignore from "ignore";
-import { getRecordActionPermission } from "./record-permissions";
-import { resolveAclDataSourceKey } from "./data-source";
-
-const REFINE_ACTION_MAP: Record<string, string> = {
-  list: "list",
-  show: "get",
-  create: "create",
-  edit: "update",
-  delete: "destroy",
-  clone: "create",
-};
-
-const getResourceAcl = (params?: AclCanParams["params"]) =>
-  params?.resource?.meta?.acl as ResourceAcl | undefined;
-
-export const mapRefineAction = (action: string) =>
-  REFINE_ACTION_MAP[action] ?? action;
-
-export const getAclDataForDataSource = (
-  snapshot: AclSnapshot,
-  dataSourceKey = "main"
-): AclRoleData => {
-  const dataSourceAcl = snapshot.meta.dataSources?.[dataSourceKey];
-  return dataSourceAcl
-    ? {
-        ...snapshot.data,
-        ...dataSourceAcl,
-        snippets: snapshot.data.snippets,
-      }
-    : snapshot.data;
-};
-
-export const resolveActionPermission = ({
-  snapshot,
-  resource,
-  action,
-  dataSourceKey = "main",
-}: {
-  snapshot: AclSnapshot;
-  resource: string;
-  action: string;
-  dataSourceKey?: string;
-}): AclActionParams | null => {
-  const data = getAclDataForDataSource(snapshot, dataSourceKey);
-  if (data.allowAll) return {};
-
-  const canonicalAction = data.actionAlias?.[action] ?? action;
-  if (data.resources?.includes(resource)) {
-    return (
-      data.actions?.[`${resource}:${canonicalAction}`] ??
-      data.actions?.[`${resource}:${action}`] ??
-      null
-    );
-  }
-
-  const strategyAllowed = data.strategy?.actions?.some(
-    (item) => item.split(":")[0] === canonicalAction
-  );
-  return strategyAllowed ? {} : null;
-};
-
-const matchesSnippet = (snippets: string[], target: string) =>
-  !target || target === "*" || ignore().add(snippets).ignores(target);
-
-export const canAccessWithSnapshot = (
-  snapshot: AclSnapshot,
-  { resource, action, params }: AclCanParams
-) => {
-  if (snapshot.status !== "ready") return false;
-
-  const resourceAcl = getResourceAcl(params);
-  if (resourceAcl === false || resourceAcl?.type === "authenticated") {
-    return true;
-  }
-
-  if (resourceAcl?.type === "snippet") {
-    return (
-      snapshot.data.allowAll ||
-      matchesSnippet(snapshot.data.snippets ?? [], resourceAcl.name)
-    );
-  }
-
-  if (resourceAcl?.type === "route") {
-    return (
-      snapshot.data.allowAll ||
-      (snapshot.data.allowMenuItemIds ?? [])
-        .map(String)
-        .includes(String(resourceAcl.routeId))
-    );
-  }
-
-  const targetResource =
-    resourceAcl?.type === "collection" && resourceAcl.resource
-      ? resourceAcl.resource
-      : resource;
-  if (!targetResource) return true;
-
-  const dataSourceKey =
-    resolveAclDataSourceKey(
-      params,
-      params?.meta as { dataSourceKey?: unknown; acl?: ResourceAcl } | undefined,
-      params?.resource?.meta as
-        | { dataSourceKey?: unknown; acl?: ResourceAcl }
-        | undefined
-    ) ?? "main";
-  const mappedAction =
-    (resourceAcl?.type === "collection" && resourceAcl.actionMap?.[action]) ||
-    mapRefineAction(action);
-  const permission = resolveActionPermission({
-    snapshot,
-    resource: targetResource,
-    action: mappedAction,
-    dataSourceKey,
-  });
-  if (!permission) return false;
-
-  if (params?.id !== undefined) {
-    const recordPermission = getRecordActionPermission({
-      dataSourceKey,
-      resource: targetResource,
-      action: mappedAction,
-      id: params.id,
-      actionAlias: getAclDataForDataSource(snapshot, dataSourceKey).actionAlias,
-    });
-    if (recordPermission !== undefined) return recordPermission;
-  }
-
-  if (typeof params?.field === "string") {
-    const fields = [
-      ...(permission.fields ?? []),
-      ...(permission.whitelist ?? []),
-      ...(permission.appends ?? []),
-    ];
-    if (!fields.length) return true;
-    return fields.includes(params.field);
-  }
-
-  return true;
-};

package/src/pages/users/layout.tsx

@@ -1,15 +0,0 @@
-import { Outlet } from "react-router";
-
-import { ResourceAccessGuard } from "@/components/access-control/resource-access-guard";
-import { UserList } from "./list";
-
-export function UserResourceLayout() {
-  return (
-    <>
-      <ResourceAccessGuard resource="users" action="list">
-        <UserList />
-      </ResourceAccessGuard>
-      <Outlet />
-    </>
-  );
-}