@farthershore/client 0.8.0 → 0.9.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Changelog — @farthershore/client
2
2
 
3
+ ## [0.9.0] - 2026-11-21
4
+
5
+ - `businesses.release` (cut the next release of a live business) and `businesses.releaseTag.set` (choose the release tag prefix). `Business.releaseTagPrefix` on reads. `businesses.release` takes `expectedCommit` to refuse a release on any other commit, and its dry run is retried like a read.
6
+
3
7
  ## [0.8.0] - 2026-11-21
4
8
 
5
9
  - **Breaking:** runtime tokens are now secret keys. `runtimeTokens.read`, `.mint`, `.rotate` and `.revoke` are replaced by the same operations under `secretKeys`, on the `/secret-keys` routes, with no old-name aliases.
package/README.md CHANGED
@@ -5,7 +5,7 @@ namespaced, typed operation surface (`fs.secretKeys.revoke(…)`) over an
5
5
  authenticated `fetch` transport with exact retry and outcome semantics,
6
6
  pluggable credential sources, and typed errors.
7
7
 
8
- > **Status: `0.8.0`.** Pre-1.0: minor releases may include breaking changes.
8
+ > **Status: `0.9.0`.** Pre-1.0: minor releases may include breaking changes.
9
9
  > Every response is typed. Responses are generated
10
10
  > from the platform's zod schemas (through the API's OpenAPI components), so a
11
11
  > field exists in a type exactly when the server sends it.
package/dist/index.js CHANGED
@@ -1493,6 +1493,7 @@ var PLATFORM_OPERATION_DEFINITIONS = [
1493
1493
  // API verb is the read — mutations happen through the manifest contract.
1494
1494
  { key: "rbac.subjects.read", class: "operate", domain: "businesses" },
1495
1495
  { key: "business.preview_env.set", class: "operate", domain: "businesses" },
1496
+ { key: "business.release_tag.set", class: "operate", domain: "businesses" },
1496
1497
  // FAR-797 — `workflows.replay` was REMOVED from this catalog, not just from
1497
1498
  // the CLI. The command was a stub that always threw, so leaving the key here
1498
1499
  // advertised a live control-plane operation that no surface implements —
@@ -1530,6 +1531,7 @@ var PLATFORM_OPERATION_DEFINITIONS = [
1530
1531
  { key: "business.routes.read", class: "contract", domain: "businesses" },
1531
1532
  { key: "business.contract.read", class: "contract", domain: "businesses" },
1532
1533
  { key: "business.publish", class: "operate", domain: "lifecycle" },
1534
+ { key: "business.release", class: "operate", domain: "lifecycle" },
1533
1535
  {
1534
1536
  key: "manifest.apply",
1535
1537
  class: "contract",
@@ -1865,6 +1867,14 @@ var AGENT_OPERATION_AUTHORIZATIONS = {
1865
1867
  permission: "business:publish",
1866
1868
  targetKind: "business"
1867
1869
  },
1870
+ "business.release": {
1871
+ permission: "business:publish",
1872
+ targetKind: "business"
1873
+ },
1874
+ "business.release_tag.set": {
1875
+ permission: "business:publish",
1876
+ targetKind: "business"
1877
+ },
1868
1878
  "business.read": {
1869
1879
  permission: BUSINESS_READ_PERMISSION,
1870
1880
  targetKind: "business"
@@ -2583,6 +2593,14 @@ var SPECS = {
2583
2593
  preview: true,
2584
2594
  reconcile: { op: "business.status" }
2585
2595
  },
2596
+ "business.release": {
2597
+ summary: "Release what is on the default branch of a live business, with the version picked from what changed",
2598
+ description: "Cut the next release of a live business from its default branch. Compares that commit with the last release, picks a major, minor or patch version from what changed (removals and tightened access are major, additions and price changes minor, everything else patch), runs the go-live checks and creates the release, which then deploys. Use a dry run first to see the plan, and business status to prove it is live. A draft business goes live with business publish instead.",
2599
+ destructive: false,
2600
+ oneTimeSecret: false,
2601
+ preview: true,
2602
+ reconcile: { op: "business.status" }
2603
+ },
2586
2604
  "business.delete": {
2587
2605
  summary: "Permanently delete a business (stage only)",
2588
2606
  description: "(stage only) Permanently delete a business. Requires --yes. Registered only in the stage channel (`make cli-stage`); production businesses are deleted from the dashboard.",
@@ -2599,6 +2617,14 @@ var SPECS = {
2599
2617
  preview: false,
2600
2618
  reconcile: { op: "environment.read" }
2601
2619
  },
2620
+ "business.release_tag.set": {
2621
+ summary: "Choose the prefix of a business's release tags",
2622
+ description: "Choose the prefix of a business's release tags. Releases are tagged `<prefix>X.Y.Z`: `v` by default, or for example `release-`, `prod/` or an empty prefix for bare numbers. Changing the prefix continues the version numbers and never renames existing tags.",
2623
+ destructive: false,
2624
+ oneTimeSecret: false,
2625
+ preview: false,
2626
+ reconcile: { op: "business.read" }
2627
+ },
2602
2628
  "business.docs.enable": {
2603
2629
  summary: "Enable docs for a business (publish/serve docs scaffold)",
2604
2630
  description: "Enable docs for a business \u2014 published docs become available in the portal. Safe to repeat: enabling them when already enabled changes nothing.",
@@ -3895,6 +3921,10 @@ var ERROR_CODES = {
3895
3921
  /** A release cut by an earlier publish is still being applied. Wait for it
3896
3922
  * to be accepted (or fail) before cutting another release. */
3897
3923
  RELEASE_PENDING_ACCEPTANCE: "RELEASE_PENDING_ACCEPTANCE",
3924
+ /** The default branch holds nothing that the last release did not ship. */
3925
+ NOTHING_TO_RELEASE: "NOTHING_TO_RELEASE",
3926
+ /** The latest push is still being checked; retry the release shortly. */
3927
+ RELEASE_SOURCE_NOT_READY: "RELEASE_SOURCE_NOT_READY",
3898
3928
  /** A RollbackWorkflow for this source execution is already running. */
3899
3929
  ROLLBACK_IN_FLIGHT: "ROLLBACK_IN_FLIGHT",
3900
3930
  INTERNAL_ERROR: "INTERNAL_ERROR",
@@ -4775,6 +4805,15 @@ var businessOperations = {
4775
4805
  Object.keys(body).length > 0 ? body : void 0
4776
4806
  )
4777
4807
  }),
4808
+ "businesses.release": previewOperation({
4809
+ op: "business.release",
4810
+ run: (ctx, { businessId, ...body }) => send(
4811
+ ctx,
4812
+ "POST",
4813
+ `${business(businessId)}/release`,
4814
+ Object.keys(body).length > 0 ? body : void 0
4815
+ )
4816
+ }),
4778
4817
  // A retry may append another diagnostic compilation record; it never
4779
4818
  // applies or publishes the contract.
4780
4819
  "businesses.compile": operation({
@@ -4818,6 +4857,7 @@ var businessOperations = {
4818
4857
  run: (ctx, { businessId, kind }) => send(ctx, "DELETE", `${business(businessId)}/${seg(kind)}`)
4819
4858
  }),
4820
4859
  "businesses.previewEnv.set": patchBusiness("business.preview_env.set"),
4860
+ "businesses.releaseTag.set": patchBusiness("business.release_tag.set"),
4821
4861
  "businesses.docs.enable": setDocs("business.docs.enable", true),
4822
4862
  "businesses.docs.disable": setDocs("business.docs.disable", false),
4823
4863
  "businesses.cors.update": patchBusiness("business.cors.update"),
@@ -6355,7 +6395,7 @@ function diagnosticsOf(parsed) {
6355
6395
  }
6356
6396
 
6357
6397
  // src/version.ts
6358
- var CLIENT_VERSION = "0.8.0";
6398
+ var CLIENT_VERSION = "0.9.0";
6359
6399
  var CLIENT_PRODUCT = `@farthershore/client/${CLIENT_VERSION}`;
6360
6400
 
6361
6401
  // src/transport.ts
@@ -6409,7 +6449,7 @@ function supportsReadOnlyDryRun(method, path) {
6409
6449
  if (method.toUpperCase() !== "POST") return false;
6410
6450
  return /^\/(?:businesses|agent\/v1\/businesses)\/[^/]+\/backends\/?$/.test(
6411
6451
  pathname
6412
- ) || /^\/businesses\/[^/]+\/publish\/?$/.test(pathname) || /^\/businesses\/[^/]+\/frontend\/rollback\/?$/.test(pathname) || /^\/businesses\/[^/]+\/consumers\/[^/]+\/change-sets\/?$/.test(pathname) || /^\/agent\/v1\/(?:replay|rollback-to-config)\/?$/.test(pathname);
6452
+ ) || /^\/businesses\/[^/]+\/publish\/?$/.test(pathname) || /^\/businesses\/[^/]+\/release\/?$/.test(pathname) || /^\/businesses\/[^/]+\/frontend\/rollback\/?$/.test(pathname) || /^\/businesses\/[^/]+\/consumers\/[^/]+\/change-sets\/?$/.test(pathname) || /^\/agent\/v1\/(?:replay|rollback-to-config)\/?$/.test(pathname);
6413
6453
  }
6414
6454
  function retryPolicyFor(method, path, options) {
6415
6455
  if (options?.retry === "write") return "write";
@@ -446,6 +446,24 @@ export interface FartherShoreApi {
446
446
  * Operation `business.read` · read · requires `business:read`.
447
447
  */
448
448
  readonly read: Method<"businesses.read">;
449
+ /**
450
+ * Release what is on the default branch of a live business, with the version picked from what changed
451
+ *
452
+ * Cut the next release of a live business from its default branch. Compares that commit with the last release, picks a major, minor or patch version from what changed (removals and tightened access are major, additions and price changes minor, everything else patch), runs the go-live checks and creates the release, which then deploys. Use a dry run first to see the plan, and business status to prove it is live. A draft business goes live with business publish instead.
453
+ *
454
+ * Operation `business.release` · write · requires `business:publish` · supports `dryRun` · reconcile an unknown outcome with `business.status`.
455
+ */
456
+ readonly release: Method<"businesses.release">;
457
+ readonly releaseTag: {
458
+ /**
459
+ * Choose the prefix of a business's release tags
460
+ *
461
+ * Choose the prefix of a business's release tags. Releases are tagged `<prefix>X.Y.Z`: `v` by default, or for example `release-`, `prod/` or an empty prefix for bare numbers. Changing the prefix continues the version numbers and never renames existing tags.
462
+ *
463
+ * Operation `business.release_tag.set` · write · requires `business:publish` · reconcile an unknown outcome with `business.read`.
464
+ */
465
+ readonly set: Method<"businesses.releaseTag.set">;
466
+ };
449
467
  readonly routes: {
450
468
  /**
451
469
  * List a business's compiled routes
@@ -1254,6 +1254,7 @@ export interface components {
1254
1254
  envBranchPrefix: string | null;
1255
1255
  /** @enum {string} */
1256
1256
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
1257
+ releaseTagPrefix: string;
1257
1258
  /** Format: date-time */
1258
1259
  createdAt: string;
1259
1260
  /** Format: date-time */
@@ -1374,6 +1375,7 @@ export interface components {
1374
1375
  envBranchPrefix: string | null;
1375
1376
  /** @enum {string} */
1376
1377
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
1378
+ releaseTagPrefix: string;
1377
1379
  /** Format: date-time */
1378
1380
  createdAt: string;
1379
1381
  /** Format: date-time */
@@ -1600,6 +1602,8 @@ export interface components {
1600
1602
  envBranchPrefix?: string | null;
1601
1603
  /** @enum {string} */
1602
1604
  previewEnvTrigger?: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
1605
+ /** @description Release tags become <prefix>X.Y.Z. Letters, digits, '.', '_', '/' and '-'; may be empty; cannot end in a digit or '.'. */
1606
+ releaseTagPrefix?: string;
1603
1607
  /** @description White-label prefix for subscriber API keys (fsk_ → e.g. acme_). Null clears to the platform default fsk. */
1604
1608
  keyPrefix?: string | null;
1605
1609
  /** @description Show (true) or hide (false) this product on the organization's public page at /organization/<slug>. Defaults to true. */
@@ -3166,6 +3170,7 @@ export interface components {
3166
3170
  envBranchPrefix: string | null;
3167
3171
  /** @enum {string} */
3168
3172
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3173
+ releaseTagPrefix: string;
3169
3174
  /** Format: date-time */
3170
3175
  createdAt: string;
3171
3176
  /** Format: date-time */
@@ -3183,6 +3188,13 @@ export interface components {
3183
3188
  reasons: string[];
3184
3189
  /** @enum {string} */
3185
3190
  status: "PENDING" | "PREVIEW";
3191
+ commit?: string;
3192
+ changed?: {
3193
+ contract: boolean;
3194
+ frontend: boolean;
3195
+ docs: boolean;
3196
+ legal: boolean;
3197
+ };
3186
3198
  };
3187
3199
  ReplayInvoiceResult: {
3188
3200
  /** @constant */
@@ -1,4 +1,4 @@
1
- import type { BrandAssetUploadResult, BusinessUpdateInput, PublishBusinessBody } from "../types.js";
1
+ import type { BrandAssetUploadResult, BusinessUpdateInput, PublishBusinessBody, ReleaseBusinessBody } from "../types.js";
2
2
  import { type ListQuery } from "./define.js";
3
3
  type BusinessRef = {
4
4
  businessId: string;
@@ -45,6 +45,7 @@ export declare const businessOperations: {
45
45
  gitRepoFullName: string | null;
46
46
  envBranchPrefix: string | null;
47
47
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
48
+ releaseTagPrefix: string;
48
49
  createdAt: string;
49
50
  updatedAt: string;
50
51
  }[], {
@@ -75,6 +76,7 @@ export declare const businessOperations: {
75
76
  gitRepoFullName: string | null;
76
77
  envBranchPrefix: string | null;
77
78
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
79
+ releaseTagPrefix: string;
78
80
  createdAt: string;
79
81
  updatedAt: string;
80
82
  }[], false>;
@@ -106,6 +108,7 @@ export declare const businessOperations: {
106
108
  gitRepoFullName: string | null;
107
109
  envBranchPrefix: string | null;
108
110
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
111
+ releaseTagPrefix: string;
109
112
  createdAt: string;
110
113
  updatedAt: string;
111
114
  usageUnitLabels?: {
@@ -149,6 +152,7 @@ export declare const businessOperations: {
149
152
  gitRepoFullName: string | null;
150
153
  envBranchPrefix: string | null;
151
154
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
155
+ releaseTagPrefix: string;
152
156
  createdAt: string;
153
157
  updatedAt: string;
154
158
  usageUnitLabels?: {
@@ -343,6 +347,7 @@ export declare const businessOperations: {
343
347
  gitRepoFullName: string | null;
344
348
  envBranchPrefix: string | null;
345
349
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
350
+ releaseTagPrefix: string;
346
351
  createdAt: string;
347
352
  updatedAt: string;
348
353
  _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
@@ -374,6 +379,72 @@ export declare const businessOperations: {
374
379
  gitRepoFullName: string | null;
375
380
  envBranchPrefix: string | null;
376
381
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
382
+ releaseTagPrefix: string;
383
+ createdAt: string;
384
+ updatedAt: string;
385
+ _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
386
+ }, true>;
387
+ "businesses.release": import("./define.js").OperationEntry<BusinessRef & ReleaseBusinessBody, {
388
+ id: string;
389
+ organizationId: string | null;
390
+ name: string;
391
+ displayName: string | null;
392
+ description: string | null;
393
+ status: "DRAFT" | "ACTIVE";
394
+ visibility: "PUBLIC" | "PRIVATE";
395
+ runtimeHostname: string | null;
396
+ portalHostname: string | null;
397
+ iconUrl: string | null;
398
+ logoUrl: string | null;
399
+ keyPrefix: string | null;
400
+ allowedOrigins: string[];
401
+ docsEnabled: boolean;
402
+ listedOnOrganizationPage: boolean;
403
+ rbacEnabled: boolean;
404
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
405
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
406
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
407
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
408
+ publishedRevisionId: string | null;
409
+ latestRevisionId: string | null;
410
+ latestRevisionNumber: number | null;
411
+ latestReleaseVersion: string | null;
412
+ gitRepoFullName: string | null;
413
+ envBranchPrefix: string | null;
414
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
415
+ releaseTagPrefix: string;
416
+ createdAt: string;
417
+ updatedAt: string;
418
+ _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
419
+ }, {
420
+ id: string;
421
+ organizationId: string | null;
422
+ name: string;
423
+ displayName: string | null;
424
+ description: string | null;
425
+ status: "DRAFT" | "ACTIVE";
426
+ visibility: "PUBLIC" | "PRIVATE";
427
+ runtimeHostname: string | null;
428
+ portalHostname: string | null;
429
+ iconUrl: string | null;
430
+ logoUrl: string | null;
431
+ keyPrefix: string | null;
432
+ allowedOrigins: string[];
433
+ docsEnabled: boolean;
434
+ listedOnOrganizationPage: boolean;
435
+ rbacEnabled: boolean;
436
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
437
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
438
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
439
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
440
+ publishedRevisionId: string | null;
441
+ latestRevisionId: string | null;
442
+ latestRevisionNumber: number | null;
443
+ latestReleaseVersion: string | null;
444
+ gitRepoFullName: string | null;
445
+ envBranchPrefix: string | null;
446
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
447
+ releaseTagPrefix: string;
377
448
  createdAt: string;
378
449
  updatedAt: string;
379
450
  _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
@@ -457,6 +528,7 @@ export declare const businessOperations: {
457
528
  gitRepoFullName: string | null;
458
529
  envBranchPrefix: string | null;
459
530
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
531
+ releaseTagPrefix: string;
460
532
  createdAt: string;
461
533
  updatedAt: string;
462
534
  }, {
@@ -487,6 +559,7 @@ export declare const businessOperations: {
487
559
  gitRepoFullName: string | null;
488
560
  envBranchPrefix: string | null;
489
561
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
562
+ releaseTagPrefix: string;
490
563
  createdAt: string;
491
564
  updatedAt: string;
492
565
  }, false>;
@@ -530,6 +603,74 @@ export declare const businessOperations: {
530
603
  gitRepoFullName: string | null;
531
604
  envBranchPrefix: string | null;
532
605
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
606
+ releaseTagPrefix: string;
607
+ createdAt: string;
608
+ updatedAt: string;
609
+ }, {
610
+ id: string;
611
+ organizationId: string | null;
612
+ name: string;
613
+ displayName: string | null;
614
+ description: string | null;
615
+ status: "DRAFT" | "ACTIVE";
616
+ visibility: "PUBLIC" | "PRIVATE";
617
+ runtimeHostname: string | null;
618
+ portalHostname: string | null;
619
+ iconUrl: string | null;
620
+ logoUrl: string | null;
621
+ keyPrefix: string | null;
622
+ allowedOrigins: string[];
623
+ docsEnabled: boolean;
624
+ listedOnOrganizationPage: boolean;
625
+ rbacEnabled: boolean;
626
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
627
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
628
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
629
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
630
+ publishedRevisionId: string | null;
631
+ latestRevisionId: string | null;
632
+ latestRevisionNumber: number | null;
633
+ latestReleaseVersion: string | null;
634
+ gitRepoFullName: string | null;
635
+ envBranchPrefix: string | null;
636
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
637
+ releaseTagPrefix: string;
638
+ createdAt: string;
639
+ updatedAt: string;
640
+ }, false>;
641
+ "businesses.releaseTag.set": import("./define.js").OperationEntry<BusinessRef & {
642
+ env?: string;
643
+ } & {
644
+ body: BusinessUpdateInput;
645
+ }, {
646
+ id: string;
647
+ organizationId: string | null;
648
+ name: string;
649
+ displayName: string | null;
650
+ description: string | null;
651
+ status: "DRAFT" | "ACTIVE";
652
+ visibility: "PUBLIC" | "PRIVATE";
653
+ runtimeHostname: string | null;
654
+ portalHostname: string | null;
655
+ iconUrl: string | null;
656
+ logoUrl: string | null;
657
+ keyPrefix: string | null;
658
+ allowedOrigins: string[];
659
+ docsEnabled: boolean;
660
+ listedOnOrganizationPage: boolean;
661
+ rbacEnabled: boolean;
662
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
663
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
664
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
665
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
666
+ publishedRevisionId: string | null;
667
+ latestRevisionId: string | null;
668
+ latestRevisionNumber: number | null;
669
+ latestReleaseVersion: string | null;
670
+ gitRepoFullName: string | null;
671
+ envBranchPrefix: string | null;
672
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
673
+ releaseTagPrefix: string;
533
674
  createdAt: string;
534
675
  updatedAt: string;
535
676
  }, {
@@ -560,6 +701,7 @@ export declare const businessOperations: {
560
701
  gitRepoFullName: string | null;
561
702
  envBranchPrefix: string | null;
562
703
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
704
+ releaseTagPrefix: string;
563
705
  createdAt: string;
564
706
  updatedAt: string;
565
707
  }, false>;
@@ -591,6 +733,7 @@ export declare const businessOperations: {
591
733
  gitRepoFullName: string | null;
592
734
  envBranchPrefix: string | null;
593
735
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
736
+ releaseTagPrefix: string;
594
737
  createdAt: string;
595
738
  updatedAt: string;
596
739
  }, {
@@ -621,6 +764,7 @@ export declare const businessOperations: {
621
764
  gitRepoFullName: string | null;
622
765
  envBranchPrefix: string | null;
623
766
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
767
+ releaseTagPrefix: string;
624
768
  createdAt: string;
625
769
  updatedAt: string;
626
770
  }, false>;
@@ -652,6 +796,7 @@ export declare const businessOperations: {
652
796
  gitRepoFullName: string | null;
653
797
  envBranchPrefix: string | null;
654
798
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
799
+ releaseTagPrefix: string;
655
800
  createdAt: string;
656
801
  updatedAt: string;
657
802
  }, {
@@ -682,6 +827,7 @@ export declare const businessOperations: {
682
827
  gitRepoFullName: string | null;
683
828
  envBranchPrefix: string | null;
684
829
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
830
+ releaseTagPrefix: string;
685
831
  createdAt: string;
686
832
  updatedAt: string;
687
833
  }, false>;
@@ -717,6 +863,7 @@ export declare const businessOperations: {
717
863
  gitRepoFullName: string | null;
718
864
  envBranchPrefix: string | null;
719
865
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
866
+ releaseTagPrefix: string;
720
867
  createdAt: string;
721
868
  updatedAt: string;
722
869
  }, {
@@ -747,6 +894,7 @@ export declare const businessOperations: {
747
894
  gitRepoFullName: string | null;
748
895
  envBranchPrefix: string | null;
749
896
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
897
+ releaseTagPrefix: string;
750
898
  createdAt: string;
751
899
  updatedAt: string;
752
900
  }, false>;
@@ -778,6 +926,7 @@ export declare const businessOperations: {
778
926
  gitRepoFullName: string | null;
779
927
  envBranchPrefix: string | null;
780
928
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
929
+ releaseTagPrefix: string;
781
930
  createdAt: string;
782
931
  updatedAt: string;
783
932
  usageUnitLabels?: {
@@ -821,6 +970,7 @@ export declare const businessOperations: {
821
970
  gitRepoFullName: string | null;
822
971
  envBranchPrefix: string | null;
823
972
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
973
+ releaseTagPrefix: string;
824
974
  createdAt: string;
825
975
  updatedAt: string;
826
976
  usageUnitLabels?: {
@@ -3380,6 +3380,7 @@ export declare const OPERATION_TABLE: {
3380
3380
  gitRepoFullName: string | null;
3381
3381
  envBranchPrefix: string | null;
3382
3382
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3383
+ releaseTagPrefix: string;
3383
3384
  createdAt: string;
3384
3385
  updatedAt: string;
3385
3386
  }[], {
@@ -3410,6 +3411,7 @@ export declare const OPERATION_TABLE: {
3410
3411
  gitRepoFullName: string | null;
3411
3412
  envBranchPrefix: string | null;
3412
3413
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3414
+ releaseTagPrefix: string;
3413
3415
  createdAt: string;
3414
3416
  updatedAt: string;
3415
3417
  }[], false>;
@@ -3445,6 +3447,7 @@ export declare const OPERATION_TABLE: {
3445
3447
  gitRepoFullName: string | null;
3446
3448
  envBranchPrefix: string | null;
3447
3449
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3450
+ releaseTagPrefix: string;
3448
3451
  createdAt: string;
3449
3452
  updatedAt: string;
3450
3453
  usageUnitLabels?: {
@@ -3488,6 +3491,7 @@ export declare const OPERATION_TABLE: {
3488
3491
  gitRepoFullName: string | null;
3489
3492
  envBranchPrefix: string | null;
3490
3493
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3494
+ releaseTagPrefix: string;
3491
3495
  createdAt: string;
3492
3496
  updatedAt: string;
3493
3497
  usageUnitLabels?: {
@@ -3702,6 +3706,7 @@ export declare const OPERATION_TABLE: {
3702
3706
  gitRepoFullName: string | null;
3703
3707
  envBranchPrefix: string | null;
3704
3708
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3709
+ releaseTagPrefix: string;
3705
3710
  createdAt: string;
3706
3711
  updatedAt: string;
3707
3712
  _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
@@ -3733,6 +3738,74 @@ export declare const OPERATION_TABLE: {
3733
3738
  gitRepoFullName: string | null;
3734
3739
  envBranchPrefix: string | null;
3735
3740
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3741
+ releaseTagPrefix: string;
3742
+ createdAt: string;
3743
+ updatedAt: string;
3744
+ _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
3745
+ }, true>;
3746
+ "businesses.release": import("./define.js").OperationEntry<{
3747
+ businessId: string;
3748
+ } & import("../types.js").ReleaseBusinessBody, {
3749
+ id: string;
3750
+ organizationId: string | null;
3751
+ name: string;
3752
+ displayName: string | null;
3753
+ description: string | null;
3754
+ status: "DRAFT" | "ACTIVE";
3755
+ visibility: "PUBLIC" | "PRIVATE";
3756
+ runtimeHostname: string | null;
3757
+ portalHostname: string | null;
3758
+ iconUrl: string | null;
3759
+ logoUrl: string | null;
3760
+ keyPrefix: string | null;
3761
+ allowedOrigins: string[];
3762
+ docsEnabled: boolean;
3763
+ listedOnOrganizationPage: boolean;
3764
+ rbacEnabled: boolean;
3765
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
3766
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
3767
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
3768
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
3769
+ publishedRevisionId: string | null;
3770
+ latestRevisionId: string | null;
3771
+ latestRevisionNumber: number | null;
3772
+ latestReleaseVersion: string | null;
3773
+ gitRepoFullName: string | null;
3774
+ envBranchPrefix: string | null;
3775
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3776
+ releaseTagPrefix: string;
3777
+ createdAt: string;
3778
+ updatedAt: string;
3779
+ _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
3780
+ }, {
3781
+ id: string;
3782
+ organizationId: string | null;
3783
+ name: string;
3784
+ displayName: string | null;
3785
+ description: string | null;
3786
+ status: "DRAFT" | "ACTIVE";
3787
+ visibility: "PUBLIC" | "PRIVATE";
3788
+ runtimeHostname: string | null;
3789
+ portalHostname: string | null;
3790
+ iconUrl: string | null;
3791
+ logoUrl: string | null;
3792
+ keyPrefix: string | null;
3793
+ allowedOrigins: string[];
3794
+ docsEnabled: boolean;
3795
+ listedOnOrganizationPage: boolean;
3796
+ rbacEnabled: boolean;
3797
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
3798
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
3799
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
3800
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
3801
+ publishedRevisionId: string | null;
3802
+ latestRevisionId: string | null;
3803
+ latestRevisionNumber: number | null;
3804
+ latestReleaseVersion: string | null;
3805
+ gitRepoFullName: string | null;
3806
+ envBranchPrefix: string | null;
3807
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3808
+ releaseTagPrefix: string;
3736
3809
  createdAt: string;
3737
3810
  updatedAt: string;
3738
3811
  _release: import("../generated/schemas.js").components["schemas"]["PublishRelease"];
@@ -3822,6 +3895,7 @@ export declare const OPERATION_TABLE: {
3822
3895
  gitRepoFullName: string | null;
3823
3896
  envBranchPrefix: string | null;
3824
3897
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3898
+ releaseTagPrefix: string;
3825
3899
  createdAt: string;
3826
3900
  updatedAt: string;
3827
3901
  }, {
@@ -3852,6 +3926,7 @@ export declare const OPERATION_TABLE: {
3852
3926
  gitRepoFullName: string | null;
3853
3927
  envBranchPrefix: string | null;
3854
3928
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3929
+ releaseTagPrefix: string;
3855
3930
  createdAt: string;
3856
3931
  updatedAt: string;
3857
3932
  }, false>;
@@ -3901,6 +3976,76 @@ export declare const OPERATION_TABLE: {
3901
3976
  gitRepoFullName: string | null;
3902
3977
  envBranchPrefix: string | null;
3903
3978
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
3979
+ releaseTagPrefix: string;
3980
+ createdAt: string;
3981
+ updatedAt: string;
3982
+ }, {
3983
+ id: string;
3984
+ organizationId: string | null;
3985
+ name: string;
3986
+ displayName: string | null;
3987
+ description: string | null;
3988
+ status: "DRAFT" | "ACTIVE";
3989
+ visibility: "PUBLIC" | "PRIVATE";
3990
+ runtimeHostname: string | null;
3991
+ portalHostname: string | null;
3992
+ iconUrl: string | null;
3993
+ logoUrl: string | null;
3994
+ keyPrefix: string | null;
3995
+ allowedOrigins: string[];
3996
+ docsEnabled: boolean;
3997
+ listedOnOrganizationPage: boolean;
3998
+ rbacEnabled: boolean;
3999
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
4000
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
4001
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
4002
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
4003
+ publishedRevisionId: string | null;
4004
+ latestRevisionId: string | null;
4005
+ latestRevisionNumber: number | null;
4006
+ latestReleaseVersion: string | null;
4007
+ gitRepoFullName: string | null;
4008
+ envBranchPrefix: string | null;
4009
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4010
+ releaseTagPrefix: string;
4011
+ createdAt: string;
4012
+ updatedAt: string;
4013
+ }, false>;
4014
+ "businesses.releaseTag.set": import("./define.js").OperationEntry<{
4015
+ businessId: string;
4016
+ } & {
4017
+ env?: string;
4018
+ } & {
4019
+ body: import("../types.js").BusinessUpdateInput;
4020
+ }, {
4021
+ id: string;
4022
+ organizationId: string | null;
4023
+ name: string;
4024
+ displayName: string | null;
4025
+ description: string | null;
4026
+ status: "DRAFT" | "ACTIVE";
4027
+ visibility: "PUBLIC" | "PRIVATE";
4028
+ runtimeHostname: string | null;
4029
+ portalHostname: string | null;
4030
+ iconUrl: string | null;
4031
+ logoUrl: string | null;
4032
+ keyPrefix: string | null;
4033
+ allowedOrigins: string[];
4034
+ docsEnabled: boolean;
4035
+ listedOnOrganizationPage: boolean;
4036
+ rbacEnabled: boolean;
4037
+ meters: import("../generated/schemas.js").components["schemas"]["BusinessMeter"][];
4038
+ plans: import("../generated/schemas.js").components["schemas"]["BusinessPlan"][];
4039
+ unreadablePlans?: import("../generated/schemas.js").components["schemas"]["BusinessUnreadablePlan"][];
4040
+ rateLimitConfig: import("../generated/schemas.js").components["schemas"]["BusinessRateLimit"] | null;
4041
+ publishedRevisionId: string | null;
4042
+ latestRevisionId: string | null;
4043
+ latestRevisionNumber: number | null;
4044
+ latestReleaseVersion: string | null;
4045
+ gitRepoFullName: string | null;
4046
+ envBranchPrefix: string | null;
4047
+ previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4048
+ releaseTagPrefix: string;
3904
4049
  createdAt: string;
3905
4050
  updatedAt: string;
3906
4051
  }, {
@@ -3931,6 +4076,7 @@ export declare const OPERATION_TABLE: {
3931
4076
  gitRepoFullName: string | null;
3932
4077
  envBranchPrefix: string | null;
3933
4078
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4079
+ releaseTagPrefix: string;
3934
4080
  createdAt: string;
3935
4081
  updatedAt: string;
3936
4082
  }, false>;
@@ -3966,6 +4112,7 @@ export declare const OPERATION_TABLE: {
3966
4112
  gitRepoFullName: string | null;
3967
4113
  envBranchPrefix: string | null;
3968
4114
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4115
+ releaseTagPrefix: string;
3969
4116
  createdAt: string;
3970
4117
  updatedAt: string;
3971
4118
  }, {
@@ -3996,6 +4143,7 @@ export declare const OPERATION_TABLE: {
3996
4143
  gitRepoFullName: string | null;
3997
4144
  envBranchPrefix: string | null;
3998
4145
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4146
+ releaseTagPrefix: string;
3999
4147
  createdAt: string;
4000
4148
  updatedAt: string;
4001
4149
  }, false>;
@@ -4031,6 +4179,7 @@ export declare const OPERATION_TABLE: {
4031
4179
  gitRepoFullName: string | null;
4032
4180
  envBranchPrefix: string | null;
4033
4181
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4182
+ releaseTagPrefix: string;
4034
4183
  createdAt: string;
4035
4184
  updatedAt: string;
4036
4185
  }, {
@@ -4061,6 +4210,7 @@ export declare const OPERATION_TABLE: {
4061
4210
  gitRepoFullName: string | null;
4062
4211
  envBranchPrefix: string | null;
4063
4212
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4213
+ releaseTagPrefix: string;
4064
4214
  createdAt: string;
4065
4215
  updatedAt: string;
4066
4216
  }, false>;
@@ -4098,6 +4248,7 @@ export declare const OPERATION_TABLE: {
4098
4248
  gitRepoFullName: string | null;
4099
4249
  envBranchPrefix: string | null;
4100
4250
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4251
+ releaseTagPrefix: string;
4101
4252
  createdAt: string;
4102
4253
  updatedAt: string;
4103
4254
  }, {
@@ -4128,6 +4279,7 @@ export declare const OPERATION_TABLE: {
4128
4279
  gitRepoFullName: string | null;
4129
4280
  envBranchPrefix: string | null;
4130
4281
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4282
+ releaseTagPrefix: string;
4131
4283
  createdAt: string;
4132
4284
  updatedAt: string;
4133
4285
  }, false>;
@@ -4161,6 +4313,7 @@ export declare const OPERATION_TABLE: {
4161
4313
  gitRepoFullName: string | null;
4162
4314
  envBranchPrefix: string | null;
4163
4315
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4316
+ releaseTagPrefix: string;
4164
4317
  createdAt: string;
4165
4318
  updatedAt: string;
4166
4319
  usageUnitLabels?: {
@@ -4204,6 +4357,7 @@ export declare const OPERATION_TABLE: {
4204
4357
  gitRepoFullName: string | null;
4205
4358
  envBranchPrefix: string | null;
4206
4359
  previewEnvTrigger: "BRANCH_PREFIX" | "PULL_REQUEST" | "DISABLED";
4360
+ releaseTagPrefix: string;
4207
4361
  createdAt: string;
4208
4362
  updatedAt: string;
4209
4363
  usageUnitLabels?: {
@@ -77,6 +77,14 @@ export type PublishBusinessBody = {
77
77
  version?: string;
78
78
  acceptBreaking?: boolean;
79
79
  };
80
+ /** Overrides a release MAY carry; `version` is the numbers only (X.Y.Z). */
81
+ export type ReleaseBusinessBody = {
82
+ bump?: SemverBump;
83
+ version?: string;
84
+ acceptBreaking?: boolean;
85
+ /** Refuse unless the default branch is still at this commit. */
86
+ expectedCommit?: string;
87
+ };
80
88
  /** The `_release` block the publish route returns. */
81
89
  export type PublishRelease = Schemas["PublishRelease"];
82
90
  /** `GET /agent/v1/businesses/subdomain-availability` response. */
@@ -3,6 +3,6 @@
3
3
  * `package.json` by `version.test.ts` and checked in the built bundle by
4
4
  * `scripts/check-pack.mjs`.
5
5
  */
6
- export declare const CLIENT_VERSION = "0.8.0";
6
+ export declare const CLIENT_VERSION = "0.9.0";
7
7
  /** The `x-fs-client` product token for this package. */
8
- export declare const CLIENT_PRODUCT = "@farthershore/client/0.8.0";
8
+ export declare const CLIENT_PRODUCT = "@farthershore/client/0.9.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farthershore/client",
3
- "version": "0.8.0",
3
+ "version": "0.9.0",
4
4
  "description": "Farther Shore API client: the authenticated HTTP transport, credential sources, and typed errors shared by the CLI and agent tooling",
5
5
  "type": "module",
6
6
  "sideEffects": false,