vyriy 0.3.5 → 0.3.9

package/presets/createProjectFiles.js

@@ -1,179 +1,8 @@
-import { agentsTemplate } from './agentsTemplate.js';
-const json = (value) => `${JSON.stringify(value, null, 2)}\n`;
-const createRootPackageJson = ({ description, packageScope, projectName, }) => ({
-    path: 'package.json',
-    content: json({
-        name: `${packageScope}/${projectName}`,
-        version: '0.1.0',
-        description,
-        private: true,
-        type: 'module',
-        packageManager: 'yarn@4.14.1',
-        engines: {
-            node: '>=24.0.0',
-        },
-        scripts: {
-            lint: 'eslint .',
-            test: 'jest --coverage=false',
-            build: 'tsc --pretty false',
-            deploy: 'echo "Deploy is not configured yet."',
-            smoke: 'echo "Smoke checks are not configured yet."',
-            e2e: 'echo "E2E checks are not configured yet."',
-        },
-        devDependencies: {},
-        workspaces: [
-            'packages/*',
-            'workspaces/*',
-        ],
-    }),
-});
-const createPackageManifest = ({ packageScope, workspaceName, }) => ({
-    path: `packages/${workspaceName}/package.json`,
-    content: json({
-        name: `${packageScope}/${workspaceName}`,
-        version: '0.1.0',
-        private: true,
-        type: 'module',
-        main: 'index.js',
-    }),
-});
-const createPackageFiles = (plan, packagePlan) => [
-    createPackageManifest({
-        packageScope: plan.packageScope,
-        workspaceName: packagePlan.name,
-    }),
-    {
-        path: `packages/${packagePlan.name}/README.md`,
-        content: `# ${plan.packageScope}/${packagePlan.name}\n\n${plan.description}\n`,
-    },
-    {
-        path: `packages/${packagePlan.name}/index.ts`,
-        content: packagePlan.kind === 'stack' ? "export * from './stack.js';\n" : "export type * from './types.js';\n",
-    },
-    ...(packagePlan.kind === 'stack'
-        ? [
-            {
-                path: `packages/${packagePlan.name}/stack.ts`,
-                content: 'export type StackName = string;\n',
-            },
-            {
-                path: `packages/${packagePlan.name}/stack.test.ts`,
-                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('stack', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
-            },
-        ]
-        : [
-            {
-                path: `packages/${packagePlan.name}/types.ts`,
-                content: 'export type PackageName = string;\n',
-            },
-            {
-                path: `packages/${packagePlan.name}/${packagePlan.name}.test.ts`,
-                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('package', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
-            },
-        ]),
-];
-const createWorkspaceFiles = (plan, workspacePlan) => [
-    {
-        path: `workspaces/${workspacePlan.name}/package.json`,
-        content: json({
-            name: `${plan.packageScope}/${workspacePlan.name}-workspace`,
-            version: '0.1.0',
-            private: true,
-            type: 'module',
-            main: 'index.js',
-        }),
-    },
-    {
-        path: `workspaces/${workspacePlan.name}/index.ts`,
-        content: 'export type WorkspaceName = string;\n',
-    },
-    {
-        path: `workspaces/${workspacePlan.name}/${workspacePlan.name}.test.ts`,
-        content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('workspace', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
-    },
-];
-const shouldCreateStylelintConfig = (plan) => plan.features.some((feature) => [
-    'react',
-    'webpack',
-].includes(feature));
+import { createBaseFiles } from './base/createBaseFiles.js';
+import { createPackageFiles } from './packages/createPackageFiles.js';
+import { createWorkspaceFiles } from './workspaces/createWorkspaceFiles.js';
 export const createProjectFiles = (plan) => [
-    createRootPackageJson(plan),
-    {
-        path: 'README.md',
-        content: `# ${plan.projectName}\n\n${plan.description}\n`,
-    },
-    {
-        path: 'doc.mdx',
-        content: "import { Meta, Markdown } from '@storybook/addon-docs/blocks';\nimport ReadMe from './README.md?raw';\n\n<Meta title=\"Project/README\" />\n\n<Markdown>{ReadMe}</Markdown>\n",
-    },
-    {
-        path: 'AGENTS.md',
-        content: agentsTemplate,
-    },
-    {
-        path: '.editorconfig',
-        content: 'root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\nindent_style = space\nindent_size = 2\n',
-    },
-    {
-        path: '.gitignore',
-        content: 'node_modules/\ndist/\ncoverage/\n.yarn/cache/\n.env\n',
-    },
-    {
-        path: '.npmrc',
-        content: 'engine-strict=true\n',
-    },
-    {
-        path: '.nvmrc',
-        content: '24\n',
-    },
-    {
-        path: '.yarnrc.yml',
-        content: 'nodeLinker: node-modules\n',
-    },
-    {
-        path: 'yarn.lock',
-        content: '',
-    },
-    {
-        path: 'tsconfig.json',
-        content: json({
-            extends: '@vyriy/typescript-config/index.json',
-            compilerOptions: {
-                noEmit: false,
-            },
-            include: [
-                'packages/**/*.ts',
-                'packages/**/*.tsx',
-                'workspaces/**/*.ts',
-                'workspaces/**/*.tsx',
-                '*.ts',
-            ],
-        }),
-    },
-    {
-        path: 'prettier.config.ts',
-        content: "export { default } from '@vyriy/prettier-config';\n",
-    },
-    {
-        path: '.prettierignore',
-        content: 'node_modules\ndist\ncoverage\nstorybook-static\n',
-    },
-    {
-        path: 'eslint.config.ts',
-        content: "export { default } from '@vyriy/eslint-config';\n",
-    },
-    {
-        path: 'jest.config.ts',
-        content: "export { default } from '@vyriy/jest-config';\n",
-    },
-    ...(shouldCreateStylelintConfig(plan)
-        ? [
-            {
-                path: 'stylelint.config.ts',
-                content: "export { default } from '@vyriy/stylelint-config';\n",
-            },
-        ]
-        : []),
+    ...createBaseFiles(plan),
     ...plan.packages.flatMap((packagePlan) => createPackageFiles(plan, packagePlan)),
     ...plan.workspaces.flatMap((workspacePlan) => createWorkspaceFiles(plan, workspacePlan)),
 ];

package/presets/library/createLibraryUiFiles.d.ts

@@ -0,0 +1,3 @@
+import { ProjectFile } from '../../file-plan/index.js';
+import type { VyriyPackagePlan, VyriyProjectPlan } from '../../project-plan/index.js';
+export declare const createLibraryUiFiles: (plan: VyriyProjectPlan, packagePlan: VyriyPackagePlan) => ProjectFile[];

package/presets/library/createLibraryUiFiles.js

@@ -0,0 +1,127 @@
+import { packageVersion, peerDependencies, publishedPackageJson } from '../config.js';
+import { createPackageManifest } from '../packages/createPackageManifest.js';
+export const createLibraryUiFiles = (plan, packagePlan) => [
+    createPackageManifest({
+        dependencies: {
+            '@vyriy/cn': packageVersion(publishedPackageJson.version),
+        },
+        packageScope: plan.packageScope,
+        peerDependencies: {
+            react: peerDependencies.react,
+        },
+        workspaceName: packagePlan.name,
+    }),
+    {
+        path: `packages/${packagePlan.name}/README.md`,
+        content: `# ${plan.packageScope}/${packagePlan.name}\n\n${plan.description}\n`,
+    },
+    {
+        path: `packages/${packagePlan.name}/index.ts`,
+        content: "export * from './button.js';\n",
+    },
+    {
+        path: `packages/${packagePlan.name}/button.tsx`,
+        content: `import type { ComponentProps, FC } from 'react';
+import { cn } from '@vyriy/cn';
+
+import './button.scss';
+
+export type ButtonProps = ComponentProps<'button'> & {
+  readonly variant?: 'primary' | 'secondary';
+};
+
+export type ButtonType = FC<ButtonProps>;
+
+export const Button: ButtonType = ({ className, type = 'button', variant = 'primary', ...props }) => (
+  <button className={cn('button', \`button--\${variant}\`, className)} type={type} {...props} />
+);
+`,
+    },
+    {
+        path: `packages/${packagePlan.name}/button.scss`,
+        content: `.button {
+  border: 1px solid transparent;
+  border-radius: 6px;
+  cursor: pointer;
+  font: inherit;
+  padding: 0.5rem 0.875rem;
+}
+
+.button--primary {
+  background: #1f6feb;
+  color: #fff;
+}
+
+.button--secondary {
+  background: #fff;
+  border-color: #d0d7de;
+  color: #24292f;
+}
+`,
+    },
+    {
+        path: `packages/${packagePlan.name}/styles.d.ts`,
+        content: "declare module '*.scss';\n",
+    },
+    {
+        path: `packages/${packagePlan.name}/button.stories.tsx`,
+        content: `import type { Meta, StoryObj } from '@storybook/react-webpack5';
+
+import { Button } from './button.js';
+
+const meta = {
+  title: 'UI/Button',
+  component: Button,
+  args: {
+    children: 'Button',
+  },
+} satisfies Meta<typeof Button>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Primary: Story = {};
+
+export const Secondary: Story = {
+  args: {
+    variant: 'secondary',
+  },
+};
+`,
+    },
+    {
+        path: `packages/${packagePlan.name}/button.test.tsx`,
+        content: `import type { ReactElement } from 'react';
+import { describe, expect, it } from '@jest/globals';
+
+import { Button } from './button.js';
+
+type ButtonElement = ReactElement<{
+  readonly className: string;
+  readonly type: string;
+}>;
+
+describe('Button', () => {
+  it('creates a primary button by default', () => {
+    const element = Button({ children: 'Save' }) as ButtonElement;
+
+    expect(element.props.className).toBe('button button--primary');
+    expect(element.props.type).toBe('button');
+  });
+
+  it('composes secondary and custom classes', () => {
+    const element = Button({
+      children: 'Cancel',
+      className: 'wide',
+      type: 'submit',
+      variant: 'secondary',
+    }) as ButtonElement;
+
+    expect(element.props.className).toBe('button button--secondary wide');
+    expect(element.props.type).toBe('submit');
+  });
+});
+`,
+    },
+];

package/presets/packages/createPackageFiles.d.ts

@@ -0,0 +1,3 @@
+import { ProjectFile } from '../../file-plan/index.js';
+import type { VyriyPackagePlan, VyriyProjectPlan } from '../../project-plan/index.js';
+export declare const createPackageFiles: (plan: VyriyProjectPlan, packagePlan: VyriyPackagePlan) => ProjectFile[];

package/presets/packages/createPackageFiles.js

@@ -0,0 +1,39 @@
+import { createLibraryUiFiles } from '../library/createLibraryUiFiles.js';
+import { createPackageManifest } from './createPackageManifest.js';
+const createGenericPackageFiles = (plan, packagePlan) => [
+    createPackageManifest({
+        packageScope: plan.packageScope,
+        workspaceName: packagePlan.name,
+    }),
+    {
+        path: `packages/${packagePlan.name}/README.md`,
+        content: `# ${plan.packageScope}/${packagePlan.name}\n\n${plan.description}\n`,
+    },
+    {
+        path: `packages/${packagePlan.name}/index.ts`,
+        content: packagePlan.kind === 'stack' ? "export * from './stack.js';\n" : "export type * from './types.js';\n",
+    },
+    ...(packagePlan.kind === 'stack'
+        ? [
+            {
+                path: `packages/${packagePlan.name}/stack.ts`,
+                content: 'export type StackName = string;\n',
+            },
+            {
+                path: `packages/${packagePlan.name}/stack.test.ts`,
+                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('stack', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+            },
+        ]
+        : [
+            {
+                path: `packages/${packagePlan.name}/types.ts`,
+                content: 'export type PackageName = string;\n',
+            },
+            {
+                path: `packages/${packagePlan.name}/${packagePlan.name}.test.ts`,
+                content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('package', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+            },
+        ]),
+];
+const createPresetPackageFiles = (plan, packagePlan) => plan.preset === 'library' && packagePlan.kind === 'ui' ? createLibraryUiFiles(plan, packagePlan) : undefined;
+export const createPackageFiles = (plan, packagePlan) => createPresetPackageFiles(plan, packagePlan) ?? createGenericPackageFiles(plan, packagePlan);

package/presets/packages/createPackageManifest.d.ts

@@ -0,0 +1,7 @@
+import { ProjectFile } from '../../file-plan/index.js';
+export declare const createPackageManifest: ({ dependencies, packageScope, peerDependencies, workspaceName, }: {
+    readonly dependencies?: Record<string, string>;
+    readonly packageScope: string;
+    readonly peerDependencies?: Record<string, string>;
+    readonly workspaceName: string;
+}) => ProjectFile;

package/presets/packages/createPackageManifest.js

@@ -0,0 +1,13 @@
+import { json } from '../config.js';
+export const createPackageManifest = ({ dependencies = {}, packageScope, peerDependencies = {}, workspaceName, }) => ({
+    path: `packages/${workspaceName}/package.json`,
+    content: json({
+        name: `${packageScope}/${workspaceName}`,
+        version: '0.0.0',
+        private: true,
+        type: 'module',
+        main: 'index.js',
+        ...(Object.keys(dependencies).length > 0 ? { dependencies } : {}),
+        ...(Object.keys(peerDependencies).length > 0 ? { peerDependencies } : {}),
+    }),
+});

package/presets/workspaces/createWorkspaceFiles.d.ts

@@ -0,0 +1,3 @@
+import { ProjectFile } from '../../file-plan/index.js';
+import type { VyriyProjectPlan, VyriyWorkspacePlan } from '../../project-plan/index.js';
+export declare const createWorkspaceFiles: (plan: VyriyProjectPlan, workspacePlan: VyriyWorkspacePlan) => ProjectFile[];

package/presets/workspaces/createWorkspaceFiles.js

@@ -0,0 +1,98 @@
+import { json, packageVersion, publishedPackageJson } from '../config.js';
+const getWorkspacePath = (workspacePlan) => workspacePlan.kind === 'lambda' && workspacePlan.name === 'api'
+    ? `workspaces/lambda/${workspacePlan.name}`
+    : `workspaces/${workspacePlan.name}`;
+const getWorkspacePackageName = ({ packageScope, workspacePlan, }) => workspacePlan.kind === 'lambda' && workspacePlan.name === 'api'
+    ? `${packageScope}/lambda-api-workspace`
+    : `${packageScope}/${workspacePlan.name}-workspace`;
+const isApiWorkspace = (workspacePlan) => [
+    'api',
+    'lambda',
+    'fargate',
+].includes(workspacePlan.kind);
+const createApiWorkspaceDependencies = (workspacePlan) => isApiWorkspace(workspacePlan)
+    ? {
+        '@vyriy/handler': packageVersion(publishedPackageJson.version),
+        '@vyriy/server': packageVersion(publishedPackageJson.version),
+    }
+    : {};
+const createApiHandlerFile = (workspacePath) => ({
+    path: `${workspacePath}/handler.ts`,
+    content: `import { api } from '@vyriy/handler';
+
+export const handler = api(async (event) => ({
+  statusCode: 200,
+  body: JSON.stringify({
+    path: event.path,
+  }),
+}));
+`,
+});
+const createApiServerFile = ({ entrypoint, workspacePath, }) => ({
+    path: `${workspacePath}/${entrypoint}`,
+    content: `import { server } from '@vyriy/server';
+
+import { handler } from './handler.js';
+
+server(handler);
+`,
+});
+const createDockerfile = (workspacePath) => ({
+    path: `${workspacePath}/Dockerfile`,
+    content: `FROM node:24-alpine
+
+WORKDIR /app
+
+COPY package.json yarn.lock .yarnrc.yml ./
+COPY .yarn ./.yarn
+COPY packages ./packages
+COPY workspaces ./workspaces
+
+RUN corepack enable && yarn install --immutable
+RUN yarn build
+
+CMD ["node", "workspaces/api/index.js"]
+`,
+});
+const createApiWorkspaceFiles = (plan, workspacePlan) => {
+    const workspacePath = getWorkspacePath(workspacePlan);
+    const isLambda = workspacePlan.kind === 'lambda';
+    return [
+        createApiHandlerFile(workspacePath),
+        createApiServerFile({ entrypoint: isLambda ? 'server.ts' : 'index.ts', workspacePath }),
+        {
+            path: `${workspacePath}/${workspacePlan.name}.test.ts`,
+            content: "import { describe, expect, it } from '@jest/globals';\n\nimport { handler } from './handler.js';\n\ndescribe('api workspace', () => {\n  it('exports a handler', () => {\n    expect(handler).toEqual(expect.any(Function));\n  });\n});\n",
+        },
+        ...(plan.features.includes('docker') && !isLambda ? [createDockerfile(workspacePath)] : []),
+    ];
+};
+export const createWorkspaceFiles = (plan, workspacePlan) => {
+    const workspacePath = getWorkspacePath(workspacePlan);
+    const dependencies = createApiWorkspaceDependencies(workspacePlan);
+    return [
+        {
+            path: `${workspacePath}/package.json`,
+            content: json({
+                name: getWorkspacePackageName({ packageScope: plan.packageScope, workspacePlan }),
+                version: '0.0.0',
+                private: true,
+                type: 'module',
+                main: workspacePlan.kind === 'lambda' ? 'server.js' : 'index.js',
+                ...(Object.keys(dependencies).length > 0 ? { dependencies } : {}),
+            }),
+        },
+        ...(isApiWorkspace(workspacePlan)
+            ? createApiWorkspaceFiles(plan, workspacePlan)
+            : [
+                {
+                    path: `${workspacePath}/index.ts`,
+                    content: 'export type WorkspaceName = string;\n',
+                },
+                {
+                    path: `${workspacePath}/${workspacePlan.name}.test.ts`,
+                    content: "import { describe, expect, it } from '@jest/globals';\n\ndescribe('workspace', () => {\n  it('has a test harness', () => {\n    expect(true).toBe(true);\n  });\n});\n",
+                },
+            ]),
+    ];
+};

package/project-plan/api/api.js

@@ -1,30 +1,25 @@
 const apiPresets = [
     'api',
     'fullstack',
-    'mfe-bff',
-    'openmfe-bff',
-    'aws-serverless',
+    'mfe',
 ];
 export const isApiPreset = (preset) => apiPresets.includes(preset);
-export const getApiRuntimeFromPreset = (preset) => preset === 'aws-serverless' ? 'lambda' : 'node';
-export const getDefaultApiStyleFromPreset = (preset) => preset === 'openmfe-bff' ? 'mixed' : 'rest';
+export const getApiRuntimeFromPreset = () => 'docker';
+export const getDefaultApiStyleFromPreset = () => 'rest';
 export const getFeaturesFromApiPlan = (api) => {
     if (!api) {
         return [];
     }
-    if (api.style === 'mixed') {
-        return ['rest-api', 'graphql-api'];
-    }
     return api.style === 'rest' ? ['rest-api'] : ['graphql-api'];
 };
-export const createApiPlan = ({ preset, style = getDefaultApiStyleFromPreset(preset) }) => {
+export const createApiPlan = ({ preset, runtime = getApiRuntimeFromPreset(preset), style = getDefaultApiStyleFromPreset(preset), }) => {
     if (!isApiPreset(preset)) {
         return undefined;
     }
     const basePlan = {
         enabled: true,
         style,
-        runtime: getApiRuntimeFromPreset(preset),
+        runtime,
     };
     const restPlan = {
         rest: {
@@ -37,13 +32,6 @@ export const createApiPlan = ({ preset, style = getDefaultApiStyleFromPreset(pre
             packageName: 'graphql',
         },
     };
-    if (style === 'mixed') {
-        return {
-            ...basePlan,
-            ...restPlan,
-            ...graphqlPlan,
-        };
-    }
     return style === 'rest'
         ? {
             ...basePlan,

package/project-plan/api/types.d.ts

@@ -1,6 +1,7 @@
 import { VyriyApiPlan, VyriyApiRuntime, VyriyApiStyle, VyriyFeature, VyriyPreset } from '../types.js';
 export type CreateApiPlanOptions = {
     readonly preset: VyriyPreset;
+    readonly runtime?: VyriyApiRuntime;
     readonly style?: VyriyApiStyle;
 };
 export type CreateApiPlan = (options: CreateApiPlanOptions) => VyriyApiPlan | undefined;