@equinor/fusion-framework-cli 11.1.2 → 11.1.4

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 (35) hide show
  1. package/CHANGELOG.md +82 -0
  2. package/README.md +3 -2
  3. package/bin/build/bin.mjs +1 -1
  4. package/bin/build/cli.mjs +6 -6
  5. package/dist/esm/lib/utils/resolve-package.js +12 -3
  6. package/dist/esm/lib/utils/resolve-package.js.map +1 -1
  7. package/dist/esm/version.js +1 -1
  8. package/dist/types/cli/commands/app/build.d.ts +1 -1
  9. package/dist/types/cli/commands/app/check.d.ts +3 -3
  10. package/dist/types/cli/commands/app/config.d.ts +4 -4
  11. package/dist/types/cli/commands/app/dev.d.ts +4 -4
  12. package/dist/types/cli/commands/app/manifest.d.ts +4 -4
  13. package/dist/types/cli/commands/app/pack.d.ts +3 -3
  14. package/dist/types/cli/commands/app/publish.d.ts +4 -4
  15. package/dist/types/cli/commands/app/tag.d.ts +10 -11
  16. package/dist/types/cli/commands/app/upload.d.ts +4 -4
  17. package/dist/types/cli/commands/auth/login.d.ts +14 -0
  18. package/dist/types/cli/commands/auth/logout.d.ts +13 -3
  19. package/dist/types/cli/commands/auth/token.d.ts +15 -1
  20. package/dist/types/cli/commands/portal/build.d.ts +25 -0
  21. package/dist/types/cli/commands/portal/config.d.ts +4 -4
  22. package/dist/types/cli/commands/portal/dev.d.ts +25 -0
  23. package/dist/types/cli/commands/portal/manifest.d.ts +28 -0
  24. package/dist/types/cli/commands/portal/pack.d.ts +24 -0
  25. package/dist/types/cli/commands/portal/publish.d.ts +29 -0
  26. package/dist/types/cli/commands/portal/schema.d.ts +27 -0
  27. package/dist/types/cli/commands/portal/tag.d.ts +29 -0
  28. package/dist/types/cli/commands/portal/upload.d.ts +25 -0
  29. package/dist/types/cli/options/auth.d.ts +16 -0
  30. package/dist/types/version.d.ts +1 -1
  31. package/docs/application.md +5 -6
  32. package/docs/auth.md +7 -0
  33. package/docs/portal.md +4 -4
  34. package/package.json +8 -6
  35. package/docs/libsecret.md +0 -66
@@ -1,5 +1,6 @@
1
1
  import { dirname } from 'node:path';
2
2
  import { readPackageUp, } from 'read-package-up';
3
+ import normalizePackageData from 'normalize-package-data'; // Correct import for normalize-package-data
3
4
  /**
4
5
  * Resolves the application package by searching for the nearest `package.json` file.
5
6
  *
@@ -8,11 +9,19 @@ import { readPackageUp, } from 'read-package-up';
8
9
  * @throws Will throw an error if the `package.json` file is not found.
9
10
  */
10
11
  export const resolvePackage = async (options) => {
11
- const pkg = await readPackageUp(options);
12
+ const pkg = await readPackageUp({ ...options, normalize: false });
12
13
  if (!pkg) {
13
- throw Error('failed to find package.json');
14
+ throw new Error('failed to find package.json');
14
15
  }
15
- return { ...pkg, root: dirname(pkg.path) };
16
+ // normalizePackageData mutates its argument and returns void, so clone first
17
+ const normalizedPackageJson = { ...pkg.packageJson };
18
+ normalizePackageData(normalizedPackageJson);
19
+ const packageJson = { ...normalizedPackageJson, version: pkg.packageJson.version };
20
+ return {
21
+ packageJson,
22
+ path: pkg.path,
23
+ root: dirname(pkg.path),
24
+ };
16
25
  };
17
26
  export default resolvePackage;
18
27
  //# sourceMappingURL=resolve-package.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"resolve-package.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-package.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC;AAQzB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,OAA+B,EAA4B,EAAE;IAChG,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAqB,CAAC;AAChE,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}
1
+ {"version":3,"file":"resolve-package.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-package.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,oBAAoB,MAAM,wBAAwB,CAAC,CAAC,4CAA4C;AAQvG;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,OAA+B,EAA4B,EAAE;IAChG,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IACD,6EAA6E;IAC7E,MAAM,qBAAqB,GAAG,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IACrD,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,EAAE,GAAG,qBAAqB,EAAE,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;IACnF,OAAO;QACL,WAAW;QACX,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;KACL,CAAC;AACvB,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}
@@ -1,3 +1,3 @@
1
1
  // Generated by genversion.
2
- export const version = '11.1.2';
2
+ export const version = '11.1.4';
3
3
  //# sourceMappingURL=version.js.map
@@ -19,7 +19,7 @@
19
19
  * -d, --debug Enable debug mode for verbose logging (default: false)
20
20
  *
21
21
  * Example:
22
- * $ fusion build app.manifest.dev.ts --debug
22
+ * $ ffc app build app.manifest.dev.ts --debug
23
23
  *
24
24
  * @see buildApplication for build implementation details
25
25
  */
@@ -10,15 +10,15 @@
10
10
  * - Provides a debug mode for verbose logging.
11
11
  *
12
12
  * Usage:
13
- * $ fusion check [options]
13
+ * $ ffc app check [options]
14
14
  *
15
15
  * Options:
16
16
  * -d, --debug Enable debug mode for verbose logging (default: false)
17
- * --environment <env> Specify the environment (see available environments)
17
+ * --env <env> Specify the environment (see available environments)
18
18
  * --token <token> Provide an authentication token (if required)
19
19
  *
20
20
  * Example:
21
- * $ fusion check --environment prod --debug
21
+ * $ ffc app check --env prod --debug
22
22
  *
23
23
  * @see checkApp for implementation details
24
24
  */
@@ -10,7 +10,7 @@
10
10
  * - Option [-e, --env] cannot be set to dev when --publish is used.
11
11
  *
12
12
  * Usage:
13
- * $ fusion config [config] [options]
13
+ * $ ffc app config [config] [options]
14
14
  *
15
15
  * Arguments:
16
16
  * [config] Config build file to use (e.g., app.config[.env]?.[ts,js,json])
@@ -24,9 +24,9 @@
24
24
  * -o, --output <stdout|path> Output to stdout or a file (default: stdout)
25
25
  *
26
26
  * Example:
27
- * $ fusion-framework-cli config app.config.ts
28
- * $ fusion-framework-cli config app.config.prod.ts --output ./dist/app.config.json
29
- * $ fusion-framework-cli config --publish --manifest app.manifest.ts --env prod
27
+ * $ ffc app config app.config.ts
28
+ * $ ffc app config app.config.prod.ts --output ./dist/app.config.json
29
+ * $ ffc app config --publish --manifest app.manifest.ts --env prod
30
30
  *
31
31
  * @see generateApplicationConfig, publishAppConfig for implementation details
32
32
  */
@@ -9,7 +9,7 @@
9
9
  * - Debug mode available for verbose logging.
10
10
  *
11
11
  * Usage:
12
- * $ fusion app dev [options]
12
+ * $ ffc app dev [options]
13
13
  *
14
14
  * Options:
15
15
  * --debug Enable debug mode
@@ -19,9 +19,9 @@
19
19
  * --port <port> Port for the development server (default: 3000)
20
20
  *
21
21
  * Example:
22
- * $ fusion app dev
23
- * $ fusion app dev --port 4000
24
- * $ fusion app dev --manifest ./app.manifest.local.ts --config ./app.config.ts
22
+ * $ ffc app dev
23
+ * $ ffc app dev --port 4000
24
+ * $ ffc app dev --manifest ./app.manifest.local.ts --config ./app.config.ts
25
25
  *
26
26
  * @see startAppDevServer for implementation details
27
27
  */
@@ -9,7 +9,7 @@
9
9
  * - Debug and silent modes for flexible output.
10
10
  *
11
11
  * Usage:
12
- * $ fusion manifest [manifest] [options]
12
+ * $ ffc app manifest [manifest] [options]
13
13
  *
14
14
  * Arguments:
15
15
  * [manifest] Manifest build file to use (e.g., app.manifest[.env]?.[ts,js,json])
@@ -20,9 +20,9 @@
20
20
  * -s, --silent Silent mode, suppresses output except errors
21
21
  *
22
22
  * Example:
23
- * $ fusion manifest
24
- * $ fusion manifest app.manifest.prod.ts --output ./dist/app.manifest.json
25
- * $ fusion manifest --debug
23
+ * $ ffc app manifest
24
+ * $ ffc app manifest app.manifest.prod.ts --output ./dist/app.manifest.json
25
+ * $ ffc app manifest --debug
26
26
  *
27
27
  * @see loadAppManifest for implementation details
28
28
  */
@@ -11,7 +11,7 @@ export declare const DEFAULT_ARCHIVE: "app-bundle.zip";
11
11
  * - If no manifest is provided, defaults to app.manifest.[ts|js|json] in the current directory.
12
12
  *
13
13
  * Usage:
14
- * $ fusion pack [manifest] [options]
14
+ * $ ffc app pack [manifest] [options]
15
15
  *
16
16
  * Arguments:
17
17
  * [manifest] Manifest file to use for bundling (e.g., app.manifest.ts)
@@ -22,8 +22,8 @@ export declare const DEFAULT_ARCHIVE: "app-bundle.zip";
22
22
  * -d, --debug Enable debug mode for verbose logging
23
23
  *
24
24
  * Example:
25
- * $ fusion pack
26
- * $ fusion pack app.manifest.dev.ts --archive my-app.zip --output ./dist
25
+ * $ ffc app pack
26
+ * $ ffc app pack app.manifest.dev.ts --archive my-app.zip --output ./dist
27
27
  *
28
28
  * @see bundleApp for implementation details
29
29
  */
@@ -9,7 +9,7 @@
9
9
  * - Debug mode and authentication options are supported.
10
10
  *
11
11
  * Usage:
12
- * $ fusion publish [bundle] [options]
12
+ * $ ffc app publish [bundle] [options]
13
13
  *
14
14
  * Arguments:
15
15
  * [bundle] Path to the app bundle to upload
@@ -21,9 +21,9 @@
21
21
  * -t, --tag Tag to apply to the published app (latest | preview)
22
22
  *
23
23
  * Example:
24
- * $ fusion publish
25
- * $ fusion publish --env prod --manifest app.manifest.prod.ts
26
- * $ fusion publish --tag latest app.bundle.zip
24
+ * $ ffc app publish
25
+ * $ ffc app publish --env prod --manifest app.manifest.prod.ts
26
+ * $ ffc app publish --tag latest app.bundle.zip
27
27
  *
28
28
  * @see uploadApplication, tagApplication for implementation details
29
29
  */
@@ -5,27 +5,26 @@
5
5
  *
6
6
  * Features:
7
7
  * - Applies a tag to the specified application version for release management.
8
- * - App key and version can be provided or resolved from the manifest file.
8
+ * - Package name and version can be provided via --package or resolved from the manifest file.
9
9
  * - Supports environment selection, debug, and silent modes.
10
10
  *
11
11
  * Usage:
12
12
  * $ fusion tag <tag> [options]
13
13
  *
14
14
  * Arguments:
15
- * <tag> Tag to apply (latest | preview | stable)
15
+ * <tag> Tag to apply (latest | preview)
16
16
  *
17
17
  * Options:
18
- * --appKey <string> Application key (if not provided, resolved from manifest)
19
- * -v, --version <string> Version to tag (if not provided, resolved from manifest)
20
- * -m, --manifest <string> Manifest file to use for resolving app key and version
21
- * --debug Enable debug mode for verbose logging
22
- * --silent Silent mode, suppresses output except errors
23
- * -e, --env <env> Target environment
18
+ * -p, --package [package@version] Package to tag in format name@version (e.g., my-app@1.0.0). If not provided, loaded from manifest
19
+ * -m, --manifest <string> Manifest file to use (optional, defaults to app.manifest.ts)
20
+ * --debug Enable debug mode for verbose logging
21
+ * --silent Silent mode, suppresses output except errors
22
+ * -e, --env <env> Target environment
24
23
  *
25
24
  * Example:
26
- * $ fusion tag latest
27
- * $ fusion tag preview --env prod --manifest app.manifest.prod.ts
28
- * $ fusion tag stable --appKey my-app --version 1.2.3
25
+ * $ ffc app tag latest
26
+ * $ ffc app tag preview --env prod --manifest app.manifest.prod.ts
27
+ * $ ffc app tag latest --package my-app@1.2.3
29
28
  *
30
29
  * @see tagApplication for implementation details
31
30
  */
@@ -8,7 +8,7 @@
8
8
  * - Supports specifying application key, environment, and debug mode.
9
9
  *
10
10
  * Usage:
11
- * $ fusion upload [bundle] [options]
11
+ * $ ffc app upload [bundle] [options]
12
12
  *
13
13
  * Arguments:
14
14
  * [bundle] Application bundle to upload (default: app-bundle.zip)
@@ -19,9 +19,9 @@
19
19
  * -d, --debug Enable debug mode for verbose logging
20
20
  *
21
21
  * Example:
22
- * $ fusion upload
23
- * $ fusion upload my-app-bundle.zip --appKey my-app
24
- * $ fusion upload --debug
22
+ * $ ffc app upload
23
+ * $ ffc app upload my-app-bundle.zip --appKey my-app
24
+ * $ ffc app upload --debug
25
25
  *
26
26
  * @see uploadApplication for implementation details
27
27
  */
@@ -1,2 +1,16 @@
1
+ /**
2
+ * Command to authenticate and log in to Fusion Framework using interactive browser-based authentication.
3
+ *
4
+ * This command initializes the Fusion Framework and opens a browser window for secure login.
5
+ * Supports custom tenant, client, and scope options for advanced authentication scenarios.
6
+ *
7
+ * @remarks
8
+ * - Opens a browser for user authentication.
9
+ * - Stores authentication state for future CLI commands.
10
+ *
11
+ * @example
12
+ * $ ffc auth login
13
+ * $ ffc auth login --tenant my-tenant --client my-client-id --scope api://my-app/.default
14
+ */
1
15
  export declare const command: import("commander").Command;
2
16
  export default command;
@@ -1,8 +1,18 @@
1
1
  /**
2
- * Command to log out from Fusion Framework and clear your authentication session.
2
+ * CLI command: `logout`
3
3
  *
4
- * This command removes your current authentication state from the Fusion Framework CLI.
5
- * Supports custom tenant and client options for advanced scenarios.
4
+ * Logs out the user from the Fusion Framework CLI and clears the authentication session.
5
+ *
6
+ * This command removes the current authentication state, effectively signing the user out.
7
+ * Supports specifying a custom tenant and client for advanced logout scenarios.
8
+ *
9
+ * @remarks
10
+ * - Useful for invalidating local authentication and ensuring a fresh login on next use.
11
+ * - Does not revoke tokens server-side; only clears local session.
12
+ *
13
+ * @example
14
+ * $ ffc auth logout
15
+ * $ ffc auth logout --tenant my-tenant --client my-client-id
6
16
  */
7
17
  export declare const command: import("commander").Command;
8
18
  export default command;
@@ -1,8 +1,22 @@
1
1
  /**
2
- * Command to acquire and print an access token for Fusion APIs using your current authentication context.
2
+ * CLI command: `token`
3
+ *
4
+ * Acquires and prints an access token for Fusion APIs using your current authentication context.
3
5
  *
4
6
  * This command retrieves an access token for the specified scopes, tenant, and client.
5
7
  * Supports debug and silent modes for flexible output.
8
+ *
9
+ * @remarks
10
+ * - Supports specifying scopes, tenant, and client for advanced token acquisition.
11
+ * - Silent mode outputs only the token (no extra logging).
12
+ *
13
+ * @example
14
+ * $ ffc auth token
15
+ * $ export MY_TOKEN=$(ffc auth token --silent)
16
+ * $ ffc auth token --scope api://my-app/.default
17
+ * $ ffc auth token --tenant my-tenant --client my-client-id --silent
18
+ *
19
+ * @see acquireAccessToken for token acquisition implementation details
6
20
  */
7
21
  export declare const command: import("commander").Command;
8
22
  export default command;
@@ -1,2 +1,27 @@
1
+ /**
2
+ * CLI command: `build`
3
+ *
4
+ * Builds the Fusion portal using a manifest file and environment-specific configuration.
5
+ *
6
+ * Features:
7
+ * - If no manifest is provided, searches for a default `portal.manifest.[ts|js|json]` in the current directory.
8
+ * - Supports environment variables to customize the build process.
9
+ * - Provides a debug mode for verbose logging.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal build
13
+ * $ ffc portal build portal.manifest.prod.ts --debug
14
+ *
15
+ * Arguments:
16
+ * [manifest] Manifest file to use for building (e.g., portal.manifest.ts)
17
+ *
18
+ * Options:
19
+ * -d, --debug Enable debug mode for verbose logging (default: false)
20
+ *
21
+ * Example:
22
+ * $ ffc portal build portal.manifest.prod.ts --debug
23
+ *
24
+ * @see buildPortal for build implementation details
25
+ */
1
26
  export declare const command: import("commander").Command;
2
27
  export default command;
@@ -10,7 +10,7 @@
10
10
  * - Option [--env] cannot be set to dev when --publish is used.
11
11
  *
12
12
  * Usage:
13
- * $ fusion-framework-cli portal config --identifier <portal@version> [options]
13
+ * $ ffc portal config --identifier <portal@version> [options]
14
14
  *
15
15
  * Options:
16
16
  * --debug Enable debug mode for verbose logging
@@ -22,9 +22,9 @@
22
22
  * --env <env> Target environment
23
23
  *
24
24
  * Examples:
25
- * $ fusion-framework-cli portal config --identifier my-portal@1.2.3 -o stdout portal.config.ts
26
- * $ fusion-framework-cli portal config --identifier my-portal@1.2.3 -o ./dist/portal.config.json portal.config.prod.ts
27
- * $ fusion-framework-cli portal config --publish --env prod --identifier my-portal@1.2.3 portal.config.ts
25
+ * $ ffc portal config --identifier my-portal@1.2.3 -o stdout portal.config.ts
26
+ * $ ffc portal config --identifier my-portal@1.2.3 -o ./dist/portal.config.json portal.config.prod.ts
27
+ * $ ffc portal config --publish --env prod --identifier my-portal@1.2.3 portal.config.ts
28
28
  *
29
29
  * @see generatePortalConfig, publishPortalConfig for implementation details
30
30
  */
@@ -1,2 +1,27 @@
1
+ /**
2
+ * CLI command: `dev`
3
+ *
4
+ * Starts the portal in development mode with a local dev server.
5
+ *
6
+ * Features:
7
+ * - Launches the development server for your portal.
8
+ * - Supports custom runtime environment and port selection.
9
+ * - Debug mode available for verbose logging.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal dev [options]
13
+ *
14
+ * Options:
15
+ * --debug Enable debug mode
16
+ * --env <environment> Runtime environment for the dev server (default: local)
17
+ * --port <port> Port for the development server (default: 3000)
18
+ *
19
+ * Example:
20
+ * $ ffc portal dev
21
+ * $ ffc portal dev --port 4000
22
+ * $ ffc portal dev --debug
23
+ *
24
+ * @see startPortalDevServer for implementation details
25
+ */
1
26
  export declare const command: import("commander").Command;
2
27
  export default command;
@@ -1,2 +1,30 @@
1
+ /**
2
+ * CLI command: `portal manifest`
3
+ *
4
+ * Generates or validates a Fusion portal manifest file.
5
+ *
6
+ * Features:
7
+ * - Outputs the generated manifest to stdout or a file (use --output).
8
+ * - Falls back to a default manifest if no `portal.manifest(.$ENV)?.[ts|js|json]` is found.
9
+ * - Supports debug and silent modes for flexible output.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal manifest [manifest] [options]
13
+ *
14
+ * Arguments:
15
+ * [manifest] Manifest build file to use (e.g., portal.manifest[.env]?.[ts,js,json])
16
+ *
17
+ * Options:
18
+ * -d, --debug Enable debug mode for verbose logging
19
+ * -o, --output Write manifest to the specified file (default: stdout)
20
+ * -s, --silent Silent mode, suppresses output except errors
21
+ *
22
+ * Example:
23
+ * $ ffc portal manifest
24
+ * $ ffc portal manifest portal.manifest.prod.ts --output ./dist/portal.manifest.json
25
+ * $ ffc portal manifest --debug
26
+ *
27
+ * @see loadPortalManifest for implementation details
28
+ */
1
29
  export declare const command: import("commander").Command;
2
30
  export default command;
@@ -1,2 +1,26 @@
1
+ /**
2
+ * CLI command: `pack`
3
+ *
4
+ * Bundles the Fusion portal into a deployable archive.
5
+ *
6
+ * Features:
7
+ * - If no manifest is provided, a default portal.manifest(.$ENV)?.[ts|js|json] is used from the current directory.
8
+ * - Supports environment variables to customize the build process.
9
+ * - Provides a debug mode for verbose logging.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal pack [manifest] [options]
13
+ *
14
+ * Arguments:
15
+ * [manifest] Manifest file to use for bundling (e.g., portal.manifest.ts)
16
+ *
17
+ * Options:
18
+ * -d, --debug Enable debug mode for verbose logging (default: false)
19
+ *
20
+ * Example:
21
+ * $ ffc portal pack portal.manifest.prod.ts --debug
22
+ *
23
+ * @see bundlePortal for build implementation details
24
+ */
1
25
  export declare const command: import("commander").Command;
2
26
  export default command;
@@ -1,2 +1,31 @@
1
+ /**
2
+ * CLI command: `publish`
3
+ *
4
+ * Builds, uploads, and tags a Fusion portal bundle for deployment to the portal registry.
5
+ *
6
+ * Features:
7
+ * - Bundles the portal, uploads it to the Fusion portal registry, and applies a tag for versioning.
8
+ * - Supports specifying environment, manifest file, and tag.
9
+ * - Debug mode and authentication options are supported.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal publish [bundle] [options]
13
+ *
14
+ * Arguments:
15
+ * [bundle] Path to the portal bundle to upload
16
+ *
17
+ * Options:
18
+ * -d, --debug Enable debug mode for verbose logging
19
+ * -e, --env <env> Target environment
20
+ * -m, --manifest Manifest file to use for bundling
21
+ * -t, --tag Tag to apply to the published portal
22
+ *
23
+ * Example:
24
+ * $ ffc portal publish
25
+ * $ ffc portal publish --env prod --manifest portal.manifest.prod.ts
26
+ * $ ffc portal publish --tag latest app.bundle.zip
27
+ *
28
+ * @see uploadPortalBundle, tagPortal for implementation details
29
+ */
1
30
  export declare const command: import("commander").Command;
2
31
  export default command;
@@ -1,2 +1,29 @@
1
+ /**
2
+ * CLI command: `schema`
3
+ *
4
+ * Generates or validates a Fusion portal schema file.
5
+ *
6
+ * Features:
7
+ * - Supports environment variables to customize the schema generation.
8
+ * - Provides a debug mode for verbose logging.
9
+ *
10
+ * Usage:
11
+ * $ ffc portal schema [schema] [options]
12
+ *
13
+ * Arguments:
14
+ * [schema] Schema build file to use (e.g., portal.schema[.env]?.[ts,js,json])
15
+ *
16
+ * Options:
17
+ * -o, --output <string> Output file name (default: stdout)
18
+ * -d, --debug Enable debug mode for verbose logging
19
+ * -v, --validate <file> Validate the generated schema against a JSON file
20
+ *
21
+ * Example:
22
+ * $ ffc portal schema
23
+ * $ ffc portal schema --output portal.schema.json
24
+ * $ ffc portal schema --validate my-config.json
25
+ *
26
+ * @see loadPortalSchema for implementation details
27
+ */
1
28
  export declare const command: import("commander").Command;
2
29
  export default command;
@@ -1,2 +1,31 @@
1
+ /**
2
+ * CLI command: `tag`
3
+ *
4
+ * Tags a Fusion portal package with a specific version or label.
5
+ *
6
+ * Features:
7
+ * - Supports tagging a portal by package name/version or by reading from a manifest file.
8
+ * - Allows specifying the target environment.
9
+ * - Provides debug and silent modes for flexible output.
10
+ *
11
+ * Usage:
12
+ * $ ffc portal tag <tag> [options]
13
+ *
14
+ * Arguments:
15
+ * <tag> Tag to apply (e.g., latest, preview)
16
+ *
17
+ * Options:
18
+ * -m, --manifest <file> Manifest file to use (optional, defaults to portal.manifest.ts)
19
+ * -p, --package [pkg@ver] Package to tag in format name@version (e.g., my-portal@1.0.0)
20
+ * -d, --debug Enable debug mode for verbose logging
21
+ * --silent Silent mode, suppresses output except errors
22
+ * --env <env> Specify the environment (see available environments)
23
+ *
24
+ * Example:
25
+ * $ ffc portal tag latest --package my-portal@1.2.3 --env prod
26
+ * $ ffc portal tag preview --manifest ./portal.manifest.ts
27
+ *
28
+ * @see tagPortal for implementation details
29
+ */
1
30
  export declare const command: import("commander").Command;
2
31
  export default command;
@@ -1,2 +1,27 @@
1
+ /**
2
+ * CLI command: `upload`
3
+ *
4
+ * Uploads a Fusion portal bundle to the portal registry.
5
+ *
6
+ * Features:
7
+ * - Uploads a distributable portal bundle to the portal registry for deployment.
8
+ * - Supports specifying environment and debug mode.
9
+ *
10
+ * Usage:
11
+ * $ ffc portal upload [bundle] [options]
12
+ *
13
+ * Arguments:
14
+ * [bundle] Portal bundle to upload (e.g., out/bundle.zip)
15
+ *
16
+ * Options:
17
+ * -d, --debug Enable debug mode for verbose logging
18
+ * -e, --env <env> Target environment
19
+ *
20
+ * Example:
21
+ * $ ffc portal upload my-portal-bundle.zip
22
+ * $ ffc portal upload my-portal-bundle.zip --env prod
23
+ *
24
+ * @see uploadPortalBundle for implementation details
25
+ */
1
26
  export declare const command: import("commander").Command;
2
27
  export default command;
@@ -1,7 +1,23 @@
1
1
  import { type Command } from 'commander';
2
+ /**
3
+ * Option for specifying the Azure Active Directory tenant ID.
4
+ * Defaults to Equinor's Fusion tenant if not provided.
5
+ */
2
6
  export declare const tenantOption: import("commander").Option;
7
+ /**
8
+ * Option for specifying the Azure AD application client ID.
9
+ * Defaults to the Fusion CLI client if not provided.
10
+ */
3
11
  export declare const clientOption: import("commander").Option;
12
+ /**
13
+ * Option for providing an Azure AD access token directly.
14
+ * If set, tenant and client options are ignored.
15
+ */
4
16
  export declare const tokenOption: import("commander").Option;
17
+ /**
18
+ * Option for specifying Azure audience scopes.
19
+ * Defaults to Fusion API scope with /.default.
20
+ */
5
21
  export declare const scopeOption: import("commander").Option;
6
22
  /**
7
23
  * Enhances a given command with authentication-related options.
@@ -1 +1 @@
1
- export declare const version = "11.1.2";
1
+ export declare const version = "11.1.4";
@@ -512,8 +512,7 @@ The `tag` command applies a tag (such as `latest`, `preview`, or `stable`) to a
512
512
  | Argument/Option | Description | Default / Example |
513
513
  | ------------------------- | ------------------------------------------------------------------ | ----------------- |
514
514
  | `<tag>` | Tag to apply (`latest` \| `preview` \| `stable`). | |
515
- | `--appKey <string>` | Application key. If not provided, resolved from the manifest file. | |
516
- | `-v, --version <string>` | Version to tag. If not provided, resolved from the manifest file. | |
515
+ | `-p, --package` | Package to tag in format name@version. | |
517
516
  | `-m, --manifest <string>` | Manifest file to use for resolving app key and version. | `app.manifest.ts` |
518
517
  | `--debug` | Enable debug mode for verbose logging. | `false` |
519
518
  | `--silent` | Silent mode, suppresses output except errors. | `false` |
@@ -531,13 +530,13 @@ pnpm fusion-framework-cli app tag <tag> [options]
531
530
  ```sh
532
531
  pnpm fusion-framework-cli app tag latest
533
532
  pnpm fusion-framework-cli app tag preview --env prod --manifest app.manifest.prod.ts
534
- pnpm fusion-framework-cli app tag latest --appKey my-app --version 1.2.3
533
+ pnpm fusion-framework-cli app tag latest --package my-app@1.2.3
535
534
  ```
536
535
 
537
536
  > [!TIP] You can roll back a release by tagging a previous build as `latest`. Simply run the tag command with the desired version to make it the active release for deployment.
538
537
 
539
538
  > [!NOTE]
540
- > - The `tag` command requires a published application version. You can specify the app key and version directly, or let the CLI resolve them from your manifest file.
539
+ > - The `tag` command requires a published application version. You can specify the package name and version using `--package`, or let the CLI resolve them from your manifest file.
541
540
  > - Supported tags are: `latest` and `preview`.
542
541
  > - Authentication options (`--token`, `--tenantId`, `--clientId`) can be set via CLI flags or environment variables.
543
542
  > - If tagging fails, an error will be logged and the process will exit with a non-zero code.
@@ -576,7 +575,7 @@ Checks if your application is registered in the Fusion app store and helps ident
576
575
  | Option/Argument | Description | Default / Example |
577
576
  | --------------------- | ----------------------------------------------------- | ----------------- |
578
577
  | `-d`, `--debug` | Enable debug mode for verbose logging. | `false` |
579
- | `--environment <env>` | Specify the environment (see available environments). | |
578
+ | `-e`, `--env <env>` | Specify the environment (see available environments). | |
580
579
  | `--token <token>` | Provide an authentication token (if required). | |
581
580
 
582
581
  **Usage:**
@@ -587,7 +586,7 @@ pnpm fusion-framework-cli app check [options]
587
586
  **Examples:**
588
587
  ```sh
589
588
  pnpm fusion-framework-cli app check
590
- pnpm fusion-framework-cli app check --environment prod --debug
589
+ pnpm fusion-framework-cli app check --env prod --debug
591
590
  ```
592
591
 
593
592
  > [!NOTE]