@suss/adapter-ruby 0.23.0 → 0.24.1

package/dist/index.d.cts

@@ -240,9 +240,57 @@ interface RubyPack {
     /** Wire protocol for the produced boundary bindings, e.g. "http-graphql". */
     protocol: string;
     discovery: RubyDiscoveryPattern[];
+    /** The calls the library gives a project for making a request. */
+    clients?: RbClientCall[];
     /** What the library's own database calls look like. The README says how one is matched. */
     storage?: RbStoragePattern[];
 }
+/**
+ * The calls a library gives a project for making a request. A method
+ * that makes one is a client of the boundary that call states, and gets
+ * a unit bound to its method and path.
+ */
+interface RbClientCall {
+    /** The constant the calls hang on, as a project writes it: `Faraday`, `Net::HTTP`. */
+    constantName: string;
+    /** Method names that state the request method themselves: `get` means GET. */
+    verbMethodNames: Record<string, string>;
+    /** Where a call states the URL. */
+    url: {
+        position: number;
+        keyword?: string;
+    };
+    /** Methods on the constant that build a value taking the same calls, `new` for a Faraday connection. */
+    receiverBuilders?: string[];
+    /** The keyword such a builder takes the base URL under, which comes in front of the path of a call on it. */
+    builderUrlKeyword?: string;
+    /** What the response object gives a caller, so a test on it reads as a test on a status. */
+    response?: RbClientResponse;
+    /** A call that sends a request object built somewhere else, which is how Net::HTTP sends anything with a body. */
+    requestObject?: {
+        /** The method that takes the request object, `request`. */
+        attribute: string;
+        /** Each request class, as a project writes it, and the method it sends: `Net::HTTP::Get` sends GET. */
+        constructors: Record<string, string>;
+        /** Where the request class takes the URL. */
+        urlPosition: number;
+    };
+}
+/**
+ * The members a library's response object gives a caller. A caller that
+ * tests one of them is saying which statuses it handles, and the
+ * checker compares that against what the other side produces.
+ */
+interface RbClientResponse {
+    /** Members whose value is the status: `status` for Faraday, `code` for Net::HTTP. */
+    statusCode?: string[];
+    /** Members that say the request succeeded, meaning a status in 200 to 299: `success?`. */
+    success?: string[];
+    /** Members that give the body: `body`. */
+    body?: string[];
+    /** Whether a refused request comes back as a response or raises where it was made. */
+    failureDelivery?: "response" | "exception";
+}
 /**
  * Ruby writes no return type, so a call is matched by what its receiver
  * inherits from. A model is a class that reaches one of these base classes,
@@ -420,6 +468,8 @@ interface DiscoveryOptions extends BodyReadOptions {
     absoluteFile?: string;
     /** What a summary's `location.file` says for a file other than the one being read, which a controller's filters need when an ancestor defines them. */
     displayPathOf?: (absolute: string) => string;
+    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
+    facts?: Database;
     cache: FileCache;
     /** Called once per discovered unit whose own body is a method this run can follow calls out of, so the reach walk has a place to start. */
     onReachSeed?: (raw: RawCodeStructure, seed: ReachSeed) => void;

package/dist/index.d.ts

@@ -240,9 +240,57 @@ interface RubyPack {
     /** Wire protocol for the produced boundary bindings, e.g. "http-graphql". */
     protocol: string;
     discovery: RubyDiscoveryPattern[];
+    /** The calls the library gives a project for making a request. */
+    clients?: RbClientCall[];
     /** What the library's own database calls look like. The README says how one is matched. */
     storage?: RbStoragePattern[];
 }
+/**
+ * The calls a library gives a project for making a request. A method
+ * that makes one is a client of the boundary that call states, and gets
+ * a unit bound to its method and path.
+ */
+interface RbClientCall {
+    /** The constant the calls hang on, as a project writes it: `Faraday`, `Net::HTTP`. */
+    constantName: string;
+    /** Method names that state the request method themselves: `get` means GET. */
+    verbMethodNames: Record<string, string>;
+    /** Where a call states the URL. */
+    url: {
+        position: number;
+        keyword?: string;
+    };
+    /** Methods on the constant that build a value taking the same calls, `new` for a Faraday connection. */
+    receiverBuilders?: string[];
+    /** The keyword such a builder takes the base URL under, which comes in front of the path of a call on it. */
+    builderUrlKeyword?: string;
+    /** What the response object gives a caller, so a test on it reads as a test on a status. */
+    response?: RbClientResponse;
+    /** A call that sends a request object built somewhere else, which is how Net::HTTP sends anything with a body. */
+    requestObject?: {
+        /** The method that takes the request object, `request`. */
+        attribute: string;
+        /** Each request class, as a project writes it, and the method it sends: `Net::HTTP::Get` sends GET. */
+        constructors: Record<string, string>;
+        /** Where the request class takes the URL. */
+        urlPosition: number;
+    };
+}
+/**
+ * The members a library's response object gives a caller. A caller that
+ * tests one of them is saying which statuses it handles, and the
+ * checker compares that against what the other side produces.
+ */
+interface RbClientResponse {
+    /** Members whose value is the status: `status` for Faraday, `code` for Net::HTTP. */
+    statusCode?: string[];
+    /** Members that say the request succeeded, meaning a status in 200 to 299: `success?`. */
+    success?: string[];
+    /** Members that give the body: `body`. */
+    body?: string[];
+    /** Whether a refused request comes back as a response or raises where it was made. */
+    failureDelivery?: "response" | "exception";
+}
 /**
  * Ruby writes no return type, so a call is matched by what its receiver
  * inherits from. A model is a class that reaches one of these base classes,
@@ -420,6 +468,8 @@ interface DiscoveryOptions extends BodyReadOptions {
     absoluteFile?: string;
     /** What a summary's `location.file` says for a file other than the one being read, which a controller's filters need when an ancestor defines them. */
     displayPathOf?: (absolute: string) => string;
+    /** The run's own facts, which the value evaluator reads a name through. Absent in a test that builds one file by hand. */
+    facts?: Database;
     cache: FileCache;
     /** Called once per discovered unit whose own body is a method this run can follow calls out of, so the reach walk has a place to start. */
     onReachSeed?: (raw: RawCodeStructure, seed: ReachSeed) => void;