Skip to content

fix: zod plugin issue with lower-case model names #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/plugins/openapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"@zenstackhq/runtime": "workspace:*",
"@zenstackhq/sdk": "workspace:*",
"change-case": "^4.1.2",
"lower-case-first": "^2.0.2",
"openapi-types": "^12.1.0",
"tiny-invariant": "^1.3.1",
"yaml": "^2.2.1",
Expand All @@ -38,6 +39,7 @@
"@prisma/internals": "^4.7.1",
"@readme/openapi-parser": "^2.4.0",
"@types/jest": "^29.5.0",
"@types/lower-case-first": "^1.0.1",
"@types/tmp": "^0.2.3",
"@typescript-eslint/eslint-plugin": "^5.54.0",
"@typescript-eslint/parser": "^5.54.0",
Expand Down
8 changes: 4 additions & 4 deletions packages/plugins/openapi/src/generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
AggregateOperationSupport,
resolveAggregateOperationSupport,
} from '@zenstackhq/sdk/dmmf-helpers';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import * as fs from 'fs';
import type { OpenAPIV3_1 as OAPI } from 'openapi-types';
import * as path from 'path';
Expand Down Expand Up @@ -84,7 +84,7 @@ export class OpenAPIGenerator {
tags: this.includedModels.map((model) => {
const meta = getModelResourceMeta(model);
return {
name: camelCase(model.name),
name: lowerCaseFirst(model.name),
description: meta?.tagDescription ?? `${model.name} operations`,
};
}),
Expand Down Expand Up @@ -533,7 +533,7 @@ export class OpenAPIGenerator {
const def: OAPI.OperationObject = {
operationId: `${operation}${model.name}`,
description: meta?.description ?? description,
tags: meta?.tags || [camelCase(model.name)],
tags: meta?.tags || [lowerCaseFirst(model.name)],
summary: meta?.summary,
// security priority: operation-level > model-level > inferred
security: meta?.security ?? resourceMeta?.security ?? security,
Expand Down Expand Up @@ -581,7 +581,7 @@ export class OpenAPIGenerator {
}
}

result[`${prefix}/${camelCase(model.name)}/${resolvedPath}`] = {
result[`${prefix}/${lowerCaseFirst(model.name)}/${resolvedPath}`] = {
[resolvedMethod]: def,
};
}
Expand Down
12 changes: 8 additions & 4 deletions packages/plugins/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,30 @@
"@zenstackhq/sdk": "workspace:*",
"change-case": "^4.1.2",
"decimal.js": "^10.4.2",
"lower-case-first": "^2.0.2",
"superjson": "^1.11.0",
"ts-morph": "^16.0.0"
"ts-morph": "^16.0.0",
"upper-case-first": "^2.0.2"
},
"peerDependencies": {
"@tanstack/react-query": "4.x",
"react": "^17.0.2 || ^18",
"react-dom": "^17.0.2 || ^18",
"swr": "2.x",
"@tanstack/react-query": "4.x"
"swr": "2.x"
},
"devDependencies": {
"@tanstack/react-query": "^4.28.0",
"@types/jest": "^29.5.0",
"@types/lower-case-first": "^1.0.1",
"@types/react": "^18.0.26",
"@types/tmp": "^0.2.3",
"@types/upper-case-first": "^1.1.2",
"@zenstackhq/testtools": "workspace:*",
"copyfiles": "^2.4.1",
"jest": "^29.5.0",
"rimraf": "^3.0.2",
"react": "^17.0.2 || ^18",
"react-dom": "^17.0.2 || ^18",
"rimraf": "^3.0.2",
"swr": "^2.0.3",
"ts-jest": "^29.0.5",
"typescript": "^4.9.4"
Expand Down
12 changes: 7 additions & 5 deletions packages/plugins/react/src/generator/react-query.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { DMMF } from '@prisma/generator-helper';
import { PluginError, PluginOptions, createProject, getDataModels, saveProject } from '@zenstackhq/sdk';
import { DataModel, Model } from '@zenstackhq/sdk/ast';
import { camelCase, paramCase, pascalCase } from 'change-case';
import { paramCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import * as path from 'path';
import { Project, SourceFile, VariableDeclarationKind } from 'ts-morph';
import { upperCaseFirst } from 'upper-case-first';

export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
let outDir = options.output as string;
Expand Down Expand Up @@ -45,7 +47,7 @@ function generateQueryHook(
overrideInputType?: string,
overrideTypeParameters?: string[]
) {
const capOperation = pascalCase(operation);
const capOperation = upperCaseFirst(operation);

const argsType = overrideInputType ?? `Prisma.${model}${capOperation}Args`;
const inputType = `Prisma.SelectSubset<T, ${argsType}>`;
Expand All @@ -71,7 +73,7 @@ function generateQueryHook(

func.addStatements([
'const { endpoint } = useContext(RequestHandlerContext);',
`return request.query<${returnType}>('${model}', \`\${endpoint}/${camelCase(
`return request.query<${returnType}>('${model}', \`\${endpoint}/${lowerCaseFirst(
model
)}/${operation}\`, args, options);`,
]);
Expand All @@ -84,7 +86,7 @@ function generateMutationHook(
httpVerb: 'post' | 'put' | 'delete',
overrideReturnType?: string
) {
const capOperation = pascalCase(operation);
const capOperation = upperCaseFirst(operation);

const argsType = `Prisma.${model}${capOperation}Args`;
const inputType = `Prisma.SelectSubset<T, ${argsType}>`;
Expand Down Expand Up @@ -119,7 +121,7 @@ function generateMutationHook(
initializer: `
request.${httpVerb}Mutation<${argsType}, ${
overrideReturnType ?? model
}>('${model}', \`\${endpoint}/${camelCase(model)}/${operation}\`, options, invalidateQueries)
}>('${model}', \`\${endpoint}/${lowerCaseFirst(model)}/${operation}\`, options, invalidateQueries)
`,
},
],
Expand Down
5 changes: 3 additions & 2 deletions packages/plugins/react/src/generator/swr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import {
saveProject,
} from '@zenstackhq/sdk';
import { DataModel, Model } from '@zenstackhq/sdk/ast';
import { camelCase, paramCase } from 'change-case';
import { paramCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import * as path from 'path';
import { Project } from 'ts-morph';

Expand Down Expand Up @@ -79,7 +80,7 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
});

const prefixesToMutate = ['find', 'aggregate', 'count', 'groupBy'];
const modelRouteName = camelCase(model.name);
const modelRouteName = lowerCaseFirst(model.name);

useFunc.addStatements([
'const { endpoint } = useContext(RequestHandlerContext);',
Expand Down
2 changes: 2 additions & 0 deletions packages/plugins/trpc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,15 @@
"@prisma/internals": "^4.7.1",
"@zenstackhq/sdk": "workspace:*",
"change-case": "^4.1.2",
"lower-case-first": "^2.0.2",
"prettier": "^2.8.3",
"ts-morph": "^16.0.0",
"tslib": "^2.4.1",
"zod": "3.21.1"
},
"devDependencies": {
"@types/jest": "^29.5.0",
"@types/lower-case-first": "^1.0.1",
"@types/prettier": "^2.7.2",
"@zenstackhq/testtools": "workspace:*",
"copyfiles": "^2.4.1",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/trpc/src/generator.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { DMMF } from '@prisma/generator-helper';
import { CrudFailureReason, PluginError, PluginOptions, RUNTIME_PACKAGE, saveProject } from '@zenstackhq/sdk';
import { Model } from '@zenstackhq/sdk/ast';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import { promises as fs } from 'fs';
import path from 'path';
import { Project } from 'ts-morph';
Expand Down Expand Up @@ -116,7 +116,7 @@ function createAppRouter(outDir: string, modelOperations: DMMF.ModelMapping[], h
moduleSpecifier: `./${model}.router`,
});

writer.writeLine(`${camelCase(model)}: create${model}Router<Config>(router, procedure),`);
writer.writeLine(`${lowerCaseFirst(model)}: create${model}Router<Config>(router, procedure),`);
}
});
writer.write(');');
Expand Down
2 changes: 2 additions & 0 deletions packages/runtime/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"colors": "1.4.0",
"decimal.js": "^10.4.2",
"deepcopy": "^2.1.0",
"lower-case-first": "^2.0.2",
"pluralize": "^8.0.0",
"superjson": "^1.11.0",
"tslib": "^2.4.1",
Expand All @@ -45,6 +46,7 @@
"devDependencies": {
"@types/bcryptjs": "^2.4.2",
"@types/jest": "^29.5.0",
"@types/lower-case-first": "^1.0.1",
"@types/node": "^14.18.29",
"@types/pluralize": "^0.0.29",
"copyfiles": "^2.4.1",
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/enhancements/model-meta.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import { ModelMeta } from './types';

/**
Expand All @@ -17,5 +17,5 @@ export function getDefaultModelMeta(): ModelMeta {
* Resolves a model field to its metadata. Returns undefined if not found.
*/
export function resolveField(modelMeta: ModelMeta, model: string, field: string) {
return modelMeta.fields[camelCase(model)][field];
return modelMeta.fields[lowerCaseFirst(model)][field];
}
12 changes: 6 additions & 6 deletions packages/runtime/src/enhancements/policy/policy-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import { createId } from '@paralleldrive/cuid2';
import { PrismaClientKnownRequestError, PrismaClientUnknownRequestError } from '@prisma/client/runtime';
import { AUXILIARY_FIELDS, CrudFailureReason, GUARD_FIELD_NAME, TRANSACTION_FIELD_NAME } from '@zenstackhq/sdk';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import deepcopy from 'deepcopy';
import pluralize from 'pluralize';
import { fromZodError } from 'zod-validation-error';
Expand Down Expand Up @@ -97,7 +97,7 @@ export class PolicyUtil {
* otherwise returns a guard object
*/
async getAuthGuard(model: string, operation: PolicyOperationKind, preValue?: any): Promise<boolean | object> {
const guard = this.policy.guard[camelCase(model)];
const guard = this.policy.guard[lowerCaseFirst(model)];
if (!guard) {
throw this.unknownError(`unable to load policy guard for ${model}`);
}
Expand All @@ -114,15 +114,15 @@ export class PolicyUtil {
}

private async getPreValueSelect(model: string): Promise<object | undefined> {
const guard = this.policy.guard[camelCase(model)];
const guard = this.policy.guard[lowerCaseFirst(model)];
if (!guard) {
throw this.unknownError(`unable to load policy guard for ${model}`);
}
return guard.preValueSelect;
}

private async getModelSchema(model: string) {
return this.policy.schema[camelCase(model)];
return this.policy.schema[lowerCaseFirst(model)];
}

/**
Expand Down Expand Up @@ -255,7 +255,7 @@ export class PolicyUtil {
// flatten unique constraint filters
async flattenGeneratedUniqueField(model: string, args: any) {
// e.g.: { a_b: { a: '1', b: '1' } } => { a: '1', b: '1' }
const uniqueConstraints = this.modelMeta.uniqueConstraints?.[camelCase(model)];
const uniqueConstraints = this.modelMeta.uniqueConstraints?.[lowerCaseFirst(model)];
let flattened = false;
if (uniqueConstraints) {
for (const [field, value] of Object.entries<any>(args)) {
Expand Down Expand Up @@ -856,7 +856,7 @@ export class PolicyUtil {
* Gets "id" field for a given model.
*/
getIdFields(model: string) {
const fields = this.modelMeta.fields[camelCase(model)];
const fields = this.modelMeta.fields[lowerCaseFirst(model)];
if (!fields) {
throw this.unknownError(`Unable to load fields for ${model}`);
}
Expand Down
4 changes: 4 additions & 0 deletions packages/schema/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"commander": "^8.3.0",
"get-latest-version": "^5.0.1",
"langium": "1.1.0",
"lower-case-first": "^2.0.2",
"mixpanel": "^0.17.0",
"node-machine-id": "^1.1.12",
"ora": "^5.4.1",
Expand All @@ -102,6 +103,7 @@
"semver": "^7.3.8",
"sleep-promise": "^9.1.0",
"ts-morph": "^16.0.0",
"upper-case-first": "^2.0.2",
"uuid": "^9.0.0",
"vscode-jsonrpc": "^8.0.2",
"vscode-languageclient": "^8.0.2",
Expand All @@ -114,10 +116,12 @@
"devDependencies": {
"@types/async-exit-hook": "^2.0.0",
"@types/jest": "^29.5.0",
"@types/lower-case-first": "^1.0.1",
"@types/node": "^14.18.32",
"@types/pluralize": "^0.0.29",
"@types/semver": "^7.3.13",
"@types/tmp": "^0.2.3",
"@types/upper-case-first": "^1.1.2",
"@types/uuid": "^8.3.4",
"@types/vscode": "^1.56.0",
"@typescript-eslint/eslint-plugin": "^5.42.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
RUNTIME_PACKAGE,
saveProject,
} from '@zenstackhq/sdk';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import { streamAllContents } from 'langium';
import path from 'path';
import { FunctionDeclaration, SourceFile, VariableDeclarationKind } from 'ts-morph';
Expand Down Expand Up @@ -90,7 +90,7 @@ export default class PolicyGenerator {
writer.write('guard:');
writer.inlineBlock(() => {
for (const [model, map] of Object.entries(policyMap)) {
writer.write(`${camelCase(model)}:`);
writer.write(`${lowerCaseFirst(model)}:`);
writer.inlineBlock(() => {
for (const [op, func] of Object.entries(map)) {
if (typeof func === 'object') {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { DataModel, DataModelField, DataModelFieldAttribute, isDataModelField } from '@zenstackhq/language/ast';
import { AUXILIARY_FIELDS, VALIDATION_ATTRIBUTES, getLiteral } from '@zenstackhq/sdk';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import { CodeBlockWriter } from 'ts-morph';

/**
Expand All @@ -24,7 +24,7 @@ export class ZodSchemaGenerator {
}

generated = true;
writer.write(`${camelCase(model.name)}: z.object(`);
writer.write(`${lowerCaseFirst(model.name)}: z.object(`);
writer.inlineBlock(() => {
fields.forEach((field) => {
writer.writeLine(`${field.name}: ${this.makeFieldValidator(field)},`);
Expand Down
6 changes: 3 additions & 3 deletions packages/schema/src/plugins/model-meta/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
resolved,
saveProject,
} from '@zenstackhq/sdk';
import { camelCase } from 'change-case';
import { lowerCaseFirst } from 'lower-case-first';
import path from 'path';
import { CodeBlockWriter, VariableDeclarationKind } from 'ts-morph';
import { getIdFields } from '../../language-server/utils';
Expand Down Expand Up @@ -65,7 +65,7 @@ function generateModelMetadata(dataModels: DataModel[], writer: CodeBlockWriter)
writer.write('fields:');
writer.block(() => {
for (const model of dataModels) {
writer.write(`${camelCase(model.name)}:`);
writer.write(`${lowerCaseFirst(model.name)}:`);
writer.block(() => {
for (const f of model.fields) {
const backlink = getBackLink(f);
Expand Down Expand Up @@ -95,7 +95,7 @@ function generateModelMetadata(dataModels: DataModel[], writer: CodeBlockWriter)
writer.write('uniqueConstraints:');
writer.block(() => {
for (const model of dataModels) {
writer.write(`${camelCase(model.name)}:`);
writer.write(`${lowerCaseFirst(model.name)}:`);
writer.block(() => {
for (const constraint of getUniqueConstraints(model)) {
writer.write(`${constraint.name}: {
Expand Down
Loading