@happyvertical/smrt-types 0.46.0 → 0.47.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +29 -0
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -577,6 +577,12 @@ export declare interface DomainKnowledgeObject {
577
577
  tableStrategy?: 'cti' | 'sti';
578
578
  conflictColumns?: string[];
579
579
  surfaces: DomainKnowledgeSurface[];
580
+ /**
581
+ * Public methods a generated surface withheld, with the reason for each.
582
+ * Omitted entirely when nothing was withheld, so an artifact for a fully
583
+ * exposed object is unchanged (#2686).
584
+ */
585
+ withheldSurfaces?: DomainKnowledgeWithheldSurface[];
580
586
  relationshipFeatures: string[];
581
587
  tags: string[];
582
588
  summary?: string;
@@ -656,6 +662,29 @@ export declare interface DomainKnowledgeViewIntent {
656
662
  sourceFile: string;
657
663
  }
658
664
 
665
+ /**
666
+ * A public method a generated surface deliberately does NOT expose, and why.
667
+ *
668
+ * Silence is the failure mode this closes: before #2686 a method that produced
669
+ * no route simply did not appear, leaving an author to guess whether they had
670
+ * mistyped a name, hit an `exclude`, or written a signature no HTTP caller can
671
+ * satisfy. `reason` is human-readable prose; `code` is the stable key to react
672
+ * to programmatically.
673
+ */
674
+ export declare interface DomainKnowledgeWithheldSurface {
675
+ kind: DomainKnowledgeSurfaceKind;
676
+ /** The method name that was withheld. */
677
+ operation: string;
678
+ /**
679
+ * Stable rejection key — `not-wireable`, `excluded`, `not-included`,
680
+ * `withheld`, `lifecycle-method`, `no-receiver`, `api-disabled`.
681
+ */
682
+ code: string;
683
+ /** Human-readable explanation, e.g. why a parameter cannot cross a wire. */
684
+ reason: string;
685
+ objectName?: string;
686
+ }
687
+
659
688
  /** User↔Tenant↔Role junction. Runtime class: `@happyvertical/smrt-users:Membership`. */
660
689
  export declare interface Membership extends SmrtEntityFields {
661
690
  userId?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@happyvertical/smrt-types",
3
- "version": "0.46.0",
3
+ "version": "0.47.1",
4
4
  "description": "Shared type definitions for the HAVE SDK",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",