@karmaniverous/smoz 0.1.8 → 0.2.1

package/templates/{minimal → default}/app/config/app.config.ts

@@ -1,50 +1,50 @@
-import { join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { App, baseEventTypeMapSchema, toPosixPath } from '@karmaniverous/smoz';
-import { z } from 'zod';
-
-// Derive the app root as the parent directory of app/config/
-export const APP_ROOT_ABS = toPosixPath(
-  fileURLToPath(new URL('..', import.meta.url)),
-);
-
-export const app = App.create({
-  appRootAbs: APP_ROOT_ABS,
-  globalParamsSchema: z.object({
-    PROFILE: z.string(),
-    REGION: z.string(),
-    SERVICE_NAME: z.string(),
-  }),
-  stageParamsSchema: z.object({
-    STAGE: z.string(),
-  }),
-  eventTypeMapSchema: baseEventTypeMapSchema,
-  serverless: {
-    httpContextEventMap: {
-      my: {}, // place a Cognito authorizer here if needed
-      private: { private: true },
-      public: {},
-    },
-    defaultHandlerFileName: 'handler',
-    defaultHandlerFileExport: 'handler',
-  },
-  global: {
-    params: {
-      PROFILE: 'dev',
-      REGION: 'us-east-1',
-      SERVICE_NAME: 'my-smoz-app',
-    },
-    envKeys: ['PROFILE', 'REGION', 'SERVICE_NAME'] as const,
-  },
-  stage: {
-    params: {
-      dev: { STAGE: 'dev' },
-    },
-    envKeys: ['STAGE'] as const,
-  },
-});
-
-export const ENDPOINTS_ROOT_REST = toPosixPath(
-  join(APP_ROOT_ABS, 'functions', 'rest'),
-);
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { App, baseEventTypeMapSchema, toPosixPath } from '@karmaniverous/smoz';
+import { z } from 'zod';
+
+// Derive the app root as the parent directory of app/config/
+export const APP_ROOT_ABS = toPosixPath(
+  fileURLToPath(new URL('..', import.meta.url)),
+);
+
+export const app = App.create({
+  appRootAbs: APP_ROOT_ABS,
+  globalParamsSchema: z.object({
+    PROFILE: z.string(),
+    REGION: z.string(),
+    SERVICE_NAME: z.string(),
+  }),
+  stageParamsSchema: z.object({
+    STAGE: z.string(),
+  }),
+  eventTypeMapSchema: baseEventTypeMapSchema,
+  serverless: {
+    httpContextEventMap: {
+      my: {}, // place a Cognito authorizer here if needed
+      private: { private: true },
+      public: {},
+    },
+    defaultHandlerFileName: 'handler',
+    defaultHandlerFileExport: 'handler',
+  },
+  global: {
+    params: {
+      PROFILE: 'dev',
+      REGION: 'us-east-1',
+      SERVICE_NAME: 'my-smoz-app',
+    },
+    envKeys: ['PROFILE', 'REGION', 'SERVICE_NAME'] as const,
+  },
+  stage: {
+    params: {
+      dev: { STAGE: 'dev' },
+    },
+    envKeys: ['STAGE'] as const,
+  },
+});
+
+export const ENDPOINTS_ROOT_REST = toPosixPath(
+  join(APP_ROOT_ABS, 'functions', 'rest'),
+);

package/templates/{minimal → default}/app/config/openapi.ts

@@ -1,45 +1,45 @@
-import * as path from 'node:path';
-
-import * as fs from 'fs-extra';
-import { packageDirectorySync } from 'pkg-dir';
-import { createDocument } from 'zod-openapi';
-
-import { app } from '@/app/config/app.config';
-/**
- * Template note:
- * - Templates do NOT commit generated register files under app/generated; they
- *   are declared via ambient types (templates/minimal/types/registers.d.ts) so
- *   TypeScript can typecheck without artifacts.
- * - To ensure side effects still run (endpoint registration) and to satisfy
- *   noUncheckedSideEffectImports, import the register module as a namespace and
- *   reference it via `void`.
- * - In real apps, `smoz init` seeds placeholders and `smoz register` rewrites
- *   app/generated/register.*.ts at author time.
- */
-import * as __register_openapi from '@/app/generated/register.openapi';
-void __register_openapi;
-console.log('Generating OpenAPI document...');
-
-const paths = app.buildAllOpenApiPaths();
-export const doc = createDocument({
-  openapi: '3.1.0',
-  servers: [{ description: 'Dev', url: 'http://localhost' }],
-  info: {
-    title: process.env.npm_package_name ?? 'smoz-app',
-    version: process.env.npm_package_version ?? '0.0.0',
-  },
-  paths,
-});
-
-const pkgDir = packageDirectorySync();
-if (!pkgDir) {
-  throw new Error('Could not resolve package root directory');
-}
-const outDir = path.join(pkgDir, 'app', 'generated');
-fs.ensureDirSync(outDir);
-fs.writeFileSync(
-  path.join(outDir, 'openapi.json'),
-  JSON.stringify(doc, null, 2),
-);
-
-console.log('Done!');
+import * as path from 'node:path';
+
+import * as fs from 'fs-extra';
+import { packageDirectorySync } from 'pkg-dir';
+import { createDocument } from 'zod-openapi';
+
+import { app } from '@/app/config/app.config';
+/**
+ * Template note:
+ * - Templates do NOT commit generated register files under app/generated; they
+ *   are declared via ambient types (templates/minimal/types/registers.d.ts) so
+ *   TypeScript can typecheck without artifacts.
+ * - To ensure side effects still run (endpoint registration) and to satisfy
+ *   noUncheckedSideEffectImports, import the register module as a namespace and
+ *   reference it via `void`.
+ * - In real apps, `smoz init` seeds placeholders and `smoz register` rewrites
+ *   app/generated/register.*.ts at author time.
+ */
+import * as __register_openapi from '@/app/generated/register.openapi';
+void __register_openapi;
+console.log('Generating OpenAPI document...');
+
+const paths = app.buildAllOpenApiPaths();
+export const doc = createDocument({
+  openapi: '3.1.0',
+  servers: [{ description: 'Dev', url: 'http://localhost' }],
+  info: {
+    title: process.env.npm_package_name ?? 'smoz-app',
+    version: process.env.npm_package_version ?? '0.0.0',
+  },
+  paths,
+});
+
+const pkgDir = packageDirectorySync();
+if (!pkgDir) {
+  throw new Error('Could not resolve package root directory');
+}
+const outDir = path.join(pkgDir, 'app', 'generated');
+fs.ensureDirSync(outDir);
+fs.writeFileSync(
+  path.join(outDir, 'openapi.json'),
+  JSON.stringify(doc, null, 2),
+);
+
+console.log('Done!');

package/templates/{full → default}/app/functions/rest/hello/get/handler.ts

@@ -1,18 +1,18 @@
-import type { z } from 'zod';
-
-import type { responseSchema } from './lambda';
-import { fn } from './lambda';
-
-type Response = z.infer<typeof responseSchema>;
-
-type FnHandlerApi<T> = {
-  handler: (impl: () => Promise<T> | T) => (...args: unknown[]) => Promise<T>;
-};
-
-const reg = fn as unknown as FnHandlerApi<Response>;
-
-export const handler = reg.handler(async () => {
-  const res: Response = { ok: true };
-  await Promise.resolve(); // satisfy require-await without adding complexity
-  return res;
-});
+import type { z } from 'zod';
+
+import type { responseSchema } from './lambda';
+import { fn } from './lambda';
+
+type Response = z.infer<typeof responseSchema>;
+
+type FnHandlerApi<T> = {
+  handler: (impl: () => Promise<T> | T) => (...args: unknown[]) => Promise<T>;
+};
+
+const reg = fn as unknown as FnHandlerApi<Response>;
+
+export const handler = reg.handler(async () => {
+  const res: Response = { ok: true };
+  await Promise.resolve(); // satisfy require-await without adding complexity
+  return res;
+});

package/templates/{full → default}/app/functions/rest/hello/get/lambda.ts

@@ -1,28 +1,28 @@
-import { join } from 'node:path';
-
-import { toPosixPath } from '@karmaniverous/smoz';
-import { z } from 'zod';
-
-import { app, APP_ROOT_ABS } from '@/app/config/app.config';
-
-export const eventSchema = z.object({}).optional();
-export const responseSchema = z.object({ ok: z.boolean() });
-type FnApi = {
-  handler: <T>(
-    impl: () => Promise<T> | T,
-  ) => (...args: unknown[]) => Promise<T>;
-  openapi: (op: unknown) => void;
-};
-
-export const fn = app.defineFunction({
-  functionName: 'hello_get',
-  eventType: 'rest',
-  httpContexts: ['public'],
-  method: 'get',
-  basePath: 'hello',
-  contentType: 'application/json',
-  eventSchema,
-  responseSchema,
-  callerModuleUrl: import.meta.url,
-  endpointsRootAbs: toPosixPath(join(APP_ROOT_ABS, 'functions', 'rest')),
-}) as unknown as FnApi;
+import { join } from 'node:path';
+
+import { toPosixPath } from '@karmaniverous/smoz';
+import { z } from 'zod';
+
+import { app, APP_ROOT_ABS } from '@/app/config/app.config';
+
+export const eventSchema = z.object({}).optional();
+export const responseSchema = z.object({ ok: z.boolean() });
+type FnApi = {
+  handler: <T>(
+    impl: () => Promise<T> | T,
+  ) => (...args: unknown[]) => Promise<T>;
+  openapi: (op: unknown) => void;
+};
+
+export const fn = app.defineFunction({
+  functionName: 'hello_get',
+  eventType: 'rest',
+  httpContexts: ['public'],
+  method: 'get',
+  basePath: 'hello',
+  contentType: 'application/json',
+  eventSchema,
+  responseSchema,
+  callerModuleUrl: import.meta.url,
+  endpointsRootAbs: toPosixPath(join(APP_ROOT_ABS, 'functions', 'rest')),
+}) as unknown as FnApi;

package/templates/{minimal → default}/app/functions/rest/hello/get/openapi.ts

@@ -1,23 +1,23 @@
-import { fn, responseSchema } from './lambda';
-
-type FnOpenApiApi = {
-  openapi: (op: unknown) => void;
-};
-
-const reg = fn as unknown as FnOpenApiApi;
-
-reg.openapi({
-  summary: 'Hello',
-  description: 'Return a simple OK payload.',
-  responses: {
-    200: {
-      description: 'Ok',
-      content: {
-        'application/json': { schema: responseSchema },
-      },
-    },
-  },
-  tags: ['public'],
-});
-
-export {};
+import { fn, responseSchema } from './lambda';
+
+type FnOpenApiApi = {
+  openapi: (op: unknown) => void;
+};
+
+const reg = fn as unknown as FnOpenApiApi;
+
+reg.openapi({
+  summary: 'Hello',
+  description: 'Return a simple OK payload.',
+  responses: {
+    200: {
+      description: 'Ok',
+      content: {
+        'application/json': { schema: responseSchema },
+      },
+    },
+  },
+  tags: ['public'],
+});
+
+export {};

package/templates/{minimal → default}/app/functions/rest/openapi/get/handler.ts

@@ -1,22 +1,22 @@
-import type { z } from 'zod';
-
-// Import the document from its real generated location.
-// The template ships a placeholder at app/generated/openapi.json.
-import openapiDoc from '@/app/generated/openapi.json';
-
-import type { responseSchema } from './lambda';
-import { fn } from './lambda';
-
-type Response = z.infer<typeof responseSchema>;
-type FnHandlerApi<T> = {
-  handler: (impl: () => Promise<T> | T) => (...args: unknown[]) => Promise<T>;
-};
-
-const reg = fn as unknown as FnHandlerApi<Response>;
-
-export const handler = reg.handler(async () => {
-  // Tip: run `npm run openapi` to regenerate this file.
-  // Trivial await keeps parity with prior style.
-  await Promise.resolve();
-  return openapiDoc as Response;
-});
+import type { z } from 'zod';
+
+// Import the document from its real generated location.
+// The template ships a placeholder at app/generated/openapi.json.
+import openapiDoc from '@/app/generated/openapi.json';
+
+import type { responseSchema } from './lambda';
+import { fn } from './lambda';
+
+type Response = z.infer<typeof responseSchema>;
+type FnHandlerApi<T> = {
+  handler: (impl: () => Promise<T> | T) => (...args: unknown[]) => Promise<T>;
+};
+
+const reg = fn as unknown as FnHandlerApi<Response>;
+
+export const handler = reg.handler(async () => {
+  // Tip: run `npm run openapi` to regenerate this file.
+  // Trivial await keeps parity with prior style.
+  await Promise.resolve();
+  return openapiDoc as Response;
+});

package/templates/{minimal → default}/app/functions/rest/openapi/get/lambda.ts

@@ -1,29 +1,29 @@
-import { join } from 'node:path';
-
-import { toPosixPath } from '@karmaniverous/smoz';
-import { z } from 'zod';
-
-import { app, APP_ROOT_ABS } from '@/app/config/app.config';
-
-export const eventSchema = z.any().optional();
-export const responseSchema = z.unknown();
-
-type FnApi = {
-  handler: <T>(
-    impl: () => Promise<T> | T,
-  ) => (...args: unknown[]) => Promise<T>;
-  openapi: (op: unknown) => void;
-};
-
-export const fn = app.defineFunction({
-  functionName: 'openapi_get',
-  eventType: 'rest',
-  httpContexts: ['public'],
-  method: 'get',
-  basePath: 'openapi',
-  contentType: 'application/json',
-  eventSchema,
-  responseSchema,
-  callerModuleUrl: import.meta.url,
-  endpointsRootAbs: toPosixPath(join(APP_ROOT_ABS, 'functions', 'rest')),
-}) as unknown as FnApi;
+import { join } from 'node:path';
+
+import { toPosixPath } from '@karmaniverous/smoz';
+import { z } from 'zod';
+
+import { app, APP_ROOT_ABS } from '@/app/config/app.config';
+
+export const eventSchema = z.any().optional();
+export const responseSchema = z.unknown();
+
+type FnApi = {
+  handler: <T>(
+    impl: () => Promise<T> | T,
+  ) => (...args: unknown[]) => Promise<T>;
+  openapi: (op: unknown) => void;
+};
+
+export const fn = app.defineFunction({
+  functionName: 'openapi_get',
+  eventType: 'rest',
+  httpContexts: ['public'],
+  method: 'get',
+  basePath: 'openapi',
+  contentType: 'application/json',
+  eventSchema,
+  responseSchema,
+  callerModuleUrl: import.meta.url,
+  endpointsRootAbs: toPosixPath(join(APP_ROOT_ABS, 'functions', 'rest')),
+}) as unknown as FnApi;

package/templates/{full → default}/app/functions/rest/openapi/get/openapi.ts

@@ -1,20 +1,20 @@
-import { fn, responseSchema } from './lambda';
-
-type FnOpenApiApi = {
-  openapi: (op: unknown) => void;
-};
-
-const reg = fn as unknown as FnOpenApiApi;
-
-reg.openapi({
-  summary: 'Get OpenAPI document',
-  description:
-    'Return the OpenAPI 3.1 document. Generate it via "npm run openapi".',
-  responses: {
-    200: {
-      description: 'OpenAPI document',
-      content: { 'application/json': { schema: responseSchema } },
-    },
-  },
-  tags: ['openapi'],
-});
+import { fn, responseSchema } from './lambda';
+
+type FnOpenApiApi = {
+  openapi: (op: unknown) => void;
+};
+
+const reg = fn as unknown as FnOpenApiApi;
+
+reg.openapi({
+  summary: 'Get OpenAPI document',
+  description:
+    'Return the OpenAPI 3.1 document. Generate it via "npm run openapi".',
+  responses: {
+    200: {
+      description: 'OpenAPI document',
+      content: { 'application/json': { schema: responseSchema } },
+    },
+  },
+  tags: ['openapi'],
+});

package/templates/{project → default}/eslint.config.ts

@@ -9,16 +9,6 @@ import { fileURLToPath } from 'url';
 const tsconfigRootDir = dirname(fileURLToPath(import.meta.url));
 
 export default [
-  {
-    ignores: [
-      '.serverless/**',
-      '.tsbuild/**',
-      'coverage/**',
-      'dist/**',
-      'docs/**',
-      'node_modules/**',
-    ],
-  },
   eslint.configs.recommended,
   ...tseslint.configs.strictTypeChecked,
   prettierConfig,
@@ -26,7 +16,7 @@ export default [
     languageOptions: {
       parser: tseslint.parser,
       parserOptions: {
-        project: ['./tsconfig.json'],
+        project: ['./tsconfig.eslint.json'],
         tsconfigRootDir,
       },
     },
@@ -36,12 +26,13 @@ export default [
     },
     rules: {
       'prettier/prettier': 'error',
-      '@typescript-eslint/consistent-type-imports': 'error',
-      '@typescript-eslint/no-unused-expressions': 'off',
-      '@typescript-eslint/no-unused-vars': 'error',
-      'no-unused-vars': 'off',
       'simple-import-sort/imports': 'error',
       'simple-import-sort/exports': 'error',
+      '@typescript-eslint/no-empty-object-type': 'off',
+      '@typescript-eslint/no-unused-vars': 'error',
+      '@typescript-eslint/no-unsafe-assignment': 'error',
+      '@typescript-eslint/no-unsafe-member-access': 'error',
+      '@typescript-eslint/no-unsafe-return': 'error',
     },
   },
 ];

package/templates/default/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "smoz-template-default",
+  "private": true,
+  "type": "module",
+  "version": "0.0.0",
+  "dependencies": {
+    "@middy/core": "^6.4.5",
+    "zod": "^4.1.6"
+  },
+  "devDependencies": {
+    "@serverless/typescript": "^4.18.2",
+    "@types/node": "^22",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "jiti": "^2.5.1",
+    "prettier": "^3.6.2",
+    "serverless": "^4.18.2",
+    "serverless-apigateway-log-retention": "^1.1.0",
+    "serverless-deployment-bucket": "^1.6.0",
+    "serverless-domain-manager": "^8.0.0",
+    "serverless-offline": "^14.4.0",
+    "serverless-plugin-common-excludes": "^4.0.0",
+    "tsx": "^4.20.5",
+    "typedoc": "^0.28.12",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.43.0",
+    "vitest": "^3.2.4",
+    "zod-openapi": "^5.4.1"
+  },
+  "scripts": {
+    "register": "smoz register",
+    "openapi": "smoz register && tsx app/config/openapi && prettier -w app/generated/openapi.json",
+    "package": "smoz register && serverless package",
+    "dev": "smoz dev",
+    "dev:offline": "smoz dev --local offline",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest run",
+    "docs": "typedoc"
+  }
+}