@tuyau/core 0.1.3 → 0.2.0

package/README.md

@@ -1,115 +1,2 @@
-# AdonisJS package starter kit
+# @tuyau/core
 
-> A boilerplate for creating AdonisJS packages
-
-This repo provides you with a starting point for creating AdonisJS packages. Of course, you can create a package from scratch with your folder structure and workflow. However, using this starter kit can speed up the process, as you have fewer decisions to make.
-
-## Setup
-
-- Clone the repo on your computer, or use `giget` to download this repo without the Git history.
-  ```sh
-  npx giget@latest gh:adonisjs/pkg-starter-kit
-  ```
-- Install dependencies.
-- Update the `package.json` file and define the `name`, `description`, `keywords`, and `author` properties.
-- The repo is configured with an MIT license. Feel free to change that if you are not publishing under the MIT license.
-
-## Folder structure
-
-The starter kit mimics the folder structure of the official packages. Feel free to rename files and folders as per your requirements.
-
-```
-├── providers
-├── src
-├── bin
-├── stubs
-├── configure.ts
-├── index.ts
-├── LICENSE.md
-├── package.json
-├── README.md
-├── tsconfig.json
-├── tsnode.esm.js
-```
-
-- The `configure.ts` file exports the `configure` hook to configure the package using the `node ace configure` command.
-- The `index.ts` file is the main entry point of the package.
-- The `tsnode.esm.js` file runs TypeScript code using TS-Node + SWC. Please read the code comment in this file to learn more.
-- The `bin` directory contains the entry point file to run Japa tests.
-- Learn more about [the `providers` directory](./providers/README.md).
-- Learn more about [the `src` directory](./src/README.md).
-- Learn more about [the `stubs` directory](./stubs/README.md).
-
-### File system naming convention
-
-We use `snake_case` naming conventions for the file system. The rule is enforced using ESLint. However, turn off the rule and use your preferred naming conventions.
-
-## Peer dependencies
-
-The starter kit has a peer dependency on `@adonisjs/core@6`. Since you are creating a package for AdonisJS, you must make it against a specific version of the framework core.
-
-If your package needs Lucid to be functional, you may install `@adonisjs/lucid` as a development dependency and add it to the list of `peerDependencies`.
-
-As a rule of thumb, packages installed in the user application should be part of the `peerDependencies` of your package and not the main dependency.
-
-For example, if you install `@adonisjs/core` as a main dependency, then essentially, you are importing a separate copy of `@adonisjs/core` and not sharing the one from the user application. Here is a great article explaining [peer dependencies](https://blog.bitsrc.io/understanding-peer-dependencies-in-javascript-dbdb4ab5a7be).
-
-## Published files
-
-Instead of publishing your repo's source code to npm, you must cherry-pick files and folders to publish only the required files.
-
-The cherry-picking uses the `files` property inside the `package.json` file. By default, we publish the following files and folders.
-
-```json
-{
-  "files": ["build/src", "build/providers", "build/stubs", "build/index.d.ts", "build/index.js"]
-}
-```
-
-If you create additional folders or files, mention them inside the `files` array.
-
-## Exports
-
-[Node.js Subpath exports](https://nodejs.org/api/packages.html#subpath-exports) allows you to define the exports of your package regardless of the folder structure. This starter kit defines the following exports.
-
-```json
-{
-  "exports": {
-    ".": "./build/index.js",
-    "./types": "./build/src/types.js"
-  }
-}
-```
-
-- The dot `.` export is the main export.
-- The `./types` exports all the types defined inside the `./build/src/types.js` file (the compiled output).
-
-Feel free to change the exports as per your requirements.
-
-## Testing
-
-We configure the [Japa test runner](https://japa.dev/) with this starter kit. Japa is used in AdonisJS applications as well. Just run one of the following commands to execute tests.
-
-- `npm run test`: This command will first lint the code using ESlint and then run tests and report the test coverage using [c8](https://github.com/bcoe/c8).
-- `npm run quick:test`: Runs only the tests without linting or coverage reporting.
-
-The starter kit also has a Github workflow file to run tests using Github Actions. The tests are executed against `Node.js 20.x` and `Node.js 21.x` versions on both Linux and Windows. Feel free to edit the workflow file in the `.github/workflows` directory.
-
-## TypeScript workflow
-
-- The starter kit uses [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) for compiling the TypeScript to JavaScript when publishing the package.
-- [TS-Node](https://typestrong.org/ts-node/) and [SWC](https://swc.rs/) are used to run tests without compiling the source code.
-- The `tsconfig.json` file is extended from [`@adonisjs/tsconfig`](https://github.com/adonisjs/tooling-config/tree/main/packages/typescript-config) and uses the `NodeNext` module system. Meaning the packages are written using ES modules.
-- You can perform type checking without compiling the source code using the `npm run type check` script.
-
-Feel free to explore the `tsconfig.json` file for all the configured options.
-
-## ESLint and Prettier setup
-
-The starter kit configures ESLint and Prettier. Both configurations are stored within the `package.json` file and use our [shared config](https://github.com/adonisjs/tooling-config/tree/main/packages). Feel free to change the configuration, use custom plugins, or remove both tools altogether.
-
-## Using Stale bot
-
-The [Stale bot](https://github.com/apps/stale) is a Github application that automatically marks issues and PRs as stale and closes after a specific duration of inactivity.
-
-Feel free to delete the `.github/stale.yml` and `.github/lock.yml` files if you decide not to use the Stale bot.

package/build/{chunk-3KNDPG6Y.js → chunk-ADS4GRIL.js}

@@ -5,8 +5,7 @@ var __decorateClass = (decorators, target, key, kind) => {
   for (var i = decorators.length - 1, decorator; i >= 0; i--)
     if (decorator = decorators[i])
       result = (kind ? decorator(target, key, result) : decorator(result)) || result;
-  if (kind && result)
-    __defProp(target, key, result);
+  if (kind && result) __defProp(target, key, result);
   return result;
 };
 

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"tuyau:generate","description":"Tuyau generator command","help":"","namespace":"tuyau","aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Verbose logs","default":false,"alias":"v"}],"args":[],"options":{"startApp":true},"filePath":"generate.js","absoluteFilePath":"/home/julien/code/adonis/tuyau/packages/core/build/commands/generate.js"}],"version":1}
+{"commands":[{"commandName":"tuyau:generate","description":"Tuyau generator command","help":"","namespace":"tuyau","aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Verbose logs","default":false,"alias":"v"}],"args":[],"options":{"startApp":true},"filePath":"generate.js"}],"version":1}

package/build/commands/generate.js

@@ -1,6 +1,6 @@
 import {
   __decorateClass
-} from "../chunk-3KNDPG6Y.js";
+} from "../chunk-ADS4GRIL.js";
 
 // commands/generate.ts
 import { fileURLToPath as fileURLToPath2 } from "node:url";
@@ -11,6 +11,7 @@ import { BaseCommand, flags } from "@adonisjs/core/ace";
 import { Node } from "ts-morph";
 import matchit from "@poppinss/matchit";
 import { fileURLToPath } from "node:url";
+import { readFile } from "node:fs/promises";
 import { dirname, relative } from "node:path";
 import { existsSync, mkdirSync } from "node:fs";
 import string from "@adonisjs/core/helpers/string";
@@ -22,6 +23,7 @@ var ApiTypesGenerator = class {
   #config;
   #routes;
   #destination;
+  #isTuyauInertiaInstalledCached;
   constructor(options) {
     this.#config = options.config;
     this.#routes = options.routes;
@@ -30,6 +32,24 @@ var ApiTypesGenerator = class {
     this.#appRoot = options.appRoot;
     this.#prepareDestination();
   }
+  /**
+   * Check if the @tuyau/inertia package is installed.
+   */
+  async #isTuyauInertiaInstalled() {
+    if (this.#isTuyauInertiaInstalledCached !== void 0)
+      return this.#isTuyauInertiaInstalledCached;
+    try {
+      const pkgJsonText = await readFile(
+        fileURLToPath(new URL("./package.json", this.#appRoot)),
+        "utf-8"
+      );
+      const pkgJson = JSON.parse(pkgJsonText);
+      this.#isTuyauInertiaInstalledCached = !!pkgJson.dependencies?.["@tuyau/inertia"];
+      return this.#isTuyauInertiaInstalledCached;
+    } catch (error) {
+      throw new Error("Unable to read the package.json file", { cause: error });
+    }
+  }
   #getDestinationDirectory() {
     return dirname(this.#destination);
   }
@@ -48,15 +68,34 @@ var ApiTypesGenerator = class {
    */
   #extractClassHandlerData(file, routeHandler) {
     const classDef = file.getClasses().find((c) => c.isDefaultExport());
-    if (!classDef)
-      return;
+    if (!classDef) return;
     const method = classDef.getMethod(routeHandler.method);
-    if (!method)
-      return;
+    if (!method) return;
     const body = method.getBody();
-    if (!body)
-      return;
-    return { method, body };
+    if (!body) return;
+    return { method, body, file };
+  }
+  /**
+   * Get the import type of an identifier
+   */
+  #getIdentifierImportType(identifier) {
+    const sourceFile = identifier.getSourceFile();
+    const namedImport = sourceFile.getImportDeclaration((importNode) => {
+      const namedImports = importNode.getNamedImports();
+      if (namedImports.find((namedImport2) => namedImport2.getName() === identifier.getText())) {
+        return true;
+      }
+      return false;
+    });
+    const defaultImport = sourceFile.getImportDeclaration((importNode) => {
+      if (importNode.getDefaultImport()?.getText() === identifier.getText()) return true;
+      return false;
+    });
+    const isValidFile = (namedImport || defaultImport)?.getModuleSpecifierSourceFile();
+    if (!isValidFile) return void 0;
+    if (namedImport) return "named";
+    if (defaultImport) return "default";
+    return void 0;
   }
   /**
    * We have multiple ways to get the request payload :
@@ -68,8 +107,7 @@ var ApiTypesGenerator = class {
    */
   #extractRequest(handlerData) {
     const validateUsingCallNode = handlerData.method.forEachDescendant((node) => {
-      if (!Node.isCallExpression(node))
-        return false;
+      if (!Node.isCallExpression(node)) return false;
       if (node.getExpression().getText().includes("validateUsing")) {
         return node;
       }
@@ -77,16 +115,18 @@ var ApiTypesGenerator = class {
     });
     if (validateUsingCallNode) {
       const schema = validateUsingCallNode.getArguments()[0];
-      if (!Node.isIdentifier(schema))
-        return;
-      const implementation = schema.getImplementations().at(0);
-      if (!implementation) {
+      if (!Node.isIdentifier(schema)) return;
+      const definition = schema.getDefinitions().at(0);
+      const importType = this.#getIdentifierImportType(schema);
+      const isReExportedFromThisFile = definition ? handlerData.file.getExportedDeclarations().has(definition.getNode().getText()) : false;
+      if (!importType && !isReExportedFromThisFile) {
         this.#logger.warning(`Unable to find the schema file for ${schema.getText()}`);
         return;
       }
-      const importPath = implementation.getSourceFile().getFilePath();
+      const importPath = definition.getSourceFile().getFilePath();
       const relativeImportPath = slash(relative(this.#getDestinationDirectory(), importPath));
-      return `InferInput<typeof import('${relativeImportPath}')['${schema.getText()}']>`;
+      const propName = importType === "default" ? "default" : schema.getText();
+      return `InferInput<typeof import('${relativeImportPath}')['${propName}']>`;
     }
     return void 0;
   }
@@ -114,28 +154,21 @@ var ApiTypesGenerator = class {
    */
   #filterRoutes(routes, mode) {
     const config = this.#config.codegen?.[mode];
-    if (!config || !config.only && !config.except)
-      return routes;
+    if (!config || !config.only && !config.except) return routes;
     return routes.filter((route) => {
-      if (typeof config.only === "function")
-        return config.only(route);
-      if (typeof config.except === "function")
-        return !config.except(route);
+      if (typeof config.only === "function") return config.only(route);
+      if (typeof config.except === "function") return !config.except(route);
       if (config.only) {
         for (const pattern of config.only) {
-          if (pattern instanceof RegExp && pattern.test(route.pattern))
-            return true;
-          if (route.pattern === pattern)
-            return true;
+          if (pattern instanceof RegExp && pattern.test(route.pattern)) return true;
+          if (route.pattern === pattern) return true;
         }
         return false;
       }
       if (config.except) {
         for (const pattern of config.except) {
-          if (pattern instanceof RegExp && pattern.test(route.pattern))
-            return false;
-          if (route.pattern === pattern)
-            return false;
+          if (pattern instanceof RegExp && pattern.test(route.pattern)) return false;
+          if (route.pattern === pattern) return false;
         }
         return true;
       }
@@ -156,15 +189,14 @@ var ApiTypesGenerator = class {
     return routes.map(({ name, pattern, methods }) => {
       const params = matchit.parse(pattern).filter((node) => node.type !== 0).map((node) => node.val);
       let typeName = this.#generateTypeName({ pattern, methods });
-      if (!typesByPattern[typeName])
-        typeName = "unknown";
+      if (!typesByPattern[typeName]) typeName = "unknown";
       return { params, name, path: pattern, method: methods, types: typeName };
     }).filter((route) => !!route.name);
   }
   async #writeApiFile(options) {
     const file = this.#project.createSourceFile(this.#destination, "", { overwrite: true });
-    if (!file)
-      throw new Error("Unable to create the api.ts file");
+    if (!file) throw new Error("Unable to create the api.ts file");
+    const isTuyauInertiaInstalled = await this.#isTuyauInertiaInstalled();
     file.removeText().insertText(0, (writer) => {
       writer.writeLine(`import type { MakeTuyauRequest, MakeTuyauResponse } from '@tuyau/utils/types'`).writeLine(`import type { InferInput } from '@vinejs/vine/types'`).newLine();
       Object.entries(options.typesByPattern).forEach(([key, value]) => {
@@ -186,10 +218,12 @@ var ApiTypesGenerator = class {
       }
       writer.writeLine(`] as const;`);
       writer.writeLine(`export const api = {`).writeLine(`  routes,`).writeLine(`  definition: {} as ApiDefinition`).writeLine(`}`);
-      writer.writeLine(`declare module '@tuyau/inertia/types' {`);
-      writer.writeLine(`  type ApiDefinition = typeof api`);
-      writer.writeLine(`  export interface Api extends ApiDefinition {}`);
-      writer.writeLine(`}`);
+      if (isTuyauInertiaInstalled) {
+        writer.writeLine(`declare module '@tuyau/inertia/types' {`);
+        writer.writeLine(`  type ApiDefinition = typeof api`);
+        writer.writeLine(`  export interface Api extends ApiDefinition {}`);
+        writer.writeLine(`}`);
+      }
     });
     await file.save();
   }
@@ -199,8 +233,7 @@ var ApiTypesGenerator = class {
     const sourcesFiles = this.#project.getSourceFiles();
     const routes = this.#filterRoutes(this.#routes, "definitions");
     for (const route of routes) {
-      if (typeof route.handler === "function")
-        continue;
+      if (typeof route.handler === "function") continue;
       const routeHandler = await parseBindingReference(route.handler.reference);
       const file = sourcesFiles.find(
         (sf) => sf.getFilePath().endsWith(`${routeHandler.moduleNameOrPath.replace("#", "")}.ts`)
@@ -221,19 +254,16 @@ var ApiTypesGenerator = class {
       let currentLevel = definition;
       const relativePath = slash(relative(this.#getDestinationDirectory(), file.getFilePath()));
       segments.forEach((segment, i) => {
-        if (!currentLevel[segment])
-          currentLevel[segment] = {};
+        if (!currentLevel[segment]) currentLevel[segment] = {};
         currentLevel = currentLevel[segment];
-        if (i !== segments.length - 1)
-          return;
+        if (i !== segments.length - 1) return;
         const typeName = this.#generateTypeName(route);
         typesByPattern[typeName] = {
           request: schemaImport ? `MakeTuyauRequest<${schemaImport}>` : "unknown",
           response: `MakeTuyauResponse<import('${relativePath}').default['${routeHandler.method}']>`
         };
         currentLevel.$url = {};
-        for (const method of methods)
-          currentLevel[method] = typeName;
+        for (const method of methods) currentLevel[method] = typeName;
       });
     }
     const routesNameArray = this.#generateRoutesNameArray(

package/build/index.js

@@ -1,4 +1,4 @@
-import "./chunk-3KNDPG6Y.js";
+import "./chunk-ADS4GRIL.js";
 
 // stubs/main.ts
 import { getDirname } from "@adonisjs/core/helpers";

package/build/providers/tuyau_provider.js

@@ -1,4 +1,4 @@
-import "../chunk-3KNDPG6Y.js";
+import "../chunk-ADS4GRIL.js";
 
 // providers/tuyau_provider.ts
 var TuyauProvider = class {

package/build/src/hooks/build_hook.d.ts

@@ -0,0 +1,5 @@
+import { AssemblerHookHandler } from '@adonisjs/core/types/app';
+
+declare function tuyauBuildHook({ logger }: Parameters<AssemblerHookHandler>[0]): Promise<void>;
+
+export { tuyauBuildHook as default };

package/build/src/hooks/build_hook.js

@@ -0,0 +1,14 @@
+import "../../chunk-ADS4GRIL.js";
+
+// src/hooks/build_hook.ts
+import util from "node:util";
+import { exec as cpExec } from "node:child_process";
+var exec = util.promisify(cpExec);
+async function tuyauBuildHook({ logger }) {
+  logger.info("generating tuyau codegen file", { suffix: "tuyau" });
+  const { stderr } = await exec("node ace tuyau:generate");
+  if (stderr) throw new Error(stderr);
+}
+export {
+  tuyauBuildHook as default
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tuyau/core",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "",
   "author": "",
   "license": "MIT",
@@ -10,7 +10,8 @@
     ".": "./build/index.js",
     "./types": "./build/src/types.js",
     "./commands": "./build/commands/main.js",
-    "./tuyau_provider": "./build/providers/tuyau_provider.js"
+    "./tuyau_provider": "./build/providers/tuyau_provider.js",
+    "./build_hook": "./build/src/hooks/build_hook.js"
   },
   "files": [
     "build"
@@ -22,16 +23,16 @@
     "@adonisjs/core": "^6.2.0"
   },
   "dependencies": {
-    "ts-morph": "^22.0.0"
+    "ts-morph": "^23.0.0"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.5.1",
-    "@adonisjs/core": "^6.8.0",
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.14.0",
     "@julr/tooling-configs": "^2.2.0",
     "@poppinss/cliui": "^6.4.1",
     "@poppinss/matchit": "^3.1.2",
-    "@types/node": "^20.12.7",
-    "@tuyau/client": "0.1.1",
+    "@types/node": "^20.16.5",
+    "@tuyau/client": "0.1.2",
     "@tuyau/utils": "0.0.4"
   },
   "publishConfig": {
@@ -51,6 +52,7 @@
     "entry": [
       "./index.ts",
       "./src/types.ts",
+      "./src/hooks/build_hook.ts",
       "./commands/generate.ts",
       "./providers/tuyau_provider.ts"
     ],