create-nextly-app 0.0.2-alpha.42 → 0.0.2-alpha.44

package/templates/plugin/src/collections/example.ts

@@ -0,0 +1,13 @@
+import { defineCollection, text, textarea } from "nextly/config";
+
+/**
+ * An example plugin-owned collection. Replace or remove it with your own.
+ * Plugin collections are merged into the host schema automatically (D3/D12)
+ * and get a real table on `nextly migrate` / boot.
+ */
+export const Examples = defineCollection({
+  slug: "examples",
+  labels: { singular: "Example", plural: "Examples" },
+  fields: [text({ name: "title", required: true }), textarea({ name: "body" })],
+  admin: { useAsTitle: "title" },
+});

package/templates/plugin/src/index.ts

@@ -0,0 +1,6 @@
+/**
+ * {{pluginName}} — public entry. The default `.` export is React-free
+ * (Node-safe). Admin React components live on the `./admin` subpath.
+ */
+export { myPlugin } from "./plugin";
+export type { MyPluginOptions } from "./types";

package/templates/plugin/src/plugin.test.ts

@@ -0,0 +1,29 @@
+import { createTestNextly } from "@nextlyhq/plugin-sdk/testing";
+import { afterEach, beforeEach, expect, it } from "vitest";
+
+import { myPlugin } from "./index";
+
+let t: Awaited<ReturnType<typeof createTestNextly>>;
+
+beforeEach(async () => {
+  const plugin = myPlugin();
+  t = await createTestNextly({
+    plugins: [plugin],
+    // Pass the plugin's collections so the harness creates their SQLite tables.
+    collections: plugin.contributes?.collections,
+  });
+});
+
+afterEach(async () => {
+  await t.destroy();
+});
+
+it("boots and exposes the plugin's example collection (real table)", async () => {
+  // Creating an entry proves the contributed collection got a real table and
+  // the plugin's lifecycle ran. Replace with assertions for your own behavior.
+  const created = await t.nextly.create("examples", { title: "First example" });
+  expect(created.item.id).toBeDefined();
+
+  const fetched = await t.nextly.findById("examples", created.item.id);
+  expect(fetched?.title).toBe("First example");
+});

package/templates/plugin/src/plugin.ts

@@ -0,0 +1,48 @@
+import { definePlugin } from "@nextlyhq/plugin-sdk";
+
+import { Examples } from "./collections/example";
+import type { MyPluginOptions } from "./types";
+
+/**
+ * Your plugin factory. Call it in a host app's `defineConfig({ plugins: [...] })`.
+ *
+ * @example
+ * ```ts
+ * import { myPlugin } from "{{pluginName}}";
+ * export default defineConfig({ plugins: [myPlugin({ greeting: "Hi" })] });
+ * ```
+ */
+export const myPlugin = (opts: MyPluginOptions = {}) =>
+  definePlugin({
+    name: "{{pluginName}}",
+    version: "0.1.0",
+    nextly: "{{nextlyRange}}",
+    enabled: opts.enabled,
+    contributes: {
+      collections: [Examples],
+      permissions: [
+        { action: "manage", resource: "examples", label: "Manage Examples" },
+      ],
+      admin: {
+        menu: [
+          {
+            label: "Examples",
+            to: "/admin/collections/examples",
+            icon: "Sparkles",
+          },
+        ],
+        settings: { component: "{{pluginName}}/admin#SettingsPage" },
+      },
+    },
+    init(ctx) {
+      const greeting = opts.greeting ?? "Hello";
+      // Resolve your own slug via ctx.self so this keeps working if the host
+      // renames the collection (D54). React to the post-commit create event.
+      ctx.events.on(`collection.${ctx.self.collections.examples}.created`, () =>
+        ctx.logger.info(`${greeting} from {{pluginName}} — example created`)
+      );
+    },
+    destroy() {
+      // Clean up here (subscriptions are auto-dropped on registry reset).
+    },
+  });

package/templates/plugin/src/types.ts

@@ -0,0 +1,17 @@
+/**
+ * Options accepted by your plugin factory. These are JSDoc-documented so editors
+ * surface them at the call site (D44).
+ */
+export interface MyPluginOptions {
+  /**
+   * Greeting prefix used by the example collection's `afterCreate` hook.
+   * @default "Hello"
+   */
+  greeting?: string;
+
+  /**
+   * Disable the plugin's behavior (init/hooks/events/routes/admin) while still
+   * applying its schema contributions. Default `true`.
+   */
+  enabled?: boolean;
+}

package/templates/plugin/template.json

@@ -0,0 +1,14 @@
+{
+  "name": "plugin",
+  "label": "Plugin",
+  "description": "Build a reusable Nextly plugin (publishable npm package)",
+  "hint": "Plugin package + embedded /dev playground; no schema approach",
+  "approaches": [],
+  "defaultApproach": null,
+  "collections": [],
+  "singles": [],
+  "hasDemoData": false,
+  "hasFrontendPages": false,
+  "recommendedDatabase": "sqlite",
+  "release": "alpha"
+}

package/templates/plugin/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "dev"]
+}

package/templates/plugin/tsup.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from "tsup";
+
+// Builds the publishable plugin. `dev/` is NOT an entry — it never ships.
+// nextly / admin / react are peers, kept external.
+export default defineConfig({
+  entry: ["src/index.ts", "src/admin/index.ts"],
+  format: ["esm"],
+  dts: true,
+  clean: true,
+  sourcemap: true,
+  treeshake: true,
+  external: [
+    "nextly",
+    "@nextlyhq/admin",
+    "@nextlyhq/plugin-sdk",
+    "react",
+    "react-dom",
+  ],
+  outExtension() {
+    return { js: ".mjs" };
+  },
+});

package/templates/plugin/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    include: ["src/**/*.test.ts"],
+  },
+});