@karmaniverous/smoz 0.1.8 → 0.2.1

package/templates/default/serverless.ts

@@ -0,0 +1,113 @@
+import type { AWS } from '@serverless/typescript';
+
+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/serverless registration) and to
+ *   satisfy noUncheckedSideEffectImports, import register modules as namespaces
+ *   and reference them via `void`.
+ * - In real apps, `smoz init` seeds placeholders and `smoz register` rewrites
+ *   app/generated/register.*.ts at author time.
+ */
+import * as __register_functions from '@/app/generated/register.functions';
+import * as __register_serverless from '@/app/generated/register.serverless';
+void __register_functions;
+void __register_serverless;
+
+const config: AWS = {
+  service: '${param:SERVICE_NAME}',
+  frameworkVersion: '4',
+  plugins: [
+    'serverless-apigateway-log-retention',
+    'serverless-deployment-bucket',
+    'serverless-domain-manager',
+    'serverless-plugin-common-excludes',
+    'serverless-offline',
+  ],
+  package: {
+    individually: true,
+    patterns: ['!**/?(*.)test.+(!(.))'],
+  },
+  custom: {
+    apiGatewayLogRetention: {
+      accessLogging: {
+        enabled: true,
+        days: 5,
+      },
+      executionLogging: {
+        enabled: false,
+      },
+    },
+    customDomain: {
+      autoDomain: true,
+      basePath: '',
+      certificateArn: '${param:DOMAIN_CERTIFICATE_ARN}',
+      domainName: '${param:DOMAIN_NAME}',
+      preserveExternalPathMappings: true,
+    },
+    deploymentBucket: {
+      accelerate: true,
+      blockPublicAccess: true,
+    },
+    // Local emulation defaults (serverless-offline)
+    'serverless-offline': {
+      httpPort: 3000,
+      noPrependStageInUrl: true,
+    },
+  },
+  stages: app.stages as NonNullable<AWS['stages']>,
+  provider: {
+    apiGateway: {
+      apiKeys: ['${param:SERVICE_NAME}-${param:STAGE}'],
+      disableDefaultEndpoint: true,
+    },
+    apiName: '${param:SERVICE_NAME}',
+    deploymentBucket: {
+      name: '${param:SERVICE_NAME}-deployment',
+      serverSideEncryption: 'AES256',
+    },
+    deploymentMethod: 'direct',
+    endpointType: 'edge',
+    environment: app.environment as NonNullable<AWS['provider']['environment']>,
+    iam: {
+      role: {
+        managedPolicies: [
+          'arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy',
+        ],
+        statements: [{ Effect: 'Allow', Action: '*', Resource: '*' }],
+      },
+    },
+    logRetentionInDays: 5,
+    logs: {
+      lambda: { applicationLogLevel: 'DEBUG', logFormat: 'JSON' },
+      restApi: {
+        accessLogging: true,
+        executionLogging: false,
+        format:
+          '{ "accountId": "$context.accountId", "apiId": "$context.apiId", "domainName": "$context.domainName", "domainPrefix": "$context.domainPrefix", "error": { "message": "$context.error.message", "responseType": "$context.error.responseType" }, "extendedRequestId": "$context.extendedRequestId", "httpMethod": "$context.httpMethod", "identity" { "accountId": "$context.identity.accountId", "apiKey": "$context.identity.apiKey", "caller": "$context.identity.caller", "clientCert": { "clientCertPem": "$context.identity.clientCert.clientCertPem", "subjectDN": "$context.identity.clientCert.subjectDN", "issuerDN": "$context.identity.clientCert.issuerDN", "serialNumber": "$context.identity.clientCert.serialNumber", "validity": { "notBefore": "$context.identity.clientCert.validity.notBefore", "notAfter": "$context.identity.clientCert.validity.notAfter" } }, "sourceIp": "$context.identity.sourceIp", "user": "$context.identity.user", "userArn": "$context.identity.userArn", "userAgent": "$context.identity.userAgent", }, "integration": { "latency": "$context.integration.latency" }, "path": "$context.path", "protocol": "$context.protocol", "requestId": "$context.requestId", "requestTime": "$context.requestTime", "requestTimeEpoch": "$context.requestTimeEpoch", "resourceId": "$context.resourceId", "resourcePath": "$context.resourcePath", "stage": "$context.stage", "responseLatency": "$context.responseLatency", "responseLength": "$context.responseLength", "status": "$context.status" }',
+      },
+    },
+    memorySize: 256,
+    name: 'aws',
+    region: '${param:REGION}' as NonNullable<AWS['provider']['region']>,
+    runtime: 'nodejs22.x',
+    profile: '${param:PROFILE}',
+    stackName: '${param:SERVICE_NAME}-${param:STAGE}',
+    stackTags: {
+      service: '${param:SERVICE_NAME}',
+      stage: '${param:STAGE}',
+    },
+    stage: '${opt:stage, "dev"}',
+    tracing: {
+      apiGateway: true,
+      lambda: true,
+    },
+    versionFunctions: false,
+  },
+  functions: app.buildAllServerlessFunctions() as NonNullable<AWS['functions']>,
+};
+
+export default config;

package/templates/default/tsconfig.eslint.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./*"],
+      "@karmaniverous/smoz": [
+        "../../.stan/dist/index.d.ts",
+        "../../dist/index.d.ts"
+      ]
+    }
+  }
+}

package/templates/{minimal → default}/types/registers.d.ts

@@ -1,11 +1,11 @@
-// Ambient declarations to satisfy template typechecking without requiring
-// generated register files to exist on disk.
-declare module '@/app/generated/register.functions' {
-  export {};
-}
-declare module '@/app/generated/register.openapi' {
-  export {};
-}
-declare module '@/app/generated/register.serverless' {
-  export {};
-}
+// Ambient declarations to satisfy template typechecking without requiring
+// generated register files to exist on disk.
+declare module '@/app/generated/register.functions' {
+  export {};
+}
+declare module '@/app/generated/register.openapi' {
+  export {};
+}
+declare module '@/app/generated/register.serverless' {
+  export {};
+}

package/templates/.check/eslint.minimal.config.ts

@@ -1,41 +0,0 @@
-import eslint from '@eslint/js';
-import prettierConfig from 'eslint-config-prettier';
-import prettierPlugin from 'eslint-plugin-prettier';
-import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort';
-import tseslint from 'typescript-eslint';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-const tsconfigRootDir = dirname(fileURLToPath(import.meta.url));
-
-export default tseslint.config(
-  {    ignores: [
-      '**/node_modules/**',
-      '**/dist/**',
-      '**/.tsbuild/**',
-    ],
-  },
-  eslint.configs.recommended,
-  tseslint.configs.strictTypeChecked,
-  prettierConfig,
-  {
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        project: ['./tsconfig.minimal.json'],
-        tsconfigRootDir,
-      },
-    },
-    plugins: {      prettier: prettierPlugin,
-      'simple-import-sort': simpleImportSortPlugin,
-    },
-    rules: {
-      '@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',
-    },
-  },
-);

package/templates/.check/eslint.templates.config.ts

@@ -1,60 +0,0 @@
-import eslint from '@eslint/js';
-import prettierConfig from 'eslint-config-prettier';
-import prettierPlugin from 'eslint-plugin-prettier';
-import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort';
-import { dirname } from 'path';
-import tseslint from 'typescript-eslint';
-import { fileURLToPath } from 'url';
-
-// Unified ESLint config for all templates under templates/*
-// - Uses projectService so type info is picked up from each template's tsconfig.json
-// - ESLint drives Prettier via 'prettier/prettier': 'error'
-const tsconfigRootDir = dirname(fileURLToPath(import.meta.url));
-
-export default [
-  {
-    ignores: [
-      '**/node_modules/**',
-      '**/dist/**',
-      '**/.tsbuild/**',
-      '**/generated/**',
-      '**/.check/**',
-    ],
-  },
-  eslint.configs.recommended,
-  ...tseslint.configs.strictTypeChecked,
-  prettierConfig,
-  {
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        // Let the project service discover the nearest tsconfig.json per file
-        // (typed where possible; falls back to default project when unmatched).
-        project: true,
-        projectService: true,
-        allowDefaultProject: true,
-        tsconfigRootDir,
-      },
-    },
-    plugins: {
-      prettier: prettierPlugin,
-      'simple-import-sort': simpleImportSortPlugin,
-    },
-    rules: {
-      // Formatting via Prettier
-      'prettier/prettier': 'error',
-      // Code-quality and sorting
-      '@typescript-eslint/consistent-type-imports': 'error',
-      '@typescript-eslint/no-empty-object-type': 'off',
-      '@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',
-      // Keep strictness reasonable for templates
-      '@typescript-eslint/no-unsafe-assignment': 'error',
-      '@typescript-eslint/no-unsafe-member-access': 'error',
-      '@typescript-eslint/no-unsafe-return': 'error',
-    },
-  },
-];

package/templates/.check/tsconfig.eslintconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "../project/tsconfig.base.json",
-  "include": [
-    "./eslint.templates.config.ts"
-  ]
-}

package/templates/.check/tsconfig.minimal.json

@@ -1,14 +0,0 @@
-{
-  "extends": "../project/tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "../../templates/minimal",
-    "baseUrl": "../../templates/minimal",
-    "paths": {
-      "@/*": ["*"],
-      "@karmaniverous/smoz": ["../../.stan/dist/index.d.ts"]
-    },
-    "types": ["node"]
-  },  "include": [
-    "../../templates/minimal/**/*.ts"
-  ]
-}

package/templates/.manifests/package.full.json

@@ -1,22 +0,0 @@
-{
-  "dependencies": {
-    "@middy/core": "^6.4.4",
-    "zod": "^4.1.5"
-  },
-  "devDependencies": {
-    "eslint": "^9.34.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",
-    "typedoc": "^0.28.11",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
-    "vitest": "^3.2.4"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
-  }
-}

package/templates/.manifests/package.minimal.json

@@ -1,22 +0,0 @@
-{
-  "dependencies": {
-    "@middy/core": "^6.4.4",
-    "zod": "^4.1.5"
-  },
-  "devDependencies": {
-    "eslint": "^9.34.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",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
-    "vitest": "^3.2.4"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "test": "vitest run",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
-  }
-}

package/templates/.manifests/package.project.json

@@ -1,24 +0,0 @@
-{
-  "dependencies": {
-    "@middy/core": "^6.4.4",
-    "zod": "^4.1.5"
-  },
-  "devDependencies": {
-    "eslint": "^9.34.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",
-    "typedoc": "^0.28.11",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.41.0",
-    "vitest": "^3.2.4"
-  },
-  "scripts": {
-    "docs": "typedoc",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
-    "test": "vitest run",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
-  }
-}

package/templates/full/app/config/app.config.ts

@@ -1,50 +0,0 @@
-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: ['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/full/app/config/openapi.ts

@@ -1,44 +0,0 @@
-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 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/app/functions/rest/hello/get/openapi.ts

@@ -1,19 +0,0 @@
-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'],
-});

package/templates/full/app/functions/rest/openapi/get/handler.ts

@@ -1,20 +0,0 @@
-import type { z } from 'zod';
-
-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 () => {
-  // Trivial await to mirror minimal template style
-  await Promise.resolve();
-  return openapiDoc as Response;
-});

package/templates/full/app/functions/rest/openapi/get/lambda.ts

@@ -1,29 +0,0 @@
-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/app/functions/sqs/tick/handler.ts

@@ -1,7 +0,0 @@
-import { fn } from './lambda';
-
-export const handler = fn.handler((event) => {
-  // process SQS batch event
-  void event;
-  // no response payload (void)
-});

package/templates/full/app/functions/sqs/tick/lambda.ts

@@ -1,24 +0,0 @@
-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();
-export const responseSchema = z.void();
-
-type FnApi = {
-  handler: <T>(
-    impl: (e: unknown) => Promise<T> | T,
-  ) => (...args: unknown[]) => Promise<T>;
-  serverless: (extras: unknown) => void;
-};
-
-export const fn = app.defineFunction({
-  eventType: 'sqs',
-  eventSchema,
-  responseSchema,
-  callerModuleUrl: import.meta.url,
-  endpointsRootAbs: toPosixPath(join(APP_ROOT_ABS, 'functions', 'sqs')),
-}) as unknown as FnApi;

package/templates/full/app/functions/sqs/tick/serverless.ts

@@ -1,8 +0,0 @@
-import { fn } from './lambda';
-
-// Attach SQS trigger (replace ARN with your queue)
-fn.serverless([
-  {
-    sqs: { arn: 'arn:aws:sqs:us-east-1:000000000000:my-queue' },
-  },
-]);

package/templates/full/serverless.ts

@@ -1,33 +0,0 @@
-import type { AWS } from '@serverless/typescript';
-
-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 so TypeScript can typecheck without artifacts.
- * - To ensure side effects still run (endpoint/serverless registration) and to
- *   satisfy noUncheckedSideEffectImports, import register modules as namespaces
- *   and reference them via `void`.
- * - In real apps, `smoz init` seeds placeholders and `smoz register` rewrites
- *   app/generated/register.*.ts at author time.
- */
-import * as __register_functions from '@/app/generated/register.functions';
-import * as __register_serverless from '@/app/generated/register.serverless';
-void __register_functions;
-void __register_serverless;
-
-const config: AWS = {
-  service: '${param:SERVICE_NAME}',
-  frameworkVersion: '4',
-  stages: app.stages as NonNullable<AWS['stages']>,
-  provider: {
-    name: 'aws',
-    region: '${param:REGION}' as NonNullable<AWS['provider']['region']>,
-    runtime: 'nodejs22.x',
-    environment: app.environment as NonNullable<AWS['provider']['environment']>,
-    stage: '${opt:stage, "dev"}',
-  },
-  functions: app.buildAllServerlessFunctions() as NonNullable<AWS['functions']>,
-};
-
-export default config;

package/templates/full/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": ".",
-    "outDir": ".tsbuild",
-    "paths": {
-      "@/*": ["*"],
-      "@karmaniverous/smoz": ["../../.stan/dist/index.d.ts"]
-    },
-    "typeRoots": ["../../node_modules/@types", "./node_modules/@types"],
-    "tsBuildInfoFile": ".tsbuild/tsconfig.tsbuildinfo"
-  },
-  "exclude": [
-    ".serverless/**",
-    "node_modules/**",
-    "app/generated/**",
-    "dist/**"
-  ],
-  "extends": "../project/tsconfig.base.json",
-  "include": [
-    "**/*.ts",
-    "**/*.tsx",
-    "**/*.d.ts"
-  ]
-}

package/templates/full/types/registers.d.ts

@@ -1,11 +0,0 @@
-// Ambient declarations to satisfy template typechecking without requiring
-// generated register files to exist on disk.
-declare module '@/app/generated/register.functions' {
-  export {};
-}
-declare module '@/app/generated/register.openapi' {
-  export {};
-}
-declare module '@/app/generated/register.serverless' {
-  export {};
-}

package/templates/minimal/app/functions/rest/hello/get/handler.ts

@@ -1,18 +0,0 @@
-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;
-});