vyriy 0.4.4 → 0.4.6

package/README.md

@@ -78,22 +78,17 @@ Prepares every package inside the `dist/` directory for npm publishing:
 
 Registered presets:
 
-| Key       | Description                                    |
-| --------- | ---------------------------------------------- |
-| `base`    | Minimal monorepo with config only              |
-| `library` | Workspaces layout with a sample React package  |
-| `api`     | Backend API workspace with server/build setup  |
-| `ssr`     | Server-rendered React API with CMS placeholder |
-| `ssg`     | Static site generation workspace               |
-| `spa`     | Single-page application                        |
-
-Presets in progress:
-
-| Key    | Direction              |
-| ------ | ---------------------- |
-| `rest` | REST API project       |
-| `gql`  | GraphQL API project    |
-| `mfe`  | Micro-frontend project |
+| Key       | Description                                       |
+| --------- | ------------------------------------------------- |
+| `base`    | Preset to create minimal monorepo with configs    |
+| `library` | Preset to create js/react library                 |
+| `api`     | Preset to create simple API                       |
+| `ssr`     | Preset to create Server Side Rendering (SSR) API  |
+| `ssg`     | Preset to create Static site generation (SSG)     |
+| `spa`     | Preset to create Single-page application (SPA)    |
+| `rest`    | Preset to create simple REST API                  |
+| `gql`     | Preset to create GraphQL API                      |
+| `mfe`     | Preset to create Micro-frontend (MFE) application |
 
 Registered presets are selectable by the wizard. In-progress presets exist as
 source modules and are expected to become selectable as their generated project

package/commands/create/plan/plan.d.ts

@@ -2,7 +2,7 @@ export declare const plan: (dirName: string, appPath: string) => Promise<{
     name: string;
     description: string;
     target: string;
-    preset: "ssr" | "base" | "api" | "library" | "ssg" | "spa";
+    preset: "ssr" | "base" | "rest" | "api" | "library" | "ssg" | "spa";
     scope: string | undefined;
     ci: import("../preset/types.js").CiProvider | undefined;
     deploy: import("../preset/types.js").DeployProvider | undefined;

package/commands/create/preset/index.d.ts

@@ -29,4 +29,9 @@ export declare const presets: {
         description: string;
         preset: import("./types.js").Preset;
     };
+    rest: {
+        name: string;
+        description: string;
+        preset: import("./types.js").Preset;
+    };
 };

package/commands/create/preset/index.js

@@ -4,6 +4,7 @@ import { api } from './api.js';
 import { ssr } from './ssr.js';
 import { ssg } from './ssg.js';
 import { spa } from './spa.js';
+import { rest } from './rest.js';
 export const presets = {
     base: {
         name: 'Base',
@@ -35,4 +36,9 @@ export const presets = {
         description: 'Preset for Single Page Application (SPA)',
         preset: spa,
     },
+    rest: {
+        name: 'REST',
+        description: 'Preset for simple REST API',
+        preset: rest,
+    },
 };

package/commands/create/preset/rest.js

@@ -1,16 +1,346 @@
+import packageJson from '../../../package.json' with { type: 'json' };
 import { base } from './base.js';
 export const rest = {
     files: (options) => ({
         ...base.files(options),
-    }),
-    ci: {
-        github: {
-            '.gitlab-ci.yml': 'code',
+        'package.json': JSON.stringify({
+            name: options.name,
+            version: '0.0.0',
+            description: options.description,
+            private: true,
+            type: 'module',
+            agents: './AGENTS.md',
+            packageManager: packageJson.packageManager,
+            engines: {
+                node: packageJson.engines.node,
+            },
+            workspaces: [
+                'workspaces/*',
+            ],
+            scripts: {
+                storybook: 'cross-env STORYBOOK_DISABLE_TELEMETRY=1 storybook dev -p 6006 --disable-telemetry',
+                check: 'run-s lint build test',
+                fix: "run-s 'fix:*'",
+                start: "run-p 'start:*'",
+                lint: "run-s 'lint:*'",
+                build: "run-s 'build:*'",
+                test: "run-s 'test:*'",
+                'fix:prettier': 'prettier . --write',
+                'fix:eslint': 'eslint . --fix',
+                'start:api': 'sh workspaces/api/bin/start.sh',
+                'lint:ts': 'tsc',
+                'lint:prettier': 'prettier . --check',
+                'lint:eslint': 'eslint .',
+                'build:api': 'rimraf dist && sh workspaces/api/bin/build.sh',
+                'build:storybook': 'cross-env STORYBOOK_DISABLE_TELEMETRY=1 storybook build --quiet --disable-telemetry',
+                'test:jest': 'jest',
+                postinstall: 'husky',
+            },
+            dependencies: {
+                '@vyriy/typescript-config': `^${packageJson.version}`,
+                typescript: packageJson.peerDependencies.typescript,
+                '@vyriy/prettier-config': `^${packageJson.version}`,
+                prettier: packageJson.peerDependencies.prettier,
+                '@vyriy/eslint-config': `^${packageJson.version}`,
+                eslint: packageJson.peerDependencies.eslint,
+                '@vyriy/jest-config': `^${packageJson.version}`,
+                jest: packageJson.peerDependencies.jest,
+                '@vyriy/storybook-config': `^${packageJson.version}`,
+                storybook: packageJson.peerDependencies.storybook,
+                '@vyriy/path': `^${packageJson.version}`,
+                vyriy: `^${packageJson.version}`,
+                husky: packageJson.peerDependencies.husky,
+                'npm-run-all2': packageJson.peerDependencies['npm-run-all2'],
+                'cross-env': packageJson.peerDependencies['cross-env'],
+                rimraf: packageJson.peerDependencies.rimraf,
+                '@vyriy/webpack-config': `^${packageJson.version}`,
+                '@vyriy/handler': `^${packageJson.version}`,
+                '@vyriy/server': `^${packageJson.version}`,
+                tsx: packageJson.peerDependencies.tsx,
+                webpack: packageJson.peerDependencies.webpack,
+                'webpack-cli': packageJson.peerDependencies['webpack-cli'],
+                '@vyriy/router': `^${packageJson.version}`,
+                '@vyriy/html': `^${packageJson.version}`,
+            },
+        }, null, 2) + '\n',
+        'workspaces/api/bin/build.sh': `#!/usr/bin/env sh
+
+set -e
+
+scriptdir="$PWD/workspaces/api";
+
+NODE_ENV=production npx webpack --config $scriptdir/webpack.config.ts
+
+cp $scriptdir/package.json dist/api/package.json
+npm pkg delete "type" --prefix dist/api
+npm pkg delete "private" --prefix dist/api
+`,
+        'workspaces/api/bin/start.sh': `#!/usr/bin/env sh
+
+set -e
+
+scriptdir="$PWD/workspaces/api";
+
+NODE_ENV=production LOG_LEVEL=info tsx $scriptdir/index.ts
+`,
+        'workspaces/api/doc.mdx': `import { Meta, Markdown } from '@storybook/addon-docs/blocks';
+import ReadMe from './README.md?raw';
+
+<Meta title="Workspaces/API" />
+
+<Markdown>{ReadMe}</Markdown>
+`,
+        'workspaces/api/README.md': `# ${options.name} API\n\n${options.description}\n`,
+        'workspaces/api/webpack.config.ts': `import { path } from '@vyriy/path';
+import { ssr, external } from '@vyriy/webpack-config';
+
+export default ssr(
+  '@w/api',
+  {
+    path: path('dist', 'api'),
+    filename: 'index.js',
+    library: { type: 'commonjs2' },
+  },
+  (config) => ({
+    ...config,
+    externals: [external({ allowlist: [/^@p/, /^@w/, /^@vyriy/] })],
+  }),
+);
+`,
+        'workspaces/api/package.json': JSON.stringify({
+            name: '@w/api',
+            type: 'module',
+            private: true,
+        }, null, 2) + '\n',
+        'workspaces/api/index.ts': `import { server } from '@vyriy/server';
+import { api } from '@vyriy/handler';
+import { createRouter } from '@vyriy/router';
+import { html, minify } from '@vyriy/html';
+
+const router = createRouter();
+
+router.get('/api/test', async () => {
+  return Promise.resolve({
+    headers: {
+      'content-type': 'application/json',
+    },
+    body: JSON.stringify({ test: 'ok' }),
+  });
+});
+
+router.get('/openapi.json', async () => {
+  return Promise.resolve({
+    headers: {
+      'content-type': 'application/json',
+    },
+    body: JSON.stringify({
+      openapi: '3.0.0',
+      info: {
+        title: 'REST API',
+        description: 'A minimal example of an OpenAPI definition in JSON format.',
+        version: '1.0.0',
+      },
+      servers: [
+        {
+          url: 'http://localhost:3000',
+          description: 'Local server',
+        },
+      ],
+      paths: {
+        '/api/test': {
+          get: {
+            summary: 'Test endpoint',
+            operationId: 'getTest',
+            responses: {
+              '200': {
+                description: 'A successful test response',
+                content: {
+                  'application/json': {
+                    schema: {
+                      $ref: '#/components/schemas/TestResponse',
+                    },
+                    example: {
+                      test: 'ok',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      components: {
+        schemas: {
+          TestResponse: {
+            type: 'object',
+            required: ['test'],
+            properties: {
+              test: {
+                type: 'string',
+                example: 'ok',
+              },
+            },
+          },
         },
+      },
+    }),
+  });
+});
+
+router.get('/', async () => {
+  return Promise.resolve({
+    headers: {
+      'content-type': 'text/html; charset=utf-8',
     },
-    deploy: {
-        docker: {
-            Dockerfile: 'code',
+    body: minify(
+      html({
+        title: '<title>REST API</title>',
+        meta: '<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />',
+        body: [
+          '<div id="app"></div>',
+          '<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>',
+          "<script>Scalar.createApiReference('#app', { url: '/openapi.json' })</script>",
+        ].join(''),
+      }),
+    ),
+  });
+});
+
+server(api(async (event) => router.route(event)));
+`,
+        'workspaces/api/index.test.ts': `import { describe, expect, it, jest } from '@jest/globals';
+import type { APIGatewayProxyEvent } from '@vyriy/router';
+
+const apiMock = jest.fn((handler) => ({
+  handler,
+}));
+const serverMock = jest.fn();
+
+jest.mock('@vyriy/handler', () => ({
+  api: apiMock,
+}));
+
+jest.mock('@vyriy/server', () => ({
+  server: serverMock,
+}));
+
+describe('workspaces/api/index.ts', () => {
+  const getEvent = (path: string): APIGatewayProxyEvent =>
+    ({
+      body: null,
+      headers: {},
+      httpMethod: 'GET',
+      path,
+      pathParameters: null,
+      queryStringParameters: null,
+    }) as APIGatewayProxyEvent;
+
+  it('starts the server with the API router handler', async () => {
+    await import('./index.js');
+
+    expect(apiMock).toHaveBeenCalledTimes(1);
+    expect(serverMock).toHaveBeenCalledTimes(1);
+    expect(serverMock).toHaveBeenCalledWith(apiMock.mock.results[0]?.value);
+
+    const handler = apiMock.mock.calls[0]?.[0] as (event: APIGatewayProxyEvent) => Promise<{
+      body: string;
+      headers?: Record<string, string>;
+      statusCode: number;
+    }>;
+
+    await expect(handler(getEvent('/api/test'))).resolves.toEqual({
+      body: JSON.stringify({
+        test: 'ok',
+      }),
+      headers: {
+        'content-type': 'application/json',
+      },
+      statusCode: 200,
+    });
+
+    const openApiResponse = await handler(getEvent('/openapi.json'));
+
+    expect(openApiResponse).toEqual({
+      body: expect.any(String),
+      headers: {
+        'content-type': 'application/json',
+      },
+      statusCode: 200,
+    });
+    expect(JSON.parse(openApiResponse.body)).toEqual({
+      components: {
+        schemas: {
+          TestResponse: {
+            properties: {
+              test: {
+                example: 'ok',
+                type: 'string',
+              },
+            },
+            required: ['test'],
+            type: 'object',
+          },
+        },
+      },
+      info: {
+        description: 'A minimal example of an OpenAPI definition in JSON format.',
+        title: 'REST API',
+        version: '1.0.0',
+      },
+      openapi: '3.0.0',
+      paths: {
+        '/api/test': {
+          get: {
+            operationId: 'getTest',
+            responses: {
+              '200': {
+                content: {
+                  'application/json': {
+                    example: {
+                      test: 'ok',
+                    },
+                    schema: {
+                      $ref: '#/components/schemas/TestResponse',
+                    },
+                  },
+                },
+                description: 'A successful test response',
+              },
+            },
+            summary: 'Test endpoint',
+          },
+        },
+      },
+      servers: [
+        {
+          description: 'Local server',
+          url: 'http://localhost:3000',
         },
+      ],
+    });
+
+    const docsResponse = await handler(getEvent('/'));
+
+    expect(docsResponse).toEqual({
+      body: expect.stringContaining("Scalar.createApiReference('#app', { url: '/openapi.json' })"),
+      headers: {
+        'content-type': 'text/html; charset=utf-8',
+      },
+      statusCode: 200,
+    });
+
+    await expect(handler(getEvent('/healthcheck'))).resolves.toEqual({
+      body: JSON.stringify({
+        message: 'Not Found',
+      }),
+      statusCode: 404,
+    });
+  });
+});
+`,
+    }),
+    ci: {
+        ...base.ci,
     },
+    deploy: {},
 };

package/commands/create/preset/spa.js

@@ -93,56 +93,56 @@ extends @vyriy/browserslist-config
         'packages/components/index.ts': "export * from './page/index.js';\n",
         'packages/components/index.test.tsx': `import { describe, expect, it } from '@jest/globals';
 
-    import { Page } from './index.js';
-    import { Page as PageImplementation } from './page/index.js';
-
-    describe('packages/components/page', () => {
-      it('re-exports the page component', () => {
-        expect(Page).toBe(PageImplementation);
-      });
-    });
-    `,
+import { Page } from './index.js';
+import { Page as PageImplementation } from './page/index.js';
+
+describe('packages/components/page', () => {
+  it('re-exports the page component', () => {
+    expect(Page).toBe(PageImplementation);
+  });
+});
+`,
         'packages/components/page/index.ts': `export * from './page.js';
-    export type * from './types.js';
-    `,
+export type * from './types.js';
+`,
         'packages/components/page/index.test.ts': `import { describe, expect, it } from '@jest/globals';
 
-    import { Page } from './index.js';
-    import { Page as PageImplementation } from './page.js';
+import { Page } from './index.js';
+import { Page as PageImplementation } from './page.js';
 
-    describe('packages/components/page', () => {
-      it('re-exports the page component', () => {
-        expect(Page).toBe(PageImplementation);
-      });
-    });
-    `,
+describe('packages/components/page', () => {
+  it('re-exports the page component', () => {
+    expect(Page).toBe(PageImplementation);
+  });
+});
+`,
         'packages/components/page/types.ts': `import { FC } from 'react';
 
-    export type PageProps = {
-      content: string;
-    };
+export type PageProps = {
+  content: string;
+};
 
-    export type PageType = FC<PageProps>;
-    `,
+export type PageType = FC<PageProps>;
+`,
         'packages/components/page/page.tsx': `import type { PageType } from './types.js';
 
-    export const Page: PageType = ({ content }) => <div className="content">{content}</div>;
-    `,
+export const Page: PageType = ({ content }) => <div className="content">{content}</div>;
+`,
         'packages/components/page/styles.scss': `.content {
-      display: block;
-    }
-    `,
+  display: block;
+}
+`,
         'packages/components/page/page.test.tsx': `import { renderToStaticMarkup } from 'react-dom/server';
-    import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from '@jest/globals';
 
-    import { Page } from './page.js';
+import { Page } from './page.js';
 
-    describe('packages/components/page/page', () => {
-      it('renders content inside the page content container', () => {
-        expect(renderToStaticMarkup(<Page content="Page body" />)).toBe('<div class="content">Page body</div>');
-      });
-    });
-    `,
+describe('packages/components/page/page', () => {
+  it('renders content inside the page content container', () => {
+    expect(renderToStaticMarkup(<Page content="Page body" />)).toBe('<div class="content">Page body</div>');
+  });
+});
+`,
         'workspaces/spa/bin/build.sh': `#!/usr/bin/env sh
 
 set -e
@@ -160,12 +160,12 @@ scriptdir="$PWD/workspaces/spa";
 npx webpack serve --open --config $scriptdir/webpack.config.ts
 `,
         'workspaces/spa/doc.mdx': `import { Meta, Markdown } from '@storybook/addon-docs/blocks';
-    import ReadMe from './README.md?raw';
+import ReadMe from './README.md?raw';
 
-    <Meta title="Workspaces/SPA" />
+<Meta title="Workspaces/SPA" />
 
-    <Markdown>{ReadMe}</Markdown>
-    `,
+<Markdown>{ReadMe}</Markdown>
+`,
         'workspaces/spa/README.md': `# ${options.name} SPA\n\n${options.description}\n`,
         'workspaces/spa/webpack.config.ts': `import { csr, html } from '@vyriy/webpack-config';
 import { path } from '@vyriy/path';

package/commands/create/preset/ssg.js

@@ -82,84 +82,84 @@ export const ssg = {
         'packages/components/index.ts': "export * from './page/index.js';\n",
         'packages/components/index.test.tsx': `import { describe, expect, it } from '@jest/globals';
 
-  import { Page } from './index.js';
-  import { Page as PageImplementation } from './page/index.js';
+import { Page } from './index.js';
+import { Page as PageImplementation } from './page/index.js';
 
-  describe('packages/components/page', () => {
-    it('re-exports the page component', () => {
-      expect(Page).toBe(PageImplementation);
-    });
+describe('packages/components/page', () => {
+  it('re-exports the page component', () => {
+    expect(Page).toBe(PageImplementation);
   });
-  `,
+});
+`,
         'packages/components/page/index.ts': `export * from './page.js';
-  export type * from './types.js';
-  `,
+export type * from './types.js';
+`,
         'packages/components/page/index.test.ts': `import { describe, expect, it } from '@jest/globals';
 
-  import { Page } from './index.js';
-  import { Page as PageImplementation } from './page.js';
+import { Page } from './index.js';
+import { Page as PageImplementation } from './page.js';
 
-  describe('packages/components/page', () => {
-    it('re-exports the page component', () => {
-      expect(Page).toBe(PageImplementation);
-    });
+describe('packages/components/page', () => {
+  it('re-exports the page component', () => {
+    expect(Page).toBe(PageImplementation);
   });
-  `,
+});
+`,
         'packages/components/page/types.ts': `import { FC } from 'react';
 
-  export type PageProps = {
-    content: string;
-  };
+export type PageProps = {
+  content: string;
+};
 
-  export type PageType = FC<PageProps>;
-  `,
+export type PageType = FC<PageProps>;
+`,
         'packages/components/page/page.tsx': `import type { PageType } from './types.js';
 
-  export const Page: PageType = ({ content }) => <div className="content">{content}</div>;
-  `,
+export const Page: PageType = ({ content }) => <div className="content">{content}</div>;
+`,
         'packages/components/page/styles.scss': `.content {
-    display: block;
-  }
-  `,
+  display: block;
+}
+`,
         'packages/components/page/page.test.tsx': `import { renderToStaticMarkup } from 'react-dom/server';
-  import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from '@jest/globals';
 
-  import { Page } from './page.js';
+import { Page } from './page.js';
 
-  describe('packages/components/page/page', () => {
-    it('renders content inside the page content container', () => {
-      expect(renderToStaticMarkup(<Page content="Page body" />)).toBe('<div class="content">Page body</div>');
-    });
+describe('packages/components/page/page', () => {
+  it('renders content inside the page content container', () => {
+    expect(renderToStaticMarkup(<Page content="Page body" />)).toBe('<div class="content">Page body</div>');
   });
-  `,
+});
+`,
         'packages/services/package.json': JSON.stringify({
             name: '@p/services',
             private: true,
             type: 'module',
         }, null, 2) + '\n',
         'packages/services/cms/index.ts': `export const cms = {
-    getContent: async () => {
-      // Placeholder for fetching content from a CMS
-      return Promise.resolve({
-        title: 'Sample Content',
-        body: 'This is a sample content fetched from the CMS.',
-      });
-    },
-  };
-  `,
+  getContent: async () => {
+    // Placeholder for fetching content from a CMS
+    return Promise.resolve({
+      title: 'Sample Content',
+      body: 'This is a sample content fetched from the CMS.',
+    });
+  },
+};
+`,
         'packages/services/cms/index.test.ts': `import { describe, expect, it } from '@jest/globals';
 
-  import { cms } from './index.js';
+import { cms } from './index.js';
 
-  describe('packages/services/cms', () => {
-    it('returns content for rendering a page', async () => {
-      await expect(cms.getContent()).resolves.toEqual({
-        title: 'Sample Content',
-        body: 'This is a sample content fetched from the CMS.',
-      });
+describe('packages/services/cms', () => {
+  it('returns content for rendering a page', async () => {
+    await expect(cms.getContent()).resolves.toEqual({
+      title: 'Sample Content',
+      body: 'This is a sample content fetched from the CMS.',
     });
   });
-  `,
+});
+`,
         'workspaces/ssg/bin/build.sh': `#!/usr/bin/env sh
 
 set -e
@@ -187,29 +187,29 @@ yarn exec sass packages/components/page/styles.scss "$distdir/styles.css" --no-s
 PROJECT_CWD="$distdir" NODE_ENV=production LOG_LEVEL=info "$PWD/node_modules/.bin/tsx" $scriptdir/index.tsx
 `,
         'workspaces/ssg/doc.mdx': `import { Meta, Markdown } from '@storybook/addon-docs/blocks';
-  import ReadMe from './README.md?raw';
+import ReadMe from './README.md?raw';
 
-  <Meta title="Workspaces/SSG" />
+<Meta title="Workspaces/SSG" />
 
-  <Markdown>{ReadMe}</Markdown>
-  `,
+<Markdown>{ReadMe}</Markdown>
+`,
         'workspaces/ssg/README.md': `# ${options.name} SSG\n\n${options.description}\n`,
         'workspaces/ssg/webpack.config.ts': `import { path } from '@vyriy/path';
-  import { ssr, external } from '@vyriy/webpack-config';
-
-  export default ssr(
-    '@w/ssg',
-    {
-      path: path('dist', 'ssg'),
-      filename: 'index.js',
-      library: { type: 'commonjs2' },
-    },
-    (config) => ({
-      ...config,
-      externals: [external({ allowlist: [/^@p/, /^@w/, /^@vyriy/] })],
-    }),
-  );
-  `,
+import { ssr, external } from '@vyriy/webpack-config';
+
+export default ssr(
+  '@w/ssg',
+  {
+    path: path('dist', 'ssg'),
+    filename: 'index.js',
+    library: { type: 'commonjs2' },
+  },
+  (config) => ({
+    ...config,
+    externals: [external({ allowlist: [/^@p/, /^@w/, /^@vyriy/] })],
+  }),
+);
+`,
         'workspaces/ssg/package.json': JSON.stringify({
             name: '@w/ssg',
             type: 'module',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vyriy",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "Interactive project master for calm cloud-ready applications.",
   "type": "module",
   "bin": "./bin/vyriy.js",
@@ -29,9 +29,6 @@
     "webpack-cli": "^7.0.2"
   },
   "peerDependenciesMeta": {
-    "@storybook/react-webpack5": {
-      "optional": true
-    },
     "@types/react": {
       "optional": true
     },