@vendure-platform/create 0.5.0 → 1.0.0-major.202609091053.0.0

package/dist/assets/templates/README.md.hbs

@@ -5,7 +5,7 @@ A Vendure e-commerce demo project for **{{companyName}}**, scaffolded with `@ven
 ## Prerequisites
 
 - Node.js >= 22
-- Docker & Docker Compose (for PostgreSQL and Typesense)
+- Docker & Docker Compose (for PostgreSQL{{#if usesTypesense}} and Typesense{{/if}})
 
 ## Setup
 
@@ -35,12 +35,36 @@ The storefront will be available at `http://localhost:3001`.
 | `npm run dev` | Start all services in development mode |
 | `npm run build:dashboard` | Build the admin dashboard for production |
 | `npm run populate` | Seed the database with demo data |
+| `npm run migration:generate -- <name>` | Diff the entities against the database and write a migration |
+| `npm run migration:run` | Apply pending migrations |
+
+Run from `server/`. The Vendure CLI is installed too, with the Vendure Platform
+plugin enabled:
+
+| Command | Description |
+|---------|-------------|
+| `npx vendure downgrade-impact` | After changing to a lower edition, report the tables the departed packages left behind |
 
 ## Installed Plugins
 
 {{#each resolvedPlugins}}
 - **{{this.displayName}}** (`{{this.packageName}}`)
 {{/each}}
+{{#if profile}}
+
+## Capability Profile
+
+This project is scaffolded for the **{{profile}}** profile. The packages and
+configuration above match these capability grants:
+
+{{#each capabilityGrants}}
+- `{{this}}`
+{{/each}}
+
+Grants are authorized at runtime by the signed license token in
+`VENDURE_PLATFORM_LICENSE_TOKEN`, never by this list. A module configured
+without its grant stops the server before it serves traffic.
+{{/if}}
 
 ## Demo Accounts
 

package/dist/assets/templates/docker-compose.yml.hbs

@@ -9,6 +9,7 @@ services:
       - '5432:5432'
     volumes:
       - postgres-data:/var/lib/postgresql/data
+{{#if usesTypesense}}
 
   typesense:
     image: typesense/typesense:28.0
@@ -19,7 +20,10 @@ services:
       - '8110:8108'
     volumes:
       - typesense-data:/data
+{{/if}}
 
 volumes:
   postgres-data:
+{{#if usesTypesense}}
   typesense-data:
+{{/if}}

package/dist/assets/templates/env.hbs

@@ -14,26 +14,32 @@ SUPERADMIN_USERNAME=superadmin
 SUPERADMIN_PASSWORD=superadmin
 
 # Vendure Platform License
-# Get a license token from the Enterprise Portal: https://enterprise.vendure.io
-# NOTE: this is the SERVER license token, checked at boot by the License Guard
-# plugin. It is distinct from the npm registry auth token (which lives in
-# .npmrc) — the Enterprise Portal issues both as separate values.
-# Leave VENDURE_PLATFORM_LICENSE_TOKEN empty for local development; the
-# VENDURE_PLATFORM_LICENSE_GUARD_LOCAL_DEV=1 flag below enables the no-token
-# soft mode that lets you populate, run dev, and explore the platform without
-# enforcement. The flag is only ever read when no token is configured — once
-# you set a real token, the soft-mode code path is no longer reachable.
+# Leave this empty in development. `vendure console link` writes this project's
+# Environment Credential to .vendure/credentials.json, and `vendure dev` passes
+# it to the server, so there is nothing to paste here and no secret sitting in
+# a file your editor has open.
+#
+# In production, set this to that environment's Environment Credential from the
+# Installations page in Vendure Console, through whatever holds your secrets.
 VENDURE_PLATFORM_LICENSE_TOKEN={{licenseToken}}
+# Lets the server start with no credential at all, for a look around before you
+# link. Read only when VENDURE_PLATFORM_LICENSE_TOKEN is empty and no credential
+# was supplied, so a linked project never reaches it.
 VENDURE_PLATFORM_LICENSE_GUARD_LOCAL_DEV=1
 
+{{#if usesTypesense}}
 # Advanced Search (Typesense)
 TYPESENSE_API_KEY=your-typesense-api-key
 TYPESENSE_HOST=localhost
 TYPESENSE_PORT=8110
 TYPESENSE_PROTOCOL=http
 
+{{/if}}
 # Workflow Engine
 WORKFLOW_ENGINE_SCHEMA=dbos
+# The docker-compose Postgres above does not speak SSL. Set this to `true`
+# against a managed database that requires it.
+WORKFLOW_ENGINE_SSL=false
 
 {{#ifPlugin "sso"}}
 # SSO (Google OIDC)
@@ -46,6 +52,25 @@ VENDURE_HOST=http://localhost:3500
 # Audit Trail
 AUDIT_LOG_SCHEMA=audit_trail
 
+{{/ifPlugin}}
+{{#ifPlugin "punchout"}}
+# PunchOut
+# Where a buyer's PunchOut session lands. The cXML setup response sends the
+# buyer to this URL, so it must be the storefront the trading partner reaches.
+PUNCHOUT_STOREFRONT_URL=http://localhost:3000
+
+{{/ifPlugin}}
+{{#ifPlugin "sso-federation"}}
+# SAML SSO (sso.federation)
+# A SAML provider is registered only when SAML_IDP_SSO_URL is set. Leave these
+# empty until you have an identity provider: an unconfigured SAML provider
+# cannot complete a login, and a second provider makes this configuration
+# unloadable on any edition that does not grant sso.federation.
+SAML_SP_ENTITY_ID=
+SAML_IDP_ENTITY_ID=
+SAML_IDP_SSO_URL=
+SAML_IDP_CERTIFICATE=
+
 {{/ifPlugin}}
 {{#if includeStorefront}}
 # Storefront

package/dist/assets/templates/environment.d.ts.hbs

@@ -17,6 +17,7 @@ declare namespace NodeJS {
         TYPESENSE_PORT?: string;
         TYPESENSE_PROTOCOL?: string;
         WORKFLOW_ENGINE_SCHEMA?: string;
+        WORKFLOW_ENGINE_SSL?: string;
         VENDURE_PLATFORM_LICENSE_TOKEN?: string;
         VENDURE_PLATFORM_LICENSE_GUARD_LOCAL_DEV?: string;
 {{#ifPlugin "sso"}}

package/dist/assets/templates/gitignore.hbs

@@ -2,12 +2,15 @@ node_modules/
 dist/
 .next/
 .env
-# .npmrc may carry a literal Vendure private-registry npm auth token
-# (the registry token, NOT the runtime license token) — never commit it.
-# If you need a token-less version for CI, write a short script that strips
-# the `_authToken=` line at publish time.
+# .npmrc carries the literal Registry Access Token, so it is never committed.
+# For CI, write a fresh .npmrc at deploy time from a secret.
 .npmrc
 storefront/.npmrc
+# .vendure holds the Project Link Manifest, which is identity metadata and is
+# meant to be committed, next to the development credential, which is a secret
+# and is not. Ignore the directory and un-ignore the one file.
+.vendure/*
+!.vendure/project.json
 *.tsbuildinfo
 static/assets/
 src/gql/

package/dist/assets/templates/migrate.ts.hbs

@@ -0,0 +1,55 @@
+import * as dotenv from 'dotenv';
+import * as path from 'path';
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+import { generateMigration, runMigrations } from '@vendure/core';
+
+import { config } from './vendure-config';
+
+/**
+ * Migration runner for this project.
+ *
+ * `vendure-config.ts` only enables TypeORM's `synchronize` in development.
+ * Every other environment applies schema changes through the migration files
+ * in `src/migrations`, so generate one whenever a plugin's entities change and
+ * run them before the server boots.
+ *
+ *   npm run migration:generate -- <name>              # diff against this database
+ *   npm run migration:generate -- <name> --from-empty  # full baseline schema
+ *   npm run migration:run                              # apply pending migrations
+ *
+ * `--from-empty` diffs the entity metadata against a temporary empty database
+ * instead of this one, so it emits a complete "zero to current schema"
+ * migration. Use it for the first migration of a project whose schema was
+ * created by `synchronize`, where a plain diff would find nothing to write.
+ */
+async function main(): Promise<void> {
+    const args = process.argv.slice(2);
+    const command = args[0];
+    const fromEmpty = args.includes('--from-empty');
+    const name = args.slice(1).find((arg) => !arg.startsWith('--'));
+
+    if (command === 'generate') {
+        if (!name) {
+            throw new Error('Usage: npm run migration:generate -- <name> [--from-empty]');
+        }
+        await generateMigration(config, {
+            name,
+            fromEmpty,
+            outputDir: path.join(__dirname, './migrations'),
+        });
+        return;
+    }
+
+    if (command === 'run') {
+        await runMigrations(config);
+        return;
+    }
+
+    throw new Error(`Unknown migration command "${command ?? ''}". Use "generate" or "run".`);
+}
+
+main().catch((err: unknown) => {
+    console.error(err);
+    process.exit(1);
+});

package/dist/assets/templates/npmrc.hbs

@@ -1,3 +1,8 @@
 @vendure-platform:registry={{registryUrl}}
-{{#if registryToken}}//{{registryHost}}/:_authToken={{registryToken}}
-{{/if}}
+{{#if registryToken}}{{registryAuthTokenKey}}{{registryToken}}
+{{/if}}
+; The server depends on one edition facade, not on each capability package.
+; pnpm's strict layout would then hide those packages from `import
+; '@vendure-platform/quote-management'`, so hoist the whole scope into the
+; project's node_modules root. npm and bun hoist by default and ignore this.
+public-hoist-pattern[]=@vendure-platform/*

package/dist/assets/templates/platform-edition.ts.hbs

@@ -0,0 +1,21 @@
+/**
+ * Vendure Platform edition configuration.
+ *
+ * The Vendure CLI maintains this file. `vendure edition prepare <edition>`
+ * replaces it in full, so an edit made here is lost at the next edition change.
+ * Put your own configuration in `vendure-config.ts` instead.
+ *
+ * @vendure-platform/cli:edition-config
+ */
+import type { VendurePlatformOptions } from '@vendure-platform/platform';
+
+/**
+ * The edition this deployment composes.
+ *
+ * A composition hint, never an authorization source. License Guard compares the
+ * modules this composes against the signed Entitlement Grant while booting and
+ * fails closed when they disagree.
+ */
+export const platformEdition = {
+    capabilityProfile: '{{profile}}',
+} satisfies Pick<VendurePlatformOptions, 'capabilityProfile'>;

package/dist/assets/templates/server-package.json.hbs

@@ -9,24 +9,31 @@
     "build": "tsc",
     "build:dashboard": "vite build",
     "start": "node dist/index.js",
-    "populate": "node --require ts-node/register src/populate.ts"
+    "populate": "node --require ts-node/register src/populate.ts",
+    "migration:generate": "node --require ts-node/register src/migrate.ts generate",
+    "migration:run": "node --require ts-node/register src/migrate.ts run"
   },
   "dependencies": {
-    "@vendure/core": "^3.6.2",
-    "@vendure/dashboard": "^3.6.2",
-    "@vendure/asset-server-plugin": "^3.6.2",
+    "@vendure/core": "^3.8.0-0",
+    "@vendure/dashboard": "^3.8.0-0",
+    "@vendure/asset-server-plugin": "^3.8.0-0",
     "typeorm": "^0.3.27",
     "@vendure-platform/data-populator": "{{pluginVersionSpec}}",
-    "@vendure-platform/integration": "{{pluginVersionSpec}}",
     "@vendure-platform/scenario-default": "{{pluginVersionSpec}}",
-    "@vendure-platform/platform": "{{pluginVersionSpec}}",
-    "dotenv": "^16.4.7"{{pluginDependencies}}
+    "dotenv": "^16.4.7"{{platformDependencies}}
   },
   "devDependencies": {
     "vite": "^6.3.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
     "@types/node": "^22.0.0",
-    "@vendure/testing": "^3.6.2"
+    "@vendure/cli": "^3.8.0-0",
+    "@vendure/testing": "^3.8.0-0",
+    "@vendure-platform/cli": "{{pluginVersionSpec}}"
+  },
+  "vendure": {
+    "cli": {
+      "plugins": ["@vendure-platform/cli"]
+    }
   }
 }

package/dist/assets/templates/vendure-config.ts.hbs

@@ -1,8 +1,12 @@
 {{platformPluginImports}}
+{{#if profile}}
+import { platformEdition } from './platform-edition';
+{{/if}}
 import { AssetServerPlugin } from '@vendure/asset-server-plugin';
 import {
     configureDefaultOrderProcess,
     DefaultJobQueuePlugin,
+    DefaultSchedulerPlugin,
     dummyPaymentHandler,
     NativeAuthenticationStrategy,
     VendureConfig,
@@ -72,7 +76,21 @@ export const config: VendureConfig = {
         DefaultJobQueuePlugin.init({
             pollInterval: 2000,
         }),
+        // Without a scheduler plugin Vendure uses `NoopSchedulerStrategy`, and
+        // every scheduled task the platform plugins declare never runs.
+        DefaultSchedulerPlugin.init({}),
         ...VendurePlatform.init({
+{{#if profile}}
+            // The edition this deployment composes. The Vendure CLI maintains
+            // `platform-edition.ts`; keep your own options below it.
+            ...platformEdition,
+{{else}}
+            compositionCapabilities: [
+{{#each compositionCapabilities}}
+                '{{this}}',
+{{/each}}
+            ],
+{{/if}}
 {{platformPluginOptions}}
         }),
         DashboardPlugin.init({

package/dist/bin/run.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-"use strict";var e=this&&this.__createBinding||(Object.create?function(e,t,n,o){void 0===o&&(o=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,o,r)}:function(e,t,n,o){void 0===o&&(o=n),e[o]=t[n]}),t=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),n=this&&this.__importStar||function(){var n=function(e){return n=Object.getOwnPropertyNames||function(e){var t=[];for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&(t[t.length]=n);return t},n(e)};return function(o){if(o&&o.__esModule)return o;var r={};if(null!=o)for(var i=n(o),a=0;a<i.length;a++)"default"!==i[a]&&e(r,o,i[a]);return t(r,o),r}}();Object.defineProperty(exports,"__esModule",{value:!0});const o=n(require("fs")),r=n(require("path")),i=require("commander"),a=require("../cli"),s=require("../scaffolder"),u=require("../scaffold-storefront-only"),l=require("../add-to-existing");function c(){const e=r.join(__dirname,"..","..","package.json");return JSON.parse(o.readFileSync(e,"utf8")).version}const p=(new i.Command).name("create-vendure-platform").description("Scaffold a Vendure project with Vendure Platform plugins, or a standalone storefront").version(c(),"-v, --version").enablePositionalOptions();p.command("add").description("Add Vendure Platform to an existing Vendure project (run from the project root)").option("--plugins <list>","Comma-separated list of plugin keys to include (skips the interactive prompt)").option("--registry-token <token>","Vendure private-registry npm auth token (written to project .npmrc as _authToken)").option("--license-token <token>","Vendure Platform server-side license token (written to .env as VENDURE_PLATFORM_LICENSE_TOKEN)").option("--dry-run","Show what would be changed without writing files").action(async e=>{const t=await(0,l.runAddToExistingCli)({plugins:e.plugins,dryRun:e.dryRun,registryToken:e.registryToken,licenseToken:e.licenseToken});await(0,l.addToExisting)(t)}),p.argument("[project-name]","Name of the project to create").option("--plugins <list>","Comma-separated list of plugin keys to include").option("--company <name>","Company name for the demo project").option("--no-storefront","Skip the Next.js storefront").option("--github","Create a GitHub repository").option("--github-org <org>","GitHub organization (only used with --github)","vendurehq").option("--no-github","Do not create a GitHub repository").option("--no-install","Skip dependency install").option("--no-git","Skip git init").option("--dry-run","Show what would be created without writing files").option("--storefront-only","Scaffold just the Next.js storefront, no server or plugins").option("--api-url <url>","Vendure Shop API URL (storefront-only mode)").option("--scenario <name>","Storefront scenario (storefront-only mode; default: customer)").option("--pm <bun|npm|pnpm>","Package manager used for the install step (default: bun)").option("--registry-token <token>","Vendure private-registry npm auth token (written to project .npmrc as _authToken)").option("--license-token <token>","Vendure Platform server-side license token (written to .env as VENDURE_PLATFORM_LICENSE_TOKEN)").action(async(e,t)=>{const n={plugins:t.plugins,company:t.company,storefront:t.storefront,github:t.github,githubOrg:t.githubOrg,install:t.install,git:t.git,dryRun:t.dryRun,storefrontOnly:t.storefrontOnly,apiUrl:t.apiUrl,scenario:t.scenario,pm:t.pm,registryToken:t.registryToken,licenseToken:t.licenseToken};if(n.storefrontOnly){const t=await(0,a.runStorefrontOnlyCli)(e,n);return void await(0,u.scaffoldStorefrontOnly)(t)}const o=await(0,a.runCli)(e,n);await(0,s.scaffold)(o)}),p.parseAsync().catch(e=>{console.error("Error:",e.message),process.exit(1)});
+"use strict";var e=this&&this.__createBinding||(Object.create?function(e,o,t,n){void 0===n&&(n=t);var r=Object.getOwnPropertyDescriptor(o,t);r&&!("get"in r?!o.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return o[t]}}),Object.defineProperty(e,n,r)}:function(e,o,t,n){void 0===n&&(n=t),e[n]=o[t]}),o=this&&this.__setModuleDefault||(Object.create?function(e,o){Object.defineProperty(e,"default",{enumerable:!0,value:o})}:function(e,o){e.default=o}),t=this&&this.__importStar||function(){var t=function(e){return t=Object.getOwnPropertyNames||function(e){var o=[];for(var t in e)Object.prototype.hasOwnProperty.call(e,t)&&(o[o.length]=t);return o},t(e)};return function(n){if(n&&n.__esModule)return n;var r={};if(null!=n)for(var i=t(n),s=0;s<i.length;s++)"default"!==i[s]&&e(r,n,i[s]);return o(r,n),r}}();Object.defineProperty(exports,"__esModule",{value:!0});const n=require("commander"),r=t(require("fs")),i=t(require("path")),s=require("../add-to-existing"),a=require("../cli"),l=require("../scaffold-storefront-only"),c=require("../scaffolder");function u(){const e=i.join(__dirname,"..","..","package.json");return JSON.parse(r.readFileSync(e,"utf8")).version}const f=(new n.Command).name("create-vendure-platform").description("Scaffold a Vendure project with Vendure Platform plugins, or a standalone storefront").version(u(),"-v, --version").enablePositionalOptions();f.command("add").description("Add Vendure Platform to an existing Vendure project (run from the project root)").option("--plugins <list>","Comma-separated list of plugin keys to include (skips the interactive prompt)").option("--registry-token <token>","Registry Access Token for CI and offline scaffolds (written to project .npmrc as _authToken). The interactive flow gets one from Vendure Console instead").option("--license-token <token>","Environment Credential for CI and offline scaffolds (written to .env as VENDURE_PLATFORM_LICENSE_TOKEN). The interactive flow leaves this to vendure dev").option("--dry-run","Show what would be changed without writing files").action(async e=>{const o=await(0,s.runAddToExistingCli)({plugins:e.plugins,dryRun:e.dryRun,registryToken:e.registryToken,licenseToken:e.licenseToken});await(0,s.addToExisting)(o)}),f.argument("[project-name]","Name of the project to create").option("--plugins <list>","Comma-separated list of plugin keys to include").option("--profile <name>","Capability profile to scaffold (starter|growth|scale|enterprise). Resolves the plugin set, options, and services from the profile grants").option("--company <name>","Company name for the demo project").option("--no-storefront","Skip the Next.js storefront").option("--github","Create a GitHub repository").option("--github-org <org>","GitHub organization (only used with --github)","vendurehq").option("--no-github","Do not create a GitHub repository").option("--no-install","Skip dependency install").option("--no-git","Skip git init").option("--dry-run","Show what would be created without writing files").option("--storefront-only","Scaffold just the Next.js storefront, no server or plugins").option("--api-url <url>","Vendure Shop API URL (storefront-only mode)").option("--scenario <name>","Storefront scenario (storefront-only mode; default: customer)").option("--pm <bun|npm|pnpm>","Package manager used for the install step (default: bun)").option("--registry-token <token>","Registry Access Token for CI and offline scaffolds (written to project .npmrc as _authToken). The interactive flow gets one from Vendure Console instead").option("--license-token <token>","Environment Credential for CI and offline scaffolds (written to .env as VENDURE_PLATFORM_LICENSE_TOKEN). The interactive flow leaves this to vendure dev").option("--console-project <id>","Use this Vendure Console Project instead of asking which one this is. Needs a stored Console session, or VENDURE_HUB_PROJECTS naming a file that lists it").action(async(e,o)=>{const t={plugins:o.plugins,profile:o.profile,company:o.company,storefront:o.storefront,github:o.github,githubOrg:o.githubOrg,install:o.install,git:o.git,dryRun:o.dryRun,storefrontOnly:o.storefrontOnly,apiUrl:o.apiUrl,scenario:o.scenario,pm:o.pm,registryToken:o.registryToken,licenseToken:o.licenseToken,consoleProject:o.consoleProject};if(t.storefrontOnly){const o=await(0,a.runStorefrontOnlyCli)(e,t);return void await(0,l.scaffoldStorefrontOnly)(o)}const n=await(0,a.runCli)(e,t);await(0,c.scaffold)(n)}),f.parseAsync().catch(e=>{"ConsoleOnboardingCancelled"===(null==e?void 0:e.name)&&(console.log(e.message),process.exit(0)),console.error("Error:",e.message),process.exit(1)});

package/dist/cli.d.ts

@@ -1,4 +1,4 @@
-import { ScaffoldOptions, StorefrontOnlyOptions, CliFlags } from './types';
+import { CliFlags, ScaffoldOptions, StorefrontOnlyOptions } from './types';
 /**
  * Run the CLI in storefront-only mode. Returns options for `scaffoldStorefrontOnly`.
  * Interactive prompts kick in for any value not provided via flags.

package/dist/cli.js

@@ -1 +1 @@
-"use strict";var e=this&&this.__createBinding||(Object.create?function(e,n,r,t){void 0===t&&(t=r);var i=Object.getOwnPropertyDescriptor(n,r);i&&!("get"in i?!n.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return n[r]}}),Object.defineProperty(e,t,i)}:function(e,n,r,t){void 0===t&&(t=r),e[t]=n[r]}),n=this&&this.__setModuleDefault||(Object.create?function(e,n){Object.defineProperty(e,"default",{enumerable:!0,value:n})}:function(e,n){e.default=n}),r=this&&this.__importStar||function(){var r=function(e){return r=Object.getOwnPropertyNames||function(e){var n=[];for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&(n[n.length]=r);return n},r(e)};return function(t){if(t&&t.__esModule)return t;var i={};if(null!=t)for(var o=r(t),l=0;l<o.length;l++)"default"!==o[l]&&e(i,t,o[l]);return n(i,t),i}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.runStorefrontOnlyCli=p,exports.runCli=d;const t=r(require("@clack/prompts")),i=require("./plugin-registry"),o=["bun","npm","pnpm"];function l(e){if(!e)return"bun";if(o.includes(e))return e;throw new Error(`Invalid --pm value "${e}". Must be one of: ${o.join(", ")}`)}function a(e){if(e)try{return new URL(e),e}catch{throw new Error(`Invalid --api-url value "${e}": not a valid URL`)}}function s(e){return 0===e.trim().length?"Project name is required":/[^a-zA-Z0-9._-]/.test(e)?"Project name may only contain letters, numbers, dots, hyphens, and underscores":void 0}function c(){return i.pluginRegistry.filter(e=>"optional"===e.tier||"requires-config"===e.tier).sort((e,n)=>e.category!==n.category?e.category.localeCompare(n.category):e.displayName.localeCompare(n.displayName)).map(e=>({label:`${e.displayName} (${e.category})`,value:e.key,hint:"requires-config"===e.tier?"needs configuration":void 0}))}function u(){return i.pluginRegistry.filter(e=>"optional"===e.tier).map(e=>e.key)}async function p(e,n){var r,i,o;const c=l(null==n?void 0:n.pm),u=a(null==n?void 0:n.apiUrl),p=null!==(r=null==n?void 0:n.scenario)&&void 0!==r?r:"customer";if(e&&u){const r=s(e);return r&&(t.log.error(`Error: ${r}`),process.exit(1)),{projectName:e,apiUrl:u,scenario:p,packageManager:c,skipInstall:!1===(null==n?void 0:n.install),skipGit:!1===(null==n?void 0:n.git),dryRun:null!==(i=null==n?void 0:n.dryRun)&&void 0!==i&&i}}if(t.intro("create-vendure-platform (storefront-only)"),e){const n=s(e);n&&(t.cancel(n),process.exit(1))}const d=await t.group({projectName:()=>e?Promise.resolve(e):t.text({message:"Project name:",validate:s}),apiUrl:()=>u?Promise.resolve(u):t.text({message:"Vendure Shop API URL (leave blank to use http://localhost:3500/shop-api):",placeholder:"https://shop.example.com/shop-api",validate:e=>{if(e)try{new URL(e)}catch{return"Must be a valid URL"}}}),installDeps:()=>t.confirm({message:`Install dependencies with ${c}?`,initialValue:!0})},{onCancel:()=>{t.cancel("Setup cancelled."),process.exit(0)}});return{projectName:d.projectName,apiUrl:d.apiUrl||void 0,scenario:p,packageManager:c,skipInstall:!d.installDeps,skipGit:!1===(null==n?void 0:n.git),dryRun:null!==(o=null==n?void 0:n.dryRun)&&void 0!==o&&o}}async function d(e,n){var r,i,o,a,p,d,m,v,g;const f=l(null==n?void 0:n.pm);if(e&&(null==n?void 0:n.company)&&void 0!==(null==n?void 0:n.plugins)){const l=s(e);l&&(t.log.error(`Error: ${l}`),process.exit(1));const c=n.plugins?n.plugins.split(",").map(e=>e.trim()).filter(Boolean):[];return{projectName:e,companyName:n.company,selectedPlugins:c,includeStorefront:null===(r=n.storefront)||void 0===r||r,createGithubRepo:null!==(i=n.github)&&void 0!==i&&i,githubOrg:n.githubOrg,packageManager:f,skipInstall:!1===n.install,skipGit:!1===n.git,dryRun:null!==(o=n.dryRun)&&void 0!==o&&o,registryToken:(null===(a=n.registryToken)||void 0===a?void 0:a.trim())||void 0,licenseToken:(null===(p=n.licenseToken)||void 0===p?void 0:p.trim())||void 0}}if(t.intro("create-vendure-platform"),e){const n=s(e);n&&(t.cancel(n),process.exit(1))}const y=c(),h=u(),k=await t.group({projectName:()=>e?Promise.resolve(e):t.text({message:"Project name:",validate:s}),registryToken:()=>void 0!==(null==n?void 0:n.registryToken)?Promise.resolve(n.registryToken):t.password({message:`Vendure private-registry npm auth token (from https://enterprise.vendure.io). Used by \`${f} install\`. Leave blank to skip:`}),licenseToken:()=>void 0!==(null==n?void 0:n.licenseToken)?Promise.resolve(n.licenseToken):t.password({message:"Vendure Platform license token (server-side, written to .env). Leave blank to skip:"}),companyName:({results:e})=>{const n=e.projectName.replace(/^vendure-/,"").replace(/-demo$/,"").replace(/-/g," ").replace(/\b\w/g,e=>e.toUpperCase());return t.text({message:"Company name (used in README and project branding):",defaultValue:n,placeholder:n})},selectedPlugins:()=>t.multiselect({message:"Optional plugins to include (core plugins are always installed):",options:y,initialValues:h,required:!1}),includeStorefront:()=>t.confirm({message:"Include the Next.js storefront?",initialValue:!0}),installDeps:()=>t.confirm({message:`Install dependencies with ${f}?`,initialValue:!0})},{onCancel:()=>{t.cancel("Setup cancelled."),process.exit(0)}}),b=null!==(m=null===(d=k.registryToken)||void 0===d?void 0:d.trim())&&void 0!==m?m:"",j=null!==(g=null===(v=k.licenseToken)||void 0===v?void 0:v.trim())&&void 0!==g?g:"";return{projectName:k.projectName,companyName:k.companyName,selectedPlugins:k.selectedPlugins,includeStorefront:k.includeStorefront,createGithubRepo:!1,githubOrg:void 0,packageManager:f,skipInstall:!k.installDeps,registryToken:""===b?void 0:b,licenseToken:""===j?void 0:j}}
+"use strict";var e=this&&this.__createBinding||(Object.create?function(e,n,o,i){void 0===i&&(i=o);var r=Object.getOwnPropertyDescriptor(n,o);r&&!("get"in r?!n.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return n[o]}}),Object.defineProperty(e,i,r)}:function(e,n,o,i){void 0===i&&(i=o),e[i]=n[o]}),n=this&&this.__setModuleDefault||(Object.create?function(e,n){Object.defineProperty(e,"default",{enumerable:!0,value:n})}:function(e,n){e.default=n}),o=this&&this.__importStar||function(){var o=function(e){return o=Object.getOwnPropertyNames||function(e){var n=[];for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&(n[n.length]=o);return n},o(e)};return function(i){if(i&&i.__esModule)return i;var r={};if(null!=i)for(var t=o(i),l=0;l<t.length;l++)"default"!==t[l]&&e(r,i,t[l]);return n(r,i),r}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.runStorefrontOnlyCli=h,exports.runCli=j;const i=o(require("@clack/prompts")),r=o(require("path")),t=require("./console-onboarding"),l=require("./hub-projects"),a=require("./plugin-registry");function s(e){if(e){if(!(0,a.isCapabilityProfileName)(e))throw new Error(`Invalid --profile value "${e}". Must be one of: ${a.CAPABILITY_PROFILE_NAMES.join(", ")}`);return e}}const c=["bun","npm","pnpm"];function u(e){if(!e)return"bun";if(c.includes(e))return e;throw new Error(`Invalid --pm value "${e}". Must be one of: ${c.join(", ")}`)}function d(e){if(e)try{return new URL(e),e}catch{throw new Error(`Invalid --api-url value "${e}": not a valid URL`)}}function p(e){return 0===e.trim().length?"Project name is required":/[^a-zA-Z0-9._-]/.test(e)?"Project name may only contain letters, numbers, dots, hyphens, and underscores":void 0}function v(){return a.pluginRegistry.filter(e=>"optional"===e.tier||"requires-config"===e.tier).sort((e,n)=>e.category!==n.category?e.category.localeCompare(n.category):e.displayName.localeCompare(n.displayName)).map(e=>({label:`${e.displayName} (${e.category})`,value:e.key,hint:"requires-config"===e.tier?"needs configuration":void 0}))}function f(){return a.pluginRegistry.filter(e=>"optional"===e.tier).map(e=>e.key)}function g(){return Boolean(process.stdin.isTTY&&process.stdout.isTTY)}function m(e){if(!g())throw new Error(`No interactive terminal is available and required values are missing: ${e.join(", ")}. Pass them as flags to scaffold non-interactively.`)}async function y(e){const n=(0,l.resolveHubProjectSource)();if(!n)return;const o=await(0,l.listHubProjects)(n,e=>i.log.warn(`Could not read your Vendure Console projects: ${e}`));if(0===o.length)return;if(e){const n=o.find(n=>n.id===e);if(!n)throw new Error(`--console-project ${e} is not in the project list. Available: ${o.map(e=>e.id).join(", ")}`);return n}const r=await i.select({message:"Which Vendure Console project is this?",options:[...o.map(e=>({label:e.name,value:e.id,hint:`${e.edition} edition`})),{label:"None of these (pick plugins manually)",value:""}]});return i.isCancel(r)&&(i.cancel("Setup cancelled."),process.exit(0)),o.find(e=>e.id===r)}async function h(e,n){var o,r,t;const l=u(null==n?void 0:n.pm),a=d(null==n?void 0:n.apiUrl),s=null!==(o=null==n?void 0:n.scenario)&&void 0!==o?o:"customer";if(e&&a){const o=p(e);return o&&(i.log.error(`Error: ${o}`),process.exit(1)),{projectName:e,apiUrl:a,scenario:s,packageManager:l,skipInstall:!1===(null==n?void 0:n.install),skipGit:!1===(null==n?void 0:n.git),dryRun:null!==(r=null==n?void 0:n.dryRun)&&void 0!==r&&r}}if(m([...e?[]:["<project-name>"],...a?[]:["--api-url"]]),i.intro("create-vendure-platform (storefront-only)"),e){const n=p(e);n&&(i.cancel(n),process.exit(1))}const c=await i.group({projectName:()=>e?Promise.resolve(e):i.text({message:"Project name:",validate:p}),apiUrl:()=>a?Promise.resolve(a):i.text({message:"Vendure Shop API URL (leave blank to use http://localhost:3500/shop-api):",placeholder:"https://shop.example.com/shop-api",validate:e=>{if(e)try{new URL(e)}catch{return"Must be a valid URL"}}}),installDeps:()=>i.confirm({message:`Install dependencies with ${l}?`,initialValue:!0})},{onCancel:()=>{i.cancel("Setup cancelled."),process.exit(0)}});return{projectName:c.projectName,apiUrl:c.apiUrl||void 0,scenario:s,packageManager:l,skipInstall:!c.installDeps,skipGit:!1===(null==n?void 0:n.git),dryRun:null!==(t=null==n?void 0:n.dryRun)&&void 0!==t&&t}}async function j(e,n){var o,l,c,d,g,h,j,b,P,k,R,O,N;const C=u(null==n?void 0:n.pm),$=s(null==n?void 0:n.profile);if($&&void 0!==(null==n?void 0:n.plugins))throw new Error("--profile and --plugins are mutually exclusive. A profile resolves its own plugins.");if((null==n?void 0:n.consoleProject)&&($||void 0!==n.plugins))throw new Error("--console-project is mutually exclusive with --profile and --plugins. The Project names the edition.");if(e&&(null==n?void 0:n.company)&&(void 0!==(null==n?void 0:n.plugins)||$)){const r=p(e);r&&(i.log.error(`Error: ${r}`),process.exit(1));const t=$?(0,a.resolveProfilePluginKeys)($):n.plugins?n.plugins.split(",").map(e=>e.trim()).filter(Boolean):[];return{projectName:e,companyName:n.company,selectedPlugins:t,profile:$,includeStorefront:null===(o=n.storefront)||void 0===o||o,createGithubRepo:null!==(l=n.github)&&void 0!==l&&l,githubOrg:n.githubOrg,packageManager:C,skipInstall:!1===n.install,skipGit:!1===n.git,dryRun:null!==(c=n.dryRun)&&void 0!==c&&c,registryToken:(null===(d=n.registryToken)||void 0===d?void 0:d.trim())||void 0,licenseToken:(null===(g=n.licenseToken)||void 0===g?void 0:g.trim())||void 0}}if(e&&(null==n?void 0:n.company)&&(null==n?void 0:n.consoleProject)&&void 0===(null==n?void 0:n.plugins)){const o=p(e);if(o)throw new Error(o);const i=await y(n.consoleProject);let l,c=null==i?void 0:i.edition;if(!i){if(l=await(0,t.startConsoleOnboarding)({projectDir:r.resolve(process.cwd(),e),interactive:!1,projectId:n.consoleProject}),!l)throw new Error("--console-project needs a stored Vendure Console session, or VENDURE_HUB_PROJECTS naming a file that lists it. Neither was usable, and this run has no terminal to sign in from.");c=l.edition}const u=s(c);if(!u)throw new Error(`Vendure Console reports no edition for project ${n.consoleProject}, so there is no package set to scaffold. Give the Project an edition, or scaffold with --profile instead.`);return{projectName:e,companyName:n.company,selectedPlugins:(0,a.resolveProfilePluginKeys)(u),profile:u,includeStorefront:null===(h=n.storefront)||void 0===h||h,createGithubRepo:null!==(j=n.github)&&void 0!==j&&j,githubOrg:n.githubOrg,packageManager:C,skipInstall:!1===n.install,skipGit:!1===n.git,dryRun:null!==(b=n.dryRun)&&void 0!==b&&b,registryToken:(null===(P=n.registryToken)||void 0===P?void 0:P.trim())||void 0,licenseToken:(null===(k=n.licenseToken)||void 0===k?void 0:k.trim())||void 0,consoleOnboarding:l}}if(m([...e?[]:["<project-name>"],...(null==n?void 0:n.company)?[]:["--company"],...void 0!==(null==n?void 0:n.plugins)||$?[]:["--plugins or --profile"]]),i.intro("create-vendure-platform"),e){const n=p(e);n&&(i.cancel(n),process.exit(1))}const x=null!=e?e:await w();let E,T=$;if(!$&&!(null==n?void 0:n.dryRun)){const e=await y(null==n?void 0:n.consoleProject);e?(T=e.edition,i.log.info(`${e.name} is on the ${e.edition} edition.`)):(E=await(0,t.startConsoleOnboarding)({projectDir:r.resolve(process.cwd(),x),interactive:!0,projectId:null==n?void 0:n.consoleProject}),T=null==E?void 0:E.edition)}const I=v(),_=f(),S=await i.group({companyName:()=>{const e=x.replace(/^vendure-/,"").replace(/-demo$/,"").replace(/-/g," ").replace(/\b\w/g,e=>e.toUpperCase());return i.text({message:"Company name (used in README and project branding):",defaultValue:e,placeholder:e})},selectedPlugins:()=>T?Promise.resolve((0,a.resolveProfilePluginKeys)(T)):i.multiselect({message:"Optional plugins to include (core plugins are always installed):",options:I,initialValues:_,required:!1}),includeStorefront:()=>i.confirm({message:"Include the Next.js storefront?",initialValue:!0}),installDeps:()=>i.confirm({message:`Install dependencies with ${C}?`,initialValue:!0})},{onCancel:()=>{i.cancel("Setup cancelled."),process.exit(0)}});return{projectName:x,companyName:S.companyName,selectedPlugins:S.selectedPlugins,profile:T,includeStorefront:S.includeStorefront,createGithubRepo:!1,githubOrg:void 0,packageManager:C,skipInstall:!S.installDeps,dryRun:null!==(R=null==n?void 0:n.dryRun)&&void 0!==R&&R,registryToken:(null===(O=null==n?void 0:n.registryToken)||void 0===O?void 0:O.trim())||void 0,licenseToken:(null===(N=null==n?void 0:n.licenseToken)||void 0===N?void 0:N.trim())||void 0,consoleOnboarding:E}}async function w(){const e=await i.text({message:"Project name:",validate:p});return i.isCancel(e)&&(i.cancel("Setup cancelled."),process.exit(0)),e}

package/dist/console-onboarding.d.ts

@@ -0,0 +1,44 @@
+import type { CapabilityProfileName } from '@vendure-platform/plugin-meta';
+/**
+ * What a scaffold learned from Console before it wrote anything, and how to
+ * finish once there is a directory to write into.
+ */
+export interface ConsoleOnboarding {
+    project: {
+        id: string;
+        name: string;
+    };
+    /** The edition the Project holds, which decides the facade and the options. */
+    edition: CapabilityProfileName | undefined;
+    /**
+     * Write the Project Link Manifest and acquire the Registry Access Token for
+     * `projectDir`. Called once the directory exists.
+     */
+    finish(projectDir: string): Promise<ConsoleOnboardingResult>;
+}
+export interface ConsoleOnboardingResult {
+    registryUrl: string;
+    scope: string;
+    /** Undefined when no token could be issued; `registryLogin` then says why. */
+    registryToken?: string;
+    registryLogin?: string;
+}
+/**
+ * Sign in to Console and decide which Project this scaffold is for.
+ *
+ * Returns `undefined` for every ordinary reason a scaffold carries on without
+ * Console: no terminal to ask in, a declined login, or a session another
+ * process holds the lock on. An offline scaffold is a supported flow, so none
+ * of those stop the run.
+ */
+export declare function startConsoleOnboarding(options: {
+    /** The directory the scaffold will create. Anchors the create Idempotency-Key. */
+    projectDir: string;
+    interactive: boolean;
+    /**
+     * The Project to use, instead of asking. A Project the account does not
+     * hold is an error: creating one is a decision, and naming an id is a
+     * different one already taken.
+     */
+    projectId?: string;
+}): Promise<ConsoleOnboarding | undefined>;

package/dist/console-onboarding.js

@@ -0,0 +1 @@
+"use strict";var e=this&&this.__createBinding||(Object.create?function(e,n,t,o){void 0===o&&(o=t);var r=Object.getOwnPropertyDescriptor(n,t);r&&!("get"in r?!n.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return n[t]}}),Object.defineProperty(e,o,r)}:function(e,n,t,o){void 0===o&&(o=t),e[o]=n[t]}),n=this&&this.__setModuleDefault||(Object.create?function(e,n){Object.defineProperty(e,"default",{enumerable:!0,value:n})}:function(e,n){e.default=n}),t=this&&this.__importStar||function(){var t=function(e){return t=Object.getOwnPropertyNames||function(e){var n=[];for(var t in e)Object.prototype.hasOwnProperty.call(e,t)&&(n[n.length]=t);return n},t(e)};return function(o){if(o&&o.__esModule)return o;var r={};if(null!=o)for(var i=t(o),s=0;s<i.length;s++)"default"!==i[s]&&e(r,o,i[s]);return n(r,o),r}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.startConsoleOnboarding=a;const o=t(require("@clack/prompts")),r=require("@vendure-platform/console-auth"),i=require("./plugin-registry"),s=require("./registry");async function a(e){let n;try{n=(0,r.consoleOrigins)({apiOrigin:process.env.VENDURE_CONSOLE_API_URL,appOrigin:process.env.VENDURE_CONSOLE_APP_URL})}catch(e){return void o.log.warn(`${d(e)} Continuing without Vendure Console.`)}const t=await l(n,e.interactive);if(!t)return;let s=t;const a=new r.ConsoleApi({apiOrigin:n.apiOrigin,getAccessToken:()=>s,refreshAccessToken:async()=>{s=await(0,r.refreshStoredConsoleToken)(n)}});let g;try{g=await(0,r.selectConsoleProject)({api:a,interaction:u(e.projectId),projectRoot:e.projectDir})}catch(e){if(e instanceof r.ConsoleOnboardingCancelled)throw e;return void o.log.warn(`${d(e)} Continuing without a Vendure Console Project.`)}return{project:{id:g.project.id,name:g.project.name},edition:g.edition&&(0,i.isCapabilityProfileName)(g.edition)?g.edition:void 0,finish:e=>c(a,g.project,e)}}async function c(e,n,t){await(0,r.writeProjectLink)({api:e,interaction:u(),projectRoot:t,projectId:n.id}),o.log.success(`Linked ${t} to ${n.name}.`);const i=await(0,r.acquireRegistryAccess)({api:e,projectId:n.id,interaction:{confirmRotate:async e=>{const n=await o.confirm({message:`Replace the Registry Access Token "${e}"? Whatever installs with the current one stops working.`,initialValue:!1});if(o.isCancel(n))throw new r.ConsoleOnboardingCancelled;return n},report:e=>o.log.info(e),warn:e=>o.log.warn(e)},defaultRegistryUrl:(0,s.getRegistryUrl)(),defaultScope:s.REGISTRY_SCOPE});if("npm-login"===i.fallback){const e=`npm login --auth-type=web --registry=${(0,s.registryLoginUrl)(i.registryUrl)}`;return o.log.warn(`Your Console account cannot issue Registry Access Tokens for ${n.name}. Log in to the registry instead:\n  ${e}`),{registryUrl:i.registryUrl,scope:i.scope,registryLogin:e}}return{registryUrl:i.registryUrl,scope:i.scope,registryToken:i.token}}async function l(e,n){try{const n=await(0,r.resolveStoredConsoleToken)(e);if(n)return n}catch(e){return void o.log.warn(`${d(e)} Continuing without Vendure Console.`)}if(!n)return;const t=await o.confirm({message:"Sign in to Vendure Console to set this project up?",initialValue:!0});if(o.isCancel(t))throw new r.ConsoleOnboardingCancelled;if(!t)return;const i=o.spinner();i.start("Waiting for you to finish signing in to Vendure Console");try{const n=await(0,r.loginAndStoreConsoleToken)({client:"create",...e,reportAuthorizationUrl:e=>o.log.info(`Open this URL to sign in: ${e}`)});return i.stop("Signed in to Vendure Console."),n}catch(e){return i.stop("Could not sign in to Vendure Console."),void o.log.warn(`${d(e)} Continuing without it.`)}}function u(e){return{chooseProject:async n=>{if(e){const t=n.find(n=>n.id===e);if(!t)throw new Error(`--console-project ${e} is not one of your Vendure Console Projects.`);return t}const t=await o.select({message:"Which Vendure Console Project is this?",options:[...n.map(e=>({label:e.name,value:e.id,hint:e.edition?`${e.edition} edition`:"no edition yet"})),{label:"Create a new Project",value:""}]});if(o.isCancel(t))throw new r.ConsoleOnboardingCancelled;return n.find(e=>e.id===t)},newProjectName:async()=>{const e=await o.text({message:"Name for the new Vendure Console Project:",validate:e=>e.trim()?void 0:"A name is required"});if(o.isCancel(e))throw new r.ConsoleOnboardingCancelled;return e},chooseEvaluation:async e=>{const n=await o.select({message:"This Project has no edition yet. Which one would you like to evaluate?",options:[...e.map(e=>({label:`${e} edition`,value:e})),{label:"Not now",value:""}]});if(o.isCancel(n))throw new r.ConsoleOnboardingCancelled;return e.find(e=>e===n)},report:e=>o.log.info(e),warn:e=>o.log.warn(e)}}function d(e){return e instanceof Error?e.message:String(e)}

package/dist/hub-projects.d.ts

@@ -0,0 +1,48 @@
+import type { CapabilityProfileName } from '@vendure-platform/plugin-meta';
+/**
+ * A project the authenticated account owns in the Vendure Console (Hub), with
+ * the edition it was sold. The edition decides which facade the scaffolded
+ * project installs, which options block it writes, and whether it receives
+ * storefront assets.
+ */
+export interface HubProject {
+    id: string;
+    name: string;
+    edition: CapabilityProfileName;
+}
+/** Where `create` reads the account's projects from. */
+export interface HubProjectSource {
+    listProjects(): Promise<HubProject[]>;
+}
+/**
+ * Environment variable naming a JSON file of `HubProject` records. Used by the
+ * create-flow harness and by demo scaffolds that must exercise the Console path
+ * offline.
+ */
+export declare const HUB_PROJECTS_FIXTURE_ENV = "VENDURE_HUB_PROJECTS";
+export declare const CONSOLE_ACCESS_TOKEN_ENV = "VENDURE_CONSOLE_ACCESS_TOKEN";
+/** Reads projects from a JSON file. Throws when the file is missing or malformed. */
+export declare function fileHubProjectSource(path: string): HubProjectSource;
+/** Reads projects with the WorkOS bearer token issued by Vendure Console. */
+export declare function httpHubProjectSource(accessToken: string, options?: {
+    apiOrigin?: string;
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+}): HubProjectSource;
+/**
+ * The source to use, or `undefined` when no Console credential is configured.
+ * A caller that gets `undefined` must fall back to a manual selection rather
+ * than blocking — an offline scaffold is a supported flow.
+ */
+export declare function resolveHubProjectSource(env?: NodeJS.ProcessEnv): HubProjectSource | undefined;
+/** Validates the wire shape. An unknown edition is a hard error, not a silent Starter. */
+export declare function parseHubProjects(value: unknown): HubProject[];
+/**
+ * The account's projects, or an empty list when no source is configured or the
+ * lookup fails.
+ *
+ * `onLookupFailed` fires only for the second case. Having no Console credential
+ * is the normal state of an offline scaffold, not something to report, and a
+ * caller that announced it would print a line on every interactive run.
+ */
+export declare function listHubProjects(source: HubProjectSource | undefined, onLookupFailed?: (reason: string) => void): Promise<HubProject[]>;

package/dist/hub-projects.js

@@ -0,0 +1 @@
+"use strict";var e=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var n=Object.getOwnPropertyDescriptor(r,t);n&&!("get"in n?!r.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,n)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),r=this&&this.__setModuleDefault||(Object.create?function(e,r){Object.defineProperty(e,"default",{enumerable:!0,value:r})}:function(e,r){e.default=r}),t=this&&this.__importStar||function(){var t=function(e){return t=Object.getOwnPropertyNames||function(e){var r=[];for(var t in e)Object.prototype.hasOwnProperty.call(e,t)&&(r[r.length]=t);return r},t(e)};return function(o){if(o&&o.__esModule)return o;var n={};if(null!=o)for(var i=t(o),s=0;s<i.length;s++)"default"!==i[s]&&e(n,o,i[s]);return r(n,o),n}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.CONSOLE_ACCESS_TOKEN_ENV=exports.HUB_PROJECTS_FIXTURE_ENV=void 0,exports.fileHubProjectSource=u,exports.httpHubProjectSource=c,exports.resolveHubProjectSource=l,exports.parseHubProjects=d,exports.listHubProjects=f;const o=require("@vendure-platform/console-auth"),n=t(require("fs-extra")),i=require("./plugin-registry");exports.HUB_PROJECTS_FIXTURE_ENV="VENDURE_HUB_PROJECTS",exports.CONSOLE_ACCESS_TOKEN_ENV="VENDURE_CONSOLE_ACCESS_TOKEN";const s="/v1/projects/editions",a=1e4;function u(e){return{listProjects:async()=>d(await n.readJson(e))}}function c(e,r={}){var t,n;const i=(0,o.consoleApiOrigin)(null!==(t=r.apiOrigin)&&void 0!==t?t:o.DEFAULT_CONSOLE_API_ORIGIN),u=null!==(n=r.fetch)&&void 0!==n?n:globalThis.fetch;return{listProjects:async()=>{var t;const o=new AbortController,n=setTimeout(()=>o.abort(),null!==(t=r.timeoutMs)&&void 0!==t?t:a);let c;try{c=await u(`${i}${s}`,{method:"GET",redirect:"error",signal:o.signal,headers:{Accept:"application/json",Authorization:`Bearer ${e}`}})}catch(e){if(e instanceof Error&&"AbortError"===e.name)throw new Error("The Vendure Console project lookup timed out.");throw new Error("Could not reach Vendure Console.")}finally{clearTimeout(n)}if(!c.ok)throw new Error(`Vendure Console returned HTTP ${c.status}.`);try{return d(await c.json())}catch(e){if(e instanceof SyntaxError)throw new Error("Vendure Console returned malformed JSON.");throw e}}}}function l(e=process.env){var r,t;const o=null===(r=e[exports.HUB_PROJECTS_FIXTURE_ENV])||void 0===r?void 0:r.trim();if(o)return u(o);const n=null===(t=e[exports.CONSOLE_ACCESS_TOKEN_ENV])||void 0===t?void 0:t.trim();return n?c(n):void 0}function d(e){if(!Array.isArray(e))throw new Error("Expected a JSON array of Vendure Console projects.");return e.map((e,r)=>{const t=e;if("string"!=typeof(null==t?void 0:t.id)||"string"!=typeof(null==t?void 0:t.name))throw new Error(`Console project at index ${r} has no id or name.`);if("string"!=typeof t.edition||!(0,i.isCapabilityProfileName)(t.edition))throw new Error(`Console project "${t.name}" has an unknown edition "${String(t.edition)}".`);return{id:t.id,name:t.name,edition:t.edition}})}async function f(e,r){if(!e)return[];try{return await e.listProjects()}catch(e){return null==r||r(e instanceof Error?e.message:String(e)),[]}}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export { scaffold, TEMPLATE_FILES } from './scaffolder';
-export { scaffoldStorefrontOnly } from './scaffold-storefront-only';
-export { pluginRegistry, INTERNAL_PACKAGES, resolveActivePluginKeys, ALWAYS_ACTIVE_KEYS, SELECTABLE_KEYS, getPlugin, } from './plugin-registry';
+export type { PluginCategory, PluginKey, PluginMeta, PluginMetaKey, PluginTier, } from '@vendure-platform/plugin-meta';
 export { runCli, runStorefrontOnlyCli } from './cli';
-export { ScaffoldOptions, StorefrontOnlyOptions, PluginDefinition, ScaffolderPluginExtras, EnvVar, CliFlags, PackageManager, } from './types';
-export type { PluginKey, PluginTier, PluginCategory, PluginMeta, PluginMetaKey, } from '@vendure-platform/plugin-meta';
+export { ALWAYS_ACTIVE_KEYS, INTERNAL_PACKAGES, SELECTABLE_KEYS, getPlugin, pluginRegistry, resolveActivePluginKeys, } from './plugin-registry';
+export { scaffoldStorefrontOnly } from './scaffold-storefront-only';
+export { TEMPLATE_FILES, scaffold, templateFilesFor } from './scaffolder';
+export { CliFlags, EnvVar, PackageManager, PluginDefinition, ScaffoldOptions, ScaffolderPluginExtras, StorefrontOnlyOptions, } from './types';

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.runStorefrontOnlyCli=exports.runCli=exports.getPlugin=exports.SELECTABLE_KEYS=exports.ALWAYS_ACTIVE_KEYS=exports.resolveActivePluginKeys=exports.INTERNAL_PACKAGES=exports.pluginRegistry=exports.scaffoldStorefrontOnly=exports.TEMPLATE_FILES=exports.scaffold=void 0;var e=require("./scaffolder");Object.defineProperty(exports,"scaffold",{enumerable:!0,get:function(){return e.scaffold}}),Object.defineProperty(exports,"TEMPLATE_FILES",{enumerable:!0,get:function(){return e.TEMPLATE_FILES}});var r=require("./scaffold-storefront-only");Object.defineProperty(exports,"scaffoldStorefrontOnly",{enumerable:!0,get:function(){return r.scaffoldStorefrontOnly}});var t=require("./plugin-registry");Object.defineProperty(exports,"pluginRegistry",{enumerable:!0,get:function(){return t.pluginRegistry}}),Object.defineProperty(exports,"INTERNAL_PACKAGES",{enumerable:!0,get:function(){return t.INTERNAL_PACKAGES}}),Object.defineProperty(exports,"resolveActivePluginKeys",{enumerable:!0,get:function(){return t.resolveActivePluginKeys}}),Object.defineProperty(exports,"ALWAYS_ACTIVE_KEYS",{enumerable:!0,get:function(){return t.ALWAYS_ACTIVE_KEYS}}),Object.defineProperty(exports,"SELECTABLE_KEYS",{enumerable:!0,get:function(){return t.SELECTABLE_KEYS}}),Object.defineProperty(exports,"getPlugin",{enumerable:!0,get:function(){return t.getPlugin}});var n=require("./cli");Object.defineProperty(exports,"runCli",{enumerable:!0,get:function(){return n.runCli}}),Object.defineProperty(exports,"runStorefrontOnlyCli",{enumerable:!0,get:function(){return n.runStorefrontOnlyCli}});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.templateFilesFor=exports.scaffold=exports.TEMPLATE_FILES=exports.scaffoldStorefrontOnly=exports.resolveActivePluginKeys=exports.pluginRegistry=exports.getPlugin=exports.SELECTABLE_KEYS=exports.INTERNAL_PACKAGES=exports.ALWAYS_ACTIVE_KEYS=exports.runStorefrontOnlyCli=exports.runCli=void 0;var e=require("./cli");Object.defineProperty(exports,"runCli",{enumerable:!0,get:function(){return e.runCli}}),Object.defineProperty(exports,"runStorefrontOnlyCli",{enumerable:!0,get:function(){return e.runStorefrontOnlyCli}});var r=require("./plugin-registry");Object.defineProperty(exports,"ALWAYS_ACTIVE_KEYS",{enumerable:!0,get:function(){return r.ALWAYS_ACTIVE_KEYS}}),Object.defineProperty(exports,"INTERNAL_PACKAGES",{enumerable:!0,get:function(){return r.INTERNAL_PACKAGES}}),Object.defineProperty(exports,"SELECTABLE_KEYS",{enumerable:!0,get:function(){return r.SELECTABLE_KEYS}}),Object.defineProperty(exports,"getPlugin",{enumerable:!0,get:function(){return r.getPlugin}}),Object.defineProperty(exports,"pluginRegistry",{enumerable:!0,get:function(){return r.pluginRegistry}}),Object.defineProperty(exports,"resolveActivePluginKeys",{enumerable:!0,get:function(){return r.resolveActivePluginKeys}});var t=require("./scaffold-storefront-only");Object.defineProperty(exports,"scaffoldStorefrontOnly",{enumerable:!0,get:function(){return t.scaffoldStorefrontOnly}});var n=require("./scaffolder");Object.defineProperty(exports,"TEMPLATE_FILES",{enumerable:!0,get:function(){return n.TEMPLATE_FILES}}),Object.defineProperty(exports,"scaffold",{enumerable:!0,get:function(){return n.scaffold}}),Object.defineProperty(exports,"templateFilesFor",{enumerable:!0,get:function(){return n.templateFilesFor}});