@ 适应worx/iac- schemas
每个提供者的区域代码和名称以及标准标记键,用于 适应WorXTM 流 (原始内容存档于2019-09-31) (英语). staff-as-code.
这个软件包是 纯数据+类型 ——零运行时间依赖. 这是全区域解析真相的来源 @adaptiveworx/iac-* 包并安全地从任何 TypeScript 项目导入.
安装
pnpm add @adaptiveworx/iac-schemas
# or
yarn add @adaptiveworx/iac-schemas
# or
npm install @adaptiveworx/iac-schemas
使用量
区域决议
import { regions } from "@adaptiveworx/iac-schemas";
// AWS region aliases
regions.aws.aliases.use1; // "us-east-1"
regions.aws.aliases.usw2; // "us-west-2"
// Azure region aliases
regions.azure.aliases.eus2; // "eastus2"
// Available canonical regions per provider
regions.aws.regions; // ["us-east-1", "us-west-2", ...]
// Cloudflare (no regions): the single code glb
regions.cloudflare.aliases.glb; // "global"
输入的区域数据
import { AWS_REGION_CODES, AWS_REGION_NAMES, REGIONS } from "@adaptiveworx/iac-schemas";
import type { AwsRegionCode, AwsRegionName } from "@adaptiveworx/iac-schemas";
REGIONS.aws.aliases.use1; // "us-east-1", typed as the literal
const code: AwsRegionCode = "usw2";
REGIONS (单位:千美元)src/regions.ts)是区域数据的唯一来源;iac-core
来源 AwsRegion 财务报告和审定财务报表 AwsRegionSchema 从它. config/regions.json 实值
与JSON相同的数据,通过单位测试保持等值.
标准标签密钥
import { STANDARD_TAG_KEYS } from "@adaptiveworx/iac-schemas";
// Environment, Tenant, AccountPurpose, StackPurpose, TargetEnvironment,
// Workload, ManagedBy, Description
Workload 命名资源属于( ) 的工作量flow, (中文(简体) ), ztna; ; ; ; ;
shared 共享基础设施。 权限边界和 ABAC
其进入范围.
直接导入 JSON
对于更喜欢生JSON的工具(如JSON Schema验证器,建造管道):
import regions from "@adaptiveworx/iac-schemas/regions" with { type: "json" };
什么样的船
| 路径 | 目录 |
|---|---|
dist/index.js + 键 dist/index.d.ts | 图书馆条目 : regions, (中文(简体) ), REGIONS,AWS区域代码/名称清单和类型, STANDARD_TAG_KEYS |
config/regions.json | 区域别名数据(也可通过 ./regions 子路径) |
预生成的 JSON Schemas / OpenAPI / types.d.ts 下级 generated/
在0.2中被清除:没有东西消耗他们,他们已变成僵尸。 为了JSON
石马,用Zod 4's z.toJSONSchema() 直接在iac -core的计画.
稳定
这是一个 0.x 释放。 形状 regions.* 可能改变前向后兼容的方式 1.0一次 1.0 船,包裹会跟着 语义版本。 。 。 .
区域别名( N)use1, (中文(简体) ), usw2等)被认为是稳定的标识符,不会被更名;可能添加新的标识符.
许可证
Apache 2.0 (英语)。见 通知。 。 。 .
仓库+捐款
此软件包是在 适应性WorX/iac-worx 单重键 : libs/iac/schemas/。见 捐款额 工作流程惯例和发布程序。 文件问题 https://github.com/AdaptiveWorX/iac-worx/issues (英语)。 。 。 .