@myapihq/sdk 1.2.1 → 1.2.2

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 (4) hide show
  1. package/dist/domain.d.ts +25 -0
  2. package/dist/domain.js +26 -0
  3. package/package.json +1 -1
  4. package/src/domain.ts +55 -0
package/dist/domain.d.ts CHANGED
@@ -59,6 +59,31 @@ export declare function getDomainStatus(apiKey: string, orgId: string, domain: s
59
59
  export declare function assignDomain(apiKey: string, orgId: string, domain: string): Promise<DomainRecord>;
60
60
  export declare function unassignDomain(apiKey: string, orgId: string, domain: string): Promise<DomainRecord>;
61
61
  export declare function getDomainSettings(apiKey: string, orgId: string, domain: string): Promise<DomainSettings>;
62
+ export type DnsRecordType = 'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT';
63
+ export interface DnsRecord {
64
+ id: string;
65
+ type: DnsRecordType;
66
+ name: string;
67
+ content: string;
68
+ ttl: number;
69
+ priority: number | null;
70
+ proxied: boolean | null;
71
+ created_on: string;
72
+ modified_on: string;
73
+ }
74
+ export interface DnsRecordInput {
75
+ type: DnsRecordType;
76
+ name: string;
77
+ content: string;
78
+ ttl?: number;
79
+ priority?: number;
80
+ proxied?: boolean;
81
+ }
82
+ export declare function listDnsRecords(apiKey: string, orgId: string, domain: string, type?: DnsRecordType): Promise<DnsRecord[]>;
83
+ export declare function getDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string): Promise<DnsRecord>;
84
+ export declare function createDnsRecord(apiKey: string, orgId: string, domain: string, input: DnsRecordInput): Promise<DnsRecord>;
85
+ export declare function updateDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string, input: Partial<Omit<DnsRecordInput, 'type'>>): Promise<DnsRecord>;
86
+ export declare function deleteDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string): Promise<void>;
62
87
  export declare function updateDomainSettings(apiKey: string, orgId: string, domain: string, payload: {
63
88
  security_level?: 'essentially_off' | 'medium' | 'high' | 'under_attack';
64
89
  browser_check?: 'on' | 'off';
package/dist/domain.js CHANGED
@@ -10,6 +10,11 @@ exports.getDomainStatus = getDomainStatus;
10
10
  exports.assignDomain = assignDomain;
11
11
  exports.unassignDomain = unassignDomain;
12
12
  exports.getDomainSettings = getDomainSettings;
13
+ exports.listDnsRecords = listDnsRecords;
14
+ exports.getDnsRecord = getDnsRecord;
15
+ exports.createDnsRecord = createDnsRecord;
16
+ exports.updateDnsRecord = updateDnsRecord;
17
+ exports.deleteDnsRecord = deleteDnsRecord;
13
18
  exports.updateDomainSettings = updateDomainSettings;
14
19
  const client_1 = require("./client");
15
20
  const config_1 = require("./config");
@@ -23,6 +28,11 @@ exports.EXPOSES = [
23
28
  'GET /domain/orgs/{org_id}/{domain}/settings',
24
29
  'POST /domain/orgs/{org_id}/{domain}/settings',
25
30
  'GET /domain/orgs/{org_id}/{domain}/status',
31
+ 'GET /domain/orgs/{org_id}/{domain}/records',
32
+ 'GET /domain/orgs/{org_id}/{domain}/records/{record_id}',
33
+ 'POST /domain/orgs/{org_id}/{domain}/records',
34
+ 'PATCH /domain/orgs/{org_id}/{domain}/records/{record_id}',
35
+ 'DELETE /domain/orgs/{org_id}/{domain}/records/{record_id}',
26
36
  ];
27
37
  async function checkDomain(apiKey, orgId, domain) {
28
38
  return (0, client_1.request)('GET', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/check/available/${encodeURIComponent(domain)}`, apiKey);
@@ -56,6 +66,22 @@ async function unassignDomain(apiKey, orgId, domain) {
56
66
  async function getDomainSettings(apiKey, orgId, domain) {
57
67
  return (0, client_1.request)('GET', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/settings`, apiKey);
58
68
  }
69
+ async function listDnsRecords(apiKey, orgId, domain, type) {
70
+ const query = type ? `?type=${encodeURIComponent(type)}` : '';
71
+ return (0, client_1.request)('GET', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records${query}`, apiKey);
72
+ }
73
+ async function getDnsRecord(apiKey, orgId, domain, recordId) {
74
+ return (0, client_1.request)('GET', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey);
75
+ }
76
+ async function createDnsRecord(apiKey, orgId, domain, input) {
77
+ return (0, client_1.request)('POST', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records`, apiKey, input);
78
+ }
79
+ async function updateDnsRecord(apiKey, orgId, domain, recordId, input) {
80
+ return (0, client_1.request)('PATCH', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey, input);
81
+ }
82
+ async function deleteDnsRecord(apiKey, orgId, domain, recordId) {
83
+ return (0, client_1.request)('DELETE', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey);
84
+ }
59
85
  async function updateDomainSettings(apiKey, orgId, domain, payload) {
60
86
  return (0, client_1.request)('POST', `${config_1.DOMAIN_BASE}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/settings`, apiKey, payload);
61
87
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@myapihq/sdk",
3
3
  "license": "Apache-2.0",
4
- "version": "1.2.1",
4
+ "version": "1.2.2",
5
5
  "description": "TypeScript SDK for the MyAPI ecosystem",
6
6
  "main": "dist/index.js",
7
7
  "types": "dist/index.d.ts",
package/src/domain.ts CHANGED
@@ -12,6 +12,11 @@ export const EXPOSES: Exposes = [
12
12
  'GET /domain/orgs/{org_id}/{domain}/settings',
13
13
  'POST /domain/orgs/{org_id}/{domain}/settings',
14
14
  'GET /domain/orgs/{org_id}/{domain}/status',
15
+ 'GET /domain/orgs/{org_id}/{domain}/records',
16
+ 'GET /domain/orgs/{org_id}/{domain}/records/{record_id}',
17
+ 'POST /domain/orgs/{org_id}/{domain}/records',
18
+ 'PATCH /domain/orgs/{org_id}/{domain}/records/{record_id}',
19
+ 'DELETE /domain/orgs/{org_id}/{domain}/records/{record_id}',
15
20
  ];
16
21
 
17
22
 
@@ -117,6 +122,56 @@ export async function getDomainSettings(apiKey: string, orgId: string, domain: s
117
122
  return request('GET', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/settings`, apiKey);
118
123
  }
119
124
 
125
+ // ── DNS records ──────────────────────────────────────────────────────────────
126
+ // Per-zone CRUD on the Cloudflare zone the backend manages for this domain.
127
+ // v1 supports A / AAAA / CNAME / MX / TXT. `priority` is non-null only for MX,
128
+ // `proxied` is non-null only for A/AAAA/CNAME. `ttl: 1` is CF's "automatic"
129
+ // sentinel.
130
+
131
+ export type DnsRecordType = 'A' | 'AAAA' | 'CNAME' | 'MX' | 'TXT';
132
+
133
+ export interface DnsRecord {
134
+ id: string;
135
+ type: DnsRecordType;
136
+ name: string; // FQDN as stored by CF
137
+ content: string;
138
+ ttl: number;
139
+ priority: number | null;
140
+ proxied: boolean | null;
141
+ created_on: string;
142
+ modified_on: string;
143
+ }
144
+
145
+ export interface DnsRecordInput {
146
+ type: DnsRecordType;
147
+ name: string; // Accepts FQDN, host-only, or apex tokens (`@`, `""`).
148
+ content: string;
149
+ ttl?: number; // Default 1 (CF auto). Range [60, 86400] otherwise.
150
+ priority?: number; // Required for MX.
151
+ proxied?: boolean; // A/AAAA/CNAME only. Defaults false.
152
+ }
153
+
154
+ export async function listDnsRecords(apiKey: string, orgId: string, domain: string, type?: DnsRecordType): Promise<DnsRecord[]> {
155
+ const query = type ? `?type=${encodeURIComponent(type)}` : '';
156
+ return request('GET', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records${query}`, apiKey);
157
+ }
158
+
159
+ export async function getDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string): Promise<DnsRecord> {
160
+ return request('GET', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey);
161
+ }
162
+
163
+ export async function createDnsRecord(apiKey: string, orgId: string, domain: string, input: DnsRecordInput): Promise<DnsRecord> {
164
+ return request('POST', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records`, apiKey, input);
165
+ }
166
+
167
+ export async function updateDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string, input: Partial<Omit<DnsRecordInput, 'type'>>): Promise<DnsRecord> {
168
+ return request('PATCH', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey, input);
169
+ }
170
+
171
+ export async function deleteDnsRecord(apiKey: string, orgId: string, domain: string, recordId: string): Promise<void> {
172
+ return request('DELETE', `${BASE_URL}/domain/orgs/${encodeURIComponent(orgId)}/${encodeURIComponent(domain)}/records/${encodeURIComponent(recordId)}`, apiKey);
173
+ }
174
+
120
175
  export async function updateDomainSettings(apiKey: string, orgId: string, domain: string, payload: {
121
176
  security_level?: 'essentially_off' | 'medium' | 'high' | 'under_attack';
122
177
  browser_check?: 'on' | 'off';