Axway CLI 用户
Axway CLI 和相关软件包常用的 utils 库.
安装
npm i @axway/amplify-cli-utils --save
API 密码
buildAuthParams(opts, config)
基于所供应的 Amplify SDK 或 Amplify SDK Auth 构造器选项对象 opts
和 Axway CLI 数据 config 对象。 若为 config 未定义,配置是从磁盘上加载的.
import { buildAuthParams } from '@axway/amplify-cli-utils';
const opts = buildAuthParams({
baseUrl: 'foo',
clientId: 'bar'
});
createNPMRequestArgs(opts, config)
如果你正在产卵 npm,则以下内容可能有用:
import { createNPMRequestArgs } from '@axway/amplify-cli-utils';
import { spawnSync } from 'child_process';
spawnSync('npm', [ 'view', 'axway', ...createNPMRequestArgs() ]);
createRequestClient(opts, config)
创建一个 got 配置 Axway CLI 网络设置的 HTTP 客户端 .
import { createRequestClient } from '@axway/amplify-cli-utils';
const got = createRequestClient();
const response = await got('https://www.axway.com/');
createRequestOptions(opts, config)
装入 Axway 的 CLI 配置文件并构建各种节点.js HTTP 客户端的选项
包括 pacote, (中文(简体) ), npm-registry-fetch, (中文(简体) ), make-fetch-happen,以及 request。 。 。 .
import { createRequestOptions } from '@axway/amplify-cli-utils';
const opts = createRequestOptions();
console.log({
ca: opts.ca,
cert: opts.cert,
key: opts.key,
proxy: opts.proxy,
strictSSL: opts.strictSSL
});
createTable(heading1, heading2, heading3, ...)
创建一个 cli-table3 使用普通桌垫和样式.
import { createTable } from '@axway/amplify-cli-utils';
const table = createTable('Name', 'Version');
table.push([ 'foo', '1.0.0' ]);
table.push([ 'bar', '2.0.0' ]);
console.log(table.toString());
environments.resolve(env)
返回环境特定设置.
import { environments } from '@axway/amplify-cli-utils';
console.log(environments.resolve());
console.log(environments.resolve('prod'));
console.log(environments.resolve('production'));
locations
包含 axwayHome 财务报告和审定财务报表 configFile 路径.
import { locations } from '@axway/amplify-cli-utils';
console.log('Axway Home Directory:', locations.axwayHome);
console.log('Axway CLI Config Path:', locations.configFile);
initSDK(opts, config)
装入 Axway CLI 配置并初始化一个 Amplify SDK 实例 .
需要时获取默认账户或登录 :
import { initSDK } from '@axway/amplify-cli-utils';
async function getAccount(opts) {
try {
return await initSDK(opts).sdk.auth.login();
} catch (err) {
if (err.code === 'EAUTHENTICATED') {
return err.account;
}
throw err;
}
}
(async () => {
const account = await getAccount({ clientId: 'foo' });
if (!account) {
console.error('Please login in by running: amplify auth login');
process.exit(1);
}
}());
通过登录参数查找账户
import { initSDK } from '@axway/amplify-cli-utils';
(async () => {
const { sdk, config } = initSDK({
baseUrl: '',
clientId: '',
clientSecret: '',
env: '',
password: '',
realm: '',
secretFile: '',
username: ''
});
const account = await sdk.auth.find('foo');
if (account && !account.expired) {
console.log('Found a valid access token!');
console.log(account);
return;
}
console.error('No valid authentication token found. Please login in again by running:');
console.error(' amplify auth login');
process.exit(1);
}());
通过 id 查找账户
const accountName = '<client_id>:<email_address>';
const account = await sdk.auth.getAccount(accountName);
获取所有认证账户
const accounts = await sdk.auth.list();
console.log(accounts);
loadConfig()
使用懒惰装入的 Amplify 配置包装入 Axway CLI 配置文件.
import { loadConfig } from '@axway/amplify-cli-utils';
const config = loadConfig();
console.log(config);
遥测
如果您想要在 Axway CLI 扩展名中添加遥测功能, 您需要创建一个应用程序 用于生成 app guid 的平台。 然后需要复制并粘贴以下锅炉板. API的设计是灵活的,其代价是做更多的工作来整合.
import {
createRequestOptions,
environments,
loadConfig,
locations,
Telemetry
} from '@axway/amplify-cli-utils';
const appGuid = '<GUID>';
const appVersion = 'x.y.z';
const telemetryCacheDir = path.join(locations.axwayHome, '<PRODUCT_NAME>', 'telemetry');
function initTelemetry(opts = {}) {
const config = opts.config || loadConfig();
if (!config.get('telemetry.enabled')) {
return;
}
const env = environments.resolve(opts.env || config.get('env'));
const telemetryInst = new Telemetry({
appGuid,
appVersion,
cacheDir,
environment: env === 'preprod' ? 'preproduction' : 'production',
requestOptions: createRequestOptions(opts, config)
});
process.on('exit', () => {
try {
telemetryInst.send();
} catch (err) {
warn(err);
}
});
return telemetryInst;
}
const telemetry = initTelemetry();
telemetry.addEvent({
event: 'my.event',
some: 'data'
});
从1.x版本升级
在v2,整个 auth API被移除是为了利用新的Amplified SDK,它现在
包含认证 API.
// Find account by login parameters
// v1
import { auth } from '@axway/amplify-cli-utils';
const { account, client, config } = await auth.getAccount({ /* auth options */ });
// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const account = await sdk.auth.find();
// Find account by id
// v1
import { auth } from '@axway/amplify-cli-utils';
const { account, client, config } = await auth.getAccount('<CLIENT_ID>:<EMAIL>');
// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const account = await sdk.auth.find('<CLIENT_ID>:<EMAIL>');
// Get all credentialed accounts
// v1
import { auth } from '@axway/amplify-cli-utils';
const accounts = await auth.list();
// v2
import { initSDK } from '@axway/amplify-cli-utils';
const { config, sdk } = initSDK({ /* auth options */ });
const accounts = await sdk.auth.list();
法律
此工程在 : Apache 公共许可证 v2 开发者
阿克斯韦公司 与社区。 请读一下 LICENSE 包含文件
在此分发更多信息.