@namefi/api-client 0.0.0-pre.2 → 0.0.0-pre.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 (17) hide show
  1. package/README.md +3 -3
  2. package/dist/index.cjs +3 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +556 -0
  5. package/dist/index.d.ts +556 -0
  6. package/dist/index.js +3 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +4 -1
  9. package/contract.json +0 -449
  10. package/package.build.json +0 -36
  11. package/package.publish.json +0 -24
  12. package/scripts/minify-contract.ts +0 -7
  13. package/src/index.ts +0 -79
  14. package/switch-config-copy.sh +0 -67
  15. package/switch-config.sh +0 -71
  16. package/tsconfig.json +0 -17
  17. package/tsup.config.ts +0 -39
package/dist/index.d.cts ADDED
@@ -0,0 +1,556 @@
1
+ import * as _orpc_client from '@orpc/client';
2
+ import * as zod from 'zod';
3
+
4
+ type CreateNamefiClientOptions = {
5
+ authentication: {
6
+ apiKey: string;
7
+ type: 'API_KEY';
8
+ };
9
+ logger: {
10
+ info: (...args: any[]) => void;
11
+ error: (...args: any[]) => void;
12
+ } | boolean | undefined;
13
+ baseUrl?: string;
14
+ };
15
+ declare function createNamefiClient({ authentication, logger, baseUrl, }: CreateNamefiClientOptions): {
16
+ dnsRecords: {
17
+ getRecords: _orpc_client.Client<Record<never, never>, {
18
+ zoneName: string;
19
+ }, {
20
+ createdAt: string;
21
+ updatedAt: string;
22
+ zoneName: string & zod.$brand<"NamefiNormalizedDomain">;
23
+ name: string;
24
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
25
+ class: string;
26
+ ttl: number;
27
+ rdata: string;
28
+ metadata: any;
29
+ id: string;
30
+ }[], Error>;
31
+ createDnsRecord: _orpc_client.Client<Record<never, never>, {
32
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
33
+ zoneName: string;
34
+ rdata: string;
35
+ name?: string | undefined;
36
+ ttl?: number | undefined;
37
+ }, {
38
+ createdAt: string;
39
+ updatedAt: string;
40
+ zoneName: string & zod.$brand<"NamefiNormalizedDomain">;
41
+ name: string;
42
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
43
+ class: string;
44
+ ttl: number;
45
+ rdata: string;
46
+ metadata: any;
47
+ id: string;
48
+ }, Error>;
49
+ updateRecord: _orpc_client.Client<Record<never, never>, {
50
+ id: string;
51
+ zoneName: string;
52
+ type?: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF" | undefined;
53
+ name?: string | undefined;
54
+ rdata?: string | undefined;
55
+ ttl?: number | undefined;
56
+ }, {
57
+ createdAt: string;
58
+ updatedAt: string;
59
+ zoneName: string & zod.$brand<"NamefiNormalizedDomain">;
60
+ name: string;
61
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
62
+ class: string;
63
+ ttl: number;
64
+ rdata: string;
65
+ metadata: any;
66
+ id: string;
67
+ }, Error>;
68
+ deleteRecord: _orpc_client.Client<Record<never, never>, {
69
+ id: string;
70
+ zoneName: string;
71
+ }, {
72
+ success: boolean;
73
+ }, Error>;
74
+ updateRecords: _orpc_client.Client<Record<never, never>, {
75
+ records: {
76
+ id: string;
77
+ name?: string | undefined;
78
+ type?: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF" | undefined;
79
+ ttl?: number | undefined;
80
+ rdata?: string | undefined;
81
+ }[];
82
+ zoneName: string;
83
+ }, {
84
+ createdAt: string;
85
+ updatedAt: string;
86
+ zoneName: string & zod.$brand<"NamefiNormalizedDomain">;
87
+ name: string;
88
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
89
+ class: string;
90
+ ttl: number;
91
+ rdata: string;
92
+ metadata: any;
93
+ id: string;
94
+ }[], Error>;
95
+ createRecords: _orpc_client.Client<Record<never, never>, {
96
+ records: ({
97
+ name: string;
98
+ ttl: number;
99
+ type: "A";
100
+ rdata: string;
101
+ } | {
102
+ name: string;
103
+ ttl: number;
104
+ type: "AAAA";
105
+ rdata: string;
106
+ } | {
107
+ name: string;
108
+ ttl: number;
109
+ type: "CNAME";
110
+ rdata: string;
111
+ } | {
112
+ name: string;
113
+ ttl: number;
114
+ type: "MX";
115
+ rdata: string;
116
+ } | {
117
+ name: string;
118
+ ttl: number;
119
+ type: "TXT";
120
+ rdata: string;
121
+ } | {
122
+ name: string;
123
+ ttl: number;
124
+ type: "NS";
125
+ rdata: string;
126
+ } | {
127
+ name: string;
128
+ ttl: number;
129
+ type: "SOA";
130
+ rdata: string;
131
+ } | {
132
+ name: string;
133
+ ttl: number;
134
+ type: "PTR";
135
+ rdata: string;
136
+ } | {
137
+ name: string;
138
+ ttl: number;
139
+ type: "SRV";
140
+ rdata: string;
141
+ } | {
142
+ name: string;
143
+ ttl: number;
144
+ type: "CAA";
145
+ rdata: string;
146
+ } | {
147
+ name: string;
148
+ ttl: number;
149
+ type: "DS";
150
+ rdata: string;
151
+ } | {
152
+ name: string;
153
+ ttl: number;
154
+ type: "TLSA";
155
+ rdata: string;
156
+ } | {
157
+ name: string;
158
+ ttl: number;
159
+ type: "SSHFP";
160
+ rdata: string;
161
+ } | {
162
+ name: string;
163
+ ttl: number;
164
+ type: "HTTPS";
165
+ rdata: string;
166
+ } | {
167
+ name: string;
168
+ ttl: number;
169
+ type: "SVCB";
170
+ rdata: string;
171
+ } | {
172
+ name: string;
173
+ ttl: number;
174
+ type: "NAPTR";
175
+ rdata: string;
176
+ } | {
177
+ name: string;
178
+ ttl: number;
179
+ type: "SPF";
180
+ rdata: string;
181
+ })[];
182
+ zoneName: string;
183
+ }, {
184
+ createdAt: string;
185
+ updatedAt: string;
186
+ zoneName: string & zod.$brand<"NamefiNormalizedDomain">;
187
+ name: string;
188
+ type: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS" | "SOA" | "PTR" | "SRV" | "CAA" | "DS" | "TLSA" | "SSHFP" | "HTTPS" | "SVCB" | "NAPTR" | "SPF";
189
+ class: string;
190
+ ttl: number;
191
+ rdata: string;
192
+ metadata: any;
193
+ id: string;
194
+ }[], Error>;
195
+ deleteRecords: _orpc_client.Client<Record<never, never>, {
196
+ recordsIds: string[];
197
+ zoneName: string;
198
+ }, {
199
+ success: boolean;
200
+ }, Error>;
201
+ parkDomain: _orpc_client.Client<Record<never, never>, {
202
+ normalizedDomainName: string;
203
+ overrideExistingRecords?: boolean | undefined;
204
+ }, {
205
+ success: boolean;
206
+ }, Error>;
207
+ isDomainParked: _orpc_client.Client<Record<never, never>, {
208
+ normalizedDomainName: string;
209
+ }, boolean, Error>;
210
+ };
211
+ user: {
212
+ getDomains: _orpc_client.Client<Record<never, never>, void, {
213
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
214
+ chainId: number;
215
+ ownerAddress: string;
216
+ tokenId: string;
217
+ expirationDate: string | null;
218
+ dnsStatus: {
219
+ nameservers: string[];
220
+ isUsingNamefiNameservers: boolean;
221
+ isParkingEnabled: boolean;
222
+ forwardTo: string | null;
223
+ hasWebRecords: boolean;
224
+ hasMxRecords: boolean;
225
+ ensRecord: string | null;
226
+ };
227
+ }[], Error>;
228
+ getUserCart: _orpc_client.Client<Record<never, never>, void, {
229
+ id: string;
230
+ userId: string;
231
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
232
+ amountInUSDCents: number;
233
+ durationInYears: number;
234
+ type: "REGISTER" | "IMPORT" | "RENEW";
235
+ registrar: string;
236
+ encryptionKeyId: string | null;
237
+ encryptedEppAuthorizationCode: string | null;
238
+ createdAt: string;
239
+ updatedAt: string;
240
+ claims: {
241
+ groupOrCampaignKey: string;
242
+ claimsAvailable: number;
243
+ exactMatchClaims: {
244
+ createdAt: string;
245
+ updatedAt: string;
246
+ userId: string;
247
+ groupOrCampaignKey: string;
248
+ reason: string | null;
249
+ expirationDate: string | null;
250
+ orderItemId: string | null;
251
+ claimingStatus: "IDLE" | "CLAIMING" | "CLAIMED";
252
+ claimedAt: string | null;
253
+ metadata: any;
254
+ id: string;
255
+ exactDomainName?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
256
+ parentDomain?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
257
+ claimedDomainName?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
258
+ }[];
259
+ parentMatchClaims: {
260
+ createdAt: string;
261
+ updatedAt: string;
262
+ userId: string;
263
+ groupOrCampaignKey: string;
264
+ reason: string | null;
265
+ expirationDate: string | null;
266
+ orderItemId: string | null;
267
+ claimingStatus: "IDLE" | "CLAIMING" | "CLAIMED";
268
+ claimedAt: string | null;
269
+ metadata: any;
270
+ id: string;
271
+ exactDomainName?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
272
+ parentDomain?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
273
+ claimedDomainName?: (string & zod.$brand<"NamefiNormalizedDomain">) | null | undefined;
274
+ }[];
275
+ }[];
276
+ metadata?: {
277
+ [x: string]: unknown;
278
+ freeClaim?: boolean | undefined;
279
+ groupOrCampaignKey?: string | undefined;
280
+ claimId?: string | undefined;
281
+ } | null | undefined;
282
+ }[], Error>;
283
+ getUserOrders: _orpc_client.Client<Record<never, never>, void, {
284
+ id: string;
285
+ orderId: string;
286
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
287
+ amountInUSDCents: number;
288
+ durationInYears: number;
289
+ type: "REGISTER" | "IMPORT" | "RENEW";
290
+ registrar: string;
291
+ encryptionKeyId: string | null;
292
+ encryptedEppAuthorizationCode: string | null;
293
+ status: "PARTIALLY_COMPLETED" | "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | null;
294
+ createdAt: string;
295
+ updatedAt: string;
296
+ metadata?: {
297
+ [x: string]: unknown;
298
+ freeClaim?: boolean | undefined;
299
+ groupOrCampaignKey?: string | undefined;
300
+ claimId?: string | undefined;
301
+ mintTransaction?: {
302
+ txHash: string;
303
+ recordedAt: string;
304
+ } | undefined;
305
+ } | null | undefined;
306
+ }[], Error>;
307
+ };
308
+ orders: {
309
+ getOrder: _orpc_client.Client<Record<never, never>, {
310
+ orderId: string;
311
+ }, {
312
+ order: {
313
+ createdAt: string;
314
+ updatedAt: string;
315
+ nftWalletAddress: string | null;
316
+ nftChainId: number | null;
317
+ amountInUSDCents: number;
318
+ userId: string;
319
+ status: "PARTIALLY_COMPLETED" | "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED";
320
+ id: string;
321
+ metadata?: {
322
+ [x: string]: unknown;
323
+ mintTransactions?: {
324
+ [x: string]: {
325
+ txHash: string;
326
+ recordedAt: string;
327
+ };
328
+ } | undefined;
329
+ freeClaim?: boolean | undefined;
330
+ groupOrCampaignKey?: string | undefined;
331
+ claimId?: string | undefined;
332
+ } | null | undefined;
333
+ };
334
+ items: {
335
+ createdAt: string;
336
+ updatedAt: string;
337
+ durationInYears: number;
338
+ type: "REGISTER" | "IMPORT" | "RENEW";
339
+ registrar: string;
340
+ encryptionKeyId: string | null;
341
+ encryptedEppAuthorizationCode: string | null;
342
+ status: "PARTIALLY_COMPLETED" | "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | null;
343
+ amountInUSDCents: number;
344
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
345
+ orderId: string;
346
+ id: string;
347
+ metadata?: {
348
+ [x: string]: unknown;
349
+ freeClaim?: boolean | undefined;
350
+ groupOrCampaignKey?: string | undefined;
351
+ claimId?: string | undefined;
352
+ mintTransaction?: {
353
+ txHash: string;
354
+ recordedAt: string;
355
+ } | undefined;
356
+ } | null | undefined;
357
+ }[];
358
+ payments: {
359
+ createdAt: string;
360
+ updatedAt: string;
361
+ status: "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | "REFUND_REQUESTED" | "REQUIRES_CAPTURE";
362
+ paymentProvider: "NFSC_BASE" | "NFSC_ETHEREUM" | "NFSC_ETHEREUM_SEPOLIA" | "STRIPE";
363
+ paymentProviderReferenceId: string | null;
364
+ orderId: string | null;
365
+ nfscPaymentDetails: {
366
+ chainId: number;
367
+ walletAddress: string;
368
+ } | null;
369
+ stripePaymentDetails: {
370
+ paymentMethodId?: string | undefined;
371
+ } | null;
372
+ amountInUSDCents: number;
373
+ id: string;
374
+ }[];
375
+ user: {
376
+ createdAt: string;
377
+ updatedAt: string;
378
+ primaryEmail: string | null;
379
+ stripeCustomerId: string | null;
380
+ privyUserId: string;
381
+ subscribeToEmails: boolean;
382
+ lastSignInAt: string | null;
383
+ lastAccessedSessionAt: string | null;
384
+ id: string;
385
+ };
386
+ }, Error>;
387
+ getOrderItems: _orpc_client.Client<Record<never, never>, void, {
388
+ createdAt: string;
389
+ updatedAt: string;
390
+ durationInYears: number;
391
+ type: "REGISTER" | "IMPORT" | "RENEW";
392
+ registrar: string;
393
+ encryptionKeyId: string | null;
394
+ encryptedEppAuthorizationCode: string | null;
395
+ status: "PARTIALLY_COMPLETED" | "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | null;
396
+ amountInUSDCents: number;
397
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
398
+ orderId: string;
399
+ id: string;
400
+ metadata?: {
401
+ [x: string]: unknown;
402
+ freeClaim?: boolean | undefined;
403
+ groupOrCampaignKey?: string | undefined;
404
+ claimId?: string | undefined;
405
+ mintTransaction?: {
406
+ txHash: string;
407
+ recordedAt: string;
408
+ } | undefined;
409
+ } | null | undefined;
410
+ }[], Error>;
411
+ registerDomain: _orpc_client.Client<Record<never, never>, {
412
+ normalizedDomainName: string;
413
+ durationInYears?: number | undefined;
414
+ nftReceivinggWallet?: {
415
+ walletAddress: string;
416
+ chainId: number;
417
+ } | undefined;
418
+ }, {
419
+ id: string;
420
+ userId: string;
421
+ amountInUSDCents: number;
422
+ nftWalletAddress: string | null;
423
+ nftChainId: number | null;
424
+ items: {
425
+ createdAt: string;
426
+ updatedAt: string;
427
+ durationInYears: number;
428
+ type: "REGISTER" | "IMPORT" | "RENEW";
429
+ registrar: string;
430
+ encryptionKeyId: string | null;
431
+ encryptedEppAuthorizationCode: string | null;
432
+ status: "PARTIALLY_COMPLETED" | "CREATED" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | null;
433
+ amountInUSDCents: number;
434
+ normalizedDomainName: string & zod.$brand<"NamefiNormalizedDomain">;
435
+ orderId: string;
436
+ id: string;
437
+ metadata?: {
438
+ [x: string]: unknown;
439
+ freeClaim?: boolean | undefined;
440
+ groupOrCampaignKey?: string | undefined;
441
+ claimId?: string | undefined;
442
+ mintTransaction?: {
443
+ txHash: string;
444
+ recordedAt: string;
445
+ } | undefined;
446
+ } | undefined;
447
+ }[];
448
+ }, Error>;
449
+ getOrderPaymentMethodsDetails: _orpc_client.Client<Record<never, never>, {
450
+ orderId: string;
451
+ }, ({
452
+ paymentId: string;
453
+ isOnChainPayment: true;
454
+ chainId: number;
455
+ walletAddress: string;
456
+ txHash?: string | null | undefined;
457
+ } | {
458
+ paymentId: string;
459
+ isOnChainPayment: false;
460
+ brand?: string | undefined;
461
+ last4?: string | undefined;
462
+ })[], Error>;
463
+ };
464
+ balance: {
465
+ getBalance: _orpc_client.Client<Record<never, never>, void, {
466
+ balances: {
467
+ chainId: number;
468
+ chainName: string;
469
+ walletAddress: string;
470
+ rawBalance: string;
471
+ balanceInUsd: number;
472
+ balanceInUsdCents: number;
473
+ paymentProvider: "NFSC_BASE" | "NFSC_ETHEREUM" | "NFSC_ETHEREUM_SEPOLIA";
474
+ }[];
475
+ totalBalanceInUsd: number;
476
+ totalBalanceInUsdCents: number;
477
+ }, Error>;
478
+ };
479
+ search: {
480
+ checkAvailability: _orpc_client.Client<Record<never, never>, {
481
+ domain: string;
482
+ }, {
483
+ domain: string & zod.$brand<"NamefiNormalizedDomain">;
484
+ availability: boolean;
485
+ importable: boolean;
486
+ supported: boolean;
487
+ pricingDetails?: {
488
+ registrationPrice: {
489
+ type: "PER_YEAR";
490
+ price: {
491
+ amount: number;
492
+ currency: string;
493
+ };
494
+ } | {
495
+ type: "MULTI_YEAR";
496
+ price: {
497
+ [x: string]: {
498
+ amount: number;
499
+ currency: string;
500
+ };
501
+ };
502
+ };
503
+ renewalPrice: {
504
+ type: "PER_YEAR";
505
+ price: {
506
+ amount: number;
507
+ currency: string;
508
+ };
509
+ } | {
510
+ type: "MULTI_YEAR";
511
+ price: {
512
+ [x: string]: {
513
+ amount: number;
514
+ currency: string;
515
+ };
516
+ };
517
+ };
518
+ importPrice: {
519
+ type: "PER_YEAR";
520
+ price: {
521
+ amount: number;
522
+ currency: string;
523
+ };
524
+ } | {
525
+ type: "MULTI_YEAR";
526
+ price: {
527
+ [x: string]: {
528
+ amount: number;
529
+ currency: string;
530
+ };
531
+ };
532
+ };
533
+ } | undefined;
534
+ currentOwner?: string | undefined;
535
+ registrarKey?: string | undefined;
536
+ durationValidationInYears?: {
537
+ min: number;
538
+ max: number;
539
+ } | undefined;
540
+ }, Error>;
541
+ getSuggestions: _orpc_client.Client<Record<never, never>, {
542
+ query: string;
543
+ parentDomain?: string | undefined;
544
+ page?: number | undefined;
545
+ pageSize?: number | undefined;
546
+ }, {
547
+ domains: (string & zod.$brand<"NamefiNormalizedDomain">)[];
548
+ page: number;
549
+ totalPages: number;
550
+ nextPage: number | null;
551
+ pageSize: number;
552
+ }, Error>;
553
+ };
554
+ };
555
+
556
+ export { createNamefiClient };