orionplace-nuxt 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,6 +9,8 @@ setup CLI and the full storefront source, so every page and component in your
9
9
  project is yours to change.
10
10
 
11
11
  - **Setup CLI:** `init`, `set backend`, `add frontend`, `set mimic` and `update`.
12
+ - **Server install:** `install` builds the storefront on your Linux server and
13
+ runs it as a system service behind nginx with HTTPS.
12
14
  - **API gateway:** the browser calls `/api/...` on your own domain; the server
13
15
  forwards it to your marketplace backend with cookies bound to the storefront.
14
16
  - **Typed store:** one Application Load request fills it before the first render.
@@ -19,8 +21,8 @@ project is yours to change.
19
21
 
20
22
  **Contents:** [Quick start](#quick-start-from-zero) ·
21
23
  [Existing project](#existing-nuxt-4-project) · [Components](#components) ·
22
- [Commands](#commands) · [Android app](#android-app) ·
23
- [Update](#update-an-existing-project)
24
+ [Commands](#commands) · [Server install](#install-on-your-server) ·
25
+ [Android app](#android-app) · [Update](#update-an-existing-project)
24
26
 
25
27
  Requires Node.js 22.12+ and a Node server deployment. Static-only and edge
26
28
  hosting are not supported by this filesystem-based integration.
@@ -316,6 +318,9 @@ npx orionplace-nuxt add frontend shop.example.com
316
318
  npx orionplace-nuxt add frontend www.shop.example.com
317
319
  npx orionplace-nuxt remove frontend www.shop.example.com
318
320
  npx orionplace-nuxt set mimic shop.example.com
321
+ sudo npx orionplace-nuxt install
322
+ npx orionplace-nuxt status
323
+ sudo npx orionplace-nuxt restart
319
324
  npx orionplace-nuxt help
320
325
  ```
321
326
 
@@ -332,8 +337,63 @@ npm run orionplace:update
332
337
  ```
333
338
 
334
339
  `npm set` belongs to npm's own configuration system; use the commands above.
335
- These commands configure local integration files. They do not provision a backend,
336
- change your account, create DNS records, configure TLS, or deploy a VPS.
340
+ The setup commands configure local integration files. They do not provision a
341
+ backend, change your account or create DNS records. `install` deploys the
342
+ storefront on your server; see [Install on your server](#install-on-your-server).
343
+
344
+ ## Install on your server
345
+
346
+ Prepare a Linux server once with the OrionMarketplace server script: it installs
347
+ Node.js, nginx and certbot and adds the `orionplace` command
348
+ ([server guide](https://orionmarket.place/en/sandbox/install)).
349
+
350
+ ```bash
351
+ curl -fsSLo orionplace.sh https://orionmarket.place/downloads/orionplace.sh
352
+ sudo sh orionplace.sh setup
353
+ ```
354
+
355
+ Then create the storefront in `/srv/orionplace` and install it:
356
+
357
+ ```bash
358
+ cd /srv/orionplace
359
+ sudo npx --yes orionplace-nuxt init shop
360
+ cd shop
361
+ sudo npm install
362
+ sudo npx orionplace-nuxt install
363
+ ```
364
+
365
+ `install` asks for your backend and storefront domain when they are missing,
366
+ builds the project, runs it as the system service `orionplace-shop` on a free
367
+ local port and connects each storefront domain with nginx and a Let's Encrypt
368
+ certificate. Run it again after code or package updates; the service keeps its
369
+ port. Options: `--name <service>`, `--port <port>`, `--user <user>`,
370
+ `--no-build` (install the build already in the folder), `--no-domains`, `--yes`,
371
+ `--dry-run`. Full guide:
372
+ [Install a storefront](https://orionmarket.place/en/sandbox/install/storefront).
373
+
374
+ ### Manage the service
375
+
376
+ Run these in the project folder, or name the service from anywhere with
377
+ `--name shop`:
378
+
379
+ ```bash
380
+ npx orionplace-nuxt status # running?, autostart, port, home page answer, domains
381
+ sudo npx orionplace-nuxt start
382
+ sudo npx orionplace-nuxt stop
383
+ sudo npx orionplace-nuxt restart # waits until the home page answers again
384
+ sudo npx orionplace-nuxt logs 200 # last log lines; --follow keeps reading
385
+ npx orionplace-nuxt list # every storefront service on this server
386
+ sudo npx orionplace-nuxt uninstall # stop and remove the service (alias: cleanup)
387
+ ```
388
+
389
+ `start` and `restart` wait up to 90 seconds for the home page and print the
390
+ last log lines when it does not answer. `status` ends with code 3 when the
391
+ storefront is stopped or does not answer, so scripts and monitors can use it.
392
+ `uninstall` (or `cleanup`) stops the service, takes it out of autostart and
393
+ deletes its unit file and registration; the project folder and its build stay.
394
+ With the `orionplace` server tool it runs `orionplace app remove`, which also
395
+ turns the storefront's domains into a placeholder page. `--dry-run` shows what it
396
+ would remove; `--yes` skips the question.
337
397
 
338
398
  ## Generated files
339
399
 
@@ -397,6 +457,20 @@ authorization and cookies are forwarded. Backend statuses are retained and cooki
397
457
  Domain attributes are removed to bind cookies to the storefront. Gateway responses
398
458
  use `Cache-Control: no-store`. Network failures return `502`.
399
459
 
460
+ A changing request (POST, PUT, PATCH, DELETE) from another site is rejected with
461
+ `403`. A request from the page's own host or the storefront domain passes, and the
462
+ backend receives it with the storefront domain's origin
463
+ (`https://shop.example.com`), the one it accepts forms from. So a host that shows
464
+ the storefront through `X-Front-Domain`, such as a preview host or a local port,
465
+ can sign in too.
466
+
467
+ A changing request (POST, PUT, PATCH, DELETE) from another site is rejected with
468
+ `403`. A request from the page's own host or the storefront domain passes, and the
469
+ backend receives it with the storefront domain's origin
470
+ (`https://shop.example.com`), the one it accepts forms from. So a host that shows
471
+ the storefront through `X-Front-Domain`, such as a preview host or a local port,
472
+ can sign in too.
473
+
400
474
  Browser requests use `/api/...`. For SSR, use Nuxt's `useRequestFetch()` to pass
401
475
  the current request's domain and authentication to the same gateway. See the
402
476
  project README for examples and cookie handling.
@@ -1,6 +1,8 @@
1
1
  #!/usr/bin/env node
2
2
  import { setupProject } from '../src/setup.mjs';
3
3
  import { updateProject } from '../src/update.mjs';
4
+ import { installService } from '../src/install.mjs';
5
+ import { SERVICE_ACTIONS, SERVICE_ALIASES, controlService, findApp, printService } from '../src/service.mjs';
4
6
  import { readFile } from 'node:fs/promises';
5
7
  import { resolve } from 'node:path';
6
8
  import { createInterface } from 'node:readline/promises';
@@ -29,8 +31,27 @@ Commands for an existing project (run from its root):
29
31
  npx orionplace-nuxt set mimic <existing-frontend.example.com>
30
32
  npx orionplace-nuxt set frontend <shop.example.com>
31
33
 
34
+ On your Linux server (run from the project root):
35
+ sudo npx orionplace-nuxt install
36
+ Builds the storefront, installs it as a system service (systemd or OpenRC)
37
+ and, when the orionplace server tool is set up, connects its domains with
38
+ nginx and HTTPS. Run it again after changes or an update to rebuild and restart.
39
+ Server tool: https://orionmarket.place/downloads/orionplace.sh
40
+
41
+ Manage the installed service (from the project root, or name it with --name):
42
+ npx orionplace-nuxt status service, autostart, port and home page answer
43
+ sudo npx orionplace-nuxt start
44
+ sudo npx orionplace-nuxt stop
45
+ sudo npx orionplace-nuxt restart restart and wait until the home page answers
46
+ sudo npx orionplace-nuxt logs [lines] last log lines (100); --follow keeps reading
47
+ npx orionplace-nuxt list every storefront service on this server
48
+ sudo npx orionplace-nuxt uninstall stop the service and remove it (alias: cleanup);
49
+ the project folder stays
50
+
32
51
  Options: --cwd <directory> --dry-run --help --version
33
52
  Update option: --local (apply this CLI version instead of fetching the latest release)
53
+ Install options: --name <service> --port <port> --user <user> --no-build --no-domains --yes
54
+ Service options: --name <service> --follow (logs) --dry-run --yes (uninstall)
34
55
 
35
56
  Update downloads the latest release, refreshes unedited source, and installs dependencies.
36
57
  It preserves edited source, domain mappings and MIMIC. --dry-run leaves project files unchanged.
@@ -52,19 +73,64 @@ try {
52
73
  let cwd = process.cwd();
53
74
  let dryRun = false;
54
75
  let local = false;
76
+ let follow = false;
77
+ const install = { domains: true, build: true, yes: false };
55
78
  for (let index = 0; index < argv.length; index++) {
56
79
  if (argv[index] === '--dry-run') dryRun = true;
57
80
  else if (argv[index] === '--local') local = true;
58
- else if (argv[index] === '--cwd') {
81
+ else if (argv[index] === '--no-domains') install.domains = false;
82
+ else if (argv[index] === '--no-build') install.build = false;
83
+ else if (argv[index] === '--follow' || argv[index] === '-f') follow = true;
84
+ else if (argv[index] === '--yes' || argv[index] === '-y') install.yes = true;
85
+ else if (['--name', '--port', '--user'].includes(argv[index])) {
86
+ if (!argv[index + 1]) throw new Error(`${argv[index]} needs a value`);
87
+ install[argv[index].slice(2)] = argv[++index];
88
+ } else if (argv[index] === '--cwd') {
59
89
  if (!argv[index + 1]) throw new Error('--cwd needs a directory');
60
90
  cwd = resolve(argv[++index]);
61
91
  } else if (argv[index].startsWith('--')) throw new Error(`Unknown option: ${argv[index]}`);
62
92
  else positional.push(argv[index]);
63
93
  }
64
- const [command, target] = positional;
94
+ const [given, target] = positional;
95
+ const command = SERVICE_ALIASES[given] || given;
65
96
  if (local && command !== 'update') throw new Error('--local is only supported by update.');
97
+ const service = SERVICE_ACTIONS.includes(command);
98
+ if (command !== 'install' && (install.port || install.user || !install.domains || !install.build || (install.yes && command !== 'uninstall') || (install.name && !service))) {
99
+ throw new Error('--port, --user, --no-build, --no-domains and --yes are install options (--yes also for uninstall); --name is for install and the service commands.');
100
+ }
101
+ if (follow && command !== 'logs') throw new Error('--follow is a logs option.');
102
+ if (dryRun && service && command !== 'uninstall') throw new Error('--dry-run is only for uninstall among the service commands; status shows the state without changes.');
66
103
  let result;
67
- if (command === 'init' && positional.length <= 2) {
104
+ if (command === 'install' && positional.length === 1) {
105
+ const done = await installService({ cwd, dryRun, ...install });
106
+ if (done.dryRun) {
107
+ console.log(`Planned service orionplace-${done.name} on 127.0.0.1:${done.port} as ${done.user}`);
108
+ console.log(`Domains: ${done.frontends.join(', ') || 'none yet'} -> ${done.backend || 'no backend yet'}`);
109
+ console.log(`\n${done.unitPath}:\n${done.unit}`);
110
+ } else {
111
+ console.log(`\nInstalled orionplace-${done.name} (port ${done.port}, user ${done.user}).`);
112
+ for (const domain of done.frontends) {
113
+ if (!install.domains) console.log(` - ${domain}: not connected (--no-domains)`);
114
+ else if (!done.connected) console.log(` - ${domain}: not connected to nginx (see above)`);
115
+ else if (done.failed.includes(domain)) console.log(` ✗ ${domain}: not connected (see above)`);
116
+ else console.log(` ✓ https://${domain}`);
117
+ }
118
+ if (done.failed.length) console.log('Fix the problems above, then run: sudo orionplace domain add <domain>');
119
+ console.log(`Manage it from this folder: npx orionplace-nuxt status | sudo npx orionplace-nuxt restart | sudo npx orionplace-nuxt logs`);
120
+ console.log('After code changes or npx orionplace-nuxt update, run sudo npx orionplace-nuxt install again.');
121
+ }
122
+ } else if (service && positional.length <= (command === 'logs' ? 2 : 1)) {
123
+ if (command === 'uninstall' && !dryRun && !install.yes && process.stdin.isTTY) {
124
+ const app = await findApp({ cwd, name: install.name });
125
+ const prompt = createInterface({ input: process.stdin, output: process.stdout });
126
+ let answer;
127
+ try { answer = await prompt.question(`Stop and remove the service orionplace-${app.NAME}? The project stays in ${app.DIR}. [y/N] `); }
128
+ finally { prompt.close(); }
129
+ if (!/^y(es)?$/i.test(answer.trim())) { console.log('Nothing changed.'); process.exit(0); }
130
+ }
131
+ const done = await controlService({ action: command, cwd, name: install.name, lines: positional[1] ?? 100, follow, dryRun });
132
+ process.exitCode = printService(done);
133
+ } else if (command === 'init' && positional.length <= 2) {
68
134
  result = await setupProject({ cwd: target ? resolve(cwd, target) : cwd, dryRun });
69
135
  } else if (command === 'update' && positional.length === 1) {
70
136
  result = await updateProject({ cwd, dryRun, local });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orionplace-nuxt",
3
- "version": "0.2.1",
3
+ "version": "0.4.0",
4
4
  "description": "Nuxt 4 storefront for your Orionplace marketplace: setup CLI, server API gateway, typed store and ready-made catalog, cart, checkout and account components in English and Russian, plus an Android app build.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -208,6 +208,18 @@ export async function forwardMarketplace(request, configuration = {}) {
208
208
  }
209
209
  }
210
210
  headers.set('X-Front-Domain', tenant.domain);
211
+ // The backend accepts forms from the storefront domain's own origin. A public
212
+ // host that shows this storefront (MIMIC, a preview host or a local port)
213
+ // passed the same-origin check above, so it is sent as that origin.
214
+ let ownOrigin = false;
215
+ try {
216
+ ownOrigin = Boolean(origin) && originHosts.includes(new URL(origin).host);
217
+ } catch {
218
+ ownOrigin = false;
219
+ }
220
+ if (ownOrigin) {
221
+ headers.set('origin', `https://${tenant.domain}`);
222
+ }
211
223
  headers.set('Accept-Encoding', 'identity');
212
224
  const clientIp =
213
225
  request.headers.get('x-init-ip') ||
@@ -0,0 +1,356 @@
1
+ // Installs the built storefront as a system service on a Linux server and
2
+ // connects its domains through the "orionplace" server tool
3
+ // (https://orionmarket.place/downloads/orionplace.sh) when that tool is set up.
4
+ import { spawn } from 'node:child_process';
5
+ import { mkdir, readFile, readdir, rename, stat, writeFile } from 'node:fs/promises';
6
+ import { existsSync } from 'node:fs';
7
+ import { request } from 'node:http';
8
+ import { createServer } from 'node:net';
9
+ import { basename, dirname, join, resolve } from 'node:path';
10
+ import { createInterface } from 'node:readline/promises';
11
+ import { setupProject } from './setup.mjs';
12
+
13
+ export const framework = {
14
+ id: 'nuxt',
15
+ title: 'Nuxt',
16
+ dependency: 'nuxt',
17
+ output: '.output/server/index.mjs',
18
+ start: () => ['.output/server/index.mjs'],
19
+ environment: {},
20
+ };
21
+
22
+ export const defaultPaths = {
23
+ etc: process.env.ORIONPLACE_ETC || '/etc/orionplace',
24
+ systemd: '/etc/systemd/system',
25
+ openrc: '/etc/init.d',
26
+ logs: '/var/log/orionplace',
27
+ srv: '/srv/orionplace',
28
+ tool: ['/usr/local/bin/orionplace', '/usr/bin/orionplace'],
29
+ };
30
+
31
+ const SERVICE_USER = 'orionplace';
32
+
33
+ // run(command, args, { cwd, capture, env }) -> { code, output }
34
+ export function runCommand(command, args, { cwd, capture = false, env = process.env } = {}) {
35
+ return new Promise((done, reject) => {
36
+ const child = spawn(command, args, { cwd, env, stdio: capture ? ['ignore', 'pipe', 'pipe'] : 'inherit' });
37
+ let output = '';
38
+ if (capture) {
39
+ child.stdout.on('data', chunk => { output += chunk; });
40
+ child.stderr.on('data', chunk => { output += chunk; });
41
+ }
42
+ child.once('error', reject);
43
+ child.once('exit', code => done({ code: code ?? 1, output }));
44
+ });
45
+ }
46
+
47
+ function parseConf(text) {
48
+ const values = {};
49
+ for (const line of text.split('\n')) {
50
+ const match = /^([A-Z_]+)=(.*)$/.exec(line);
51
+ if (match) values[match[1]] = match[2];
52
+ }
53
+ return values;
54
+ }
55
+
56
+ export async function readApps(paths = defaultPaths) {
57
+ const directory = join(paths.etc, 'apps');
58
+ let names = [];
59
+ try { names = (await readdir(directory)).filter(name => name.endsWith('.conf')); }
60
+ catch (error) { if (error.code !== 'ENOENT') throw error; }
61
+ const apps = [];
62
+ for (const name of names) apps.push(parseConf(await readFile(join(directory, name), 'utf8')));
63
+ return apps;
64
+ }
65
+
66
+ export function serviceName(value) {
67
+ const name = value.toLowerCase().replace(/[^a-z0-9-]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 40);
68
+ if (!/^[a-z0-9][a-z0-9-]*$/.test(name)) throw new Error('Choose a service name with letters, digits and dashes: --name shop');
69
+ return name;
70
+ }
71
+
72
+ function portIsFree(port) {
73
+ return new Promise(done => {
74
+ const server = createServer();
75
+ server.once('error', () => done(false));
76
+ server.listen({ port, host: '127.0.0.1', exclusive: true }, () => server.close(() => done(true)));
77
+ });
78
+ }
79
+
80
+ export async function choosePort(apps, wanted, isFree = portIsFree) {
81
+ const taken = new Set(apps.map(app => Number(app.PORT)));
82
+ if (wanted) {
83
+ if (!Number.isInteger(wanted) || wanted < 1024 || wanted > 65535) throw new Error('Use a port between 1024 and 65535.');
84
+ return wanted;
85
+ }
86
+ for (let port = 3000; port < 4000; port++) {
87
+ if (!taken.has(port) && await isFree(port)) return port;
88
+ }
89
+ throw new Error('No free port between 3000 and 3999. Choose one with --port.');
90
+ }
91
+
92
+ async function passwdEntry(user) {
93
+ const text = await readFile('/etc/passwd', 'utf8');
94
+ for (const line of text.split('\n')) {
95
+ const [name, , uid, gid, , home] = line.split(':');
96
+ if (name === user) return { name, uid: Number(uid), gid: Number(gid), home };
97
+ }
98
+ return null;
99
+ }
100
+
101
+ async function userByUid(uid) {
102
+ const text = await readFile('/etc/passwd', 'utf8');
103
+ for (const line of text.split('\n')) {
104
+ const [name, , id, gid, , home] = line.split(':');
105
+ if (Number(id) === uid && name) return { name, uid, gid: Number(gid), home };
106
+ }
107
+ return null;
108
+ }
109
+
110
+ // Every parent folder must let the service user through.
111
+ async function checkReachable(root, account) {
112
+ let cursor = dirname(root);
113
+ while (true) {
114
+ const info = await stat(cursor);
115
+ const open = info.uid === account.uid ? info.mode & 0o100 : info.gid === account.gid ? info.mode & 0o010 : info.mode & 0o001;
116
+ if (!open) {
117
+ throw new Error(`The folder ${cursor} is closed to the service user ${account.name}. Move the storefront to ${defaultPaths.srv}/ (for example ${defaultPaths.srv}/${basename(root)}) and run install there.`);
118
+ }
119
+ if (cursor === dirname(cursor)) return;
120
+ cursor = dirname(cursor);
121
+ }
122
+ }
123
+
124
+ async function writeAtomic(path, content, mode = 0o644) {
125
+ await mkdir(dirname(path), { recursive: true });
126
+ const temporary = `${path}.orionplace-${process.pid}.tmp`;
127
+ await writeFile(temporary, content, { mode });
128
+ await rename(temporary, path);
129
+ }
130
+
131
+ export function systemdUnit({ name, root, user, group, port, node, env }) {
132
+ const environment = Object.entries({ NODE_ENV: 'production', HOST: '127.0.0.1', PORT: String(port), SITEMAPS_DIR: join(root, 'sitemaps'), ...env })
133
+ .map(([key, value]) => `Environment=${key}=${value}`).join('\n');
134
+ const args = [...(existsSync(join(root, '.env')) ? ['--env-file=.env'] : []), ...framework.start(port)];
135
+ return `# Installed by "orionplace-${framework.id} install". Run it again after changes;
136
+ # manage with: orionplace app status|logs|restart ${name}
137
+ [Unit]
138
+ Description=OrionMarketplace storefront ${name} (${framework.title})
139
+ After=network-online.target
140
+ Wants=network-online.target
141
+
142
+ [Service]
143
+ Type=simple
144
+ User=${user}
145
+ Group=${group}
146
+ WorkingDirectory=${root}
147
+ ${environment}
148
+ ExecStart=${node} ${args.join(' ')}
149
+ Restart=on-failure
150
+ RestartSec=3
151
+ LimitNOFILE=65535
152
+ NoNewPrivileges=true
153
+ PrivateTmp=true
154
+ ProtectSystem=full
155
+
156
+ [Install]
157
+ WantedBy=multi-user.target
158
+ `;
159
+ }
160
+
161
+ export function openrcScript({ name, root, user, group, port, node, env, logs }) {
162
+ const environment = Object.entries({ NODE_ENV: 'production', HOST: '127.0.0.1', PORT: String(port), SITEMAPS_DIR: join(root, 'sitemaps'), ...env })
163
+ .map(([key, value]) => `export ${key}="${value}"`).join('\n');
164
+ const args = [...(existsSync(join(root, '.env')) ? ['--env-file=.env'] : []), ...framework.start(port)];
165
+ return `#!/sbin/openrc-run
166
+ # Installed by "orionplace-${framework.id} install". Run it again after changes;
167
+ # manage with: orionplace app status|logs|restart ${name}
168
+ name="orionplace-${name}"
169
+ description="OrionMarketplace storefront ${name} (${framework.title})"
170
+ supervisor=supervise-daemon
171
+ respawn_delay=3
172
+ command="${node}"
173
+ command_args="${args.join(' ')}"
174
+ command_user="${user}:${group}"
175
+ directory="${root}"
176
+ output_log="${logs}/${name}.log"
177
+ error_log="${logs}/${name}.log"
178
+ ${environment}
179
+
180
+ depend() {
181
+ need net
182
+ after firewall
183
+ }
184
+
185
+ start_pre() {
186
+ checkpath --directory --owner ${user}:${group} --mode 0755 ${logs}
187
+ }
188
+ `;
189
+ }
190
+
191
+ async function prompt(question) {
192
+ const terminal = createInterface({ input: process.stdin, output: process.stdout });
193
+ try { return (await terminal.question(question)).trim(); }
194
+ finally { terminal.close(); }
195
+ }
196
+
197
+ function log(message) { console.log(message); }
198
+
199
+ // /usr/local/bin/node from the server tool follows Node.js updates; the
200
+ // versioned path of the running binary would not.
201
+ function stableNode() {
202
+ return ['/usr/local/bin/node', '/usr/bin/node'].find(path => existsSync(path)) || process.execPath;
203
+ }
204
+
205
+ // Fills in the backend and first storefront domain when the project has none.
206
+ async function ensureDomains(root, { yes }) {
207
+ const read = async () => JSON.parse(await readFile(join(root, 'orionplace/settings.json'), 'utf8'));
208
+ let settings = await read();
209
+ const ask = process.stdin.isTTY && !yes;
210
+ if (!settings.backend) {
211
+ if (!ask) throw new Error(`Set the personal backend first: npx orionplace-${framework.id} set backend my-shop.orionplace.app`);
212
+ log('Your personal backend is shown in your orionmarket.place profile, for example my-shop.orionplace.app.');
213
+ await setupProject({ cwd: root, field: 'backend', value: await prompt('Personal backend domain: ') });
214
+ settings = await read();
215
+ }
216
+ if (!settings.frontends?.length) {
217
+ if (!ask) throw new Error(`Add the storefront domain first: npx orionplace-${framework.id} add frontend shop.example.com`);
218
+ await setupProject({ cwd: root, action: 'add', field: 'frontend', value: await prompt('Storefront domain (for example shop.example.com): ') });
219
+ settings = await read();
220
+ }
221
+ return settings;
222
+ }
223
+
224
+ // The storefront's home page as the public domain sees it -> HTTP status, 0 when down.
225
+ export function homeStatus(port, host) {
226
+ return new Promise(done => {
227
+ const call = request({ host: '127.0.0.1', port, path: '/', headers: { host }, timeout: 15000 }, response => {
228
+ response.resume();
229
+ done(response.statusCode);
230
+ });
231
+ call.once('timeout', () => call.destroy());
232
+ call.once('error', () => done(0));
233
+ call.end();
234
+ });
235
+ }
236
+
237
+ export async function waitForHttp(port, host, seconds = 90) {
238
+ const until = Date.now() + seconds * 1000;
239
+ while (Date.now() < until) {
240
+ const status = await homeStatus(port, host);
241
+ if (status) return status;
242
+ await new Promise(done => setTimeout(done, 1000));
243
+ }
244
+ return 0;
245
+ }
246
+
247
+ export async function installService({
248
+ cwd = process.cwd(), name, port, user, build = true, domains = true, yes = false, dryRun = false,
249
+ paths = defaultPaths, run = runCommand, uid = process.getuid?.(), isFree = portIsFree,
250
+ systemd = existsSync('/run/systemd/system'), node = stableNode(),
251
+ } = {}) {
252
+ if (process.platform !== 'linux') throw new Error('install sets up a Linux server service. Run it on your VPS.');
253
+ if (uid !== 0 && !dryRun) throw new Error(`install needs root: sudo npx orionplace-${framework.id} install`);
254
+ const root = resolve(cwd);
255
+ if (!/^\/[A-Za-z0-9._/@+-]+$/.test(root)) throw new Error(`Use a storefront folder path without spaces or special characters (for example ${paths.srv}/shop), not ${root}.`);
256
+ let pkg;
257
+ try { pkg = JSON.parse(await readFile(join(root, 'package.json'), 'utf8')); }
258
+ catch { throw new Error(`Run install in your storefront folder (created with: npx orionplace-${framework.id} init).`); }
259
+ if (!{ ...pkg.devDependencies, ...pkg.dependencies }[framework.dependency] || !existsSync(join(root, 'orionplace/settings.json'))) {
260
+ throw new Error(`This folder is not an Orionplace ${framework.title} storefront. Run install in the folder created with: npx orionplace-${framework.id} init`);
261
+ }
262
+ const openrc = !systemd && existsSync('/sbin/openrc-run');
263
+ if (!systemd && !openrc && !dryRun) throw new Error('Neither systemd nor OpenRC was found; start the storefront with your own process manager (see orionplace/README.md, Deploy on your VPS).');
264
+
265
+ const settings = dryRun ? JSON.parse(await readFile(join(root, 'orionplace/settings.json'), 'utf8')) : await ensureDomains(root, { yes });
266
+ const apps = await readApps(paths);
267
+ const previous = apps.find(app => app.DIR === root);
268
+ const service = serviceName(name || previous?.NAME || basename(root));
269
+ if (apps.some(app => app.NAME === service && app.DIR !== root)) {
270
+ throw new Error(`Another storefront already uses the name ${service} (${apps.find(app => app.NAME === service).DIR}). Choose one with --name.`);
271
+ }
272
+ const chosen = await choosePort(apps.filter(app => app.DIR !== root), port ? Number(port) : Number(previous?.PORT) || 0, isFree);
273
+
274
+ // The service runs as the folder's owner, or as "orionplace" for root-owned folders.
275
+ const owner = await stat(root);
276
+ let account = user ? await passwdEntry(user) : owner.uid === 0 ? await passwdEntry(SERVICE_USER) : await userByUid(owner.uid);
277
+ if (user && !account) throw new Error(`No system user ${user}.`);
278
+ if (!account && !dryRun) {
279
+ if (existsSync('/usr/sbin/useradd') || existsSync('/sbin/useradd')) {
280
+ await run('useradd', ['--system', '--home-dir', paths.srv, '--shell', '/sbin/nologin', '--user-group', SERVICE_USER], { capture: true });
281
+ } else {
282
+ await run('addgroup', ['-S', SERVICE_USER], { capture: true });
283
+ await run('adduser', ['-S', '-D', '-H', '-h', paths.srv, '-s', '/sbin/nologin', '-G', SERVICE_USER, SERVICE_USER], { capture: true });
284
+ }
285
+ account = await passwdEntry(SERVICE_USER);
286
+ if (!account) throw new Error(`Could not create the system user ${SERVICE_USER}.`);
287
+ }
288
+ account ||= { name: SERVICE_USER, uid: -1, gid: -1 };
289
+ const group = account.gid >= 0 ? (await readFile('/etc/group', 'utf8')).split('\n').map(line => line.split(':'))
290
+ .find(([, , gid]) => Number(gid) === account.gid)?.[0] || account.name : account.name;
291
+ if (account.uid >= 0) await checkReachable(root, account);
292
+
293
+ const values = { name: service, root, user: account.name, group, port: chosen, node, env: framework.environment, logs: paths.logs };
294
+ const unitPath = systemd ? join(paths.systemd, `orionplace-${service}.service`) : join(paths.openrc, `orionplace-${service}`);
295
+ const unit = systemd ? systemdUnit(values) : openrcScript(values);
296
+ const conf = [
297
+ `# Managed by orionplace-${framework.id} install. Use "orionplace app" commands to change it.`,
298
+ `NAME=${service}`, `FRAMEWORK=${framework.id}`, `DIR=${root}`, `PORT=${chosen}`,
299
+ `USER=${account.name}`, `NODE=${node}`, `SERVICE=orionplace-${service}`, '',
300
+ ].join('\n');
301
+ if (dryRun) {
302
+ return { dryRun, name: service, port: chosen, user: account.name, unitPath, unit, conf, frontends: settings.frontends || [], backend: settings.backend };
303
+ }
304
+
305
+ const rebuild = build || !existsSync(join(root, framework.output));
306
+ log(rebuild ? `\n==> Building the ${framework.title} storefront ${service}` : `\n==> Using the existing build of ${service} (--no-build)`);
307
+ // The website build; ORIONPLACE_APP_ORIGIN would make the Android app build.
308
+ const buildEnv = { ...process.env };
309
+ delete buildEnv.ORIONPLACE_APP_ORIGIN;
310
+ if (!existsSync(join(root, 'node_modules', framework.dependency))) {
311
+ const installed = await run('npm', ['install', '--no-audit', '--no-fund'], { cwd: root, env: buildEnv });
312
+ if (installed.code) throw new Error('npm install failed; see the messages above.');
313
+ }
314
+ if (rebuild) {
315
+ const built = await run('npm', ['run', 'build'], { cwd: root, env: buildEnv });
316
+ if (built.code) throw new Error('The build failed; see the messages above. The running service (if any) was not changed.');
317
+ }
318
+ if (!existsSync(join(root, framework.output))) throw new Error(`The build did not produce ${framework.output}.`);
319
+ const owned = await run('chown', ['-R', `${account.uid}:${account.gid}`, root], { capture: true });
320
+ if (owned.code) throw new Error(`Could not give ${root} to ${account.name}:\n${owned.output}`);
321
+
322
+ log(`\n==> Installing the service orionplace-${service} on port ${chosen}`);
323
+ await writeAtomic(unitPath, unit, systemd ? 0o644 : 0o755);
324
+ await writeAtomic(join(paths.etc, 'apps', `${service}.conf`), conf);
325
+ const steps = systemd
326
+ ? [['systemctl', ['daemon-reload']], ['systemctl', ['enable', `orionplace-${service}`]], ['systemctl', ['restart', `orionplace-${service}`]]]
327
+ : [['rc-update', ['add', `orionplace-${service}`, 'default']], ['rc-service', [`orionplace-${service}`, 'restart']]];
328
+ for (const [command, args] of steps) {
329
+ const result = await run(command, args, { capture: true });
330
+ if (result.code) throw new Error(`${command} ${args.join(' ')} failed:\n${result.output}`);
331
+ }
332
+ const status = await waitForHttp(chosen, settings.frontends[0]);
333
+ if (!status) {
334
+ const logs = systemd
335
+ ? await run('journalctl', ['-u', `orionplace-${service}`, '-n', '40', '--no-pager'], { capture: true })
336
+ : await run('tail', ['-n', '40', join(paths.logs, `${service}.log`)], { capture: true });
337
+ throw new Error(`The storefront did not start on port ${chosen}. Last log lines:\n${logs.output}`);
338
+ }
339
+ log(` ✓ orionplace-${service} answers on 127.0.0.1:${chosen} (HTTP ${status})`);
340
+
341
+ const tool = paths.tool.find(path => existsSync(path));
342
+ const failed = [];
343
+ if (domains && tool) {
344
+ for (const domain of settings.frontends) {
345
+ log(`\n==> Connecting ${domain}`);
346
+ const backend = settings.backend.replace(/^https:\/\//, '').replace(/\/api$/, '');
347
+ const result = await run(tool, ['domain', 'add', domain, '--app', service, '--backend', backend, '--yes']);
348
+ if (result.code) failed.push(domain);
349
+ }
350
+ } else if (domains) {
351
+ log('\nThe orionplace server tool is not set up, so nginx and HTTPS were not configured. Prepare the server:');
352
+ log(' curl -fsSLo orionplace.sh https://orionmarket.place/downloads/orionplace.sh && sudo sh orionplace.sh setup');
353
+ log(`Then run this install again. Or proxy your HTTPS site to http://127.0.0.1:${chosen} as orionplace/README.md describes.`);
354
+ }
355
+ return { name: service, port: chosen, user: account.name, unitPath, frontends: settings.frontends, failed, connected: domains && Boolean(tool) };
356
+ }
@@ -513,6 +513,16 @@ If installation fails after source generation, run \`npm install\` and retry.
513
513
 
514
514
  ## Deploy on your VPS
515
515
 
516
+ The quickest way: prepare the server with the OrionMarketplace server script,
517
+ then run \`sudo npx orionplace-nuxt install\` in this folder. It builds the
518
+ project, runs it as a system service and connects your domains with nginx and
519
+ HTTPS. Steps: [Install a storefront](https://orionmarket.place/en/sandbox/install/storefront).
520
+ Then manage it from this folder: \`npx orionplace-nuxt status\`, \`sudo npx orionplace-nuxt restart\`,
521
+ \`sudo npx orionplace-nuxt stop\`, \`sudo npx orionplace-nuxt start\` and \`sudo npx orionplace-nuxt logs\`.
522
+ \`sudo npx orionplace-nuxt uninstall\` (or \`cleanup\`) stops and removes the service; this folder stays.
523
+
524
+ To set the server up yourself instead:
525
+
516
526
  This integration needs a Node.js server and its domain configuration files.
517
527
  It does not support static-only or edge hosting. Deploy the build, dependencies,
518
528
  \`sitemaps\`, and your environment configuration together; use an absolute
@@ -0,0 +1,186 @@
1
+ // Manages the storefront service that "install" set up: start, stop, restart,
2
+ // status, logs and the list of every storefront service on this server.
3
+ // The service is found by its folder (the project root) or by --name.
4
+ import { existsSync } from 'node:fs';
5
+ import { readFile, rm } from 'node:fs/promises';
6
+ import { join, resolve } from 'node:path';
7
+ import { defaultPaths, framework, homeStatus, readApps, runCommand, waitForHttp } from './install.mjs';
8
+
9
+ export const SERVICE_ACTIONS = ['start', 'stop', 'restart', 'status', 'logs', 'list', 'uninstall'];
10
+ // "cleanup" is another name for uninstall.
11
+ export const SERVICE_ALIASES = { cleanup: 'uninstall' };
12
+
13
+ async function frontends(dir) {
14
+ try { return JSON.parse(await readFile(join(dir, 'orionplace/settings.json'), 'utf8')).frontends || []; }
15
+ catch { return []; }
16
+ }
17
+
18
+ // The registered storefront of this folder, or the one named with --name.
19
+ export async function findApp({ cwd = process.cwd(), name, paths = defaultPaths } = {}) {
20
+ const apps = await readApps(paths);
21
+ const root = resolve(cwd);
22
+ const app = name ? apps.find(item => item.NAME === name) : apps.find(item => item.DIR === root);
23
+ if (app) return app;
24
+ const known = apps.map(item => item.NAME).join(', ');
25
+ if (name) throw new Error(`No storefront service named ${name}.${known ? ` Installed: ${known}.` : ''}`);
26
+ throw new Error(`${root} is not installed as a service. Install it first: sudo npx orionplace-${framework.id} install`
27
+ + (known ? `\nOr name another storefront: --name ${apps[0].NAME} (installed: ${known})` : ''));
28
+ }
29
+
30
+ // true / false; "unknown" when neither systemd nor OpenRC answers.
31
+ async function isRunning(service, { run, systemd }) {
32
+ const result = systemd
33
+ ? await run('systemctl', ['is-active', '--quiet', service], { capture: true })
34
+ : await run('rc-service', [service, 'status'], { capture: true });
35
+ return result.code === 0;
36
+ }
37
+
38
+ async function isEnabled(service, { run, systemd }) {
39
+ const result = systemd
40
+ ? await run('systemctl', ['is-enabled', '--quiet', service], { capture: true })
41
+ : await run('rc-update', ['show', 'default'], { capture: true });
42
+ return systemd ? result.code === 0 : new RegExp(`^\\s*${service}\\s`, 'm').test(result.output);
43
+ }
44
+
45
+ async function lastLogs(app, { run, systemd, paths, lines = 40 }) {
46
+ const result = systemd
47
+ ? await run('journalctl', ['-u', app.SERVICE || `orionplace-${app.NAME}`, '-n', String(lines), '--no-pager'], { capture: true })
48
+ : await run('tail', ['-n', String(lines), join(paths.logs, `${app.NAME}.log`)], { capture: true });
49
+ return result.output;
50
+ }
51
+
52
+ // One storefront's state: service, autostart, and the home page as its first domain sees it.
53
+ export async function serviceStatus(app, { run = runCommand, systemd = existsSync('/run/systemd/system'), probe = homeStatus } = {}) {
54
+ const service = app.SERVICE || `orionplace-${app.NAME}`;
55
+ const domains = await frontends(app.DIR);
56
+ const running = await isRunning(service, { run, systemd });
57
+ const enabled = await isEnabled(service, { run, systemd });
58
+ const http = running ? await probe(Number(app.PORT), domains[0] || 'localhost') : 0;
59
+ return { name: app.NAME, service, framework: app.FRAMEWORK, dir: app.DIR, port: Number(app.PORT), running, enabled, http, domains };
60
+ }
61
+
62
+ /**
63
+ * controlService({ action, cwd, name, lines, follow }) runs one action and
64
+ * returns what happened; logs and follow print straight to the terminal.
65
+ */
66
+ export async function controlService({
67
+ action, cwd = process.cwd(), name, lines = 100, follow = false,
68
+ paths = defaultPaths, run = runCommand, uid = process.getuid?.(),
69
+ systemd = existsSync('/run/systemd/system'), openrc = existsSync('/sbin/openrc-run'),
70
+ platform = process.platform, probe = homeStatus, wait = waitForHttp, dryRun = false,
71
+ } = {}) {
72
+ action = SERVICE_ALIASES[action] || action;
73
+ if (!SERVICE_ACTIONS.includes(action)) throw new Error(`Unknown service command ${action}. Use ${SERVICE_ACTIONS.join(', ')}.`);
74
+ if (platform !== 'linux') throw new Error(`${action} manages the Linux service that install set up. Run it on your server.`);
75
+ if (!systemd && !openrc) throw new Error('Neither systemd nor OpenRC was found on this server.');
76
+
77
+ if (action === 'list') {
78
+ const apps = await readApps(paths);
79
+ return { action, apps: await Promise.all(apps.map(app => serviceStatus(app, { run, systemd, probe }))) };
80
+ }
81
+
82
+ const app = await findApp({ cwd, name, paths });
83
+ const service = app.SERVICE || `orionplace-${app.NAME}`;
84
+ if (action === 'status') return { action, ...await serviceStatus(app, { run, systemd, probe }) };
85
+
86
+ if (action === 'logs') {
87
+ const count = Number(lines);
88
+ if (!Number.isInteger(count) || count < 1) throw new Error('Give the number of log lines as a whole number, for example: logs 200');
89
+ const args = systemd
90
+ ? ['journalctl', ['-u', service, '-n', String(count), '--no-pager', ...(follow ? ['--follow'] : [])]]
91
+ : ['tail', ['-n', String(count), ...(follow ? ['-F'] : []), join(paths.logs, `${app.NAME}.log`)]];
92
+ const result = await run(...args);
93
+ if (result.code) throw new Error(`${args[0]} could not read the logs of ${service}${uid !== 0 ? `; try: sudo npx orionplace-${framework.id} logs` : ''}.`);
94
+ return { action, name: app.NAME, service };
95
+ }
96
+
97
+ if (action === 'uninstall') return uninstallService(app, { paths, run, uid, systemd, name, dryRun });
98
+ if (uid !== 0) throw new Error(`${action} needs root: sudo npx orionplace-${framework.id} ${action}${name ? ` --name ${name}` : ''}`);
99
+ const result = systemd
100
+ ? await run('systemctl', [action, service], { capture: true })
101
+ : await run('rc-service', [service, action], { capture: true });
102
+ if (result.code) throw new Error(`Could not ${action} ${service}:\n${result.output.trim()}`);
103
+ if (action === 'stop') return { action, name: app.NAME, service, running: false };
104
+
105
+ const domains = await frontends(app.DIR);
106
+ const http = await wait(Number(app.PORT), domains[0] || 'localhost', 90);
107
+ if (!http) {
108
+ throw new Error(`${service} did not answer on port ${app.PORT} within 90 seconds. Last log lines:\n${await lastLogs(app, { run, systemd, paths })}`);
109
+ }
110
+ return { action, name: app.NAME, service, port: Number(app.PORT), running: true, http, domains };
111
+ }
112
+
113
+ /**
114
+ * Stops the service, removes it from autostart, deletes its unit or init
115
+ * script and its registration. The project folder and its build stay. With
116
+ * the orionplace server tool, "orionplace app remove" does it and also turns
117
+ * the storefront's domains into a placeholder page.
118
+ */
119
+ async function uninstallService(app, { paths, run, uid, systemd, name, dryRun }) {
120
+ const service = app.SERVICE || `orionplace-${app.NAME}`;
121
+ const unitPath = systemd ? join(paths.systemd, `${service}.service`) : join(paths.openrc, service);
122
+ const confPath = join(paths.etc, 'apps', `${app.NAME}.conf`);
123
+ const tool = (paths.tool || []).find(path => existsSync(path));
124
+ const result = { action: 'uninstall', name: app.NAME, service, dir: app.DIR, domains: await frontends(app.DIR), tool: Boolean(tool), unitPath, confPath, dryRun };
125
+ if (dryRun) return result;
126
+ if (uid !== 0) throw new Error(`uninstall needs root: sudo npx orionplace-${framework.id} uninstall${name ? ` --name ${name}` : ''}`);
127
+ if (tool) {
128
+ const removed = await run(tool, ['app', 'remove', app.NAME, '--yes']);
129
+ if (removed.code) throw new Error(`orionplace app remove ${app.NAME} failed; see the messages above.`);
130
+ return result;
131
+ }
132
+ // A service that is already stopped or missing is fine: the goal is that it is gone.
133
+ if (systemd) await run('systemctl', ['disable', '--now', service], { capture: true });
134
+ else {
135
+ await run('rc-service', [service, 'stop'], { capture: true });
136
+ await run('rc-update', ['del', service, 'default'], { capture: true });
137
+ }
138
+ await rm(unitPath, { force: true });
139
+ if (systemd) await run('systemctl', ['daemon-reload'], { capture: true });
140
+ await rm(confPath, { force: true });
141
+ return result;
142
+ }
143
+
144
+ // The CLI output of controlService; returns the process exit code.
145
+ export function printService(result, log = console.log) {
146
+ const line = item => {
147
+ const state = item.running ? (item.http ? `running, home page HTTP ${item.http}` : 'running, home page does not answer') : 'stopped';
148
+ return `${item.name.padEnd(16)} ${String(item.framework || '').padEnd(7)} ${String(item.port).padEnd(6)} ${state}`;
149
+ };
150
+ if (result.action === 'list') {
151
+ if (!result.apps.length) {
152
+ log(`No storefront services on this server. Install one from its folder: sudo npx orionplace-${framework.id} install`);
153
+ return 0;
154
+ }
155
+ log(`${'NAME'.padEnd(16)} ${'TYPE'.padEnd(7)} ${'PORT'.padEnd(6)} STATE`);
156
+ for (const item of result.apps) log(line(item));
157
+ return 0;
158
+ }
159
+ if (result.action === 'status') {
160
+ log(`${result.service} (${result.framework || framework.id}) in ${result.dir}`);
161
+ log(` Service: ${result.running ? 'running' : 'stopped'}${result.enabled ? ', starts with the server' : ', does not start with the server'}`);
162
+ log(` Port: 127.0.0.1:${result.port}`);
163
+ log(` Home page: ${result.running ? (result.http ? `HTTP ${result.http}` : 'does not answer') : '-'}`);
164
+ for (const domain of result.domains) log(` Domain: https://${domain}`);
165
+ return result.running && result.http && result.http < 500 ? 0 : 3;
166
+ }
167
+ if (result.action === 'uninstall') {
168
+ if (result.dryRun) {
169
+ log(`Would stop and remove ${result.service}:`);
170
+ log(result.tool ? ` orionplace app remove ${result.name} --yes (also turns its domains into a placeholder)` : ` ${result.unitPath}\n ${result.confPath}`);
171
+ log(`The project stays in ${result.dir}.`);
172
+ return 0;
173
+ }
174
+ log(`Removed the service ${result.service}. The project and its build stay in ${result.dir}; delete the folder when you no longer need it.`);
175
+ if (!result.tool && result.domains.length) {
176
+ log(`nginx still sends ${result.domains.join(', ')} to the stopped service; remove those sites from your nginx configuration.`);
177
+ }
178
+ log(`Install it again with: sudo npx orionplace-${framework.id} install`);
179
+ return 0;
180
+ }
181
+ if (result.action === 'stop') log(`Stopped ${result.service}.`);
182
+ else if (result.action === 'start' || result.action === 'restart') {
183
+ log(`${result.action === 'start' ? 'Started' : 'Restarted'} ${result.service}: home page HTTP ${result.http} on 127.0.0.1:${result.port}.`);
184
+ }
185
+ return 0;
186
+ }
@@ -20,6 +20,7 @@
20
20
  tariffMediaItems,
21
21
  tariffPagePath,
22
22
  } from '@/utils/orionplace/tariffPage';
23
+ import { tariffResumable } from '@/utils/orionplace/tariffs';
23
24
  import {
24
25
  getAvailableNestedValueFromObject,
25
26
  plainText,
@@ -74,6 +75,18 @@
74
75
  const tariff = computed(() =>
75
76
  confirmed.value ? catalogStore.getTariff(props.tariffId) : undefined,
76
77
  );
78
+ /*
79
+ * A trial chosen before sign-in opens again only once the customer's
80
+ * subscription records are known and the customer is new to this one;
81
+ * the backend refuses a trial to a returning customer.
82
+ */
83
+ const resumable = computed(() =>
84
+ tariffResumable(
85
+ props.resume,
86
+ tariff.value,
87
+ catalogStore.usedSubscriptionsOf(store.profile?.id),
88
+ ),
89
+ );
77
90
  // The heading names the plan; `tariff_title` is its SEO page title.
78
91
  const title = computed(
79
92
  () =>
@@ -190,6 +203,7 @@
190
203
  if (!confirmed.value) {
191
204
  void load();
192
205
  }
206
+ void account.loadUsed();
193
207
  });
194
208
 
195
209
  watch(media, () => {
@@ -201,7 +215,13 @@
201
215
  }
202
216
  });
203
217
  watch(
204
- () => props.resume,
218
+ () => store.profile?.id,
219
+ () => {
220
+ void account.loadUsed();
221
+ },
222
+ );
223
+ watch(
224
+ resumable,
205
225
  (value) => {
206
226
  if (
207
227
  value?.tariff === props.tariffId &&
@@ -1,10 +1,11 @@
1
1
  <script setup lang="ts">
2
- import { computed, onMounted, ref } from 'vue';
2
+ import { computed, onMounted, ref, watch } from 'vue';
3
3
  import { NuxtLink } from '#components';
4
4
  import { useOrionplaceStore } from '@/stores/orionplace';
5
5
  import { useOrionplaceCatalogStore } from '@/stores/orionplaceCatalog';
6
6
  import { useOrionplaceSelectionsStore } from '@/stores/orionplaceSelections';
7
7
  import { useOrionplaceSubscriptions } from '@/composables/useOrionplaceSubscriptions';
8
+ import { tariffResumable } from '@/utils/orionplace/tariffs';
8
9
  import {
9
10
  useOrionplaceFeatureApi,
10
11
  useOrionplaceTask,
@@ -47,7 +48,20 @@
47
48
  const busy = computed(() =>
48
49
  Boolean(task.state.pending || account.task.state.pending),
49
50
  );
50
- const open = computed(() => (guest.value ? undefined : props.resume));
51
+ /*
52
+ * The choice to reopen after sign-in. A trial waits for the customer's
53
+ * subscription records and opens only for a customer new to the record;
54
+ * the backend refuses a trial to a returning customer.
55
+ */
56
+ const open = computed(() =>
57
+ guest.value
58
+ ? undefined
59
+ : tariffResumable(
60
+ props.resume,
61
+ props.resume && catalogStore.getTariff(props.resume.tariff),
62
+ catalogStore.usedSubscriptionsOf(store.profile?.id),
63
+ ),
64
+ );
51
65
  // The plans this page shows: every loaded plan, or only the requested IDs.
52
66
  const shown = computed(() => {
53
67
  const data = catalogStore.tariffs?.data ?? [];
@@ -141,7 +155,14 @@
141
155
  if (!catalogStore.tariffs || catalogStore.tariffsSnapshot) {
142
156
  void load();
143
157
  }
158
+ void account.loadUsed();
144
159
  });
160
+ watch(
161
+ () => store.profile?.id,
162
+ () => {
163
+ void account.loadUsed();
164
+ },
165
+ );
145
166
  </script>
146
167
  <template>
147
168
  <section
@@ -104,11 +104,13 @@
104
104
  <script setup lang="ts">
105
105
  import { computed, ref, watch } from 'vue';
106
106
  import { NuxtLink } from '#components';
107
+ import { useOrionplaceStore } from '@/stores/orionplace';
107
108
  import { useOrionplaceCatalogStore } from '@/stores/orionplaceCatalog';
108
109
  import { useOrionplaceSelectionsStore } from '@/stores/orionplaceSelections';
109
110
  import {
110
111
  tariffIsOpen,
111
112
  tariffSubscribeRequest,
113
+ tariffTrialOpen,
112
114
  } from '@/utils/orionplace/tariffs';
113
115
  import {
114
116
  tariffDays,
@@ -164,6 +166,7 @@
164
166
  select: [selection: ITariffSelection];
165
167
  subscribe: [request: ITariffSubscribeRequest];
166
168
  }>();
169
+ const store = useOrionplaceStore();
167
170
  const catalogStore = useOrionplaceCatalogStore();
168
171
  const selectionStore = useOrionplaceSelectionsStore();
169
172
  const tariff = computed(() => catalogStore.getTariff(props.tariffId));
@@ -178,15 +181,22 @@
178
181
  // The option chosen in the card; the dialog opens on it and keeps its own
179
182
  // choice from there.
180
183
  const optionId = ref<number>();
184
+ // No trial badge for a customer who already had this subscription record.
181
185
  const trialBadge = computed(() => {
182
- const days = tariff.value?.trial_days ?? 0;
186
+ const value = tariff.value;
183
187
 
184
- if (days <= 0) {
188
+ if (
189
+ !value ||
190
+ !tariffTrialOpen(
191
+ value,
192
+ catalogStore.usedSubscriptionsOf(store.profile?.id),
193
+ )
194
+ ) {
185
195
  return '';
186
196
  }
187
197
 
188
198
  return tariffText(tariffLabels(selectionStore.localeCode).trialBadge, {
189
- days: tariffDays(days, selectionStore.localeCode),
199
+ days: tariffDays(value.trial_days, selectionStore.localeCode),
190
200
  });
191
201
  });
192
202
 
@@ -1,6 +1,6 @@
1
1
  # TariffCardPrices · Nuxt
2
2
 
3
- The period switcher, the price for the chosen period and the Subscribe and Try actions. A plan that only the store administrator assigns, or a plan that no longer accepts new subscriptions, shows a note instead of actions. The plan and its parent subscription each carry `is_new_subs_allowed` and `only_admin_can_subscribe`, and both have to allow the purchase.
3
+ The period switcher, the price for the chosen period and the Subscribe and Try actions. A plan that only the store administrator assigns, or a plan that no longer accepts new subscriptions, shows a note instead of actions. The plan and its parent subscription each carry `is_new_subs_allowed` and `only_admin_can_subscribe`, and both have to allow the purchase. A signed-in customer who already had the plan's subscription sees no Try action and no trial badge: the backend gives a trial once per subscription. The plan pages load the customer's records with `subscriptions_get`; until they arrive, the trial stays shown.
4
4
 
5
5
  [English guide](https://orionmarket.place/en/sandbox/components/nuxt/tariff-prices) ·
6
6
  [Russian guide](https://orionmarket.place/ru/sandbox/components/nuxt/tariff-prices)
@@ -116,6 +116,7 @@
116
116
  </template>
117
117
  <script setup lang="ts">
118
118
  import { computed, useId } from 'vue';
119
+ import { useOrionplaceStore } from '@/stores/orionplace';
119
120
  import { useOrionplaceCatalogStore } from '@/stores/orionplaceCatalog';
120
121
  import { useOrionplaceSelectionsStore } from '@/stores/orionplaceSelections';
121
122
  import { useOrionplaceSignIn } from '@/composables/useOrionplaceSignIn';
@@ -125,6 +126,7 @@
125
126
  tariffMoney,
126
127
  tariffPaidPeriods,
127
128
  tariffReturnPath,
129
+ tariffTrialOpen,
128
130
  } from '@/utils/orionplace/tariffs';
129
131
  import {
130
132
  tariffDays,
@@ -155,6 +157,7 @@
155
157
  // The chosen paid period as its `tariff_cost_id`.
156
158
  const selectedPeriod = defineModel<number>();
157
159
  const emit = defineEmits<{ select: [selection: ITariffSelection] }>();
160
+ const store = useOrionplaceStore();
158
161
  const catalogStore = useOrionplaceCatalogStore();
159
162
  const selectionStore = useOrionplaceSelectionsStore();
160
163
  const signIn = useOrionplaceSignIn();
@@ -194,11 +197,24 @@
194
197
  paidPeriods.value.find((item) => item.price === selectedPeriod.value) ??
195
198
  paidPeriods.value[0],
196
199
  );
197
- const trialDuration = computed(() => {
198
- const days = tariff.value?.trial_days ?? 0;
200
+ // A customer who already had this subscription record gets no trial.
201
+ const trialUsed = computed(() => {
202
+ const value = tariff.value;
199
203
 
200
- return days > 0 ? duration(days) : '';
204
+ return Boolean(
205
+ value &&
206
+ value.trial_days > 0 &&
207
+ !tariffTrialOpen(
208
+ value,
209
+ catalogStore.usedSubscriptionsOf(store.profile?.id),
210
+ ),
211
+ );
201
212
  });
213
+ const trialDuration = computed(() =>
214
+ tariff.value && !trialUsed.value && tariff.value.trial_days > 0
215
+ ? duration(tariff.value.trial_days)
216
+ : '',
217
+ );
202
218
  const actions = computed(() => {
203
219
  const list: TariffPeriodAction[] = [];
204
220
 
@@ -237,7 +253,11 @@
237
253
  return copy.value.closed;
238
254
  }
239
255
 
240
- return actions.value.length ? '' : copy.value.noPeriods;
256
+ if (actions.value.length) {
257
+ return '';
258
+ }
259
+
260
+ return trialUsed.value ? copy.value.trialUsed : copy.value.noPeriods;
241
261
  });
242
262
  const actionClasses = `
243
263
  box-border inline-flex h-11 w-full items-center justify-center px-6
@@ -1,10 +1,12 @@
1
1
  import { onMounted, ref, shallowRef, watch } from 'vue';
2
2
  import { useOrionplaceStore } from '@/stores/orionplace';
3
+ import { useOrionplaceCatalogStore } from '@/stores/orionplaceCatalog';
3
4
  import {
4
5
  useOrionplaceFeatureApi,
5
6
  useOrionplaceTask,
6
7
  } from '@/composables/useOrionplaceFeature';
7
8
  import { useOrionplaceSignIn } from '@/composables/useOrionplaceSignIn';
9
+ import { tariffUsedSubscriptions } from '@/utils/orionplace/tariffs';
8
10
  import type {
9
11
  ICustomerSubscription,
10
12
  ICustomerSubscriptionsResponse,
@@ -19,6 +21,7 @@ import type { IProfileData } from '@/interfaces/orionplace/accounts/IProfileData
19
21
 
20
22
  export function useOrionplaceSubscriptions(loadOnMount = true) {
21
23
  const store = useOrionplaceStore();
24
+ const catalogStore = useOrionplaceCatalogStore();
22
25
  const api = useOrionplaceFeatureApi();
23
26
  const task = useOrionplaceTask();
24
27
  const signIn = useOrionplaceSignIn();
@@ -38,6 +41,7 @@ export function useOrionplaceSubscriptions(loadOnMount = true) {
38
41
  subscriptions.value = result.data;
39
42
  tariffs.value = result.tariffs;
40
43
  loaded.value = true;
44
+ rememberUsed(result);
41
45
  const profileData = await api.request<{ profile_info: IProfileData[] }>(
42
46
  'profile_get',
43
47
  { filters: {} },
@@ -58,6 +62,44 @@ export function useOrionplaceSubscriptions(loadOnMount = true) {
58
62
  }
59
63
  }
60
64
 
65
+ function rememberUsed(
66
+ result: NonNullable<ICustomerSubscriptionsResponse['page_data']>,
67
+ ) {
68
+ if (store.profile) {
69
+ catalogStore.setUsedSubscriptions(
70
+ store.profile.id,
71
+ tariffUsedSubscriptions(result),
72
+ );
73
+ }
74
+ }
75
+
76
+ /*
77
+ * The plan pages hide the trial of a subscription record the customer
78
+ * already had (the backend refuses it). They read the records once per
79
+ * profile; a failed read leaves the trial shown, as for an unknown customer.
80
+ */
81
+ async function loadUsed() {
82
+ const profile = store.profile?.id;
83
+
84
+ if (
85
+ !store.isAuthenticated ||
86
+ profile === undefined ||
87
+ catalogStore.usedSubscriptionsOf(profile)
88
+ ) {
89
+ return;
90
+ }
91
+ try {
92
+ rememberUsed(
93
+ await api.request<NonNullable<ICustomerSubscriptionsResponse['page_data']>>(
94
+ 'subscriptions_get',
95
+ {},
96
+ ),
97
+ );
98
+ } catch {
99
+ catalogStore.setUsedSubscriptions(profile, []);
100
+ }
101
+ }
102
+
61
103
  /*
62
104
  * Each plan the customer buys is its own subscription, so a purchase that
63
105
  * already succeeded must not block the next one. Only repeating the same
@@ -206,6 +248,7 @@ export function useOrionplaceSubscriptions(loadOnMount = true) {
206
248
  completed,
207
249
  needsRefresh,
208
250
  load,
251
+ loadUsed,
209
252
  subscribe,
210
253
  renew,
211
254
  setRenewal,
@@ -17,6 +17,9 @@ import { resolveAppLoadProducts } from '@/utils/orionplace/productSeller';
17
17
  * `storeTariffs` is every plan the storefront sells; the subscriptions page
18
18
  * and its dialogs read it. `tariffs` is what the plan pages show: the same
19
19
  * list, or a search result or one plan set with `setTariffs`.
20
+ * `usedSubscriptions` holds the subscription records the signed-in customer
21
+ * already had, for the profile that loaded them; a new Application Load
22
+ * keeps it, another profile ignores it.
20
23
  */
21
24
  export function useOrionplaceCatalog(
22
25
  scope: string,
@@ -27,6 +30,7 @@ export function useOrionplaceCatalog(
27
30
  const catalogSnapshot = shallowRef<NonNullable<IAppLoadCommon['catalog']>>();
28
31
  const tariffsSnapshot = shallowRef<NonNullable<IAppLoadCommon['tariffs']>>();
29
32
  const storeTariffsSnapshot = shallowRef<NonNullable<IAppLoadCommon['tariffs']>>();
33
+ const usedSubscriptions = shallowRef<{ profile: number; ids: number[] }>();
30
34
  const catalog = computed(
31
35
  () => catalogSnapshot.value ?? init.value?.catalog ?? [],
32
36
  );
@@ -68,6 +72,19 @@ export function useOrionplaceCatalog(
68
72
  tariffsSnapshot.value = undefined;
69
73
  }
70
74
 
75
+ /** The records the customer had, see `tariffUsedSubscriptions`. */
76
+ function setUsedSubscriptions(profile: number, ids: number[]) {
77
+ usedSubscriptions.value = { profile, ids };
78
+ }
79
+
80
+ /** Those records for this profile; undefined until they are loaded. */
81
+ function usedSubscriptionsOf(profile: number | undefined) {
82
+ return usedSubscriptions.value &&
83
+ usedSubscriptions.value.profile === profile
84
+ ? usedSubscriptions.value.ids
85
+ : undefined;
86
+ }
87
+
71
88
  function getTariff(id: number) {
72
89
  return tariffs.value?.data.find((tariff) => tariff.id === id);
73
90
  }
@@ -94,6 +111,7 @@ export function useOrionplaceCatalog(
94
111
  catalogSnapshot,
95
112
  tariffsSnapshot,
96
113
  storeTariffsSnapshot,
114
+ usedSubscriptions,
97
115
  catalog,
98
116
  tariffs,
99
117
  storeTariffs,
@@ -105,6 +123,8 @@ export function useOrionplaceCatalog(
105
123
  setCatalogTree,
106
124
  setTariffs,
107
125
  setStoreTariffs,
126
+ setUsedSubscriptions,
127
+ usedSubscriptionsOf,
108
128
  getTariff,
109
129
  getCatalogCategory,
110
130
  getCatalogProducts,
@@ -190,8 +190,8 @@ export class OrionplaceApi {
190
190
  const body = response.body as {
191
191
  page_data?: { csrf?: boolean };
192
192
  } | null;
193
- // Only a CSRF rejection permits one automatic retry: Django views answer
194
- // 419, API endpoints answer 403 with page_data.csrf set to false.
193
+ // A CSRF rejection: Django views answer 419, API endpoints answer 403
194
+ // with page_data.csrf set to false. The request is not repeated.
195
195
  const csrfRejected =
196
196
  response.status === 419 ||
197
197
  (response.status === 403 && body?.page_data?.csrf === false);
@@ -9,6 +9,7 @@ const labels = {
9
9
  adminOnly:
10
10
  'This plan is assigned by the store administrator. It cannot be subscribed to online.',
11
11
  closed: 'New subscriptions to this plan are closed.',
12
+ trialUsed: 'You have already used the trial of this subscription.',
12
13
  subscribe: 'Subscribe',
13
14
  tryTrial: 'Try',
14
15
  perPeriod: 'for {days}',
@@ -57,6 +58,7 @@ const labels = {
57
58
  adminOnly:
58
59
  'Этот тариф подключает администратор магазина. Самостоятельное подключение недоступно.',
59
60
  closed: 'Новые подключения к этому тарифу закрыты.',
61
+ trialUsed: 'Пробный период этой подписки вы уже использовали.',
60
62
  subscribe: 'Подключить',
61
63
  tryTrial: 'Попробовать',
62
64
  perPeriod: 'за {days}',
@@ -201,6 +201,55 @@ export function tariffSubscribeRequest(
201
201
  };
202
202
  }
203
203
 
204
+ /**
205
+ * The subscription records the customer already had a period of, paid or
206
+ * trial, read from the `subscriptions_get` response. The backend gives a trial
207
+ * only to a customer new to the record, so the plans of these records offer
208
+ * none.
209
+ */
210
+ export function tariffUsedSubscriptions(page: {
211
+ data: { subscription: number | null; tariff: number | null }[];
212
+ tariffs: { id: number; subscription: number }[];
213
+ }) {
214
+ const ids = page.data.map(
215
+ (item) =>
216
+ item.subscription ??
217
+ page.tariffs.find((tariff) => tariff.id === item.tariff)?.subscription,
218
+ );
219
+
220
+ return [...new Set(ids.filter((id): id is number => typeof id === 'number'))];
221
+ }
222
+
223
+ /**
224
+ * Whether the plan offers its trial: it has trial days and the customer is
225
+ * not known to have had its subscription record (`used`, see
226
+ * `tariffUsedSubscriptions`). A guest and a customer whose records are not
227
+ * loaded yet see the trial; the backend refuses it to a returning customer.
228
+ */
229
+ export function tariffTrialOpen(
230
+ tariff: ISubscribeTariff,
231
+ used: readonly number[] = [],
232
+ ) {
233
+ return tariff.trial_days > 0 && !used.includes(tariff.subscription);
234
+ }
235
+
236
+ /**
237
+ * The plan choice to open again after sign-in: a paid period as it is, a
238
+ * trial only once the customer's records are loaded (`used`) and the
239
+ * customer is new to the record.
240
+ */
241
+ export function tariffResumable(
242
+ selection: ITariffSelection | undefined,
243
+ tariff: ISubscribeTariff | undefined,
244
+ used: readonly number[] | undefined,
245
+ ) {
246
+ if (!selection || selection.price !== null) {
247
+ return selection;
248
+ }
249
+
250
+ return tariff && used && tariffTrialOpen(tariff, used) ? selection : undefined;
251
+ }
252
+
204
253
  export interface ITariffFeature {
205
254
  key: string;
206
255
  label: string;
@@ -705,7 +705,11 @@ the short description comes from `tariff_short_description` with HTML stripped,
705
705
  and the full `tariff_description` opens under Details after sanitizing. Both use
706
706
  available translation fallback. The image uses `tariff_image.small[0]`; a plan
707
707
  without it shows no picture and leaves that row of the card empty. A positive
708
- `trial_days` adds a trial badge.
708
+ `trial_days` adds a trial badge and the Try action, except for a signed-in
709
+ customer who already had the plan's subscription: the backend gives a trial
710
+ once per subscription. The plan pages read the customer's records with
711
+ `subscriptions_get` and keep them in the catalog store
712
+ (`usedSubscriptionsOf(profileId)`).
709
713
 
710
714
  `TariffCardFeatures` lists the flags and numeric limits of
711
715
  `tariff_variables_json`: `true` is shown as included, `false` as not included,