@postxl/generators 0.2.2

package/dist/backend-router-trpc/router-trpc.generator.d.ts

@@ -0,0 +1,108 @@
+import * as Generator from '@postxl/generator';
+import { WithActions } from '../backend-actions';
+import { WithBackendAuthentication } from '../backend-authentication';
+import { WithBackend } from '../backend-core';
+import { WithRepositories } from '../backend-repositories';
+import { WithUpdates } from '../backend-update';
+import { WithView } from '../backend-view';
+import { WithBase } from '../base';
+import { WithDecoders } from '../decoders';
+import { WithTypes } from '../types';
+type ContextRequirements = WithBackendAuthentication<WithUpdates<WithView<WithRepositories<WithActions<WithDecoders<WithTypes<WithBackend<WithBase<Generator.Context>>>>>>>>>;
+export type ContextResult = WithTrpcRouter<ContextRequirements>;
+export type ModelContextResult = Generator.InferModelContext<ContextResult>;
+export type WithTrpcRouter<Context> = Generator.ExtendContextAndModel<Context, {
+    trpcRouter: TrpcRouterContext;
+}, {
+    trpcRoute: TrpcRouterModelContext;
+}>;
+export type TrpcRouterContext = {
+    packageVersions: {
+        /**
+         * The version tag of TRPC used in the project (used for package.json, e.g. "11.5.0")
+         */
+        trpc: string;
+        /**
+         * The version tag of SuperJSON used in the project (used for package.json, e.g. "1.13.1")
+         */
+        superJSON: string;
+    };
+    module: Generator.ImportableClass;
+    /**
+     * NestJS provider for the TRPC plugin that registers the server with NestJS/Fastify
+     */
+    plugin: Generator.ImportableClass & {
+        _filePath: Generator.FilePath;
+    };
+    /**
+     * The routes of the app routes. Mainly used inside the TRPC plugin.
+     */
+    appRoutes: Generator.ImportableConstant & {
+        /**
+         * The type of the app routes - needs to be used in by the TRPC client
+         */
+        type: Generator.ImportableType;
+        _filePath: Generator.FilePath;
+    };
+    /**
+     * Audit log route for querying action operations
+     */
+    auditLogRoute: Generator.ImportableFunction & {
+        _filePath: Generator.FilePath;
+    };
+    defaultMethodNames: {
+        create: Generator.FunctionName;
+        update: Generator.FunctionName;
+        delete: Generator.FunctionName;
+    };
+    /**
+     * File that configures/provides all relevant TRPC elements: router, middleware, procedure
+     */
+    _shared: {
+        _filePath: Generator.FilePath;
+        /**
+         * The router function, used to define the individual model routes
+         */
+        router: Generator.ImportableFunction;
+        /**
+         * The procedure function, used to compose the route endpoints
+         */
+        procedure: Generator.ImportableFunction;
+        /**
+         * The middleware function, used to define composable middleware
+         */
+        middleware: Generator.ImportableFunction;
+        /**
+         * The context for any endpoint before any middleware.
+         * **Important**: This does only include the optional viewer!
+         *                Use `_middleware.auth.context` to access the user!
+         */
+        context: Generator.ImportableType;
+    };
+    /**
+     * Middleware that can be used in any route
+     */
+    _middleware: {
+        /**
+         * Auth middleware that ensure user is authenticated
+         */
+        auth: Generator.ImportableFunction & {
+            context: Generator.ImportableType;
+        };
+        /**
+         * Helpful function to log the request and response
+         */
+        debugLogger: Generator.ImportableFunction;
+        _filePath: Generator.FilePath;
+    };
+};
+export type TrpcRouterModelContext = Generator.ImportableFunction & {
+    _filePath: Generator.FilePath;
+    get: Generator.ImportableFunction;
+    getMap: Generator.ImportableFunction;
+    getList: Generator.ImportableFunction;
+};
+export type RouterEnumContext = Generator.ImportableFunction;
+export declare const generatorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;
+export declare const generator: Generator.GeneratorInterface;
+export {};

package/dist/backend-router-trpc/router-trpc.generator.js

@@ -0,0 +1,189 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generator = exports.generatorId = void 0;
+const node_path_1 = require("node:path");
+const Generator = __importStar(require("@postxl/generator"));
+const backend_actions_1 = require("../backend-actions");
+const backend_authentication_1 = require("../backend-authentication");
+const backend_core_1 = require("../backend-core");
+const backend_repositories_1 = require("../backend-repositories");
+const backend_update_1 = require("../backend-update");
+const backend_view_1 = require("../backend-view");
+const base_1 = require("../base");
+const types_1 = require("../types");
+const app_routes_generator_1 = require("./generators/app-routes.generator");
+const audit_log_route_generator_1 = require("./generators/audit-log-route.generator");
+const middleware_generator_1 = require("./generators/middleware.generator");
+const model_routes_generator_1 = require("./generators/model-routes.generator");
+const trpc_plugin_generator_1 = require("./generators/trpc-plugin.generator");
+const trpc_router_module_generator_1 = require("./generators/trpc-router-module.generator");
+const trpc_shared_generator_1 = require("./generators/trpc-shared.generator");
+const packageVersions = {
+    trpc: '11.7.1',
+    superJSON: '1.13.1',
+};
+exports.generatorId = Generator.toGeneratorInterfaceId('backend-router-trpc');
+exports.generator = {
+    id: exports.generatorId,
+    requires: [
+        backend_core_1.backendGeneratorId,
+        base_1.baseGeneratorId,
+        types_1.typesGeneratorId,
+        backend_actions_1.backendActionsGeneratorId,
+        backend_repositories_1.backendRepositoriesGeneratorId,
+        backend_view_1.backendViewGeneratorId,
+        backend_update_1.backendUpdateGeneratorId,
+        backend_authentication_1.backendAuthenticationGeneratorId,
+    ],
+    register: (context) => {
+        const moduleName = Generator.toBackendModuleName('router-trpc');
+        context.backend.packageJson.dependencies.push(
+        // Register backend module
+        { packageName: '@trpc/server', version: packageVersions.trpc }, 
+        // Do not upgrade to 2.x, as it requires ESM and NestJS does not support it yet.
+        { packageName: 'superjson', version: packageVersions.superJSON });
+        const module = {
+            name: Generator.toClassName('RouterTrpcModule'),
+            location: Generator.toBackendModuleLocation(`@router-trpc/router-trpc.module`),
+        };
+        const routerModule = {
+            name: moduleName,
+            moduleClass: module,
+            bootStrap: {
+                import: Generator.ts(`import { TrpcPlugin } from '@router-trpc/trpc.plugin'`),
+                code: Generator.ts(`await app.get(TrpcPlugin).register(app, {urlPrefix: config.data.urlPrefix})`),
+            },
+        };
+        context.backend.modules.push(routerModule);
+        const models = new Map();
+        for (const [modelName, model] of context.models) {
+            const modelWithRouters = registerModelRouter(model);
+            models.set(modelName, modelWithRouters);
+        }
+        const trpcLocation = Generator.toBackendModuleLocation(`@router-trpc/trpc-shared`);
+        const middlewareLocation = Generator.toBackendModuleLocation(`@router-trpc/middleware`);
+        const appRoutesLocation = Generator.toBackendModuleLocation(`@router-trpc/routes/app-routes`);
+        const trpcRouter = {
+            packageVersions,
+            module,
+            plugin: {
+                name: Generator.toClassName('TrpcPlugin'),
+                location: Generator.toBackendModuleLocation(`@router-trpc/trpc.plugin`),
+                _filePath: Generator.toFilePath(`./trpc.plugin.ts`),
+            },
+            appRoutes: {
+                name: Generator.toConstantName('appRoutes'),
+                location: appRoutesLocation,
+                _filePath: Generator.toFilePath(`./routes/app-routes.ts`),
+                type: {
+                    name: Generator.toTypeName('AppRoutes'),
+                    location: appRoutesLocation,
+                },
+            },
+            auditLogRoute: {
+                name: Generator.toFunctionName('auditLogs'),
+                location: Generator.toBackendModuleLocation('@router-trpc/routes/audit-log.route'),
+                _filePath: Generator.toFilePath(`./routes/audit-log.route.ts`),
+            },
+            defaultMethodNames: {
+                create: Generator.toFunctionName('create'),
+                update: Generator.toFunctionName('update'),
+                delete: Generator.toFunctionName('delete'),
+            },
+            _shared: {
+                _filePath: Generator.toFilePath(`./trpc-shared.ts`),
+                router: { name: Generator.toFunctionName('router'), location: trpcLocation },
+                procedure: { name: Generator.toFunctionName('procedure'), location: trpcLocation },
+                middleware: { name: Generator.toFunctionName('middleware'), location: trpcLocation },
+                context: { name: Generator.toTypeName('InitialContext'), location: trpcLocation },
+            },
+            _middleware: {
+                _filePath: Generator.toFilePath(`./middleware.ts`),
+                auth: {
+                    name: Generator.toFunctionName('authMiddleware'),
+                    location: middlewareLocation,
+                    context: {
+                        name: Generator.toTypeName('ContextWithAuth'),
+                        location: middlewareLocation,
+                    },
+                },
+                debugLogger: {
+                    name: Generator.toFunctionName('debugLogger'),
+                    location: middlewareLocation,
+                },
+            },
+        };
+        return {
+            ...context,
+            trpcRouter,
+            models,
+        };
+    },
+    generate: async (context) => {
+        const vfsSrc = new Generator.VirtualFileSystem();
+        vfsSrc.write(Generator.toLocalFile(context.trpcRouter.module), (0, trpc_router_module_generator_1.generateTrpcRouterModule)(context));
+        vfsSrc.write(context.trpcRouter.plugin._filePath, (0, trpc_plugin_generator_1.generateTrpc)(context));
+        vfsSrc.write(context.trpcRouter.appRoutes._filePath, (0, app_routes_generator_1.generateAppRoutes)({ context }));
+        vfsSrc.write(context.trpcRouter._shared._filePath, (0, trpc_shared_generator_1.generateTrpcShared)(context));
+        vfsSrc.write(context.trpcRouter._middleware._filePath, (0, middleware_generator_1.generateMiddleware)(context));
+        vfsSrc.write(context.trpcRouter.auditLogRoute._filePath, (0, audit_log_route_generator_1.generateAuditLogRoute)({ context }));
+        for (const model of context.models.values()) {
+            vfsSrc.write(model.trpcRoute._filePath, (0, model_routes_generator_1.generateModelRoutes)({ model, context }));
+        }
+        const vfs = new Generator.VirtualFileSystem();
+        vfs.insertFromVfs({ targetPath: 'src', vfs: vfsSrc });
+        vfs.write('/tsconfig.lib.json', Generator.generateTsConfig('router-trpc'));
+        await vfs.loadFile({
+            diskPath: (0, node_path_1.resolve)(__dirname, './template', 'viewer.router.ts'),
+            targetPath: 'src/routes/viewer.router.ts',
+        });
+        context.vfs.insertFromVfs({ targetPath: 'backend/libs/router-trpc', vfs });
+        return context;
+    },
+};
+function registerModelRouter(model) {
+    const location = Generator.toBackendModuleLocation(`@router-trpc/routes/${model._conjugated.camelCase}.route`);
+    const router = {
+        name: Generator.toFunctionName(`${model._conjugated.camelCasePlural}`),
+        location,
+        _filePath: Generator.toFilePath(`./routes/${model._conjugated.camelCase}.route.ts`),
+        get: { name: Generator.toFunctionName(`get`), location },
+        getMap: { name: Generator.toFunctionName(`getMap`), location },
+        getList: { name: Generator.toFunctionName(`getList`), location },
+    };
+    return { ...model, trpcRoute: router };
+}
+//# sourceMappingURL=router-trpc.generator.js.map

package/dist/backend-router-trpc/router-trpc.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-trpc.generator.js","sourceRoot":"","sources":["../../src/backend-router-trpc/router-trpc.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAmC;AAEnC,6DAA8C;AAE9C,wDAA2E;AAC3E,sEAAuG;AACvG,kDAA+E;AAC/E,kEAA0F;AAC1F,sDAAyE;AACzE,kDAAkE;AAClE,kCAAmD;AAEnD,oCAAsD;AAEtD,4EAAqE;AACrE,sFAA8E;AAC9E,4EAAsE;AACtE,gFAAyE;AACzE,8EAAuF;AACvF,4FAAoF;AACpF,8EAAuE;AA4GvE,MAAM,eAAe,GAAG;IACtB,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,QAAQ;CACpB,CAAA;AAWY,QAAA,WAAW,GAAG,SAAS,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,CAAA;AAErE,QAAA,SAAS,GAAiC;IACrD,EAAE,EAAE,mBAAW;IACf,QAAQ,EAAE;QACR,iCAAkB;QAClB,sBAAe;QACf,wBAAgB;QAChB,2CAAyB;QACzB,qDAA8B;QAC9B,qCAAsB;QACtB,yCAAwB;QACxB,yDAAgC;KACjC;IAED,QAAQ,EAAE,CAAsC,OAAgB,EAAiB,EAAE;QACjF,MAAM,UAAU,GAAG,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAA;QAE/D,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI;QAC3C,0BAA0B;QAC1B,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,eAAe,CAAC,IAAI,EAAE;QAC9D,gFAAgF;QAChF,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,CAAC,SAAS,EAAE,CACjE,CAAA;QAED,MAAM,MAAM,GAA8B;YACxC,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC;YAC/C,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,iCAAiC,CAAC;SAC/E,CAAA;QACD,MAAM,YAAY,GAAiB;YACjC,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE;gBACT,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,uDAAuD,CAAC;gBAC7E,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,6EAA6E,CAAC;aAClG;SACF,CAAA;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAE1C,MAAM,MAAM,GAAsC,IAAI,GAAG,EAAE,CAAA;QAC3D,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAA;YACnD,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;QACzC,CAAC;QACD,MAAM,YAAY,GAAG,SAAS,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAA;QAClF,MAAM,kBAAkB,GAAG,SAAS,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAA;QACvF,MAAM,iBAAiB,GAAG,SAAS,CAAC,uBAAuB,CAAC,gCAAgC,CAAC,CAAA;QAC7F,MAAM,UAAU,GAAsB;YACpC,eAAe;YACf,MAAM;YAEN,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;gBACzC,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,0BAA0B,CAAC;gBACvE,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,kBAAkB,CAAC;aACpD;YAED,SAAS,EAAE;gBACT,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC;gBAC3C,QAAQ,EAAE,iBAAiB;gBAC3B,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,wBAAwB,CAAC;gBAEzD,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC;oBACvC,QAAQ,EAAE,iBAAiB;iBAC5B;aACF;YAED,aAAa,EAAE;gBACb,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC;gBAC3C,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,qCAAqC,CAAC;gBAClF,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,6BAA6B,CAAC;aAC/D;YAED,kBAAkB,EAAE;gBAClB,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAC1C,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAC1C,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC;aAC3C;YAED,OAAO,EAAE;gBACP,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACnD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;gBAC5E,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;gBAClF,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;gBACpF,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE;aAClF;YAED,WAAW,EAAE;gBACX,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,iBAAiB,CAAC;gBAElD,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,gBAAgB,CAAC;oBAChD,QAAQ,EAAE,kBAAkB;oBAC5B,OAAO,EAAE;wBACP,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,iBAAiB,CAAC;wBAC7C,QAAQ,EAAE,kBAAkB;qBAC7B;iBACF;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC;oBAC7C,QAAQ,EAAE,kBAAkB;iBAC7B;aACF;SACF,CAAA;QAED,OAAO;YACL,GAAG,OAAO;YACV,UAAU;YACV,MAAM;SACoB,CAAA;IAC9B,CAAC;IAED,QAAQ,EAAE,KAAK,EAAiC,OAAgB,EAAoB,EAAE;QACpF,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAEhD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAA,uDAAwB,EAAC,OAAO,CAAC,CAAC,CAAA;QACjG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,IAAA,oCAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QAC9E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,EAAE,IAAA,wCAAiB,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAEpF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,IAAA,0CAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QAC/E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAA,yCAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QACnF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,EAAE,IAAA,iDAAqB,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAE5F,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,IAAA,4CAAmB,EAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QAClF,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAC7C,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;QAErD,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,SAAS,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAA;QAC1E,MAAM,GAAG,CAAC,QAAQ,CAAC;YACjB,QAAQ,EAAE,IAAA,mBAAO,EAAC,SAAS,EAAE,YAAY,EAAE,kBAAkB,CAAC;YAC9D,UAAU,EAAE,6BAA6B;SAC1C,CAAC,CAAA;QACF,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAA;QAE1E,OAAO,OAAO,CAAA;IAChB,CAAC;CACF,CAAA;AAED,SAAS,mBAAmB,CAC1B,KAA2C;IAE3C,MAAM,QAAQ,GAAG,SAAS,CAAC,uBAAuB,CAAC,uBAAuB,KAAK,CAAC,WAAW,CAAC,SAAS,QAAQ,CAAC,CAAA;IAC9G,MAAM,MAAM,GAA2B;QACrC,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;QACtE,QAAQ;QACR,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,KAAK,CAAC,WAAW,CAAC,SAAS,WAAW,CAAC;QACnF,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE;QACxD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE;QAC9D,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE;KACjE,CAAA;IAED,OAAO,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAA;AACxC,CAAC"}

package/dist/backend-router-trpc/template/viewer.router.ts

@@ -0,0 +1,25 @@
+import { ViewerResult } from '@authentication/authentication.types'
+
+import { z } from 'zod'
+
+import { err, ok } from '@postxl/utils'
+
+import { procedure, router } from '../trpc-shared'
+
+function omit<T extends Record<string, unknown>, Key extends keyof T>(obj: T, key: Key): Omit<T, Key> {
+  const { [key]: _, ...rest } = obj
+  return rest
+}
+
+export const viewer = router({
+  viewer: procedure
+    .input(z.object({ pageUrl: z.string().describe('The url of the active page.') }))
+    .query(async ({ ctx, input }): Promise<ViewerResult> => {
+      if (ctx.viewer) {
+        return ok(omit(ctx.viewer, 'userInfo'))
+      }
+      const redirectUrl = await ctx.auth.getAuthenticationUrl({ redirectTo: decodeURIComponent(input.pageUrl) })
+
+      return err({ type: 'redirect', redirectUrl })
+    }),
+})

package/dist/backend-s3/generators/s3.config.generator.d.ts

@@ -0,0 +1,2 @@
+import { S3Context } from '../s3.generator';
+export declare function generateS3Config({ config }: S3Context): string;

package/dist/backend-s3/generators/s3.config.generator.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateS3Config = generateS3Config;
+function generateS3Config({ config }) {
+    return /* ts */ `
+import { Injectable } from '@nestjs/common'
+
+export type ${config.type.name} = Readonly<{
+  readonly useS3: boolean
+  readonly useCredentials: boolean
+  readonly accessKey?: string
+  readonly secretAccessKey?: string
+  readonly region: string
+  readonly bucket: string
+  readonly filePrefix: string
+}>
+
+@Injectable()
+export class ${config.name} {
+  constructor(public readonly config: ${config.type.name}) { }
+}
+`;
+}
+//# sourceMappingURL=s3.config.generator.js.map

package/dist/backend-s3/generators/s3.config.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.config.generator.js","sourceRoot":"","sources":["../../../src/backend-s3/generators/s3.config.generator.ts"],"names":[],"mappings":";;AAEA,4CAmBC;AAnBD,SAAgB,gBAAgB,CAAC,EAAE,MAAM,EAAa;IACpD,OAAO,QAAQ,CAAC;;;cAGJ,MAAM,CAAC,IAAI,CAAC,IAAI;;;;;;;;;;;eAWf,MAAM,CAAC,IAAI;wCACc,MAAM,CAAC,IAAI,CAAC,IAAI;;CAEvD,CAAA;AACD,CAAC"}

package/dist/backend-s3/generators/s3.module.generator.d.ts

@@ -0,0 +1,2 @@
+import { S3Context } from '../s3.generator';
+export declare function generateS3Module({ config, service, module }: S3Context): string;

package/dist/backend-s3/generators/s3.module.generator.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateS3Module = generateS3Module;
+const generator_1 = require("@postxl/generator");
+function generateS3Module({ config, service, module }) {
+    const imports = generator_1.ImportGenerator
+        //
+        .from(module.location)
+        .add(service)
+        .add(config)
+        .addType(config.type);
+    return /* ts */ `
+import { DynamicModule } from '@nestjs/common'
+${imports.generate()}
+
+export class ${module.name} {
+  static forRoot(config: ${config.type.name}): DynamicModule {
+    return {
+      module: ${module.name},
+      providers: [
+        ${service.name}, 
+        {
+          provide: ${config.name},
+          useFactory: () => new ${config.name}(config),
+        },
+      ],
+      exports: [${service.name}],
+      global: true,
+    }
+  }
+}`;
+}
+//# sourceMappingURL=s3.module.generator.js.map

package/dist/backend-s3/generators/s3.module.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.module.generator.js","sourceRoot":"","sources":["../../../src/backend-s3/generators/s3.module.generator.ts"],"names":[],"mappings":";;AAIA,4CA4BC;AAhCD,iDAAmD;AAInD,SAAgB,gBAAgB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAa;IACrE,MAAM,OAAO,GAAG,2BAAe;QAC7B,EAAE;SACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;SACrB,GAAG,CAAC,OAAO,CAAC;SACZ,GAAG,CAAC,MAAM,CAAC;SACX,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAEvB,OAAO,QAAQ,CAAC;;EAEhB,OAAO,CAAC,QAAQ,EAAE;;eAEL,MAAM,CAAC,IAAI;2BACC,MAAM,CAAC,IAAI,CAAC,IAAI;;gBAE3B,MAAM,CAAC,IAAI;;UAEjB,OAAO,CAAC,IAAI;;qBAED,MAAM,CAAC,IAAI;kCACE,MAAM,CAAC,IAAI;;;kBAG3B,OAAO,CAAC,IAAI;;;;EAI5B,CAAA;AACF,CAAC"}

package/dist/backend-s3/generators/s3.service.generator.d.ts

@@ -0,0 +1,2 @@
+import { S3Context } from '../s3.generator';
+export declare function generateS3Service({ config, service }: S3Context): string;

package/dist/backend-s3/generators/s3.service.generator.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateS3Service = generateS3Service;
+const generator_1 = require("@postxl/generator");
+function generateS3Service({ config, service }) {
+    const imports = generator_1.ImportGenerator
+        //
+        .from(service.location)
+        .add(config);
+    return `
+import { GetObjectCommand, PutObjectCommand, S3Client } from '@aws-sdk/client-s3'
+import { Injectable, Logger } from '@nestjs/common'
+
+import { generateRandomAlphanumericString } from '@postxl/utils'
+
+${imports.generate()}
+
+@Injectable()
+export class ${service.name} {
+  private readonly logger = new Logger(${service.name}.name)
+  private readonly s3: S3Client
+
+  /**
+   * Normalize the bucket name by removing the "s3://" prefix, any leading slashes and returning the first part (bucket name).
+   */
+  get normalizedBucket(): string {
+    let url = this.config.config.bucket
+
+    // Remove the "s3://" prefix if it exists
+    if (url.startsWith('s3://')) {
+      url = url.slice(5)
+    }
+
+    // Remove any leading slashes
+    url = url.replace(/^\\/+/, '')
+
+    // Split the URL by the first slash and return the first part (bucket name)
+    return url.split('/')[0]
+  }
+
+  constructor(private readonly config: ${config.name}) {
+    this.s3 = new S3Client({
+      credentials: this.config.config.useCredentials
+        ? {
+            accessKeyId: this.config.config.accessKey ?? '',
+            secretAccessKey: this.config.config.secretAccessKey ?? '',
+          }
+        : undefined,
+      region: this.config.config.region,
+    })
+  }
+
+  /**
+   * Get file from AWS S3 bucket.
+   */
+  public async getFile(key: string) {
+    const command = new GetObjectCommand({
+      Bucket: this.normalizedBucket,
+      Key: key,
+    })
+
+    const response = await this.s3.send(command)
+    if (!response.Body) {
+      return null
+    }
+    return response.Body.transformToByteArray()
+  }
+
+  /**
+   * Uploads a file to the AWS S3 bucket.
+   */
+  public async send(stream: NodeJS.ReadableStream, uuid: string, extension?: string): Promise<string> {
+    this.logger.log('Uploading to S3')
+
+    const key = generateS3Key(uuid, extension)
+    const command = new PutObjectCommand({
+      Bucket: this.normalizedBucket,
+      Key: key,
+      Body: await streamToBuffer(stream),
+    })
+
+    await this.s3.send(command)
+
+    const fileUrl = \`https://\${this.normalizedBucket}.s3.\${this.config.config.region}.amazonaws.com/\${key}\`
+    this.logger.log(\`Uploaded to S3 to \${fileUrl}\`)
+
+    return key
+  }
+}
+
+const streamToBuffer = (stream: NodeJS.ReadableStream): Promise<Buffer> =>
+  new Promise((resolve, reject) => {
+    const chunks: Buffer[] = []
+
+    stream.on('data', (chunk: Buffer) => chunks.push(chunk))
+    stream.on('end', () => resolve(Buffer.concat(chunks)))
+    stream.on('error', (err: any) => {
+      // Ensure the error is wrapped in an Error object
+      const error = err instanceof Error ? err : new Error(String(err))
+      reject(error)
+    })
+  })
+
+const generateS3Key = (uuid: string, extension?: string | null): string => {
+  // S3 performance is tied to the file prefix. By creating more prefixes,
+  // we improve S3 performance (https://docs.aws.amazon.com/AmazonS3/latest/dev/optimizing-performance.html).
+  const subfolder = generateRandomAlphanumericString(2)
+
+  let key = \`\${subfolder}/\${uuid}\`
+  if (extension) {
+    key += '.' + extension
+  }
+  return key
+}`;
+}
+//# sourceMappingURL=s3.service.generator.js.map

package/dist/backend-s3/generators/s3.service.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.service.generator.js","sourceRoot":"","sources":["../../../src/backend-s3/generators/s3.service.generator.ts"],"names":[],"mappings":";;AAIA,8CA+GC;AAnHD,iDAAmD;AAInD,SAAgB,iBAAiB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAa;IAC9D,MAAM,OAAO,GAAG,2BAAe;QAC7B,EAAE;SACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;SACtB,GAAG,CAAC,MAAM,CAAC,CAAA;IAEd,OAAO;;;;;;EAMP,OAAO,CAAC,QAAQ,EAAE;;;eAGL,OAAO,CAAC,IAAI;yCACc,OAAO,CAAC,IAAI;;;;;;;;;;;;;;;;;;;;;yCAqBZ,MAAM,CAAC,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyElD,CAAA;AACF,CAAC"}

package/dist/backend-s3/index.d.ts

@@ -0,0 +1,4 @@
+import * as Generator from './s3.generator';
+export type WithBackendS3<Context> = Generator.WithS3<Context>;
+export declare const backendS3Generator: import("@postxl/generator").GeneratorInterface;
+export declare const backendS3GeneratorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;

package/dist/backend-s3/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.backendS3GeneratorId = exports.backendS3Generator = void 0;
+const Generator = __importStar(require("./s3.generator"));
+exports.backendS3Generator = Generator.generator;
+exports.backendS3GeneratorId = Generator.generatorId;
+//# sourceMappingURL=index.js.map

package/dist/backend-s3/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backend-s3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAA2C;AAG9B,QAAA,kBAAkB,GAAG,SAAS,CAAC,SAAS,CAAA;AACxC,QAAA,oBAAoB,GAAG,SAAS,CAAC,WAAW,CAAA"}

package/dist/backend-s3/s3.generator.d.ts

@@ -0,0 +1,19 @@
+import * as Generator from '@postxl/generator';
+import { WithBackend } from '../backend-core';
+import { WithBase } from '../base';
+type ContextRequirements = WithBackend<WithBase<Generator.Context>>;
+export type ContextResult = WithS3<ContextRequirements>;
+export type ModelContextResult = Generator.InferModelContext<ContextResult>;
+export type WithS3<Context> = Generator.ExtendContext<Context, {
+    s3: S3Context;
+}>;
+export type S3Context = {
+    module: Generator.ImportableClass;
+    service: Generator.ImportableClass;
+    config: Generator.ImportableClass & {
+        type: Generator.ImportableType;
+    };
+};
+export declare const generatorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;
+export declare const generator: Generator.GeneratorInterface;
+export {};