@stripchatdev/create-stripchat-extension 0.1.48 → 0.2.1

package/dist/bin/create.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
-import { checkbox, input, select } from '@inquirer/prompts';
+import { checkbox, confirm, input, select } from '@inquirer/prompts';
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
 import { parseArgs } from 'node:util';
 import { CATEGORIES, CATEGORY_LABELS, FRAMEWORK_LABELS, FRAMEWORKS, LANGUAGE_LABELS, LANGUAGES, SLOT_RULES_BY_CATEGORY, SLOT_LABELS, EXT_HELPER_VERSION, CLI_COMMANDS_MAP, VERSION, } from '../src/constants.js';
 import { AppError } from '../src/helpers/error.js';
+import { hasUi } from '../src/helpers/hasUI.js';
 import { buildProjectConfig } from '../src/projectConfig/buildProjectConfig.js';
 import { detectPackageManagerRuntime } from '../src/projectConfig/detectPackageManagerRuntime.js';
 import { executeCommands } from '../src/templater/executor.js';
@@ -26,6 +27,7 @@ Options:
   --name <name>           Project name (used as a directory and package name)
   --category <category>   Extension category (${CATEGORIES.join(', ')})
   --slots <items>         Comma-separated slots (e.g. "EXTENSION_SLOT_MAIN_GAME_FUN,EXTENSION_SLOT_RIGHT_OVERLAY") or empty string
+  --settings <boolean>    Include a model-facing settings page (exactly true or false)
   --framework <framework> UI framework (${FRAMEWORKS.join(', ')})
   --language <lang>       Language (${LANGUAGES.join(', ')})
   -h, --help              Display this help message
@@ -41,6 +43,7 @@ const parseCliArgs = () => {
                 help: { short: 'h', type: 'boolean' },
                 language: { type: 'string' },
                 name: { type: 'string' },
+                settings: { type: 'string' },
                 slots: { type: 'string' },
                 version: { short: 'v', type: 'boolean' },
                 templateVersion: { short: 't', type: 'string' },
@@ -150,10 +153,19 @@ const resolveSlots = async (flagValue, category) => {
     });
     return [...requiredSlots, ...selectedSlots];
 };
-const resolveFramework = (flagValue, category) => {
-    if (category === 'chat-bots') {
-        return Promise.resolve('vanilla');
+const resolveSettings = (flagValue) => {
+    if (flagValue !== undefined) {
+        if (flagValue !== 'true' && flagValue !== 'false') {
+            throw new AppError(`Invalid settings value "${flagValue}". Choose one of: true, false`);
+        }
+        return Promise.resolve(flagValue === 'true');
     }
+    return confirm({
+        default: false,
+        message: 'Include a settings page?',
+    });
+};
+const resolveFramework = (flagValue) => {
     if (flagValue) {
         if (!getIsValidFramework(flagValue)) {
             throw new AppError(`Invalid framework "${flagValue}". Choose one of: ${FRAMEWORKS.join(', ')}`);
@@ -210,7 +222,10 @@ const main = async () => {
     const name = await resolveName(opts.name);
     const category = await resolveCategory(opts.category);
     const slots = await resolveSlots(opts.slots, category);
-    const framework = await resolveFramework(opts.framework, category);
+    const hasSettings = await resolveSettings(opts.settings);
+    const framework = hasUi(hasSettings, slots)
+        ? await resolveFramework(opts.framework)
+        : 'vanilla';
     const language = await resolveLanguage(opts.language);
     const projectDir = resolveProjectDir(name);
     const templateVersion = resolveTemplateVersion(opts.templateVersion);
@@ -220,6 +235,7 @@ const main = async () => {
         category,
         slots,
         framework,
+        hasSettings,
         language,
         packageManager: detectPackageManagerRuntime(),
         extHelperVersion: EXT_HELPER_VERSION,

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stripchatdev/create-stripchat-extension",
-    "version": "0.1.48",
+    "version": "0.2.1",
     "type": "module",
     "files": [
         "dist",

package/dist/src/helpers/hasUI.d.ts

@@ -0,0 +1,2 @@
+import type { TSlot } from '../types';
+export declare const hasUi: (hasSettings: boolean, slots: readonly TSlot[]) => boolean;

package/dist/src/helpers/hasUI.js

@@ -0,0 +1 @@
+export const hasUi = (hasSettings, slots) => hasSettings || slots.some((slot) => slot !== 'EXTENSION_SLOT_BACKGROUND');

package/dist/src/helpers/hasUI.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/helpers/hasUI.test.js

@@ -0,0 +1,15 @@
+import { describe, expect, it } from 'vitest';
+import { hasUi } from './hasUI.js';
+describe('settings configuration', () => {
+    it.each([
+        [false, ['EXTENSION_SLOT_BACKGROUND'], false],
+        [
+            false,
+            ['EXTENSION_SLOT_BACKGROUND', 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY'],
+            true,
+        ],
+        [true, ['EXTENSION_SLOT_BACKGROUND'], true],
+    ])('detects UI from settings and non-background slots', (hasSettings, slots, expected) => {
+        expect(hasUi(hasSettings, slots)).toBe(expected);
+    });
+});

package/dist/src/projectConfig/buildProjectConfig.d.ts

@@ -4,6 +4,7 @@ export type TBuildProjectConfigOptions = {
     cliCommands: TCliCommandsMap;
     extHelperVersion: string;
     framework: TFramework;
+    hasSettings?: boolean;
     language: TLanguage;
     lastTemplateVersion: number;
     managedTemplates: TRelPath[];

package/dist/src/projectConfig/buildProjectConfig.js

@@ -2,7 +2,7 @@ import { resolveDependencies } from '../dependencies/resolveDependencies.js';
 import { toNormalizedRelPath } from '../helpers/normalizePath.js';
 import { collectManagedFiles, TEMPLATES_DIR } from '../templates/templates.js';
 export const buildProjectConfig = (options) => {
-    const { category, cliCommands, extHelperVersion, framework, language, lastTemplateVersion, managedTemplates, name, packageManager, slots, } = options;
+    const { category, cliCommands, extHelperVersion, framework, hasSettings = false, language, lastTemplateVersion, managedTemplates, name, packageManager, slots, } = options;
     const { dependencies, devDependencies } = resolveDependencies(language, framework);
     const managedFiles = collectManagedFiles(TEMPLATES_DIR, managedTemplates, lastTemplateVersion).map((file) => {
         return {
@@ -16,6 +16,7 @@ export const buildProjectConfig = (options) => {
         category,
         language,
         framework,
+        hasSettings,
         packageManager,
         dependencies,
         devDependencies,

package/dist/src/projectConfig/updateProjectConfig.js

@@ -3,12 +3,13 @@ import { MANAGED_TEMPLATES } from '../templates/constants.js';
 import { TEMPLATES_DIR } from '../templates/templates.js';
 import { buildProjectConfig } from './buildProjectConfig.js';
 export const updateProjectConfig = (lastTemplateVersion, projectConfigUserProps) => {
-    const { category, framework, language, name, packageManager, slots } = projectConfigUserProps;
+    const { category, framework, hasSettings, language, name, packageManager, slots, } = projectConfigUserProps;
     return buildProjectConfig({
         name,
         category,
         language,
         framework,
+        hasSettings,
         packageManager,
         slots,
         extHelperVersion: EXT_HELPER_VERSION,

package/dist/src/projectConfig/validators/getIsValidProjectConfig.test.js

@@ -12,6 +12,7 @@ describe('isValidProjectConfig', () => {
         name: 'project-name',
         packageManager: 'npm',
         framework,
+        hasSettings: false,
         language,
         category: 'chat-bots',
         dependencies,

package/dist/src/templater/executor.test.js

@@ -5,7 +5,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { CLI_COMMANDS_MAP, EXT_HELPER_VERSION } from '../constants.js';
 import { buildProjectConfig } from '../projectConfig/buildProjectConfig.js';
 import { MANAGED_TEMPLATES } from '../templates/constants.js';
-import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR } from '../templates/templates.js';
+import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR, } from '../templates/templates.js';
 import { executeCommands } from './executor.js';
 import { mapProjectConfigToTemplateData } from './mappers/mapProjectConfigToTemplateModel.js';
 import { planProject } from './planner.js';
@@ -34,6 +34,7 @@ describe('executeCommands', () => {
         const projectConfig = buildProjectConfig({
             category: 'games-and-fun',
             framework: 'vanilla',
+            hasSettings: false,
             language: 'ts',
             name: 'my-ext',
             packageManager: 'npm',
@@ -60,15 +61,51 @@ describe('executeCommands', () => {
                     readFile(command.destPath),
                 ]);
                 expect(dest.equals(src)).toBe(true);
-                continue;
             }
         }
         expect(cb).toHaveBeenCalledTimes(commands.length);
     });
+    it.each(new Array(LAST_TEMPLATE_VERSION).fill(0).map((_, index) => index + 1))('generates non-empty settings files for template version %s', async (templateVersion) => {
+        const projectConfig = buildProjectConfig({
+            category: 'chat-bots',
+            framework: 'vanilla',
+            hasSettings: true,
+            language: 'ts',
+            name: 'my-ext',
+            packageManager: 'npm',
+            slots: ['EXTENSION_SLOT_BACKGROUND'],
+            extHelperVersion: EXT_HELPER_VERSION,
+            lastTemplateVersion: templateVersion,
+            cliCommands: CLI_COMMANDS_MAP,
+            managedTemplates: MANAGED_TEMPLATES,
+            templatesDir: TEMPLATES_DIR,
+        });
+        const commands = buildCommands(projectConfig, tmpDir);
+        const settingsCommands = commands.filter((command) => command.destPath.includes('/settings'));
+        expect(settingsCommands.map(({ destPath }) => destPath)).toEqual(expect.arrayContaining([
+            join(tmpDir, 'settings.html'),
+            join(tmpDir, 'src/slots/settings/app.ts'),
+            join(tmpDir, 'src/slots/settings/main.css'),
+            join(tmpDir, 'src/slots/settings/main.ts'),
+        ]));
+        executeCommands(commands);
+        for (const command of settingsCommands) {
+            const content = await readFile(command.destPath, 'utf-8');
+            expect(content.trim().length).toBeGreaterThan(0);
+            expect(content).not.toMatch(EJS_TAG_PATTERN);
+        }
+        const [manifest, viteConfig] = await Promise.all([
+            readFile(join(tmpDir, 'public/manifest.json'), 'utf-8'),
+            readFile(join(tmpDir, 'vite.config.ts'), 'utf-8'),
+        ]);
+        expect(manifest).toContain('"settings": "settings.html"');
+        expect(viteConfig).toContain("'settings': resolve(__dirname, 'settings.html')");
+    });
     it('rejects with ENOENT when a source template is missing', () => {
         const projectConfig = buildProjectConfig({
             category: 'sex-toys',
             framework: 'vanilla',
+            hasSettings: true,
             language: 'js',
             name: 'my-ext',
             packageManager: 'npm',

package/dist/src/templater/mappers/mapProjectConfigToTemplateModel.test.js

@@ -3,7 +3,7 @@ import { CLI_COMMANDS_MAP, EXT_HELPER_VERSION } from '../../constants.js';
 import { DEPENDENCIES } from '../../dependencies/constants.js';
 import { buildProjectConfig } from '../../projectConfig/buildProjectConfig.js';
 import { MANAGED_TEMPLATES } from '../../templates/constants.js';
-import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR } from '../../templates/templates.js';
+import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR, } from '../../templates/templates.js';
 import { mapProjectConfigToTemplateData } from './mapProjectConfigToTemplateModel.js';
 const makeConfig = (overrides = {}) => {
     const language = overrides.language ?? 'ts';
@@ -58,7 +58,10 @@ describe('mapProjectConfigToTemplateData', () => {
         expect(result.slotsEntries).toEqual([
             { slot: 'EXTENSION_SLOT_MAIN_GAME_FUN', slotCamelCased: 'mainGameFun' },
             { slot: 'EXTENSION_SLOT_BACKGROUND', slotCamelCased: 'background' },
-            { slot: 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY', slotCamelCased: 'videoDecorativeOverlay' },
+            {
+                slot: 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY',
+                slotCamelCased: 'videoDecorativeOverlay',
+            },
         ]);
     });
     it('maps broadcast-tools category slots correctly', () => {
@@ -67,23 +70,35 @@ describe('mapProjectConfigToTemplateData', () => {
             slots: ['EXTENSION_SLOT_MOVEABLE_OVERLAY', 'EXTENSION_SLOT_BACKGROUND'],
         }));
         expect(result.slotsEntries).toEqual([
-            { slot: 'EXTENSION_SLOT_MOVEABLE_OVERLAY', slotCamelCased: 'moveableOverlay' },
+            {
+                slot: 'EXTENSION_SLOT_MOVEABLE_OVERLAY',
+                slotCamelCased: 'moveableOverlay',
+            },
             { slot: 'EXTENSION_SLOT_BACKGROUND', slotCamelCased: 'background' },
         ]);
     });
     it('maps sex-toys category slots correctly', () => {
         const result = mapProjectConfigToTemplateData(makeConfig({
             category: 'sex-toys',
-            slots: ['EXTENSION_SLOT_MAIN_SEX_TOY', 'EXTENSION_SLOT_BACKGROUND', 'EXTENSION_SLOT_MOVEABLE_OVERLAY'],
+            slots: [
+                'EXTENSION_SLOT_MAIN_SEX_TOY',
+                'EXTENSION_SLOT_BACKGROUND',
+                'EXTENSION_SLOT_MOVEABLE_OVERLAY',
+            ],
         }));
         expect(result.slotsEntries).toEqual([
             { slot: 'EXTENSION_SLOT_MAIN_SEX_TOY', slotCamelCased: 'mainSexToy' },
             { slot: 'EXTENSION_SLOT_BACKGROUND', slotCamelCased: 'background' },
-            { slot: 'EXTENSION_SLOT_MOVEABLE_OVERLAY', slotCamelCased: 'moveableOverlay' },
+            {
+                slot: 'EXTENSION_SLOT_MOVEABLE_OVERLAY',
+                slotCamelCased: 'moveableOverlay',
+            },
         ]);
     });
     it('preserves slot order from config', () => {
-        const result = mapProjectConfigToTemplateData(makeConfig({ slots: ['EXTENSION_SLOT_BACKGROUND', 'EXTENSION_SLOT_MAIN_GAME_FUN'] }));
+        const result = mapProjectConfigToTemplateData(makeConfig({
+            slots: ['EXTENSION_SLOT_BACKGROUND', 'EXTENSION_SLOT_MAIN_GAME_FUN'],
+        }));
         expect(result.slotsEntries[0].slot).toBe('EXTENSION_SLOT_BACKGROUND');
         expect(result.slotsEntries[1].slot).toBe('EXTENSION_SLOT_MAIN_GAME_FUN');
     });
@@ -91,6 +106,20 @@ describe('mapProjectConfigToTemplateData', () => {
         const result = mapProjectConfigToTemplateData(makeConfig({ slots: [] }));
         expect(result.slotsEntries).toEqual([]);
     });
+    it('passes config reference unchanged', () => {
+        const config = makeConfig();
+        const result = mapProjectConfigToTemplateData(config);
+        expect(result.config).toBe(config);
+    });
+    it('preserves settings without creating a slot entry', () => {
+        const result = mapProjectConfigToTemplateData(makeConfig({ hasSettings: true }));
+        expect(result.hasSettings).toBe(true);
+        expect(result.config.hasSettings).toBe(true);
+        expect(result.slotsEntries).toEqual([
+            { slot: 'EXTENSION_SLOT_MAIN_GAME_FUN', slotCamelCased: 'mainGameFun' },
+            { slot: 'EXTENSION_SLOT_BACKGROUND', slotCamelCased: 'background' },
+        ]);
+    });
     it('passes name, framework, language, and slots from config', () => {
         const config = makeConfig({
             framework: 'preact',

package/dist/src/templater/planner.js

@@ -1,4 +1,3 @@
-import { existsSync } from 'node:fs';
 import { join } from 'node:path';
 import { isSubPath } from '../helpers/isSubPath.js';
 import { GENERAL_SLOT_NAME_PLACEHOLDER, TEMPLATE_EXT, } from '../templates/constants.js';
@@ -64,10 +63,11 @@ const buildSlotTemplateData = (data, slotKey) => {
 };
 const planSlotTemplates = (projectDir, targetVersion, data, slotKey) => {
     const specificDir = join(SLOTS_TEMPLATE_DIR_REL, slotKey);
-    const hasSpecificDir = existsSync(specificDir);
-    const slotTemplatedDirRel = hasSpecificDir ? specificDir : GENERAL_SLOT_TEMPLATE_DIR_REL;
+    const specificFiles = collectTemplateFiles(TEMPLATES_DIR, targetVersion, specificDir);
+    const files = specificFiles.length > 0
+        ? specificFiles
+        : collectTemplateFiles(TEMPLATES_DIR, targetVersion, GENERAL_SLOT_TEMPLATE_DIR_REL);
     const slotData = buildSlotTemplateData(data, slotKey);
-    const files = collectTemplateFiles(TEMPLATES_DIR, targetVersion, slotTemplatedDirRel);
     const allRelPaths = new Set(files.map((f) => f.relPath));
     const commands = [];
     for (const file of files) {
@@ -100,5 +100,8 @@ const planSlotTemplates = (projectDir, targetVersion, data, slotKey) => {
 export const planProject = (projectDir, targetVersion, data) => {
     const globalCommands = planGlobalTemplates(projectDir, targetVersion, data);
     const slotCommands = data.slotsEntries.flatMap(({ slotCamelCased }) => planSlotTemplates(projectDir, targetVersion, data, slotCamelCased));
-    return [...globalCommands, ...slotCommands];
+    const settingsCommands = data.hasSettings
+        ? planSlotTemplates(projectDir, targetVersion, data, 'settings')
+        : [];
+    return [...globalCommands, ...slotCommands, ...settingsCommands];
 };

package/dist/src/templater/planner.test.js

@@ -4,7 +4,7 @@ import { CATEGORIES, CLI_COMMANDS_MAP, EXT_HELPER_VERSION, FRAMEWORKS, LANGUAGES
 import { toNormalizedRelPath } from '../helpers/normalizePath.js';
 import { buildProjectConfig } from '../projectConfig/buildProjectConfig.js';
 import { MANAGED_TEMPLATES } from '../templates/constants.js';
-import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR } from '../templates/templates.js';
+import { LAST_TEMPLATE_VERSION, TEMPLATES_DIR, } from '../templates/templates.js';
 import { mapProjectConfigToTemplateData } from './mappers/mapProjectConfigToTemplateModel.js';
 import { planProject } from './planner.js';
 const PROJECT_DIR = '/output/my-ext';
@@ -18,7 +18,15 @@ const buildSlotCombos = (category) => {
         return combos;
     }
     if (category === 'sex-toys') {
-        combos.push([...base, 'EXTENSION_SLOT_MOVEABLE_OVERLAY'], [...base, 'EXTENSION_SLOT_RIGHT_OVERLAY'], [...base, 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY'], [...base, 'EXTENSION_SLOT_MOVEABLE_OVERLAY', 'EXTENSION_SLOT_RIGHT_OVERLAY'], [...base, 'EXTENSION_SLOT_MOVEABLE_OVERLAY', 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY']);
+        combos.push([...base, 'EXTENSION_SLOT_MOVEABLE_OVERLAY'], [...base, 'EXTENSION_SLOT_RIGHT_OVERLAY'], [...base, 'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY'], [
+            ...base,
+            'EXTENSION_SLOT_MOVEABLE_OVERLAY',
+            'EXTENSION_SLOT_RIGHT_OVERLAY',
+        ], [
+            ...base,
+            'EXTENSION_SLOT_MOVEABLE_OVERLAY',
+            'EXTENSION_SLOT_VIDEO_DECORATIVE_OVERLAY',
+        ]);
     }
     return combos;
 };
@@ -43,7 +51,7 @@ const normalizeCommands = (commands) => commands.map((cmd) => {
     return { type: 'render', src: srcNormalized, dest: destNormalized };
 });
 describe('planProject', { tags: ['snapshot'] }, () => {
-    it.each(TEST_CASES)('template version $templateVersion + $language + $framework, $category ($slotsStr)', ({ category, framework, language, slots, templateVersion, }) => {
+    it.each(TEST_CASES)('template version $templateVersion + $language + $framework, $category ($slotsStr)', ({ category, framework, language, slots, templateVersion }) => {
         const projectConfig = buildProjectConfig({
             category,
             framework,
@@ -61,4 +69,44 @@ describe('planProject', { tags: ['snapshot'] }, () => {
         const commands = planProject(PROJECT_DIR, templateVersion, data);
         expect(normalizeCommands(commands)).toMatchSnapshot();
     });
+    it.each(new Array(LAST_TEMPLATE_VERSION).fill(0).map((_, index) => index + 1))('adds settings templates for template version %s', (templateVersion) => {
+        const projectConfig = buildProjectConfig({
+            category: 'chat-bots',
+            framework: 'vanilla',
+            hasSettings: true,
+            language: 'ts',
+            name: basename(PROJECT_DIR),
+            packageManager: 'npm',
+            slots: ['EXTENSION_SLOT_BACKGROUND'],
+            extHelperVersion: EXT_HELPER_VERSION,
+            lastTemplateVersion: templateVersion,
+            cliCommands: CLI_COMMANDS_MAP,
+            managedTemplates: MANAGED_TEMPLATES,
+            templatesDir: TEMPLATES_DIR,
+        });
+        const commands = planProject(PROJECT_DIR, templateVersion, mapProjectConfigToTemplateData(projectConfig));
+        const settingsCommands = normalizeCommands(commands).filter(({ dest }) => dest.includes('settings'));
+        expect(settingsCommands).toEqual([
+            {
+                dest: 'my-ext/src/slots/settings/app.ts',
+                src: 'templates/v1/src/slots/settings/app.ts.ejs',
+                type: 'render',
+            },
+            {
+                dest: 'my-ext/src/slots/settings/main.css',
+                src: 'templates/v1/src/slots/settings/main.css.ejs',
+                type: 'render',
+            },
+            {
+                dest: 'my-ext/src/slots/settings/main.ts',
+                src: 'templates/v1/src/slots/settings/main.ts.ejs',
+                type: 'render',
+            },
+            {
+                dest: 'my-ext/settings.html',
+                src: 'templates/v1/src/slots/settings/settings.html.ejs',
+                type: 'render',
+            },
+        ]);
+    });
 });

package/dist/src/types.d.ts

@@ -14,6 +14,7 @@ export type TCliCommandsMap = Record<string, string>;
 export type TProjectConfigUserProps = {
     category: TCategory;
     framework: TFramework;
+    hasSettings: boolean;
     language: TLanguage;
     name: string;
     packageManager: TPackageManager;
@@ -42,6 +43,7 @@ export type TTemplateData = {
     config: TProjectConfig;
     ext: 'ts' | 'js';
     framework: TFramework;
+    hasSettings: boolean;
     isJsxFramework: boolean;
     isTypescript: boolean;
     jsxExt: 'tsx' | 'jsx';