@tuyau/core 0.1.2 → 0.1.4

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/commands/generate.js

@@ -14,7 +14,7 @@ import { fileURLToPath } from "node:url";
 import { dirname, relative } from "node:path";
 import { existsSync, mkdirSync } from "node:fs";
 import string from "@adonisjs/core/helpers/string";
-import { parseBindingReference } from "@adonisjs/core/helpers";
+import { parseBindingReference, slash } from "@adonisjs/core/helpers";
 var ApiTypesGenerator = class {
   #appRoot;
   #logger;
@@ -56,7 +56,33 @@ var ApiTypesGenerator = class {
     const body = method.getBody();
     if (!body)
       return;
-    return { method, body };
+    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 :
@@ -79,14 +105,16 @@ var ApiTypesGenerator = class {
       const schema = validateUsingCallNode.getArguments()[0];
       if (!Node.isIdentifier(schema))
         return;
-      const implementation = schema.getImplementations().at(0);
-      if (!implementation) {
+      const definition = schema.getDefinitions().at(0);
+      const importType = this.#getIdentifierImportType(schema);
+      if (!definition || !importType) {
         this.#logger.warning(`Unable to find the schema file for ${schema.getText()}`);
         return;
       }
-      const importPath = implementation.getSourceFile().getFilePath();
-      const relativeImportPath = relative(this.#getDestinationDirectory(), importPath);
-      return `InferInput<typeof import('${relativeImportPath}')['${schema.getText()}']>`;
+      const importPath = definition.getSourceFile().getFilePath();
+      const relativeImportPath = slash(relative(this.#getDestinationDirectory(), importPath));
+      const propName = importType === "default" ? "default" : schema.getText();
+      return `InferInput<typeof import('${relativeImportPath}')['${propName}']>`;
     }
     return void 0;
   }
@@ -219,7 +247,7 @@ var ApiTypesGenerator = class {
       const methods = route.methods.map((method) => "$" + method.toLowerCase()).filter((method) => method !== "head");
       const segments = route.pattern.split("/").filter(Boolean);
       let currentLevel = definition;
-      const relativePath = relative(this.#getDestinationDirectory(), file.getFilePath());
+      const relativePath = slash(relative(this.#getDestinationDirectory(), file.getFilePath()));
       segments.forEach((segment, i) => {
         if (!currentLevel[segment])
           currentLevel[segment] = {};

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,15 @@
+import "../../chunk-3KNDPG6Y.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.2",
+  "version": "0.1.4",
   "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"
@@ -31,7 +32,7 @@
     "@poppinss/cliui": "^6.4.1",
     "@poppinss/matchit": "^3.1.2",
     "@types/node": "^20.12.7",
-    "@tuyau/client": "0.1.1",
+    "@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"
     ],