@suss/adapter-python 0.23.0 → 0.24.1

package/dist/index.d.cts

@@ -229,6 +229,8 @@ interface PythonPack {
      * and never says why (#188).
      */
     projectModules?: string[];
+    /** The callables the library gives a project for making a request. */
+    clients?: PyClientCall[];
     /** What the library's own database queries look like. The README says how one is matched. */
     storage?: StoragePattern[];
     /** How the library lets a project hand the database SQL it wrote itself. */
@@ -285,6 +287,49 @@ interface RawSqlPattern {
     storageSystem: "postgresql" | "mysql" | "sqlite";
 }
 type PythonDiscoveryPattern = DecoratedClassRoute | DecoratedFunctionRoute;
+/**
+ * The callables a library gives a project for making a request. A
+ * function that calls one of them is a client of the boundary that call
+ * states, and gets a unit bound to its method and path.
+ */
+interface PyClientCall {
+    type: "clientCall";
+    /** The module the callables come from, `requests`. */
+    importModule: string[];
+    /** Attribute names that state the method themselves: `get` means GET. */
+    verbAttributeNames: Record<string, string>;
+    /** Where a call whose name states the method states its URL. */
+    url: {
+        position: number;
+        keyword: string;
+    };
+    /** A call that takes the method as an argument instead, `request("GET", url)`. */
+    methodCall?: {
+        attribute: string;
+        methodPosition: number;
+        methodKeyword?: string;
+        urlPosition: number;
+    };
+    /** Constructors whose instances take the same calls, `Session`. */
+    receiverConstructors?: string[];
+    /** What the response object gives a caller, so a guard on it reads as a guard on a status. */
+    response?: PyClientResponse;
+}
+/**
+ * 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 PyClientResponse {
+    /** Members whose value is the status code: `status_code`. */
+    statusCode?: string[];
+    /** Members that say the request succeeded, meaning a status in 200 to 299: `ok`. */
+    success?: string[];
+    /** Members that give the body: `json`, `text`, `content`. */
+    body?: string[];
+    /** Whether a refused request comes back as a response or raises where it was made. */
+    failureDelivery?: "response" | "exception";
+}
 /** Conventions both kinds of route share. Each one describes what the library does, never a project's choice. */
 interface RouteConventions {
     /** How the library spells a path parameter. The README lists the syntaxes we know how to read. */

package/dist/index.d.ts

@@ -229,6 +229,8 @@ interface PythonPack {
      * and never says why (#188).
      */
     projectModules?: string[];
+    /** The callables the library gives a project for making a request. */
+    clients?: PyClientCall[];
     /** What the library's own database queries look like. The README says how one is matched. */
     storage?: StoragePattern[];
     /** How the library lets a project hand the database SQL it wrote itself. */
@@ -285,6 +287,49 @@ interface RawSqlPattern {
     storageSystem: "postgresql" | "mysql" | "sqlite";
 }
 type PythonDiscoveryPattern = DecoratedClassRoute | DecoratedFunctionRoute;
+/**
+ * The callables a library gives a project for making a request. A
+ * function that calls one of them is a client of the boundary that call
+ * states, and gets a unit bound to its method and path.
+ */
+interface PyClientCall {
+    type: "clientCall";
+    /** The module the callables come from, `requests`. */
+    importModule: string[];
+    /** Attribute names that state the method themselves: `get` means GET. */
+    verbAttributeNames: Record<string, string>;
+    /** Where a call whose name states the method states its URL. */
+    url: {
+        position: number;
+        keyword: string;
+    };
+    /** A call that takes the method as an argument instead, `request("GET", url)`. */
+    methodCall?: {
+        attribute: string;
+        methodPosition: number;
+        methodKeyword?: string;
+        urlPosition: number;
+    };
+    /** Constructors whose instances take the same calls, `Session`. */
+    receiverConstructors?: string[];
+    /** What the response object gives a caller, so a guard on it reads as a guard on a status. */
+    response?: PyClientResponse;
+}
+/**
+ * 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 PyClientResponse {
+    /** Members whose value is the status code: `status_code`. */
+    statusCode?: string[];
+    /** Members that say the request succeeded, meaning a status in 200 to 299: `ok`. */
+    success?: string[];
+    /** Members that give the body: `json`, `text`, `content`. */
+    body?: string[];
+    /** Whether a refused request comes back as a response or raises where it was made. */
+    failureDelivery?: "response" | "exception";
+}
 /** Conventions both kinds of route share. Each one describes what the library does, never a project's choice. */
 interface RouteConventions {
     /** How the library spells a path parameter. The README lists the syntaxes we know how to read. */