@povio/openapi-codegen-cli 2.0.8-rc.37 → 2.0.8-rc.39

package/README.md

@@ -69,14 +69,12 @@ yarn openapi-codegen generate --config my-config.ts
   --config                            Path to TS config file (default: 'openapi-codegen.config.ts')
   --input                             Path/URL to OpenAPI JSON/YAML document
   --output                            Output directory path (default: 'output')
-  --incremental                       Skip generation when OpenAPI and config are unchanged (default: true)
   --format                            Format the generated code using Oxfmt (default: true)
   --verbose                           Display detailed log messages during execution (default: false)
 
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
 
-  --includeTags                       Comma-separated list of tags to include in generation
   --excludeTags                       Comma-separated list of tags to exclude from generation
   --excludePathRegex                  Exclude operations whose paths match the given regular expression
   --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
@@ -86,17 +84,11 @@ yarn openapi-codegen generate --config my-config.ts
   --tsPath                            (Requires `--importPath` to be 'ts') Typescript import path (default: '@/data')
   --removeOperationPrefixEndingWith   Remove operation name prefixes that end with the specified string (default: 'Controller_')
   --extractEnums                      Extract enums into separate Zod schemas (default: true)
-  --modelsInCommon                    Keep all schema declarations in defaultTag models and emit per-module proxy exports (default: false)
   --replaceOptionalWithNullish        Replace `.optional()` chains with `.nullish()` in generated Zod schemas (default: false)
 
   --axiosRequestConfig                Include Axios request config parameters in query hooks (default: false)
   --infiniteQueries                   Generate infinite queries for paginated API endpoints (default: false)
   --mutationEffects                   Add mutation effects options to mutation hooks (default: true)
-  --mutationDefaultOnError            Use OpenApiQueryConfig.onError as the default onError for mutation hooks (default: false)
-  --workspaceContext                  Comma-separated list of path/ACL params that generated hooks may resolve from OpenApiWorkspaceContext
-  --inlineEndpoints                   Inline endpoint implementations into generated query files (default: false)
-  --inlineEndpointsExcludeModules     Comma-separated modules/tags to keep as separate API files while inlineEndpoints=true
-  --modelsOnly                        Generate only model files (default: false)
   --parseRequestParams                Add Zod parsing to API endpoints (default: true)
 
   --acl                               Generate ACL related files (default: true)
@@ -117,7 +109,6 @@ yarn openapi-codegen generate --config my-config.ts
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
 
-  --includeTags                       Comma-separated list of tags to include in generation
   --excludeTags                       Comma-separated list of tags to exclude from generation
   --excludePathRegex                  Exclude operations whose paths match the given regular expression
   --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
@@ -195,84 +186,6 @@ const config: OpenAPICodegenConfig = {
 export default config;
 ```
 
-### Default mutation errors
-
-Set `mutationDefaultOnError: true` in codegen config (or pass `--mutationDefaultOnError`) to let generated mutation hooks fall back to `OpenApiQueryConfig.Provider` when a mutation call does not define its own `onError`.
-
-```tsx
-import { ErrorHandler, OpenApiQueryConfig } from "@povio/openapi-codegen-cli";
-
-<OpenApiQueryConfig.Provider
-  onError={(error) => {
-    errorToast({ text: ErrorHandler.getErrorMessage(error) });
-  }}
->
-  <App />
-</OpenApiQueryConfig.Provider>;
-```
-
-### OpenApiWorkspaceContext (Path + ACL defaults)
-
-Set `workspaceContext` to a list of param names in codegen config (or pass `--workspaceContext officeId,projectId`) and wrap your app subtree with `OpenApiWorkspaceContext.Provider` if generated hooks frequently repeat workspace-scoped params.
-
-```tsx
-import { OpenApiWorkspaceContext } from "@povio/openapi-codegen-cli";
-// openapi-codegen.config.ts -> { workspaceContext: ["officeId", "projectId"] }
-
-<OpenApiWorkspaceContext.Provider values={{ officeId: "office_123" }}>
-  <MyWorkspacePages />
-</OpenApiWorkspaceContext.Provider>;
-```
-
-Generated query/mutation hooks can then omit only those matching path/ACL params and resolve them from `OpenApiWorkspaceContext`. Params not listed in `workspaceContext` remain explicit and required.
-
-### Generation Modes
-
-You can control whether API endpoint files are emitted, inlined into query files, or skipped entirely.
-
-```ts
-import type { OpenAPICodegenConfig } from "@povio/openapi-codegen-cli";
-
-const config: OpenAPICodegenConfig = {
-  // 1) Default mode: separate *.api.ts files are generated
-  // 2) Inline mode: endpoint logic is generated inside *.queries.ts
-  // and can be used without separate api files:
-  // inlineEndpoints: true,
-  // inlineEndpointsExcludeModules: ["Users", "Billing"],
-  // 3) Models-only mode: generate only *.models.ts files
-  // modelsOnly: true,
-  // 4) Keep all model declarations in common.models and generate per-module model proxies
-  // modelsInCommon: true,
-};
-```
-
-### Vite Plugin
-
-You can run codegen directly from Vite config (without CLI config file):
-
-```ts
-import { defineConfig } from "vite";
-import { openApiCodegen } from "@povio/openapi-codegen-cli/vite";
-
-export default defineConfig({
-  plugins: [
-    openApiCodegen({
-      input: "./openapi.yaml",
-      output: "./src/data",
-      inlineEndpoints: true,
-      incremental: true,
-      formatGeneratedFile: async ({ fileName, content }) => {
-        void fileName;
-        return content;
-      },
-    }),
-  ],
-});
-```
-
-The plugin runs on both `vite serve` and `vite build`, and watches local OpenAPI files in dev mode.
-If you provide `formatGeneratedFile`, the plugin formats each generated file in memory before comparing and writing it, which helps avoid unnecessary HMR when the formatted output is unchanged.
-
 ### Enums
 
 If you're using Enums in your backend DTOs with `@Expose()` and `@IsEnum`, they may still not appear correctly in the OpenAPI schema unless you also provide both `enum` **and** `enumName` to `@ApiProperty`.

package/dist/acl.d.ts

@@ -0,0 +1,4 @@
+export { AbilityContext } from './lib/acl/ability.context';
+export { createAclGuard } from './lib/acl/AclGuard';
+export { Can } from './lib/acl/Can';
+export type { AppAbilities, AppAbility } from './lib/acl/appAbility.types';

package/dist/acl.mjs

@@ -1,74 +1,8 @@
-import { r as SharedErrorHandler } from "./error-handling-DkPY7Asf.mjs";
-import { n as OpenApiRouter, t as AuthContext } from "./auth.context-Bu5KW2sI.mjs";
-import { createContext, useCallback, useEffect, useState } from "react";
-import { jsx } from "react/jsx-runtime";
-import { AbilityBuilder, createMongoAbility } from "@casl/ability";
-import { unpackRules } from "@casl/ability/extra";
-import { createContextualCan, useAbility } from "@casl/react";
-
-//#region src/lib/acl/ability.context.tsx
-let AbilityContext;
-(function(_AbilityContext) {
-	const createAppAbilityBuilder = () => new AbilityBuilder(createMongoAbility);
-	const initialAppAbility = createAppAbilityBuilder().build();
-	const Context = createContext({});
-	const { Consumer } = Context;
-	_AbilityContext.Consumer = Consumer;
-	_AbilityContext.Provider = ({ children }) => {
-		const [ability, setAbility] = useState(initialAppAbility);
-		const { user } = AuthContext.useAuth();
-		useEffect(() => {
-			if (!user || !("aclRules" in user)) return;
-			const { can, build } = createAppAbilityBuilder();
-			const packedRules = user.aclRules;
-			unpackRules(packedRules).forEach(({ action, subject, conditions }) => {
-				can(action, subject, conditions);
-			});
-			setAbility(build());
-		}, [user]);
-		return /* @__PURE__ */ jsx(Context.Provider, {
-			value: ability,
-			children
-		});
-	};
-	_AbilityContext.useAbility = () => {
-		return useAbility(Context);
-	};
-})(AbilityContext || (AbilityContext = {}));
-
-//#endregion
-//#region src/lib/acl/AclGuard.tsx
-const createAclGuard = () => ({ canUse, redirectTo = "/", children }) => {
-	const ability = AbilityContext.useAbility();
-	const { replace } = OpenApiRouter.useRouter();
-	if (!ability.can(canUse[0], canUse[1])) {
-		replace(redirectTo);
-		return null;
-	}
-	return children;
+import { AbilityContext } from "./lib/acl/ability.context.mjs";
+import { createAclGuard } from "./lib/acl/AclGuard.mjs";
+import { Can } from "./lib/acl/Can.mjs";
+export {
+  AbilityContext,
+  Can,
+  createAclGuard
 };
-
-//#endregion
-//#region src/lib/acl/Can.tsx
-const ContextualCan = createContextualCan(AbilityContext.Consumer);
-const Can = ({ use, ...props }) => {
-	const [action, subject] = use;
-	return /* @__PURE__ */ jsx(ContextualCan, {
-		...props,
-		do: action,
-		on: subject
-	});
-};
-
-//#endregion
-//#region src/lib/acl/useAclCheck.ts
-function useAclCheck({ errorHandler } = {}) {
-	const ability = AbilityContext.useAbility();
-	return { checkAcl: useCallback((appAbility) => {
-		const [action, subject] = appAbility;
-		if (!ability.can(action, subject)) (errorHandler ?? SharedErrorHandler).rethrowError(/* @__PURE__ */ new Error("ACL check failed"));
-	}, [ability, errorHandler]) };
-}
-
-//#endregion
-export { AbilityContext, Can, createAclGuard, useAclCheck };

package/dist/commands/check.command.d.ts

@@ -0,0 +1,2 @@
+import { default as yargs } from 'yargs';
+export declare const command: yargs.CommandModule;

package/dist/commands/check.d.ts

@@ -0,0 +1,7 @@
+import { GenerateOptions } from '../generators/types/options';
+export type CheckParams = {
+    config?: string;
+    excludeTags?: string;
+    verbose?: boolean;
+} & Partial<Pick<GenerateOptions, "input" | "splitByTags" | "defaultTag">>;
+export declare function check({ verbose, config: configParam, excludeTags: _excludeTagsParam, ...params }: CheckParams): Promise<void>;

package/dist/commands/generate.command.d.ts

@@ -0,0 +1,2 @@
+import { default as yargs } from 'yargs';
+export declare const command: yargs.CommandModule;

package/dist/commands/generate.d.ts

@@ -0,0 +1,8 @@
+import { GenerateOptions } from '../generators/types/options';
+export type GenerateParams = {
+    config?: string;
+    excludeTags?: string;
+    format?: boolean;
+    verbose?: boolean;
+} & Partial<Pick<GenerateOptions, "input" | "output" | "tsNamespaces" | "tsPath" | "splitByTags" | "defaultTag" | "removeOperationPrefixEndingWith" | "importPath" | "extractEnums" | "acl" | "checkAcl" | "baseUrl" | "replaceOptionalWithNullish" | "infiniteQueries" | "axiosRequestConfig" | "mutationEffects" | "parseRequestParams" | "builderConfigs">>;
+export declare function generate({ format, verbose, config: configParam, ...params }: GenerateParams): Promise<void>;

package/dist/generator.d.ts

@@ -0,0 +1,3 @@
+import { GenerateParams } from './generators/types/metadata';
+export declare function getGenerateMetadata({ input, options: genOptions }: GenerateParams): Promise<import('./generators/types/metadata').GenerateMetadata>;
+export declare function getGenerateFilesData({ input, options: genOptions }: GenerateParams): Promise<import('./generators/types/generate').GenerateFileData[]>;