@zenstackhq/tanstack-query 1.0.0-alpha.119

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ZenStack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# ZenStack tanstack-query plugin & runtime
+
+This package contains ZenStack plugin for generating [tanstack-query](https://tanstack.com/query/latest) hooks.
+
+Visit [Homepage](https://zenstack.dev) for more details.

package/generator.d.ts

@@ -0,0 +1,4 @@
+import { DMMF } from '@prisma/generator-helper';
+import { PluginOptions } from '@zenstackhq/sdk';
+import { Model } from '@zenstackhq/sdk/ast';
+export declare function generate(model: Model, options: PluginOptions, dmmf: DMMF.Document): Promise<string[]>;

package/generator.js

@@ -0,0 +1,376 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const sdk_1 = require("@zenstackhq/sdk");
+const change_case_1 = require("change-case");
+const fs_1 = __importDefault(require("fs"));
+const lower_case_first_1 = require("lower-case-first");
+const path_1 = __importDefault(require("path"));
+const ts_morph_1 = require("ts-morph");
+const upper_case_first_1 = require("upper-case-first");
+const _1 = require(".");
+const supportedTargets = ['react', 'svelte'];
+function generate(model, options, dmmf) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let outDir = (0, sdk_1.requireOption)(options, 'output');
+        outDir = (0, sdk_1.resolvePath)(outDir, options);
+        const project = (0, sdk_1.createProject)();
+        const warnings = [];
+        const models = (0, sdk_1.getDataModels)(model);
+        const target = (0, sdk_1.requireOption)(options, 'target');
+        if (!supportedTargets.includes(target)) {
+            throw new sdk_1.PluginError(options.name, `Unsupported target "${target}", supported values: ${supportedTargets.join(', ')}`);
+        }
+        generateIndex(project, outDir, models);
+        generateHelper(target, project, outDir, options.useSuperJson === true);
+        models.forEach((dataModel) => {
+            const mapping = dmmf.mappings.modelOperations.find((op) => op.model === dataModel.name);
+            if (!mapping) {
+                warnings.push(`Unable to find mapping for model ${dataModel.name}`);
+                return;
+            }
+            generateModelHooks(target, project, outDir, dataModel, mapping);
+        });
+        yield (0, sdk_1.saveProject)(project);
+        return warnings;
+    });
+}
+exports.generate = generate;
+function generateQueryHook(target, sf, model, operation, returnArray, optionalInput, overrideReturnType, overrideInputType, overrideTypeParameters) {
+    const capOperation = (0, upper_case_first_1.upperCaseFirst)(operation);
+    const argsType = overrideInputType !== null && overrideInputType !== void 0 ? overrideInputType : `Prisma.${model}${capOperation}Args`;
+    const inputType = `Prisma.SelectSubset<T, ${argsType}>`;
+    const returnType = overrideReturnType !== null && overrideReturnType !== void 0 ? overrideReturnType : (returnArray ? `Array<Prisma.${model}GetPayload<T>>` : `Prisma.${model}GetPayload<T>`);
+    const optionsType = makeQueryOptions(target, returnType);
+    const func = sf.addFunction({
+        name: `use${capOperation}${model}`,
+        typeParameters: overrideTypeParameters !== null && overrideTypeParameters !== void 0 ? overrideTypeParameters : [`T extends ${argsType}`],
+        parameters: [
+            {
+                name: optionalInput ? 'args?' : 'args',
+                type: inputType,
+            },
+            {
+                name: 'options?',
+                type: optionsType,
+            },
+        ],
+        isExported: true,
+    });
+    func.addStatements([
+        makeGetContext(target),
+        `return query<${returnType}>('${model}', \`\${endpoint}/${(0, lower_case_first_1.lowerCaseFirst)(model)}/${operation}\`, args, options);`,
+    ]);
+}
+function generateMutationHook(target, sf, model, operation, httpVerb, overrideReturnType) {
+    const capOperation = (0, upper_case_first_1.upperCaseFirst)(operation);
+    const argsType = `Prisma.${model}${capOperation}Args`;
+    const inputType = `Prisma.SelectSubset<T, ${argsType}>`;
+    const returnType = overrideReturnType !== null && overrideReturnType !== void 0 ? overrideReturnType : `Prisma.CheckSelect<T, ${model}, Prisma.${model}GetPayload<T>>`;
+    const nonGenericOptionsType = `Omit<${makeMutationOptions(target, overrideReturnType !== null && overrideReturnType !== void 0 ? overrideReturnType : model, argsType)}, 'mutationFn'>`;
+    const optionsType = `Omit<${makeMutationOptions(target, returnType, inputType)}, 'mutationFn'>`;
+    const func = sf.addFunction({
+        name: `use${capOperation}${model}`,
+        isExported: true,
+        parameters: [
+            {
+                name: 'options?',
+                type: nonGenericOptionsType,
+            },
+            {
+                name: 'invalidateQueries',
+                type: 'boolean',
+                initializer: 'true',
+            },
+        ],
+    });
+    // get endpoint from context
+    func.addStatements([makeGetContext(target)]);
+    func.addVariableStatement({
+        declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+        declarations: [
+            {
+                name: `_mutation`,
+                initializer: `
+                    ${httpVerb}Mutation<${argsType}, ${overrideReturnType !== null && overrideReturnType !== void 0 ? overrideReturnType : model}>('${model}', \`\${endpoint}/${(0, lower_case_first_1.lowerCaseFirst)(model)}/${operation}\`, options, invalidateQueries)
+                `,
+            },
+        ],
+    });
+    switch (target) {
+        case 'react':
+            // override the mutateAsync function to return the correct type
+            func.addVariableStatement({
+                declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                declarations: [
+                    {
+                        name: 'mutation',
+                        initializer: `{
+                    ..._mutation,
+                    async mutateAsync<T extends ${argsType}>(
+                        args: Prisma.SelectSubset<T, ${argsType}>,
+                        options?: ${optionsType}
+                      ) {
+                        return (await _mutation.mutateAsync(
+                          args,
+                          options as any
+                        )) as ${returnType};
+                    },
+                }`,
+                    },
+                ],
+            });
+            break;
+        case 'svelte':
+            // svelte-query returns a store for mutations
+            // here we override the mutateAsync function to return the correct type
+            // and call `derived` to return a new reactive store
+            func.addVariableStatement({
+                declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                declarations: [
+                    {
+                        name: 'mutation',
+                        initializer: `derived(_mutation, value => ({
+                    ...value,
+                    async mutateAsync<T extends ${argsType}>(
+                        args: Prisma.SelectSubset<T, ${argsType}>,
+                        options?: ${optionsType}
+                      ) {
+                        return (await value.mutateAsync(
+                          args,
+                          options as any
+                        )) as ${returnType};
+                    },
+                }))`,
+                    },
+                ],
+            });
+            break;
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target "${target}"`);
+    }
+    func.addStatements('return mutation;');
+}
+function generateModelHooks(target, project, outDir, model, mapping) {
+    const fileName = (0, change_case_1.paramCase)(model.name);
+    const sf = project.createSourceFile(path_1.default.join(outDir, `${fileName}.ts`), undefined, { overwrite: true });
+    sf.addStatements('/* eslint-disable */');
+    sf.addImportDeclaration({
+        namedImports: ['Prisma', model.name],
+        isTypeOnly: true,
+        moduleSpecifier: '@prisma/client',
+    });
+    sf.addStatements(makeBaseImports(target));
+    // create is somehow named "createOne" in the DMMF
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (mapping.create || mapping.createOne) {
+        generateMutationHook(target, sf, model.name, 'create', 'post');
+    }
+    // createMany
+    if (mapping.createMany) {
+        generateMutationHook(target, sf, model.name, 'createMany', 'post', 'Prisma.BatchPayload');
+    }
+    // findMany
+    if (mapping.findMany) {
+        generateQueryHook(target, sf, model.name, 'findMany', true, true);
+    }
+    // findUnique
+    if (mapping.findUnique) {
+        generateQueryHook(target, sf, model.name, 'findUnique', false, false);
+    }
+    // findFirst
+    if (mapping.findFirst) {
+        generateQueryHook(target, sf, model.name, 'findFirst', false, true);
+    }
+    // update
+    // update is somehow named "updateOne" in the DMMF
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (mapping.update || mapping.updateOne) {
+        generateMutationHook(target, sf, model.name, 'update', 'put');
+    }
+    // updateMany
+    if (mapping.updateMany) {
+        generateMutationHook(target, sf, model.name, 'updateMany', 'put', 'Prisma.BatchPayload');
+    }
+    // upsert
+    // upsert is somehow named "upsertOne" in the DMMF
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (mapping.upsert || mapping.upsertOne) {
+        generateMutationHook(target, sf, model.name, 'upsert', 'post');
+    }
+    // del
+    // delete is somehow named "deleteOne" in the DMMF
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (mapping.delete || mapping.deleteOne) {
+        generateMutationHook(target, sf, model.name, 'delete', 'delete');
+    }
+    // deleteMany
+    if (mapping.deleteMany) {
+        generateMutationHook(target, sf, model.name, 'deleteMany', 'delete', 'Prisma.BatchPayload');
+    }
+    // aggregate
+    if (mapping.aggregate) {
+        generateQueryHook(target, sf, model.name, 'aggregate', false, false, `Prisma.Get${model.name}AggregateType<T>`);
+    }
+    // groupBy
+    if (mapping.groupBy) {
+        const typeParameters = [
+            `T extends Prisma.${model.name}GroupByArgs`,
+            `HasSelectOrTake extends Prisma.Or<Prisma.Extends<'skip', Prisma.Keys<T>>, Prisma.Extends<'take', Prisma.Keys<T>>>`,
+            `OrderByArg extends Prisma.True extends HasSelectOrTake ? { orderBy: Prisma.${model.name}GroupByArgs['orderBy'] }: { orderBy?: Prisma.${model.name}GroupByArgs['orderBy'] },`,
+            `OrderFields extends Prisma.ExcludeUnderscoreKeys<Prisma.Keys<Prisma.MaybeTupleToUnion<T['orderBy']>>>`,
+            `ByFields extends Prisma.TupleToUnion<T['by']>`,
+            `ByValid extends Prisma.Has<ByFields, OrderFields>`,
+            `HavingFields extends Prisma.GetHavingFields<T['having']>`,
+            `HavingValid extends Prisma.Has<ByFields, HavingFields>`,
+            `ByEmpty extends T['by'] extends never[] ? Prisma.True : Prisma.False`,
+            `InputErrors extends ByEmpty extends Prisma.True
+            ? \`Error: "by" must not be empty.\`
+            : HavingValid extends Prisma.False
+            ? {
+                [P in HavingFields]: P extends ByFields
+                ? never
+                : P extends string
+                ? \`Error: Field "\${P}" used in "having" needs to be provided in "by".\`
+                : [
+                    Error,
+                    'Field ',
+                    P,
+                    \` in "having" needs to be provided in "by"\`,
+                    ]
+            }[HavingFields]
+            : 'take' extends Prisma.Keys<T>
+            ? 'orderBy' extends Prisma.Keys<T>
+            ? ByValid extends Prisma.True
+                ? {}
+                : {
+                    [P in OrderFields]: P extends ByFields
+                    ? never
+                    : \`Error: Field "\${P}" in "orderBy" needs to be provided in "by"\`
+                }[OrderFields]
+            : 'Error: If you provide "take", you also need to provide "orderBy"'
+            : 'skip' extends Prisma.Keys<T>
+            ? 'orderBy' extends Prisma.Keys<T>
+            ? ByValid extends Prisma.True
+                ? {}
+                : {
+                    [P in OrderFields]: P extends ByFields
+                    ? never
+                    : \`Error: Field "\${P}" in "orderBy" needs to be provided in "by"\`
+                }[OrderFields]
+            : 'Error: If you provide "skip", you also need to provide "orderBy"'
+            : ByValid extends Prisma.True
+            ? {}
+            : {
+                [P in OrderFields]: P extends ByFields
+                ? never
+                : \`Error: Field "\${P}" in "orderBy" needs to be provided in "by"\`
+            }[OrderFields]`,
+        ];
+        const returnType = `{} extends InputErrors ? 
+        Array<Prisma.PickArray<Prisma.${model.name}GroupByOutputType, T['by']> &
+          {
+            [P in ((keyof T) & (keyof Prisma.${model.name}GroupByOutputType))]: P extends '_count'
+              ? T[P] extends boolean
+                ? number
+                : Prisma.GetScalarType<T[P], Prisma.${model.name}GroupByOutputType[P]>
+              : Prisma.GetScalarType<T[P], Prisma.${model.name}GroupByOutputType[P]>
+          }
+        > : InputErrors`;
+        generateQueryHook(target, sf, model.name, 'groupBy', false, false, returnType, `Prisma.SubsetIntersection<T, Prisma.${model.name}GroupByArgs, OrderByArg> & InputErrors`, typeParameters);
+    }
+    // somehow dmmf doesn't contain "count" operation, so we unconditionally add it here
+    {
+        generateQueryHook(target, sf, model.name, 'count', false, true, `T extends { select: any; } ? T['select'] extends true ? number : Prisma.GetScalarType<T['select'], Prisma.${model.name}CountAggregateOutputType> : number`);
+    }
+}
+function generateIndex(project, outDir, models) {
+    const sf = project.createSourceFile(path_1.default.join(outDir, 'index.ts'), undefined, { overwrite: true });
+    sf.addStatements(models.map((d) => `export * from './${(0, change_case_1.paramCase)(d.name)}';`));
+    sf.addStatements(`export * from './_helper';`);
+}
+function generateHelper(target, project, outDir, useSuperJson) {
+    let srcFile;
+    switch (target) {
+        case 'react':
+            srcFile = path_1.default.join(__dirname, './res/react/helper.ts');
+            break;
+        case 'svelte':
+            srcFile = path_1.default.join(__dirname, './res/svelte/helper.ts');
+            break;
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target: ${target}`);
+    }
+    // merge content of `shared.ts`, `helper.ts` and `marshal-?.ts`
+    const sharedContent = fs_1.default.readFileSync(path_1.default.join(__dirname, './res/shared.ts'), 'utf-8');
+    const helperContent = fs_1.default.readFileSync(srcFile, 'utf-8');
+    const marshalContent = fs_1.default.readFileSync(path_1.default.join(__dirname, useSuperJson ? './res/marshal-superjson.ts' : './res/marshal-json.ts'), 'utf-8');
+    project.createSourceFile(path_1.default.join(outDir, '_helper.ts'), `${sharedContent}\n${helperContent}\n${marshalContent}`, {
+        overwrite: true,
+    });
+}
+function makeGetContext(target) {
+    switch (target) {
+        case 'react':
+            return 'const { endpoint } = useContext(RequestHandlerContext);';
+        case 'svelte':
+            return `const { endpoint } = getContext<RequestHandlerContext>(SvelteQueryContextKey);`;
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target "${target}"`);
+    }
+}
+function makeBaseImports(target) {
+    const shared = [`import { query, postMutation, putMutation, deleteMutation } from './_helper';`];
+    switch (target) {
+        case 'react':
+            return [
+                `import { useContext } from 'react';`,
+                `import type { UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';`,
+                `import { RequestHandlerContext } from './_helper';`,
+                ...shared,
+            ];
+        case 'svelte':
+            return [
+                `import { getContext } from 'svelte';`,
+                `import { derived } from 'svelte/store';`,
+                `import type { MutationOptions, QueryOptions } from '@tanstack/svelte-query';`,
+                `import { SvelteQueryContextKey, type RequestHandlerContext } from './_helper';`,
+                ...shared,
+            ];
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target: ${target}`);
+    }
+}
+function makeQueryOptions(target, returnType) {
+    switch (target) {
+        case 'react':
+            return `UseQueryOptions<${returnType}>`;
+        case 'svelte':
+            return `QueryOptions<${returnType}>`;
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target: ${target}`);
+    }
+}
+function makeMutationOptions(target, returnType, argsType) {
+    switch (target) {
+        case 'react':
+            return `UseMutationOptions<${returnType}, unknown, ${argsType}>`;
+        case 'svelte':
+            return `MutationOptions<${returnType}, unknown, ${argsType}>`;
+        default:
+            throw new sdk_1.PluginError(_1.name, `Unsupported target: ${target}`);
+    }
+}
+//# sourceMappingURL=generator.js.map

package/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,yCAQyB;AAEzB,6CAAwC;AACxC,4CAAoB;AACpB,uDAAkD;AAClD,gDAAwB;AACxB,uCAAwE;AACxE,uDAAkD;AAClD,wBAAyB;AAEzB,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAG7C,SAAsB,QAAQ,CAAC,KAAY,EAAE,OAAsB,EAAE,IAAmB;;QACpF,IAAI,MAAM,GAAG,IAAA,mBAAa,EAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,GAAG,IAAA,iBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEtC,MAAM,OAAO,GAAG,IAAA,mBAAa,GAAE,CAAC;QAChC,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAA,mBAAa,EAAC,KAAK,CAAC,CAAC;QAEpC,MAAM,MAAM,GAAG,IAAA,mBAAa,EAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACpC,MAAM,IAAI,iBAAW,CACjB,OAAO,CAAC,IAAI,EACZ,uBAAuB,MAAM,wBAAwB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrF,CAAC;SACL;QAED,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACvC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC;QAEvE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,CAAC,OAAO,EAAE;gBACV,QAAQ,CAAC,IAAI,CAAC,oCAAoC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;gBACpE,OAAO;aACV;YACD,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,MAAM,IAAA,iBAAW,EAAC,OAAO,CAAC,CAAC;QAC3B,OAAO,QAAQ,CAAC;IACpB,CAAC;CAAA;AA9BD,4BA8BC;AAED,SAAS,iBAAiB,CACtB,MAAuB,EACvB,EAAc,EACd,KAAa,EACb,SAAiB,EACjB,WAAoB,EACpB,aAAsB,EACtB,kBAA2B,EAC3B,iBAA0B,EAC1B,sBAAiC;IAEjC,MAAM,YAAY,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,UAAU,KAAK,GAAG,YAAY,MAAM,CAAC;IAC3E,MAAM,SAAS,GAAG,0BAA0B,QAAQ,GAAG,CAAC;IACxD,MAAM,UAAU,GACZ,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,KAAK,gBAAgB,CAAC,CAAC,CAAC,UAAU,KAAK,eAAe,CAAC,CAAC;IACjH,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEzD,MAAM,IAAI,GAAG,EAAE,CAAC,WAAW,CAAC;QACxB,IAAI,EAAE,MAAM,YAAY,GAAG,KAAK,EAAE;QAClC,cAAc,EAAE,sBAAsB,aAAtB,sBAAsB,cAAtB,sBAAsB,GAAI,CAAC,aAAa,QAAQ,EAAE,CAAC;QACnE,UAAU,EAAE;YACR;gBACI,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;gBACtC,IAAI,EAAE,SAAS;aAClB;YACD;gBACI,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW;aACpB;SACJ;QACD,UAAU,EAAE,IAAI;KACnB,CAAC,CAAC;IAEH,IAAI,CAAC,aAAa,CAAC;QACf,cAAc,CAAC,MAAM,CAAC;QACtB,gBAAgB,UAAU,MAAM,KAAK,qBAAqB,IAAA,iCAAc,EACpE,KAAK,CACR,IAAI,SAAS,qBAAqB;KACtC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,oBAAoB,CACzB,MAAuB,EACvB,EAAc,EACd,KAAa,EACb,SAAiB,EACjB,QAAmC,EACnC,kBAA2B;IAE3B,MAAM,YAAY,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAAG,UAAU,KAAK,GAAG,YAAY,MAAM,CAAC;IACtD,MAAM,SAAS,GAAG,0BAA0B,QAAQ,GAAG,CAAC;IACxD,MAAM,UAAU,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,yBAAyB,KAAK,YAAY,KAAK,gBAAgB,CAAC;IACzG,MAAM,qBAAqB,GAAG,QAAQ,mBAAmB,CACrD,MAAM,EACN,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,KAAK,EAC3B,QAAQ,CACX,iBAAiB,CAAC;IACnB,MAAM,WAAW,GAAG,QAAQ,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,iBAAiB,CAAC;IAEhG,MAAM,IAAI,GAAG,EAAE,CAAC,WAAW,CAAC;QACxB,IAAI,EAAE,MAAM,YAAY,GAAG,KAAK,EAAE;QAClC,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE;YACR;gBACI,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,qBAAqB;aAC9B;YACD;gBACI,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,MAAM;aACtB;SACJ;KACJ,CAAC,CAAC;IAEH,4BAA4B;IAC5B,IAAI,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE7C,IAAI,CAAC,oBAAoB,CAAC;QACtB,eAAe,EAAE,kCAAuB,CAAC,KAAK;QAC9C,YAAY,EAAE;YACV;gBACI,IAAI,EAAE,WAAW;gBACjB,WAAW,EAAE;sBACP,QAAQ,YAAY,QAAQ,KAC9B,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,KAC1B,MAAM,KAAK,qBAAqB,IAAA,iCAAc,EAAC,KAAK,CAAC,IAAI,SAAS;iBACjE;aACJ;SACJ;KACJ,CAAC,CAAC;IAEH,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,+DAA+D;YAC/D,IAAI,CAAC,oBAAoB,CAAC;gBACtB,eAAe,EAAE,kCAAuB,CAAC,KAAK;gBAC9C,YAAY,EAAE;oBACV;wBACI,IAAI,EAAE,UAAU;wBAChB,WAAW,EAAE;;kDAEa,QAAQ;uDACH,QAAQ;oCAC3B,WAAW;;;;;gCAKf,UAAU;;kBAExB;qBACG;iBACJ;aACJ,CAAC,CAAC;YACH,MAAM;QAEV,KAAK,QAAQ;YACT,6CAA6C;YAC7C,uEAAuE;YACvE,oDAAoD;YACpD,IAAI,CAAC,oBAAoB,CAAC;gBACtB,eAAe,EAAE,kCAAuB,CAAC,KAAK;gBAC9C,YAAY,EAAE;oBACV;wBACI,IAAI,EAAE,UAAU;wBAChB,WAAW,EAAE;;kDAEa,QAAQ;uDACH,QAAQ;oCAC3B,WAAW;;;;;gCAKf,UAAU;;oBAEtB;qBACC;iBACJ;aACJ,CAAC,CAAC;YACH,MAAM;QAEV;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,GAAG,CAAC,CAAC;KACrE;IAED,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,kBAAkB,CACvB,MAAuB,EACvB,OAAgB,EAChB,MAAc,EACd,KAAgB,EAChB,OAA0B;IAE1B,MAAM,QAAQ,GAAG,IAAA,uBAAS,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,KAAK,CAAC,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEzG,EAAE,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;IAEzC,EAAE,CAAC,oBAAoB,CAAC;QACpB,YAAY,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC;QACpC,UAAU,EAAE,IAAI;QAChB,eAAe,EAAE,gBAAgB;KACpC,CAAC,CAAC;IACH,EAAE,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1C,kDAAkD;IAClD,8DAA8D;IAC9D,IAAI,OAAO,CAAC,MAAM,IAAK,OAAe,CAAC,SAAS,EAAE;QAC9C,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;KAClE;IAED,aAAa;IACb,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC;KAC7F;IAED,WAAW;IACX,IAAI,OAAO,CAAC,QAAQ,EAAE;QAClB,iBAAiB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;KACrE;IAED,aAAa;IACb,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,iBAAiB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;KACzE;IAED,YAAY;IACZ,IAAI,OAAO,CAAC,SAAS,EAAE;QACnB,iBAAiB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KACvE;IAED,SAAS;IACT,kDAAkD;IAClD,8DAA8D;IAC9D,IAAI,OAAO,CAAC,MAAM,IAAK,OAAe,CAAC,SAAS,EAAE;QAC9C,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;KACjE;IAED,aAAa;IACb,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,qBAAqB,CAAC,CAAC;KAC5F;IAED,SAAS;IACT,kDAAkD;IAClD,8DAA8D;IAC9D,IAAI,OAAO,CAAC,MAAM,IAAK,OAAe,CAAC,SAAS,EAAE;QAC9C,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;KAClE;IAED,MAAM;IACN,kDAAkD;IAClD,8DAA8D;IAC9D,IAAI,OAAO,CAAC,MAAM,IAAK,OAAe,CAAC,SAAS,EAAE;QAC9C,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;KACpE;IAED,aAAa;IACb,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,oBAAoB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC;KAC/F;IAED,YAAY;IACZ,IAAI,OAAO,CAAC,SAAS,EAAE;QACnB,iBAAiB,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,KAAK,CAAC,IAAI,kBAAkB,CAAC,CAAC;KACnH;IAED,UAAU;IACV,IAAI,OAAO,CAAC,OAAO,EAAE;QACjB,MAAM,cAAc,GAAG;YACnB,oBAAoB,KAAK,CAAC,IAAI,aAAa;YAC3C,mHAAmH;YACnH,8EAA8E,KAAK,CAAC,IAAI,gDAAgD,KAAK,CAAC,IAAI,2BAA2B;YAC7K,uGAAuG;YACvG,+CAA+C;YAC/C,mDAAmD;YACnD,0DAA0D;YAC1D,wDAAwD;YACxD,sEAAsE;YACtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAyCe;SAClB,CAAC;QAEF,MAAM,UAAU,GAAG;wCACa,KAAK,CAAC,IAAI;;+CAEH,KAAK,CAAC,IAAI;;;sDAGH,KAAK,CAAC,IAAI;oDACZ,KAAK,CAAC,IAAI;;wBAEtC,CAAC;QAEjB,iBAAiB,CACb,MAAM,EACN,EAAE,EACF,KAAK,CAAC,IAAI,EACV,SAAS,EACT,KAAK,EACL,KAAK,EACL,UAAU,EACV,uCAAuC,KAAK,CAAC,IAAI,wCAAwC,EACzF,cAAc,CACjB,CAAC;KACL;IAED,oFAAoF;IACpF;QACI,iBAAiB,CACb,MAAM,EACN,EAAE,EACF,KAAK,CAAC,IAAI,EACV,OAAO,EACP,KAAK,EACL,IAAI,EACJ,6GAA6G,KAAK,CAAC,IAAI,oCAAoC,CAC9J,CAAC;KACL;AACL,CAAC;AAED,SAAS,aAAa,CAAC,OAAgB,EAAE,MAAc,EAAE,MAAmB;IACxE,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACnG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,IAAA,uBAAS,EAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/E,EAAE,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,cAAc,CAAC,MAAuB,EAAE,OAAgB,EAAE,MAAc,EAAE,YAAqB;IACpG,IAAI,OAAe,CAAC;IACpB,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;YACxD,MAAM;QACV,KAAK,QAAQ;YACT,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;YACzD,MAAM;QACV;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,EAAE,CAAC,CAAC;KACpE;IAED,+DAA+D;IAC/D,MAAM,aAAa,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,OAAO,CAAC,CAAC;IACxF,MAAM,aAAa,GAAG,YAAE,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,YAAE,CAAC,YAAY,CAClC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,uBAAuB,CAAC,EAC3F,OAAO,CACV,CAAC;IAEF,OAAO,CAAC,gBAAgB,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,aAAa,KAAK,aAAa,KAAK,cAAc,EAAE,EAAE;QAC/G,SAAS,EAAE,IAAI;KAClB,CAAC,CAAC;AACP,CAAC;AAED,SAAS,cAAc,CAAC,MAAuB;IAC3C,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,OAAO,yDAAyD,CAAC;QACrE,KAAK,QAAQ;YACT,OAAO,gFAAgF,CAAC;QAC5F;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,GAAG,CAAC,CAAC;KACrE;AACL,CAAC;AAED,SAAS,eAAe,CAAC,MAAuB;IAC5C,MAAM,MAAM,GAAG,CAAC,+EAA+E,CAAC,CAAC;IACjG,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,OAAO;gBACH,qCAAqC;gBACrC,mFAAmF;gBACnF,oDAAoD;gBACpD,GAAG,MAAM;aACZ,CAAC;QACN,KAAK,QAAQ;YACT,OAAO;gBACH,sCAAsC;gBACtC,yCAAyC;gBACzC,8EAA8E;gBAC9E,gFAAgF;gBAChF,GAAG,MAAM;aACZ,CAAC;QACN;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,EAAE,CAAC,CAAC;KACpE;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc,EAAE,UAAkB;IACxD,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,OAAO,mBAAmB,UAAU,GAAG,CAAC;QAC5C,KAAK,QAAQ;YACT,OAAO,gBAAgB,UAAU,GAAG,CAAC;QACzC;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,EAAE,CAAC,CAAC;KACpE;AACL,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAc,EAAE,UAAkB,EAAE,QAAgB;IAC7E,QAAQ,MAAM,EAAE;QACZ,KAAK,OAAO;YACR,OAAO,sBAAsB,UAAU,cAAc,QAAQ,GAAG,CAAC;QACrE,KAAK,QAAQ;YACT,OAAO,mBAAmB,UAAU,cAAc,QAAQ,GAAG,CAAC;QAClE;YACI,MAAM,IAAI,iBAAW,CAAC,OAAI,EAAE,uBAAuB,MAAM,EAAE,CAAC,CAAC;KACpE;AACL,CAAC"}

package/index.d.ts

@@ -0,0 +1,5 @@
+import type { DMMF } from '@prisma/generator-helper';
+import type { PluginOptions } from '@zenstackhq/sdk';
+import type { Model } from '@zenstackhq/sdk/ast';
+export declare const name = "Tanstack Query";
+export default function run(model: Model, options: PluginOptions, dmmf: DMMF.Document): Promise<string[]>;

package/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.name = void 0;
+const generator_1 = require("./generator");
+exports.name = 'Tanstack Query';
+function run(model, options, dmmf) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return (0, generator_1.generate)(model, options, dmmf);
+    });
+}
+exports.default = run;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,2CAAuC;AAE1B,QAAA,IAAI,GAAG,gBAAgB,CAAC;AAErC,SAA8B,GAAG,CAAC,KAAY,EAAE,OAAsB,EAAE,IAAmB;;QACvF,OAAO,IAAA,oBAAQ,EAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CAAA;AAFD,sBAEC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@zenstackhq/tanstack-query",
+  "displayName": "ZenStack plugin for generating tanstack-query hooks",
+  "version": "1.0.0-alpha.119",
+  "description": "ZenStack plugin for generating tanstack-query hooks",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zenstackhq/zenstack"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "keywords": [],
+  "author": "ZenStack Team",
+  "license": "MIT",
+  "dependencies": {
+    "@prisma/generator-helper": "^4.7.1",
+    "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",
+    "upper-case-first": "^2.0.2",
+    "@zenstackhq/sdk": "1.0.0-alpha.119"
+  },
+  "devDependencies": {
+    "@tanstack/react-query": "^4.29.7",
+    "@tanstack/svelte-query": "^4.29.7",
+    "@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",
+    "copyfiles": "^2.4.1",
+    "jest": "^29.5.0",
+    "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",
+    "@zenstackhq/testtools": "1.0.0-alpha.119"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist",
+    "watch": "tsc --watch",
+    "lint": "eslint src --ext ts",
+    "test": "jest",
+    "publish-dev": "pnpm publish --tag dev"
+  }
+}

package/res/marshal-json.ts

@@ -0,0 +1,12 @@
+function marshal(value: unknown) {
+    return JSON.stringify(value);
+}
+
+function unmarshal(value: string) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return JSON.parse(value) as any;
+}
+
+function makeUrl(url: string, args: unknown) {
+    return args ? url + `?q=${encodeURIComponent(JSON.stringify(args))}` : url;
+}

package/res/marshal-superjson.ts

@@ -0,0 +1,20 @@
+import superjson from 'superjson';
+
+function marshal(value: unknown) {
+    return superjson.stringify(value);
+}
+
+function unmarshal(value: string) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const j = JSON.parse(value) as any;
+    if (j?.json) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return superjson.parse<any>(value);
+    } else {
+        return j;
+    }
+}
+
+function makeUrl(url: string, args: unknown) {
+    return args ? url + `?q=${encodeURIComponent(superjson.stringify(args))}` : url;
+}

package/res/react/helper.ts

@@ -0,0 +1,148 @@
+/* eslint-disable */
+
+import {
+    useMutation,
+    useQuery,
+    useQueryClient,
+    type MutateFunction,
+    type QueryClient,
+    type UseMutationOptions,
+    type UseQueryOptions,
+} from '@tanstack/react-query';
+import { createContext } from 'react';
+
+/**
+ * Context for configuring react hooks.
+ */
+export const RequestHandlerContext = createContext<RequestHandlerContext>({
+    endpoint: DEFAULT_QUERY_ENDPOINT,
+});
+
+/**
+ * Context provider.
+ */
+export const Provider = RequestHandlerContext.Provider;
+
+/**
+ * Creates a react-query query.
+ *
+ * @param model The name of the model under query.
+ * @param url The request URL.
+ * @param args The request args object, URL-encoded and appended as "?q=" parameter
+ * @param options The react-query options object
+ * @returns useQuery hook
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function query<R>(model: string, url: string, args?: unknown, options?: UseQueryOptions<R>) {
+    const reqUrl = makeUrl(url, args);
+    return useQuery<R>({
+        queryKey: [QUERY_KEY_PREFIX + model, url, args],
+        queryFn: () => fetcher<R>(reqUrl),
+        ...options,
+    });
+}
+
+/**
+ * Creates a POST mutation with react-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The react-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function postMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<UseMutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(url, {
+            method: 'POST',
+            headers: {
+                'content-type': 'application/json',
+            },
+            body: marshal(data),
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = useMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+/**
+ * Creates a PUT mutation with react-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The react-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function putMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<UseMutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(url, {
+            method: 'PUT',
+            headers: {
+                'content-type': 'application/json',
+            },
+            body: marshal(data),
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = useMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+/**
+ * Creates a DELETE mutation with react-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The react-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function deleteMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<UseMutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(makeUrl(url, data), {
+            method: 'DELETE',
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = useMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+function mergeOptions<T, R = any>(
+    model: string,
+    options: Omit<UseMutationOptions<R, unknown, T, unknown>, 'mutationFn'> | undefined,
+    invalidateQueries: boolean,
+    mutationFn: MutateFunction<R, unknown, T>,
+    queryClient: QueryClient
+): UseMutationOptions<R, unknown, T, unknown> {
+    const result = { ...options, mutationFn };
+    if (options?.onSuccess || invalidateQueries) {
+        result.onSuccess = (...args) => {
+            if (invalidateQueries) {
+                queryClient.invalidateQueries([QUERY_KEY_PREFIX + model]);
+            }
+            return options?.onSuccess?.(...args);
+        };
+    }
+    return result;
+}

package/res/shared.ts

@@ -0,0 +1,36 @@
+/**
+ * The default query endpoint.
+ */
+export const DEFAULT_QUERY_ENDPOINT = '/api/model';
+
+/**
+ * Prefix for react-query keys.
+ */
+export const QUERY_KEY_PREFIX = 'zenstack:';
+
+/**
+ * Context type for configuring the hooks.
+ */
+export type RequestHandlerContext = {
+    endpoint: string;
+};
+
+async function fetcher<R>(url: string, options?: RequestInit) {
+    const res = await fetch(url, options);
+    if (!res.ok) {
+        const error: Error & { info?: unknown; status?: number } = new Error(
+            'An error occurred while fetching the data.'
+        );
+        error.info = unmarshal(await res.text());
+        error.status = res.status;
+        throw error;
+    }
+
+    const textResult = await res.text();
+    try {
+        return unmarshal(textResult) as R;
+    } catch (err) {
+        console.error(`Unable to deserialize data:`, textResult);
+        throw err;
+    }
+}

package/res/svelte/helper.ts

@@ -0,0 +1,140 @@
+/* eslint-disable */
+
+import {
+    createMutation,
+    createQuery,
+    useQueryClient,
+    type MutateFunction,
+    type MutationOptions,
+    type QueryClient,
+    type QueryOptions,
+} from '@tanstack/svelte-query';
+
+/**
+ * Key for setting and getting the global query context.
+ */
+export const SvelteQueryContextKey = 'zenstack-svelte-query-context';
+
+/**
+ * Creates a svelte-query query.
+ *
+ * @param model The name of the model under query.
+ * @param url The request URL.
+ * @param args The request args object, URL-encoded and appended as "?q=" parameter
+ * @param options The svelte-query options object
+ * @returns useQuery hook
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function query<R>(model: string, url: string, args?: unknown, options?: QueryOptions<R>) {
+    const reqUrl = makeUrl(url, args);
+    return createQuery<R>({
+        queryKey: [QUERY_KEY_PREFIX + model, url, args],
+        queryFn: () => fetcher<R>(reqUrl),
+        ...options,
+    });
+}
+
+/**
+ * Creates a POST mutation with svelte-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The svelte-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function postMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<MutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(url, {
+            method: 'POST',
+            headers: {
+                'content-type': 'application/json',
+            },
+            body: marshal(data),
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = createMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+/**
+ * Creates a PUT mutation with svelte-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The svelte-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function putMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<MutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(url, {
+            method: 'PUT',
+            headers: {
+                'content-type': 'application/json',
+            },
+            body: marshal(data),
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = createMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+/**
+ * Creates a DELETE mutation with svelte-query.
+ *
+ * @param model The name of the model under mutation.
+ * @param url The request URL.
+ * @param options The svelte-query options.
+ * @param invalidateQueries Whether to invalidate queries after mutation.
+ * @returns useMutation hooks
+ */
+export function deleteMutation<T, R = any>(
+    model: string,
+    url: string,
+    options?: Omit<MutationOptions<R, unknown, T>, 'mutationFn'>,
+    invalidateQueries = true
+) {
+    const queryClient = useQueryClient();
+    const mutationFn = (data: any) =>
+        fetcher<R>(makeUrl(url, data), {
+            method: 'DELETE',
+        });
+
+    const finalOptions = mergeOptions<T, R>(model, options, invalidateQueries, mutationFn, queryClient);
+    const mutation = createMutation<R, unknown, T>(finalOptions);
+    return mutation;
+}
+
+function mergeOptions<T, R = any>(
+    model: string,
+    options: Omit<MutationOptions<R, unknown, T, unknown>, 'mutationFn'> | undefined,
+    invalidateQueries: boolean,
+    mutationFn: MutateFunction<R, unknown, T>,
+    queryClient: QueryClient
+): MutationOptions<R, unknown, T, unknown> {
+    const result = { ...options, mutationFn };
+    if (options?.onSuccess || invalidateQueries) {
+        result.onSuccess = (...args) => {
+            if (invalidateQueries) {
+                queryClient.invalidateQueries([QUERY_KEY_PREFIX + model]);
+            }
+            return options?.onSuccess?.(...args);
+        };
+    }
+    return result;
+}