@lukoweb/create-apitogo 0.1.24 → 0.1.37

package/dist/templates/default/ts/tsconfig.json

@@ -1,16 +1,16 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "lib": ["ESNext", "DOM", "DOM.Iterable", "WebWorker"],
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "useDefineForClassFields": true,
-    "skipLibCheck": true,
-    "skipDefaultLibCheck": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "useUnknownInCatchVariables": false,
-    "jsx": "react-jsx"
-  },
-  "include": ["src", "apitogo.config.tsx"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ESNext", "DOM", "DOM.Iterable", "WebWorker"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "useDefineForClassFields": true,
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "useUnknownInCatchVariables": false,
+    "jsx": "react-jsx"
+  },
+  "include": ["src", "apitogo.config.tsx"]
+}

package/dist/templates/index.ts

@@ -25,6 +25,62 @@ const formatAppTitle = (appName: string) =>
     .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
     .join(" ");
 
+const resolveCoreApitogoPackageName = async (): Promise<string> => {
+  const createPackageJson = JSON.parse(
+    await fs.readFile(path.join(PACKAGE_ROOT, "package.json"), "utf8"),
+  ) as { name: string };
+  return createPackageJson.name.replace("/create-apitogo", "/apitogo");
+};
+
+/** Primary npm scope; split so secondary publish does not rewrite this guard. */
+const PRIMARY_APITOGO_SCOPE = "@lukow" + "eb";
+
+const normalizeDependencyVersion = (version: string): string =>
+  version.replace(/^[\^~>=<]+/, "");
+
+const LUCIDE_REACT_VERSION = "0.577.0";
+
+const ensureRequiredApitogoModules = (
+  dependencies: Record<string, string>,
+  corePackageName: string,
+  version: string,
+) => {
+  const scope = corePackageName.slice(0, corePackageName.indexOf("/"));
+  const landing = `${scope}/apitogo-module-landing`;
+  const userPanel = `${scope}/apitogo-module-user-panel`;
+  const billing = `${scope}/apitogo-plugin-dev-portal-billing`;
+  const moduleVersion = `^${normalizeDependencyVersion(version)}`;
+
+  dependencies[landing] ??= moduleVersion;
+  dependencies[userPanel] ??= moduleVersion;
+  dependencies[billing] ??= moduleVersion;
+  dependencies["lucide-react"] ??= LUCIDE_REACT_VERSION;
+};
+
+const ensureSecondaryApitogoAliases = (
+  dependencies: Record<string, string>,
+  corePackageName: string,
+  version: string,
+) => {
+  if (corePackageName.startsWith(`${PRIMARY_APITOGO_SCOPE}/`)) {
+    return;
+  }
+
+  const alias = (target: string) =>
+    `npm:${target}@${normalizeDependencyVersion(version)}`;
+  const scope = corePackageName.slice(0, corePackageName.indexOf("/"));
+
+  dependencies[`${PRIMARY_APITOGO_SCOPE}/apitogo`] = alias(corePackageName);
+  dependencies[`${PRIMARY_APITOGO_SCOPE}/apitogo-module-landing`] = alias(
+    `${scope}/apitogo-module-landing`,
+  );
+  dependencies[`${PRIMARY_APITOGO_SCOPE}/apitogo-module-user-panel`] = alias(
+    `${scope}/apitogo-module-user-panel`,
+  );
+  dependencies[`${PRIMARY_APITOGO_SCOPE}/apitogo-plugin-dev-portal-billing`] =
+    alias(`${scope}/apitogo-plugin-dev-portal-billing`);
+};
+
 const parseWorkspaceCatalog = async (workspaceFile: string) => {
   const content = await fs.readFile(workspaceFile, "utf8");
   const catalog: Record<string, string> = {};
@@ -187,15 +243,26 @@ export const installTemplate = async ({
   });
 
   const appTitle = formatAppTitle(appName);
+  const substituteAppTitle = (contents: string) =>
+    contents.split("__APP_TITLE__").join(appTitle);
+
   const configFilename =
     mode === "ts" ? "apitogo.config.tsx" : "apitogo.config.jsx";
   const configPath = path.join(root, configFilename);
   const configContents = await fs.readFile(configPath, "utf8");
-  await fs.writeFile(
-    configPath,
-    configContents.split("__APP_TITLE__").join(appTitle),
-    "utf8",
-  );
+  await fs.writeFile(configPath, substituteAppTitle(configContents), "utf8");
+
+  const manifestPath = path.join(root, "apitogo.local.json");
+  try {
+    const manifestContents = await fs.readFile(manifestPath, "utf8");
+    await fs.writeFile(
+      manifestPath,
+      substituteAppTitle(manifestContents),
+      "utf8",
+    );
+  } catch {
+    // Optional in customized templates.
+  }
 
   // update import alias in any files if not using the default
 
@@ -253,6 +320,8 @@ export const installTemplate = async ({
     })
     .catch(() => version);
 
+  const coreApitogoPackageName = await resolveCoreApitogoPackageName();
+
   /** Create a package.json for the new project and write it to disk. */
   // biome-ignore lint/suspicious/noExplicitAny: Allow any type
   const packageJson: any = {
@@ -273,11 +342,24 @@ export const installTemplate = async ({
     dependencies: {
       react: ">=19.0.0",
       "react-dom": ">=19.0.0",
-      "@lukoweb/apitogo": resolvedZudokuDependency,
+      [coreApitogoPackageName]: resolvedZudokuDependency,
     },
     devDependencies: {},
   };
 
+  if (!resolvedZudokuDependency.startsWith("file:")) {
+    ensureRequiredApitogoModules(
+      packageJson.dependencies,
+      coreApitogoPackageName,
+      resolvedZudokuDependency,
+    );
+    ensureSecondaryApitogoAliases(
+      packageJson.dependencies,
+      coreApitogoPackageName,
+      resolvedZudokuDependency,
+    );
+  }
+
   /**
    * TypeScript projects will have type definitions and other devDependencies.
    */

package/dist/templates/types.ts

@@ -1,22 +1,22 @@
-import type { PackageManager } from "../helpers/get-pkg-manager";
-
-export type TemplateType = "default" | "zuplo";
-export type TemplateMode = "js" | "ts";
-
-export interface GetTemplateFileArgs {
-  template: TemplateType;
-  mode: TemplateMode;
-  file: string;
-}
-
-export interface InstallTemplateArgs {
-  appName: string;
-  root: string;
-  packageManager: PackageManager;
-  isOnline: boolean;
-  template: TemplateType;
-  mode: TemplateMode;
-  eslint: boolean;
-  skipInstall: boolean;
-  zudokuVersion: string;
-}
+import type { PackageManager } from "../helpers/get-pkg-manager";
+
+export type TemplateType = "default" | "zuplo";
+export type TemplateMode = "js" | "ts";
+
+export interface GetTemplateFileArgs {
+  template: TemplateType;
+  mode: TemplateMode;
+  file: string;
+}
+
+export interface InstallTemplateArgs {
+  appName: string;
+  root: string;
+  packageManager: PackageManager;
+  isOnline: boolean;
+  template: TemplateType;
+  mode: TemplateMode;
+  eslint: boolean;
+  skipInstall: boolean;
+  zudokuVersion: string;
+}

package/dist/templates/zuplo/README-template.md

@@ -1,40 +1,40 @@
-# Developer Portal
-
-This is your [Zuplo Developer Portal](https://zuplo.com/docs/dev-portal/introduction). This
-developer portal allows you to ship a beautiful API documentation for your users. You can customize
-this portal to match your brand and style.
-
-This developer portal is configured to work with your Zuplo API. When you publish your API, your
-developer portal will be automatically published with the latest API documentation.
-
-For more information, visit the [Documentation](https://zuplo.com/docs/dev-portal/introduction).
-
-The Zuplo Developer Portal is built on top of the open source [Zudoku](https://zudoku.dev) project,
-a powerful tool for creating and managing API documentation. If you would like to learn more about
-the project, open a feature request, or contribute to the codebase, visit the
-[Zudoku GitHub repository](https://github.com/zuplo/zudoku).
-
-## Local Development
-
-After you have connected your Zuplo project to
-[source control](https://zuplo.com/docs/articles/source-control) you can clone your project locally.
-Running the Developer Portal locally allows you to see changes in real-time with live-reload.
-
-1. Clone the repository
-
-   ```bash
-   git clone https://github.com/my-org/my-repo
-   cd my-repo
-   ```
-
-2. Install dependencies
-
-   ```bash
-   npm install
-   ```
-
-3. Start the development server
-
-   ```bash
-   npm run docs
-   ```
+# Developer Portal
+
+This is your [Zuplo Developer Portal](https://zuplo.com/docs/dev-portal/introduction). This
+developer portal allows you to ship a beautiful API documentation for your users. You can customize
+this portal to match your brand and style.
+
+This developer portal is configured to work with your Zuplo API. When you publish your API, your
+developer portal will be automatically published with the latest API documentation.
+
+For more information, visit the [Documentation](https://zuplo.com/docs/dev-portal/introduction).
+
+The Zuplo Developer Portal is built on top of the open source [Zudoku](https://zudoku.dev) project,
+a powerful tool for creating and managing API documentation. If you would like to learn more about
+the project, open a feature request, or contribute to the codebase, visit the
+[Zudoku GitHub repository](https://github.com/zuplo/zudoku).
+
+## Local Development
+
+After you have connected your Zuplo project to
+[source control](https://zuplo.com/docs/articles/source-control) you can clone your project locally.
+Running the Developer Portal locally allows you to see changes in real-time with live-reload.
+
+1. Clone the repository
+
+   ```bash
+   git clone https://github.com/my-org/my-repo
+   cd my-repo
+   ```
+
+2. Install dependencies
+
+   ```bash
+   npm install
+   ```
+
+3. Start the development server
+
+   ```bash
+   npm run docs
+   ```

package/dist/templates/zuplo/gitignore

@@ -1,32 +1,32 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/versions
-
-# testing
-/coverage
-
-# zudoku
-/dist/
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# env files (can opt-in for commiting if needed)
-.env*
-
-# typescript
-*.tsbuildinfo
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# zudoku
+/dist/
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# env files (can opt-in for commiting if needed)
+.env*
+
+# typescript
+*.tsbuildinfo

package/dist/templates/zuplo/pages/introduction.mdx

@@ -1,153 +1,153 @@
----
-description: Welcome to your new Zudoku documentation site.
-sidebar_label: My Developer Portal
-sidebar_icon: panel-top
-category: ""
----
-
-<div>
-  <img src="/banner.svg" className="dark:hidden" />
-  <img src="/banner-dark.svg" className="hidden dark:block" />
-</div>
-
-# Welcome to Better API Documentation
-
-Welcome to your new developer portal that makes sense. 🎉
-
-This is your new developer portal, built with ["Zudoku by Zuplo"](https://github.com/zuplo/zudoku)
-and designed to elevate your API documentation experience. We've streamlined the setup process so
-you can focus on what matters most: creating exceptional developer experiences.
-
-Think of this as your API's professional showcase—presenting your endpoints and documentation in the
-best possible light. Whether you're launching innovative new features or improving existing
-services, this portal provides the foundation for clear, accessible, and engaging developer
-documentation.
-
-Let's explore what we've configured for you and how you can customize it to perfectly match your
-needs.
-
-## Let's Review Your Configuration
-
-The developer portal is configured in the `apitogo.config.tsx` file. We've created a starter
-configuration to get you up and running quickly. Let's walk you through everything we've set up so
-you know how to customize it:
-
-<Stepper>
-
-1. **Change the Basics**
-
-   First, you may want to change the title and banner we've put in place. These are part of the
-   `page` section in your configuration.
-
-   :::tip
-
-   **Have a company logo?** Learn how you can
-   [add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/site#logo) in our
-   documentation.
-
-   :::
-
-   ```jsx
-   {
-    // ...
-    "page": {
-      "title": "My Developer Portal",
-      "banner": {
-        "message": (
-          <div className="w-full text-center">
-            <strong>Congrats!</strong> 🙌 You just created your first developer
-            portal.
-          </div>
-        ),
-        "color": "info",
-        "dismissible": true,
-      }
-   }
-   ```
-
-1. **API Reference**
-
-   Your [API Reference](/api) is generated from your Zuplo OpenAPI file in `../routes.oas.json`—you
-   can add other APIs whenever you need them. Improve your documentation by adding more details to
-   the OpenAPI file.
-
-   ```json
-   {
-     // ...
-     "apis": {
-       "type": "file",
-       "input": "../config/routes.oas.json",
-       "navigationId": "api"
-     }
-   }
-   ```
-
-1. **Authentication & Login**
-
-   We've configured your project to use [Auth0](https://auth0.com) as an authentication provider
-   with our demo account. We support many authentication providers—check the
-   [documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers)
-   each one.
-
-   :::caution
-
-   You must change the authentication provider before taking this to **production**. Using our demo
-   provider is not secure for production use.
-
-   :::
-
-   ```json
-   {
-     // ...
-     "authentication": {
-       "type": "auth0",
-       "domain": "auth.zuplo.io",
-       "clientId": "kWQs12Q9Og4w6zzI82qJSa3klN1sMtvz",
-       "audience": "https://api.example.com/"
-     }
-   }
-   ```
-
-1. **API Keys**
-
-   We've enabled API Keys on your developer portal. This connects to the API Key Service in Zuplo.
-   To add API Keys for your users, create a consumer with the matching email address in **Services
-   => API Key Service** in Zuplo, or
-   [create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
-
-   ```json
-   {
-     // ...
-     "apiKeys": {
-       "enabled": true
-     }
-   }
-   ```
-
-</Stepper>
-
-## Make It Yours
-
-You can customize the look and feel of your documentation site by modifying the `theme` section in
-`apitogo.config.tsx`. Why not try changing the primary color of your site?
-
-```json
-{
-  // ...
-  "theme": {
-    "light": {
-      "primary": "316 100% 50%",
-      "primaryForeground": "360 100% 100%"
-    },
-    "dark": {
-      "primary": "316 100% 50%",
-      "primaryForeground": "360 100% 100%"
-    }
-  }
-  // ...
-}
-```
-
-We have extensive customization options available. From colors to fonts and borders, find the
-[full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme) in our
-documentation.
+---
+description: Welcome to your new Zudoku documentation site.
+sidebar_label: My Developer Portal
+sidebar_icon: panel-top
+category: ""
+---
+
+<div>
+  <img src="/banner.svg" className="dark:hidden" />
+  <img src="/banner-dark.svg" className="hidden dark:block" />
+</div>
+
+# Welcome to Better API Documentation
+
+Welcome to your new developer portal that makes sense. 🎉
+
+This is your new developer portal, built with ["Zudoku by Zuplo"](https://github.com/zuplo/zudoku)
+and designed to elevate your API documentation experience. We've streamlined the setup process so
+you can focus on what matters most: creating exceptional developer experiences.
+
+Think of this as your API's professional showcase—presenting your endpoints and documentation in the
+best possible light. Whether you're launching innovative new features or improving existing
+services, this portal provides the foundation for clear, accessible, and engaging developer
+documentation.
+
+Let's explore what we've configured for you and how you can customize it to perfectly match your
+needs.
+
+## Let's Review Your Configuration
+
+The developer portal is configured in the `apitogo.config.tsx` file. We've created a starter
+configuration to get you up and running quickly. Let's walk you through everything we've set up so
+you know how to customize it:
+
+<Stepper>
+
+1. **Change the Basics**
+
+   First, you may want to change the title and banner we've put in place. These are part of the
+   `page` section in your configuration.
+
+   :::tip
+
+   **Have a company logo?** Learn how you can
+   [add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/site#logo) in our
+   documentation.
+
+   :::
+
+   ```jsx
+   {
+    // ...
+    "page": {
+      "title": "My Developer Portal",
+      "banner": {
+        "message": (
+          <div className="w-full text-center">
+            <strong>Congrats!</strong> 🙌 You just created your first developer
+            portal.
+          </div>
+        ),
+        "color": "info",
+        "dismissible": true,
+      }
+   }
+   ```
+
+1. **API Reference**
+
+   Your [API Reference](/api) is generated from your Zuplo OpenAPI file in `../routes.oas.json`—you
+   can add other APIs whenever you need them. Improve your documentation by adding more details to
+   the OpenAPI file.
+
+   ```json
+   {
+     // ...
+     "apis": {
+       "type": "file",
+       "input": "../config/routes.oas.json",
+       "navigationId": "api"
+     }
+   }
+   ```
+
+1. **Authentication & Login**
+
+   We've configured your project to use [Auth0](https://auth0.com) as an authentication provider
+   with our demo account. We support many authentication providers—check the
+   [documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers)
+   each one.
+
+   :::caution
+
+   You must change the authentication provider before taking this to **production**. Using our demo
+   provider is not secure for production use.
+
+   :::
+
+   ```json
+   {
+     // ...
+     "authentication": {
+       "type": "auth0",
+       "domain": "auth.zuplo.io",
+       "clientId": "kWQs12Q9Og4w6zzI82qJSa3klN1sMtvz",
+       "audience": "https://api.example.com/"
+     }
+   }
+   ```
+
+1. **API Keys**
+
+   We've enabled API Keys on your developer portal. This connects to the API Key Service in Zuplo.
+   To add API Keys for your users, create a consumer with the matching email address in **Services
+   => API Key Service** in Zuplo, or
+   [create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
+
+   ```json
+   {
+     // ...
+     "apiKeys": {
+       "enabled": true
+     }
+   }
+   ```
+
+</Stepper>
+
+## Make It Yours
+
+You can customize the look and feel of your documentation site by modifying the `theme` section in
+`apitogo.config.tsx`. Why not try changing the primary color of your site?
+
+```json
+{
+  // ...
+  "theme": {
+    "light": {
+      "primary": "316 100% 50%",
+      "primaryForeground": "360 100% 100%"
+    },
+    "dark": {
+      "primary": "316 100% 50%",
+      "primaryForeground": "360 100% 100%"
+    }
+  }
+  // ...
+}
+```
+
+We have extensive customization options available. From colors to fonts and borders, find the
+[full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme) in our
+documentation.