@baeta/generator-sdk 2.0.0-next.2 → 2.0.0-next.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @baeta/generator-sdk
 
+## 2.0.0-next.4
+
+### Patch Changes
+
+- [`831cfa2`](https://github.com/andreisergiu98/baeta/commit/831cfa2a11445aaf7f2d1a1d7ddf073db9bb8008) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Fix generator overwriting types.ts file
+
+- Updated dependencies [[`831cfa2`](https://github.com/andreisergiu98/baeta/commit/831cfa2a11445aaf7f2d1a1d7ddf073db9bb8008), [`831cfa2`](https://github.com/andreisergiu98/baeta/commit/831cfa2a11445aaf7f2d1a1d7ddf073db9bb8008)]:
+  - @baeta/plugin@2.0.0-next.3
+  - @baeta/util-path@2.0.0-next.3
+
+## 2.0.0-next.3
+
+### Patch Changes
+
+- [#214](https://github.com/andreisergiu98/baeta/pull/214) [`6de5d15`](https://github.com/andreisergiu98/baeta/commit/6de5d15484d341a1717a1b2f3f45272912e6a886) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Fix generated import paths with custom config
+
 ## 2.0.0-next.2
 
 ### Patch Changes

package/README.md

@@ -5,7 +5,7 @@
 <div align="center">
   <h1>Baeta</h1>
   <a href="https://www.npmjs.com/package/@baeta/cli"><img src="https://img.shields.io/npm/v/@baeta/cli.svg?style=flat" /></a>
-   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/testing.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/testing.yml" /></a>
+   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/checks.yml" /></a>
   <a href="https://github.com/andreisergiu98/baeta/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
   <a href="https://github.com/andreisergiu98/baeta/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" /></a>
   <br />
@@ -77,43 +77,68 @@ type Query {
 #### 2. Implement your resolvers
 
 ```typescript
-import { getUserModule } from "./typedef";
+import { UserModule } from "./typedef.ts";
 
-const { Query } = getUserModule();
+const { Query } = UserModule;
 
-Query.user(({ args }) => {
+const userQuery = Query.user.resolve(({ args }) => {
   return dataSource.user.find(args.where);
 });
 
-Query.users(() => {
+const usersQuery = Query.users.resolve(() => {
   return dataSource.user.findMany();
 });
+
+Query.$fields({
+  user: userQuery,
+  users: usersQuery,
+});
 ```
 
 #### 3. Add authorization
 
 ```typescript
-const { Query, Mutation } = getUserModule();
-
-Query.users.$auth({
-  $or: {
-    isPublic: true,
-    isLoggedIn: true,
-  },
-});
+import { UserModule } from "./typedef.ts";
+
+const { Query } = UserModule;
+
+const userQuery = Query.user
+  .$auth({
+    $or: {
+      isPublic: true,
+      isLoggedIn: true,
+    },
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
 ```
 
 #### 4. Add caching
 
 ```typescript
-import { getUserModule } from "./typedef";
-
-const { User, Query } = getUserModule();
+const { Query, Mutation, User } = UserModule;
 
 export const userCache = User.$createCache();
 
-Query.user.$useCache(userCache);
-Query.users.$useCache(userCache);
+const userQuery = Query.user
+  .$auth({
+    // ...
+  })
+  .$useCache(userCache)
+  .resolve(async ({ args }) => {
+    // ...
+  });
+
+const updateUserMutation = Mutation.updateUser
+  .$use(async (next) => {
+    const user = await next();
+    await userCache.save(user);
+    return user;
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
 ```
 
 ## Compatibility

package/dist/index.d.ts

@@ -1,244 +1,257 @@
-import { EventType, Options, Event } from '@parcel/watcher';
-import micromatch from 'micromatch';
-export { default as micromatch } from 'micromatch';
-import * as fs_promises from 'fs/promises';
-import { PluginType } from '@baeta/plugin';
+import { PluginType } from "@baeta/plugin";
+import { Event, EventType, Options } from "@parcel/watcher";
+import micromatch from "micromatch";
+import * as fs_promises0 from "fs/promises";
 
+//#region lib/file.d.ts
 /**
  * Options for generated files.
  */
 interface FileOptions {
-    /**
-     * Disable generation notice at the beginning of the file.
-     * @defaultValue false
-     */
-    disableGenerationNoticeHeader?: boolean;
-    /**
-     * Disable eslint-disable comment at the beginning of the file.
-     * @defaultValue false
-     */
-    disableEslintHeader?: boolean;
-    /**
-     * Disable biome comment at the beginning of the file.
-     * @defaultValue false
-     */
-    disableBiomeHeader?: boolean;
-    /**
-     * Allow overwriting the file.
-     * @defaultValue true
-     */
-    allowOverwrite?: boolean;
-    /**
-     * Add custom header at the beginning of the file.
-     */
-    addHeader?: (name: string, content: string, tag: string) => string;
-    /**
-     * Edit the content of the file before writing it.
-     */
-    transformContent?: (name: string, content: string, tag: string) => string | Promise<string>;
+  /**
+   * Disable generation notice at the beginning of the file.
+   * @defaultValue false
+   */
+  disableGenerationNoticeHeader?: boolean;
+  /**
+   * Disable eslint-disable comment at the beginning of the file.
+   * @defaultValue false
+   */
+  disableEslintHeader?: boolean;
+  /**
+   * Disable biome v1 comment at the beginning of the file.
+   * @defaultValue false
+   */
+  disableBiomeV1Header?: boolean;
+  /**
+   * Disable biome v2 comment at the beginning of the file.
+   * @defaultValue false
+   */
+  disableBiomeV2Header?: boolean;
+  /**
+   * Dissallow overwriting the file.
+   * @defaultValue false
+   */
+  disableOverwrite?: boolean;
+  /**
+   * Add custom header at the beginning of the file.
+   */
+  addHeader?: (name: string, content: string, tag: string) => string;
+  /**
+   * Edit the content of the file before writing it.
+   */
+  transformContent?: (name: string, content: string, tag: string) => string | Promise<string>;
 }
 declare class File {
-    persisted: boolean;
-    filename: string;
-    content: string;
-    tag: string;
-    private options?;
-    constructor(filename: string, content: string, tag: string, options?: FileOptions);
-    write: () => Promise<void>;
-    unlink: () => Promise<void>;
-    protected buildContent(): Promise<string>;
-    protected buildHeader(): string;
-    protected createComment(comment: string): string;
+  persisted: boolean;
+  readonly filename: string;
+  readonly content: string;
+  readonly tag: string;
+  readonly options?: FileOptions;
+  constructor(filename: string, content: string, tag: string, options?: FileOptions);
+  write: () => Promise<void>;
+  unlink: () => Promise<void>;
+  protected buildContent(): Promise<string>;
+  protected buildHeader(): string;
+  protected createComment(comment: string): string;
 }
-
+//#endregion
+//#region lib/config.d.ts
 /**
  * Interface for custom schema loaders.
  */
-type GraphQlLoaderAny = any;
-interface Loader<TOptions = GraphQlLoaderAny> {
-    load(pointer: string, options?: TOptions): Promise<GraphQlLoaderAny[] | null | never>;
-    loadSync?(pointer: string, options?: TOptions): GraphQlLoaderAny[] | null | never;
+interface Loader<TOptions = any> {
+  load(pointer: string, options?: TOptions): Promise<any[] | null>;
+  loadSync?(pointer: string, options?: TOptions): any[] | null;
 }
 /**
  * Options for the Baeta Generator.
  */
 interface GeneratorOptions {
-    /**
-     * Current working directory for resolving relative paths.
-     * @defaultValue process.cwd()
-     */
-    cwd?: string;
-    /**
-     * Glob pattern(s) to locate GraphQL schema files.
-     * @defaultValue ```ts
-     * ['src/∗∗/∗.gql', 'src/∗∗/∗.graphql']
-     * ```
-     */
-    schemas: string[];
-    /**
-     * Root directory where GraphQL modules are defined.
-     * @defaultValue 'src/modules'
-     */
-    modulesDir?: string;
-    /**
-     * Filename for the generated module definition file.
-     * Contains type definitions and the GraphQL AST.
-     * @defaultValue 'typedef.ts'
-     */
-    moduleDefinitionName?: string;
-    /**
-     * Output path for the generated type files.
-     * @defaultValue ```ts
-     * `${modulesDir}/../__generated__/types.ts`
-     * ```
-     */
-    typesDir?: string;
-    /**
-     * Configuration options for generated files.
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Custom schema loaders for processing schema files.
-     */
-    loaders?: Loader[];
-    /**
-     * File extension to use in generated import statements.
-     * Set to false to omit extensions.
-     * @defaultValue '.ts'
-     */
-    importExtension?: '.js' | '.ts' | false;
+  /**
+   * Current working directory for resolving relative paths.
+   * @defaultValue process.cwd()
+   */
+  cwd?: string;
+  /**
+   * Glob pattern(s) to locate GraphQL schema files.
+   * @defaultValue ```ts
+   * ['src/∗∗/∗.gql', 'src/∗∗/∗.graphql']
+   * ```
+   */
+  schemas: string[];
+  /**
+   * Root directory where GraphQL modules are defined.
+   * @defaultValue 'src/modules'
+   */
+  modulesDir?: string;
+  /**
+   * Filename for the generated module definition file.
+   * Contains type definitions and the GraphQL AST.
+   * @defaultValue 'typedef.ts'
+   */
+  moduleDefinitionName?: string;
+  /**
+   * Output path for the generated type files.
+   * @defaultValue ```ts
+   * `${modulesDir}/../__generated__/types.ts`
+   * ```
+   */
+  typesDir?: string;
+  /**
+   * Configuration options for generated files.
+   */
+  fileOptions?: FileOptions;
+  /**
+   * Custom schema loaders for processing schema files.
+   */
+  loaders?: Loader[];
+  /**
+   * File extension to use in generated import statements.
+   * Set to false to omit extensions.
+   * @defaultValue '.ts'
+   */
+  importExtension?: '.js' | '.ts' | false;
 }
 interface NormalizedGeneratorOptions {
-    cwd: string;
-    schemas: string[];
-    modulesDir: string;
-    moduleDefinitionName: string;
-    typesDir: string;
-    fileOptions?: FileOptions;
-    loaders?: Loader[];
-    importExtension: '.js' | '.ts' | '';
+  cwd: string;
+  schemas: string[];
+  modulesDir: string;
+  moduleDefinitionName: string;
+  typesDir: string;
+  fileOptions?: FileOptions;
+  loaders?: Loader[];
+  importExtension: '.js' | '.ts' | '';
 }
 declare function loadOptions(options: GeneratorOptions): NormalizedGeneratorOptions;
-
+//#endregion
+//#region lib/file-manager.d.ts
 declare class FileManager {
-    files: File[];
-    fileOptions?: FileOptions;
-    constructor(fileOptions?: FileOptions);
-    createAndAdd(filename: string, content: string, tag: string, options?: FileOptions): File;
-    add(...file: File[]): void;
-    get(filename: string): File | undefined;
-    getAll(): File[];
-    getByTag(tag: string): File[];
-    remove(filename: string): void;
-    removeAll(): void;
-    removeByTag(tag: string): void;
-    writeAll(): Promise<void[]>;
-    writeByTag(tag: string): Promise<void[]>;
-    unlinkAll(): Promise<void>;
-    getPersistedFiles(): File[];
+  files: File[];
+  fileOptions?: FileOptions;
+  constructor(fileOptions?: FileOptions);
+  createAndAdd(filename: string, content: string, tag: string, options?: FileOptions): File;
+  add(...file: File[]): void;
+  get(filename: string): File | undefined;
+  getAll(): File[];
+  getByTag(tag: string): File[];
+  remove(filename: string): void;
+  removeAll(): void;
+  removeByTag(tag: string): void;
+  writeAll(): Promise<void[]>;
+  writeByTag(tag: string): Promise<void[]>;
+  unlinkAll(): Promise<void>;
+  getPersistedFiles(): File[];
 }
-
+//#endregion
+//#region lib/watcher-ignore.d.ts
 type MatchFn = (testString: string) => boolean;
 type MatchPattern = string | RegExp | MatchFn;
 declare class WatcherIgnore {
-    private readonly cwd;
-    private files;
-    private regexps;
-    private functions;
-    private globs;
-    private globsMap;
-    constructor(cwd: string);
-    ignore(pattern: MatchPattern): void;
-    isMicromatch(pattern: string): boolean;
-    resolveFile(file: string): string;
-    unignore(pattern: MatchPattern): void;
-    isIgnored(path: string): boolean;
+  private readonly cwd;
+  private files;
+  private regexps;
+  private functions;
+  private globs;
+  private readonly globsMap;
+  constructor(cwd: string);
+  ignore(pattern: MatchPattern): void;
+  isMicromatch(pattern: string): boolean;
+  resolveFile(file: string): string;
+  unignore(pattern: MatchPattern): void;
+  isIgnored(path: string): boolean;
 }
-
+//#endregion
+//#region lib/watcher.d.ts
 declare const isMatch: (string: string, pattern: string | readonly string[], options?: micromatch.Options) => boolean;
 type WatcherListener = (path: WatcherFile) => void;
 interface WatcherFile {
-    type: EventType;
-    path: string;
-    relativePath: string;
+  type: EventType;
+  path: string;
+  relativePath: string;
 }
 declare class Watcher {
-    private readonly cwd;
-    private readonly options?;
-    private subscription;
-    private listeners;
-    private watcherIgnore;
-    constructor(cwd: string, options?: Options);
-    onEvents: (err: Error | null, events: Event[]) => void;
-    on(event: EventType, listener: WatcherListener): void;
-    off(event: EventType, listener: WatcherListener): void;
-    ignore(pattern: MatchPattern): void;
-    unignore(pattern: MatchPattern): void;
-    createSubscription(): {
-        unsubscribe: () => Promise<void>;
-    };
-    close(): Promise<void>;
+  private readonly cwd;
+  private readonly options?;
+  private readonly subscription;
+  private readonly listeners;
+  private readonly watcherIgnore;
+  constructor(cwd: string, options?: Options);
+  onEvents: (err: Error | null, events: Event[]) => void;
+  on(event: EventType, listener: WatcherListener): void;
+  off(event: EventType, listener: WatcherListener): void;
+  ignore(pattern: MatchPattern): void;
+  unignore(pattern: MatchPattern): void;
+  createSubscription(): {
+    unsubscribe: () => Promise<void>;
+  };
+  close(): Promise<void>;
 }
-
+//#endregion
+//#region lib/ctx.d.ts
 type Ctx<T = unknown> = {
-    fileManager: FileManager;
-    didSetup: string[];
-    didGenerate: string[];
-    didEnd: string[];
-    pluginNames: string[];
-    generatorOptions: NormalizedGeneratorOptions;
-    watching: boolean;
-    changedFile?: WatcherFile;
+  fileManager: FileManager;
+  didSetup: string[];
+  didGenerate: string[];
+  didEnd: string[];
+  pluginNames: string[];
+  generatorOptions: NormalizedGeneratorOptions;
+  watching: boolean;
+  changedFile?: WatcherFile;
 } & T;
-
+//#endregion
+//#region lib/file-block.d.ts
 declare class FileBlock extends File {
-    filename: string;
-    content: string;
-    start: string;
-    end: string;
-    tag: string;
-    constructor(filename: string, content: string, start: string, end: string, tag: string, options?: FileOptions);
-    write: () => Promise<void>;
-    unlink: () => Promise<void>;
-    protected getExistingContent(): Promise<readonly [string, fs_promises.FileHandle] | readonly ["", null]>;
-    protected getSlices(existingContent: string): readonly [string, "", false] | readonly [string, string, true];
-    protected addBlockToContent(existingContent: string): string;
-    protected buildPadding(existingContent: string): "" | "\n" | "\n\n";
+  filename: string;
+  content: string;
+  start: string;
+  end: string;
+  tag: string;
+  constructor(filename: string, content: string, start: string, end: string, tag: string, options?: FileOptions);
+  write: () => Promise<void>;
+  unlink: () => Promise<void>;
+  protected getExistingContent(): Promise<readonly [string, fs_promises0.FileHandle] | readonly ["", null]>;
+  protected getSlices(existingContent: string): readonly [string, "", false] | readonly [string, string, true];
+  protected addBlockToContent(existingContent: string): string;
+  protected buildPadding(existingContent: string): "" | "\n" | "\n\n";
 }
-
+//#endregion
+//#region lib/module.d.ts
 declare function getModuleExportName(name: string): string;
-
+//#endregion
+//#region lib/plugin.d.ts
 declare const GeneratorPluginVersion: {
-    readonly V1: "v1";
+  readonly V1: "v1";
 };
 type GeneratorPluginVersion = (typeof GeneratorPluginVersion)[keyof typeof GeneratorPluginVersion];
 type GeneratorPluginV1Fn<Store = unknown> = (ctx: Ctx<Store>, next: () => Promise<void>) => Promise<void>;
 type GeneratorPluginV1ReloadFn = (file: WatcherFile) => void;
 type GeneratorPluginV1WatchOptions = (options: NormalizedGeneratorOptions, watcher: Watcher, reload: GeneratorPluginV1ReloadFn) => void;
 type GeneratorPluginV1Factory<Store = unknown> = {
-    name: string;
-    actionName: string;
-    setup?: GeneratorPluginV1Fn<Store>;
-    generate?: GeneratorPluginV1Fn<Store>;
-    end?: GeneratorPluginV1Fn<Store>;
-    watch?: GeneratorPluginV1WatchOptions;
+  name: string;
+  actionName: string;
+  setup?: GeneratorPluginV1Fn<Store>;
+  generate?: GeneratorPluginV1Fn<Store>;
+  end?: GeneratorPluginV1Fn<Store>;
+  watch?: GeneratorPluginV1WatchOptions;
 };
 interface GeneratorPluginV1<Store = unknown> {
-    name: string;
-    actionName: string;
-    version: typeof GeneratorPluginVersion.V1;
-    type: typeof PluginType.Generator;
-    setup: GeneratorPluginV1Fn<Store>;
-    generate: GeneratorPluginV1Fn<Store>;
-    end: GeneratorPluginV1Fn<Store>;
-    watch: GeneratorPluginV1WatchOptions;
+  name: string;
+  actionName: string;
+  version: typeof GeneratorPluginVersion.V1;
+  type: typeof PluginType.Generator;
+  setup: GeneratorPluginV1Fn<Store>;
+  generate: GeneratorPluginV1Fn<Store>;
+  end: GeneratorPluginV1Fn<Store>;
+  watch: GeneratorPluginV1WatchOptions;
 }
 declare function createPluginV1<Store = unknown>(options: GeneratorPluginV1Factory<Store>): GeneratorPluginV1<Store>;
 declare function isGeneratorPlugin(plugin: {
-    type: PluginType;
+  type: PluginType;
 }): plugin is GeneratorPluginV1<unknown>;
 declare function getGeneratorPlugins(plugins?: Array<{
-    type: PluginType;
+  type: PluginType;
 }>): GeneratorPluginV1<unknown>[];
-
-export { type Ctx, File, FileBlock, FileManager, type FileOptions, type GeneratorOptions, type GeneratorPluginV1, type GeneratorPluginV1Factory, type GeneratorPluginV1Fn, type GeneratorPluginV1ReloadFn, type GeneratorPluginV1WatchOptions, GeneratorPluginVersion, type Loader, type MatchFn, type MatchPattern, type NormalizedGeneratorOptions, Watcher, type WatcherFile, WatcherIgnore, type WatcherListener, createPluginV1, getGeneratorPlugins, getModuleExportName, isGeneratorPlugin, isMatch, loadOptions };
+//#endregion
+export { Ctx, File, FileBlock, FileManager, FileOptions, GeneratorOptions, GeneratorPluginV1, GeneratorPluginV1Factory, GeneratorPluginV1Fn, GeneratorPluginV1ReloadFn, GeneratorPluginV1WatchOptions, GeneratorPluginVersion, Loader, MatchFn, MatchPattern, NormalizedGeneratorOptions, Watcher, WatcherFile, WatcherIgnore, WatcherListener, createPluginV1, getGeneratorPlugins, getModuleExportName, isGeneratorPlugin, isMatch, loadOptions, micromatch };
+//# sourceMappingURL=index.d.ts.map