@shipstatic/types 2.19.0 → 2.20.0-beta.1

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.
package/dist/index.d.ts CHANGED
@@ -337,8 +337,13 @@ export interface DomainDnsResponse {
337
337
  dns: DnsLookup | null;
338
338
  }
339
339
  /**
340
- * Response for `GET /domains/:domain/share` the domain plus the salted
341
- * hash that lets someone else complete its DNS setup without an account.
340
+ * Response for `GET /domains/:domain/share`: the domain plus the link that
341
+ * lets someone else complete its DNS setup without an account.
342
+ *
343
+ * The link is FINISHED, on the deployment claim's grammar: the API composes
344
+ * it from the salted setup hash and the one environment dimension it owns,
345
+ * and no client ever parses or assembles one. What a client receives is the
346
+ * setup URL, ready to hand off.
342
347
  *
343
348
  * `/admin/domains/:domain/share` answers the same shape, which is the admin
344
349
  * law working: the operator surface is the public grammar with a prefix.
@@ -349,8 +354,8 @@ export interface DomainDnsResponse {
349
354
  export interface DomainShareResponse {
350
355
  /** The domain the setup link is for */
351
356
  readonly domain: string;
352
- /** The salted setup hash that authorizes the share */
353
- readonly hash: string;
357
+ /** The shareable setup link, carrying the salted hash that authorizes the share */
358
+ readonly url: string;
354
359
  }
355
360
  /**
356
361
  * Response for domain DNS records
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipstatic/types",
3
- "version": "2.19.0",
3
+ "version": "2.20.0-beta.1",
4
4
  "description": "Shared types for ShipStatic platform",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/index.ts CHANGED
@@ -368,8 +368,13 @@ export interface DomainDnsResponse {
368
368
  }
369
369
 
370
370
  /**
371
- * Response for `GET /domains/:domain/share` the domain plus the salted
372
- * hash that lets someone else complete its DNS setup without an account.
371
+ * Response for `GET /domains/:domain/share`: the domain plus the link that
372
+ * lets someone else complete its DNS setup without an account.
373
+ *
374
+ * The link is FINISHED, on the deployment claim's grammar: the API composes
375
+ * it from the salted setup hash and the one environment dimension it owns,
376
+ * and no client ever parses or assembles one. What a client receives is the
377
+ * setup URL, ready to hand off.
373
378
  *
374
379
  * `/admin/domains/:domain/share` answers the same shape, which is the admin
375
380
  * law working: the operator surface is the public grammar with a prefix.
@@ -380,8 +385,8 @@ export interface DomainDnsResponse {
380
385
  export interface DomainShareResponse {
381
386
  /** The domain the setup link is for */
382
387
  readonly domain: string;
383
- /** The salted setup hash that authorizes the share */
384
- readonly hash: string;
388
+ /** The shareable setup link, carrying the salted hash that authorizes the share */
389
+ readonly url: string;
385
390
  }
386
391
 
387
392
  /**