@xano/cli 1.0.5 → 1.0.6-beta.1

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.
Files changed (41) hide show
  1. package/README.md +57 -0
  2. package/dist/base-command.d.ts +2 -0
  3. package/dist/base-command.js +10 -4
  4. package/dist/commands/ephemeral/create/index.d.ts +18 -0
  5. package/dist/commands/ephemeral/create/index.js +103 -0
  6. package/dist/commands/ephemeral/delete/index.d.ts +18 -0
  7. package/dist/commands/ephemeral/delete/index.js +99 -0
  8. package/dist/commands/ephemeral/edit/index.d.ts +18 -0
  9. package/dist/commands/ephemeral/edit/index.js +109 -0
  10. package/dist/commands/ephemeral/get/index.d.ts +21 -0
  11. package/dist/commands/ephemeral/get/index.js +125 -0
  12. package/dist/commands/ephemeral/impersonate/index.d.ts +19 -0
  13. package/dist/commands/ephemeral/impersonate/index.js +112 -0
  14. package/dist/commands/ephemeral/list/index.d.ts +19 -0
  15. package/dist/commands/ephemeral/list/index.js +122 -0
  16. package/dist/commands/ephemeral/pull/index.d.ts +25 -0
  17. package/dist/commands/ephemeral/pull/index.js +249 -0
  18. package/dist/commands/ephemeral/push/index.d.ts +25 -0
  19. package/dist/commands/ephemeral/push/index.js +144 -0
  20. package/dist/commands/ephemeral/static_host/build/delete/index.d.ts +20 -0
  21. package/dist/commands/ephemeral/static_host/build/delete/index.js +121 -0
  22. package/dist/commands/ephemeral/static_host/build/get/index.d.ts +18 -0
  23. package/dist/commands/ephemeral/static_host/build/get/index.js +137 -0
  24. package/dist/commands/ephemeral/static_host/build/list/index.d.ts +19 -0
  25. package/dist/commands/ephemeral/static_host/build/list/index.js +158 -0
  26. package/dist/commands/ephemeral/static_host/build/pull/index.d.ts +53 -0
  27. package/dist/commands/ephemeral/static_host/build/pull/index.js +308 -0
  28. package/dist/commands/ephemeral/static_host/build/push/index.d.ts +24 -0
  29. package/dist/commands/ephemeral/static_host/build/push/index.js +250 -0
  30. package/dist/commands/ephemeral/static_host/create/index.d.ts +18 -0
  31. package/dist/commands/ephemeral/static_host/create/index.js +92 -0
  32. package/dist/commands/ephemeral/static_host/deploy/index.d.ts +19 -0
  33. package/dist/commands/ephemeral/static_host/deploy/index.js +112 -0
  34. package/dist/commands/ephemeral/static_host/edit/index.d.ts +24 -0
  35. package/dist/commands/ephemeral/static_host/edit/index.js +158 -0
  36. package/dist/commands/ephemeral/static_host/get/index.d.ts +19 -0
  37. package/dist/commands/ephemeral/static_host/get/index.js +101 -0
  38. package/dist/commands/ephemeral/static_host/list/index.d.ts +18 -0
  39. package/dist/commands/ephemeral/static_host/list/index.js +152 -0
  40. package/oclif.manifest.json +4369 -2352
  41. package/package.json +10 -1
@@ -0,0 +1,144 @@
1
+ import { Args, Flags } from '@oclif/core';
2
+ import * as fs from 'node:fs';
3
+ import { resolve } from 'node:path';
4
+ import BaseCommand from '../../../base-command.js';
5
+ import { executePush } from '../../../utils/multidoc-push.js';
6
+ export default class EphemeralPush extends BaseCommand {
7
+ static args = {
8
+ tenant_name: Args.string({
9
+ description: 'Ephemeral tenant name to push to',
10
+ required: true,
11
+ }),
12
+ };
13
+ static description = '[IMPORTANT] ALWAYS run --dry-run first and show the user the output before pushing. Push local documents to an ephemeral tenant via multidoc import. By default, only changed files are pushed (partial mode). Use --sync to push all files. Shows a preview of changes before pushing unless --force is specified. Use --dry-run to preview only.';
14
+ static examples = [
15
+ `$ xano ephemeral push e4f2-9ab1-xyz1
16
+ Push from current directory (default partial mode)
17
+ `,
18
+ `$ xano ephemeral push e4f2-9ab1-xyz1 -d ./my-workspace
19
+ Push from a specific directory
20
+ `,
21
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --sync
22
+ Push all files to the ephemeral tenant
23
+ `,
24
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --sync --delete
25
+ Push all files and delete remote objects not included
26
+ `,
27
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --dry-run
28
+ Preview changes without pushing
29
+ `,
30
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --force
31
+ Skip preview and push immediately
32
+ `,
33
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --records --env`,
34
+ `$ xano ephemeral push e4f2-9ab1-xyz1 --truncate`,
35
+ ];
36
+ static flags = {
37
+ ...BaseCommand.baseFlags,
38
+ directory: Flags.string({
39
+ char: 'd',
40
+ default: '.',
41
+ description: 'Directory containing documents to push (defaults to current directory)',
42
+ required: false,
43
+ }),
44
+ delete: Flags.boolean({
45
+ default: false,
46
+ description: 'Delete remote objects not included in the push (requires --sync)',
47
+ required: false,
48
+ }),
49
+ 'dry-run': Flags.boolean({
50
+ default: false,
51
+ description: 'Show preview of changes without pushing (exit after preview)',
52
+ required: false,
53
+ }),
54
+ env: Flags.boolean({
55
+ default: false,
56
+ description: 'Include environment variables in import',
57
+ required: false,
58
+ }),
59
+ force: Flags.boolean({
60
+ default: false,
61
+ description: 'Skip preview and confirmation prompt (for CI/CD pipelines)',
62
+ required: false,
63
+ }),
64
+ guids: Flags.boolean({
65
+ allowNo: true,
66
+ default: true,
67
+ description: 'Write server-assigned GUIDs back to local files (use --no-guids to skip)',
68
+ required: false,
69
+ }),
70
+ records: Flags.boolean({
71
+ default: false,
72
+ description: 'Include records in import',
73
+ required: false,
74
+ }),
75
+ sync: Flags.boolean({
76
+ default: false,
77
+ description: 'Full push — send all files, not just changed ones. Required for --delete.',
78
+ required: false,
79
+ }),
80
+ transaction: Flags.boolean({
81
+ allowNo: true,
82
+ default: true,
83
+ description: '[CRITICAL] DO NOT run with --no-transaction without explicit user confirmation; this disables rollback. Wraps import in a database transaction (use --no-transaction for debugging purposes).',
84
+ required: false,
85
+ }),
86
+ truncate: Flags.boolean({
87
+ default: false,
88
+ description: '[CRITICAL] STOP and confirm with the user; this truncates live tables before importing.',
89
+ required: false,
90
+ }),
91
+ workspace: Flags.string({
92
+ char: 'w',
93
+ description: 'Workspace ID (uses profile workspace if not provided)',
94
+ required: false,
95
+ }),
96
+ };
97
+ async run() {
98
+ const { args, flags } = await this.parse(EphemeralPush);
99
+ const { profile } = this.resolveProfile(flags);
100
+ const workspaceId = flags.workspace || profile.workspace;
101
+ if (!workspaceId) {
102
+ this.error('No workspace ID provided. Ephemeral tenants require a workspace — use --workspace or set one in your profile.');
103
+ }
104
+ const inputDir = resolve(flags.directory);
105
+ if (!fs.existsSync(inputDir)) {
106
+ this.error(`Directory not found: ${inputDir}`);
107
+ }
108
+ if (!fs.statSync(inputDir).isDirectory()) {
109
+ this.error(`Not a directory: ${inputDir}`);
110
+ }
111
+ const tenantName = args.tenant_name;
112
+ const baseUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}`;
113
+ const target = {
114
+ buildDryRunUrl: (params) => `${baseUrl}/multidoc/dry-run?${params.toString()}`,
115
+ buildPushUrl: (params) => `${baseUrl}/multidoc?${params.toString()}`,
116
+ cliVersion: this.config.version,
117
+ instanceOrigin: profile.instance_origin,
118
+ label: `ephemeral tenant ${tenantName}`,
119
+ sourceWorkspaceId: profile.workspace,
120
+ supportsBranches: false,
121
+ supportsPartial: true,
122
+ warnOnWorkspaceMismatch: false,
123
+ };
124
+ const pushFlags = {
125
+ delete: flags.delete,
126
+ 'dry-run': flags['dry-run'],
127
+ env: flags.env,
128
+ force: flags.force,
129
+ guids: flags.guids,
130
+ records: flags.records,
131
+ sync: flags.sync,
132
+ transaction: flags.transaction,
133
+ truncate: flags.truncate,
134
+ verbose: flags.verbose,
135
+ };
136
+ await executePush({
137
+ accessToken: profile.access_token,
138
+ branch: '',
139
+ command: this,
140
+ inputDir,
141
+ verboseFetch: this.verboseFetch.bind(this),
142
+ }, target, pushFlags);
143
+ }
144
+ }
@@ -0,0 +1,20 @@
1
+ import BaseCommand from '../../../../../base-command.js';
2
+ export default class EphemeralStaticHostBuildDelete extends BaseCommand {
3
+ static args: {
4
+ tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
5
+ };
6
+ static description: string;
7
+ static examples: string[];
8
+ static flags: {
9
+ build_id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
10
+ force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
11
+ output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
12
+ 'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
13
+ workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
15
+ profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
16
+ verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
17
+ };
18
+ run(): Promise<void>;
19
+ private confirm;
20
+ }
@@ -0,0 +1,121 @@
1
+ import { Args, Flags } from '@oclif/core';
2
+ import BaseCommand from '../../../../../base-command.js';
3
+ export default class EphemeralStaticHostBuildDelete extends BaseCommand {
4
+ static args = {
5
+ tenant_name: Args.string({
6
+ description: 'Ephemeral tenant name',
7
+ required: true,
8
+ }),
9
+ };
10
+ static description = 'Delete a static host build for an ephemeral tenant permanently. This action cannot be undone.';
11
+ static examples = [
12
+ `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 --static-host default --build_id 52
13
+ Are you sure you want to delete build 52 from static host 'default'? This action cannot be undone. (y/N) y
14
+ Deleted build 52 from static host 'default'
15
+ `,
16
+ `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H default --build_id 52 --force
17
+ Deleted build 52 from static host 'default'
18
+ `,
19
+ `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H myhost --build_id 123 -w 40 -f
20
+ Deleted build 123 from static host 'myhost'
21
+ `,
22
+ `$ xano ephemeral static_host build delete e4f2-9ab1-xyz1 -H default --build_id 52 -f -o json`,
23
+ ];
24
+ static flags = {
25
+ ...BaseCommand.baseFlags,
26
+ build_id: Flags.string({
27
+ description: 'Build ID to delete',
28
+ required: true,
29
+ }),
30
+ force: Flags.boolean({
31
+ char: 'f',
32
+ default: false,
33
+ description: '[CRITICAL] NEVER run without explicit user confirmation. Skips the confirmation prompt.',
34
+ required: false,
35
+ }),
36
+ output: Flags.string({
37
+ char: 'o',
38
+ default: 'summary',
39
+ description: 'Output format',
40
+ options: ['summary', 'json'],
41
+ required: false,
42
+ }),
43
+ 'static-host': Flags.string({
44
+ char: 'H',
45
+ description: 'Static host name',
46
+ required: true,
47
+ }),
48
+ workspace: Flags.string({
49
+ char: 'w',
50
+ description: 'Workspace ID (optional if set in profile)',
51
+ required: false,
52
+ }),
53
+ };
54
+ async run() {
55
+ const { args, flags } = await this.parse(EphemeralStaticHostBuildDelete);
56
+ const { profile, profileName } = this.resolveProfile(flags);
57
+ const tenantName = args.tenant_name;
58
+ const staticHost = flags['static-host'];
59
+ // Determine workspace_id from flag or profile
60
+ let workspaceId;
61
+ if (flags.workspace) {
62
+ workspaceId = flags.workspace;
63
+ }
64
+ else if (profile.workspace) {
65
+ workspaceId = profile.workspace;
66
+ }
67
+ else {
68
+ this.error(`Workspace ID is required. Either:\n` +
69
+ ` 1. Provide it as a flag: xano ephemeral static_host build delete <tenant_name> --static-host <static_host> --build_id <id> -w <workspace_id>\n` +
70
+ ` 2. Set it in your profile using: xano profile edit ${profileName} -w <workspace_id>`);
71
+ }
72
+ if (!flags.force) {
73
+ const confirmed = await this.confirm(`Are you sure you want to delete build ${flags.build_id} from static host '${staticHost}'? This action cannot be undone.`);
74
+ if (!confirmed) {
75
+ this.log('Deletion cancelled.');
76
+ return;
77
+ }
78
+ }
79
+ const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build/${flags.build_id}`;
80
+ try {
81
+ const response = await this.verboseFetch(apiUrl, {
82
+ headers: {
83
+ 'accept': 'application/json',
84
+ 'Authorization': `Bearer ${profile.access_token}`,
85
+ },
86
+ method: 'DELETE',
87
+ }, flags.verbose, profile.access_token);
88
+ if (!response.ok) {
89
+ const errorText = await response.text();
90
+ this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
91
+ }
92
+ if (flags.output === 'json') {
93
+ this.log(JSON.stringify({ build_id: flags.build_id, deleted: true, static_host: staticHost }, null, 2));
94
+ }
95
+ else {
96
+ this.log(`Deleted build ${flags.build_id} from static host '${staticHost}'`);
97
+ }
98
+ }
99
+ catch (error) {
100
+ if (error instanceof Error) {
101
+ this.error(`Failed to delete build: ${error.message}`);
102
+ }
103
+ else {
104
+ this.error(`Failed to delete build: ${String(error)}`);
105
+ }
106
+ }
107
+ }
108
+ async confirm(message) {
109
+ const readline = await import('node:readline');
110
+ const rl = readline.createInterface({
111
+ input: process.stdin,
112
+ output: process.stdout,
113
+ });
114
+ return new Promise((resolve) => {
115
+ rl.question(`${message} (y/N) `, (answer) => {
116
+ rl.close();
117
+ resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
118
+ });
119
+ });
120
+ }
121
+ }
@@ -0,0 +1,18 @@
1
+ import BaseCommand from '../../../../../base-command.js';
2
+ export default class EphemeralStaticHostBuildGet extends BaseCommand {
3
+ static args: {
4
+ tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
5
+ };
6
+ static description: string;
7
+ static examples: string[];
8
+ static flags: {
9
+ build_id: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
10
+ output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
11
+ 'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
12
+ workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
13
+ config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
15
+ verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
16
+ };
17
+ run(): Promise<void>;
18
+ }
@@ -0,0 +1,137 @@
1
+ import { Args, Flags } from '@oclif/core';
2
+ import BaseCommand from '../../../../../base-command.js';
3
+ export default class EphemeralStaticHostBuildGet extends BaseCommand {
4
+ static args = {
5
+ tenant_name: Args.string({
6
+ description: 'Ephemeral tenant name',
7
+ required: true,
8
+ }),
9
+ };
10
+ static description = 'Get details of a specific build for a static host of an ephemeral tenant';
11
+ static examples = [
12
+ `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 --static-host default --build_id 52
13
+ Build Details:
14
+ ID: 52
15
+ Name: v1.0.0
16
+ Status: completed
17
+ `,
18
+ `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H default --build_id 52 -w 40
19
+ Build Details:
20
+ ID: 52
21
+ Name: v1.0.0
22
+ Status: completed
23
+ `,
24
+ `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H myhost --build_id 123 --profile production
25
+ Build Details:
26
+ ID: 123
27
+ Name: production-build
28
+ `,
29
+ `$ xano ephemeral static_host build get e4f2-9ab1-xyz1 -H default --build_id 52 -o json
30
+ {
31
+ "id": 52,
32
+ "name": "v1.0.0",
33
+ "status": "completed"
34
+ }
35
+ `,
36
+ ];
37
+ static flags = {
38
+ ...BaseCommand.baseFlags,
39
+ build_id: Flags.string({
40
+ description: 'Build ID',
41
+ required: true,
42
+ }),
43
+ output: Flags.string({
44
+ char: 'o',
45
+ default: 'summary',
46
+ description: 'Output format',
47
+ options: ['summary', 'json'],
48
+ required: false,
49
+ }),
50
+ 'static-host': Flags.string({
51
+ char: 'H',
52
+ description: 'Static host name',
53
+ required: true,
54
+ }),
55
+ workspace: Flags.string({
56
+ char: 'w',
57
+ description: 'Workspace ID (optional if set in profile)',
58
+ required: false,
59
+ }),
60
+ };
61
+ async run() {
62
+ const { args, flags } = await this.parse(EphemeralStaticHostBuildGet);
63
+ const { profile, profileName } = this.resolveProfile(flags);
64
+ const tenantName = args.tenant_name;
65
+ const staticHost = flags['static-host'];
66
+ // Determine workspace_id from flag or profile
67
+ let workspaceId;
68
+ if (flags.workspace) {
69
+ workspaceId = flags.workspace;
70
+ }
71
+ else if (profile.workspace) {
72
+ workspaceId = profile.workspace;
73
+ }
74
+ else {
75
+ this.error(`Workspace ID is required. Either:\n` +
76
+ ` 1. Provide it as a flag: xano ephemeral static_host build get <tenant_name> --static-host <static_host> --build_id <id> -w <workspace_id>\n` +
77
+ ` 2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
78
+ }
79
+ // Construct the API URL
80
+ const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build/${flags.build_id}`;
81
+ // Fetch build from the API
82
+ try {
83
+ const response = await this.verboseFetch(apiUrl, {
84
+ headers: {
85
+ 'accept': 'application/json',
86
+ 'Authorization': `Bearer ${profile.access_token}`,
87
+ },
88
+ method: 'GET',
89
+ }, flags.verbose, profile.access_token);
90
+ if (!response.ok) {
91
+ const errorText = await response.text();
92
+ this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
93
+ }
94
+ const build = await response.json();
95
+ // Validate response
96
+ if (!build || typeof build !== 'object') {
97
+ this.error('Unexpected API response format');
98
+ }
99
+ // Output results
100
+ if (flags.output === 'json') {
101
+ this.log(JSON.stringify(build, null, 2));
102
+ }
103
+ else {
104
+ // summary format
105
+ this.log('Build Details:');
106
+ this.log(`ID: ${build.id}`);
107
+ this.log(`Name: ${build.name}`);
108
+ if (build.description) {
109
+ this.log(`Description: ${build.description}`);
110
+ }
111
+ if (build.status) {
112
+ this.log(`Status: ${build.status}`);
113
+ }
114
+ if (typeof build.file_count === 'number') {
115
+ this.log(`Files: ${build.file_count}`);
116
+ }
117
+ if (typeof build.file_bytes === 'number') {
118
+ this.log(`Size: ${build.file_bytes} bytes`);
119
+ }
120
+ if (build.created_at) {
121
+ this.log(`Created: ${build.created_at}`);
122
+ }
123
+ if (build.updated_at) {
124
+ this.log(`Updated: ${build.updated_at}`);
125
+ }
126
+ }
127
+ }
128
+ catch (error) {
129
+ if (error instanceof Error) {
130
+ this.error(`Failed to fetch build: ${error.message}`);
131
+ }
132
+ else {
133
+ this.error(`Failed to fetch build: ${String(error)}`);
134
+ }
135
+ }
136
+ }
137
+ }
@@ -0,0 +1,19 @@
1
+ import BaseCommand from '../../../../../base-command.js';
2
+ export default class EphemeralStaticHostBuildList extends BaseCommand {
3
+ static args: {
4
+ tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
5
+ };
6
+ static description: string;
7
+ static examples: string[];
8
+ static flags: {
9
+ output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
10
+ page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
11
+ per_page: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
12
+ 'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
13
+ workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
14
+ config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
15
+ profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
16
+ verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
17
+ };
18
+ run(): Promise<void>;
19
+ }
@@ -0,0 +1,158 @@
1
+ import { Args, Flags } from '@oclif/core';
2
+ import BaseCommand from '../../../../../base-command.js';
3
+ export default class EphemeralStaticHostBuildList extends BaseCommand {
4
+ static args = {
5
+ tenant_name: Args.string({
6
+ description: 'Ephemeral tenant name',
7
+ required: true,
8
+ }),
9
+ };
10
+ static description = 'List all builds for a static host of an ephemeral tenant';
11
+ static examples = [
12
+ `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 --static-host default -w 40
13
+ Available builds:
14
+ - v1.0.0 (ID: 1) - Status: completed
15
+ - v1.0.1 (ID: 2) - Status: pending
16
+ `,
17
+ `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H myhost --profile production
18
+ Available builds:
19
+ - production (ID: 1) - Status: completed
20
+ - staging (ID: 2) - Status: completed
21
+ `,
22
+ `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H default -w 40 --output json
23
+ [
24
+ {
25
+ "id": 1,
26
+ "name": "v1.0.0",
27
+ "status": "completed"
28
+ }
29
+ ]
30
+ `,
31
+ `$ xano ephemeral static_host build list e4f2-9ab1-xyz1 -H default -p staging -o json --page 2
32
+ [
33
+ {
34
+ "id": 3,
35
+ "name": "v1.0.2"
36
+ }
37
+ ]
38
+ `,
39
+ ];
40
+ static flags = {
41
+ ...BaseCommand.baseFlags,
42
+ output: Flags.string({
43
+ char: 'o',
44
+ default: 'summary',
45
+ description: 'Output format',
46
+ options: ['summary', 'json'],
47
+ required: false,
48
+ }),
49
+ page: Flags.integer({
50
+ default: 1,
51
+ description: 'Page number for pagination',
52
+ required: false,
53
+ }),
54
+ per_page: Flags.integer({
55
+ default: 50,
56
+ description: 'Number of results per page',
57
+ required: false,
58
+ }),
59
+ 'static-host': Flags.string({
60
+ char: 'H',
61
+ description: 'Static host name',
62
+ required: true,
63
+ }),
64
+ workspace: Flags.string({
65
+ char: 'w',
66
+ description: 'Workspace ID (optional if set in profile)',
67
+ required: false,
68
+ }),
69
+ };
70
+ async run() {
71
+ const { args, flags } = await this.parse(EphemeralStaticHostBuildList);
72
+ const { profile, profileName } = this.resolveProfile(flags);
73
+ const tenantName = args.tenant_name;
74
+ const staticHost = flags['static-host'];
75
+ // Determine workspace_id from flag or profile
76
+ let workspaceId;
77
+ if (flags.workspace) {
78
+ workspaceId = flags.workspace;
79
+ }
80
+ else if (profile.workspace) {
81
+ workspaceId = profile.workspace;
82
+ }
83
+ else {
84
+ this.error(`Workspace ID is required. Either:\n` +
85
+ ` 1. Provide it as a flag: xano ephemeral static_host build list <tenant_name> --static-host <static_host> -w <workspace_id>\n` +
86
+ ` 2. Set it in your profile using: xano profile:edit ${profileName} -w <workspace_id>`);
87
+ }
88
+ // Build query parameters
89
+ const queryParams = new URLSearchParams({
90
+ page: flags.page.toString(),
91
+ });
92
+ // Only add per_page if it's not the default value
93
+ if (flags.per_page !== 50) {
94
+ queryParams.append('per_page', flags.per_page.toString());
95
+ }
96
+ // Construct the API URL
97
+ const apiUrl = `${profile.instance_origin}/api:meta/workspace/${workspaceId}/tenant/${tenantName}/static_host/${staticHost}/build?${queryParams.toString()}`;
98
+ // Fetch builds from the API
99
+ try {
100
+ const response = await this.verboseFetch(apiUrl, {
101
+ headers: {
102
+ 'accept': 'application/json',
103
+ 'Authorization': `Bearer ${profile.access_token}`,
104
+ },
105
+ method: 'GET',
106
+ }, flags.verbose, profile.access_token);
107
+ if (!response.ok) {
108
+ const errorText = await response.text();
109
+ this.error(`API request failed with status ${response.status}: ${response.statusText}\n${errorText}`);
110
+ }
111
+ const data = await response.json();
112
+ // Handle different response formats
113
+ let builds;
114
+ if (Array.isArray(data)) {
115
+ builds = data;
116
+ }
117
+ else if (data && typeof data === 'object' && 'builds' in data && Array.isArray(data.builds)) {
118
+ builds = data.builds;
119
+ }
120
+ else if (data && typeof data === 'object' && 'items' in data && Array.isArray(data.items)) {
121
+ builds = data.items;
122
+ }
123
+ else {
124
+ this.error('Unexpected API response format');
125
+ }
126
+ // Output results
127
+ if (flags.output === 'json') {
128
+ this.log(JSON.stringify(builds, null, 2));
129
+ }
130
+ else {
131
+ // summary format
132
+ if (builds.length === 0) {
133
+ this.log('No builds found');
134
+ }
135
+ else {
136
+ this.log('Available builds:');
137
+ for (const build of builds) {
138
+ if (build.id === undefined) {
139
+ this.log(` - ${build.name}`);
140
+ }
141
+ else {
142
+ const statusInfo = build.status ? ` - Status: ${build.status}` : '';
143
+ this.log(` - ${build.name} (ID: ${build.id})${statusInfo}`);
144
+ }
145
+ }
146
+ }
147
+ }
148
+ }
149
+ catch (error) {
150
+ if (error instanceof Error) {
151
+ this.error(`Failed to fetch builds: ${error.message}`);
152
+ }
153
+ else {
154
+ this.error(`Failed to fetch builds: ${String(error)}`);
155
+ }
156
+ }
157
+ }
158
+ }
@@ -0,0 +1,53 @@
1
+ import BaseCommand from '../../../../../base-command.js';
2
+ export interface StaticHostEnv {
3
+ canonical?: null | string;
4
+ }
5
+ export interface StaticHostSummary {
6
+ [k: string]: unknown;
7
+ dev?: StaticHostEnv;
8
+ name: string;
9
+ prod?: StaticHostEnv;
10
+ }
11
+ export interface BuildSummary {
12
+ canonical?: string;
13
+ id: number;
14
+ }
15
+ /**
16
+ * Find the deployed `canonical` for a static host's env from a list of hosts.
17
+ * Returns null when the host isn't present or nothing is deployed to that env.
18
+ */
19
+ export declare function extractEnvCanonical(hosts: StaticHostSummary[], staticHost: string, env: string): null | string;
20
+ /** Find the build whose unique `canonical` matches, or null if none do. */
21
+ export declare function findBuildByCanonical(builds: BuildSummary[], canonical: string): BuildSummary | null;
22
+ export default class EphemeralStaticHostBuildPull extends BaseCommand {
23
+ static args: {
24
+ tenant_name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
25
+ };
26
+ static description: string;
27
+ static examples: string[];
28
+ static flags: {
29
+ build_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
30
+ directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
31
+ env: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
32
+ latest: import("@oclif/core/interfaces").BooleanFlag<boolean>;
33
+ source: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
34
+ 'static-host': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
35
+ workspace: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
36
+ config: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
37
+ profile: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
38
+ verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
39
+ };
40
+ run(): Promise<void>;
41
+ private parseFileDocument;
42
+ /**
43
+ * Resolve the build ID currently deployed to a static host's dev/prod env.
44
+ *
45
+ * The deployed env stores the `canonical` of the build it was created from
46
+ * (static_host.{env}.canonical). Each build carries that same unique
47
+ * `canonical`, so we match the env's canonical against the build list to
48
+ * recover the build ID — a shortcut for "list builds, find the deployed one,
49
+ * then pull it".
50
+ */
51
+ private resolveEnvBuild;
52
+ private resolveLatestBuild;
53
+ }