@suss/packs 0.22.4 → 0.24.0

package/dist/graphql-ruby.d.ts

@@ -1 +1 @@
-export { GRAPHQL_RUBY_ROOT_CLASS_NAMES, default, optionsSchema } from '@suss/framework-graphql-ruby';
+export { GRAPHQL_RUBY_ROOT_CLASS_NAMES, declares, default, optionsSchema } from '@suss/framework-graphql-ruby';

package/dist/graphql-ruby.js

@@ -98,9 +98,22 @@ function graphqlRubyFramework(options) {
     discovery: [pattern]
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-graphql-ruby",
+  dependencies: [{ ecosystem: "rubygems", name: "graphql" }],
+  reads: "graphql-ruby class-based field DSL (Ruby), including `mutation:` / `resolver:` wiring one hop out to what the referenced class itself declares.",
+  configuration: {
+    file: "suss.graphql-ruby.json",
+    example: { root: "app/graphql" },
+    required: true,
+    why: "the directory a field's wired class is looked up under, read relative to this file. A Rails app generated by the library keeps its types and mutations under app/graphql."
+  }
+};
 var index_default = graphqlRubyFramework;
 export {
   GRAPHQL_RUBY_ROOT_CLASS_NAMES,
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/hono.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-hono';
+export { declares, default, optionsSchema } from '@suss/framework-hono';

package/dist/hono.js

@@ -211,8 +211,15 @@ function honoFramework(_options = {}) {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-hono",
+  dependencies: [{ ecosystem: "npm", name: "hono" }],
+  reads: "Hono handlers, including the `c.json(body, status)` argument order."
+};
 var index_default = honoFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/httpx.d.ts

@@ -0,0 +1 @@
+export { declares, default } from '@suss/client-httpx';

package/dist/httpx.js

@@ -0,0 +1,53 @@
+// ../client/httpx/dist/index.js
+var VERB_FUNCTIONS = {
+  get: "GET",
+  post: "POST",
+  put: "PUT",
+  patch: "PATCH",
+  delete: "DELETE",
+  head: "HEAD",
+  options: "OPTIONS"
+};
+function httpxClient() {
+  return {
+    name: "httpx",
+    protocol: "http",
+    discovery: [],
+    clients: [
+      {
+        type: "clientCall",
+        importModule: ["httpx"],
+        verbAttributeNames: VERB_FUNCTIONS,
+        url: { position: 0, keyword: "url" },
+        methodCall: {
+          attribute: "request",
+          methodPosition: 0,
+          methodKeyword: "method",
+          urlPosition: 1
+        },
+        // Both are written as a context manager as often as they are
+        // assigned, and the adapter reads a `with ... as` the same way.
+        receiverConstructors: ["Client", "AsyncClient"],
+        // httpx spells the response the way requests does, which is
+        // deliberate on its part.
+        response: {
+          statusCode: ["status_code"],
+          success: ["is_success"],
+          body: ["json", "text", "content"],
+          failureDelivery: "response"
+        }
+      }
+    ]
+  };
+}
+var declares = {
+  kind: "client",
+  package: "@suss/client-httpx",
+  dependencies: [{ ecosystem: "pypi", name: "httpx" }],
+  reads: "httpx call sites (Python): the verb functions, `httpx.request`, and a `Client` or `AsyncClient` held in an assignment or opened with `with`."
+};
+var index_default = httpxClient;
+export {
+  declares,
+  index_default as default
+};

package/dist/mongoose.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-mongoose';
+export { declares, default, optionsSchema } from '@suss/framework-mongoose';

package/dist/mongoose.js

@@ -152,8 +152,15 @@ function mongooseFramework(options = {}) {
     protocol: "in-process"
   });
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/framework-mongoose",
+  dependencies: [{ ecosystem: "npm", name: "mongoose" }],
+  reads: `Mongoose model calls, emits storage-access interactions against the collection a model's \`.model(...)\` call declares.`
+};
 var index_default = mongooseFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/nestjs-graphql.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-nestjs-graphql';
+export { declares, default, optionsSchema } from '@suss/framework-nestjs-graphql';

package/dist/nestjs-graphql.js

@@ -85,8 +85,15 @@ function nestjsGraphqlFramework(options = {}) {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-nestjs-graphql",
+  dependencies: [{ ecosystem: "npm", name: "@nestjs/graphql" }],
+  reads: "NestJS GraphQL resolvers."
+};
 var index_default = nestjsGraphqlFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/nestjs-microservices.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-nestjs-microservices';
+export { declares, default, optionsSchema } from '@suss/framework-nestjs-microservices';

package/dist/nestjs-microservices.js

@@ -70,8 +70,15 @@ function nestjsMicroservicesFramework(options = {}) {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-nestjs-microservices",
+  dependencies: [{ ecosystem: "npm", name: "@nestjs/microservices" }],
+  reads: "NestJS microservice handlers: `@EventPattern` and `@MessagePattern` consumers on the channel the decorator states."
+};
 var index_default = nestjsMicroservicesFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/nestjs-rest.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-nestjs-rest';
+export { declares, default, optionsSchema } from '@suss/framework-nestjs-rest';

package/dist/nestjs-rest.js

@@ -96,8 +96,15 @@ function nestjsRestFramework(options = {}) {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-nestjs-rest",
+  dependencies: [{ ecosystem: "npm", name: "@nestjs/common" }],
+  reads: "NestJS REST controllers."
+};
 var index_default = nestjsRestFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/net-http.d.ts

@@ -0,0 +1 @@
+export { declares, default } from '@suss/client-net-http';

package/dist/net-http.js

@@ -0,0 +1,64 @@
+// ../client/net-http/dist/index.js
+var VERB_METHODS = {
+  get: "GET",
+  get_response: "GET",
+  post: "POST",
+  post_form: "POST",
+  put: "PUT",
+  patch: "PATCH",
+  delete: "DELETE",
+  head: "HEAD",
+  options: "OPTIONS"
+};
+var REQUEST_CLASSES = {
+  "Net::HTTP::Get": "GET",
+  "Net::HTTP::Post": "POST",
+  "Net::HTTP::Put": "PUT",
+  "Net::HTTP::Patch": "PATCH",
+  "Net::HTTP::Delete": "DELETE",
+  "Net::HTTP::Head": "HEAD",
+  "Net::HTTP::Options": "OPTIONS"
+};
+function netHttpClient() {
+  return {
+    name: "net-http",
+    protocol: "http",
+    discovery: [],
+    clients: [
+      {
+        constantName: "Net::HTTP",
+        verbMethodNames: VERB_METHODS,
+        // Every one of these takes a URI object rather than a string.
+        // `URI(...)` and `URI.parse(...)` belong to Ruby itself, so the
+        // adapter's value tables read them and the pack says nothing.
+        url: { position: 0 },
+        receiverBuilders: ["new"],
+        requestObject: {
+          attribute: "request",
+          constructors: REQUEST_CLASSES,
+          urlPosition: 0
+        },
+        // The status comes back as a string, which is why a caller
+        // writes `response.code.to_i == 404`, read the same as any
+        // other member.
+        response: {
+          statusCode: ["code"],
+          body: ["body"],
+          failureDelivery: "response"
+        }
+      }
+    ]
+  };
+}
+var declares = {
+  kind: "client",
+  package: "@suss/client-net-http",
+  dependencies: [],
+  shippedWith: "ruby",
+  reads: "Net::HTTP call sites (Ruby): the module methods that send on their own, and a request object built with `Net::HTTP::Get` and its siblings, with the URL read through `URI`."
+};
+var index_default = netHttpClient;
+export {
+  declares,
+  index_default as default
+};

package/dist/nextjs.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-nextjs';
+export { declares, default } from '@suss/framework-nextjs';

package/dist/nextjs.js

@@ -253,7 +253,14 @@ function nextjsFramework() {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-nextjs",
+  dependencies: [{ ecosystem: "npm", name: "next" }],
+  reads: `Next.js route handlers, pages, and server actions; the route comes from where the file is on disk, and a \`"use server"\` function becomes an action unit.`
+};
 var index_default = nextjsFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/node.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/runtime-node';
+export { declares, default, optionsSchema } from '@suss/runtime-node';

package/dist/node.js

@@ -674,8 +674,16 @@ function nodeRuntimePack(options = {}) {
     subUnits: nodeSchedulingSubUnits
   };
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/runtime-node",
+  dependencies: [],
+  shippedWith: "typescript",
+  reads: "Node.js runtime primitives, scheduling, the `process` surface (incl. `process.env.X` config-read interactions), module-loading globals, emitted as interaction effects."
+};
 var index_default = nodeRuntimePack;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/package-exports.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-package-exports';
+export { declares, default } from '@suss/framework-package-exports';

package/dist/package-exports.js

@@ -29,7 +29,14 @@ function packageExportsFramework() {
     inputMapping: { type: "allPositional" }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-package-exports",
+  dependencies: [],
+  reads: "The boundary between packages in one workspace: public exports on the provider side, imports of them on the consumer side. Reads the workspace manifest, so it needs no per-project package list."
+};
 var index_default = packageExportsFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/prisma.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-prisma';
+export { declares, default, optionsSchema } from '@suss/framework-prisma';

package/dist/prisma.js

@@ -409,8 +409,15 @@ function prismaFramework(options = {}) {
     declarations: declarationsIn([raw])
   };
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/framework-prisma",
+  dependencies: [{ ecosystem: "npm", name: "@prisma/client" }],
+  reads: "Prisma client calls, emits storage-access interactions per read / write."
+};
 var index_default = prismaFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/rails.d.ts

@@ -1 +1 @@
-export { RAILS_ROOT_CLASS_NAMES, default, optionsSchema } from '@suss/framework-rails';
+export { RAILS_ROOT_CLASS_NAMES, declares, default, optionsSchema } from '@suss/framework-rails';

package/dist/rails.js

@@ -445,6 +445,19 @@ var RESPONSE_STATUS_CALLS = [
   { name: "redirect_to", statusKeyword: "status", defaultStatusCode: 302 },
   { name: "redirect_back", statusKeyword: "status", defaultStatusCode: 302 }
 ];
+var CONTROLLER_FILTERS = [
+  {
+    name: "before_action",
+    methodFrom: "argument",
+    skippedBy: "skip_before_action",
+    actionKeywords: { include: "only", exclude: "except" }
+  },
+  {
+    name: "rescue_from",
+    methodFrom: "withKeyword",
+    onThrow: true
+  }
+];
 var RAILS_CONTROLLER_METHODS = [
   "params",
   "request",
@@ -518,6 +531,7 @@ function railsFramework(options = {}) {
       ...options.inheritedMethodNames ?? []
     ],
     routesFile,
+    filters: CONTROLLER_FILTERS,
     routeFor: (controllerQualifiedName, actionName) => {
       const key = controllerKeyFromQualified(controllerQualifiedName);
       const found = routeTable();
@@ -534,9 +548,22 @@ function railsFramework(options = {}) {
     discoveryInputs: () => [routesFile]
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-rails",
+  dependencies: [{ ecosystem: "rubygems", name: "rails" }],
+  reads: "Rails controller actions (Ruby), bound to the method and path `config/routes.rb` gives each one; an action the routes file does not reach is discovered with no boundary.",
+  configuration: {
+    file: "suss.rails.json",
+    example: { root: "app", routesFile: "config/routes.rb" },
+    required: false,
+    why: "the app directory a controller is defined under and the routes file suss reads each action's method and path from. rails new scaffolds both at these paths."
+  }
+};
 var index_default = railsFramework;
 export {
   RAILS_ROOT_CLASS_NAMES,
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/react-query.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-react-query';
+export { declares, default } from '@suss/framework-react-query';

package/dist/react-query.js

@@ -130,7 +130,14 @@ function reactQueryFramework() {
     subUnits: reactQuerySubUnits
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-react-query",
+  dependencies: [{ ecosystem: "npm", name: "@tanstack/react-query" }],
+  reads: "TanStack Query hooks: ties a component to the query function its `useQuery` / `useMutation` call runs."
+};
 var index_default = reactQueryFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/react-router.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-react-router';
+export { declares, default, optionsSchema } from '@suss/framework-react-router';

package/dist/react-router.js

@@ -202,8 +202,18 @@ function reactRouterFramework(options = {}) {
     }
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-react-router",
+  dependencies: [
+    { ecosystem: "npm", name: "react-router" },
+    { ecosystem: "npm", name: "react-router-dom" }
+  ],
+  reads: "React Router loaders / actions / routes."
+};
 var index_default = reactRouterFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/react.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-react';
+export { declares, default } from '@suss/framework-react';

package/dist/react.js

@@ -304,7 +304,14 @@ function reactFramework() {
     ]
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-react",
+  dependencies: [{ ecosystem: "npm", name: "react" }],
+  reads: "React function components, event handlers, `useEffect` bodies."
+};
 var index_default = reactFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/redis.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-redis';
+export { declares, default } from '@suss/framework-redis';

package/dist/redis.js

@@ -87,7 +87,18 @@ function redisFramework() {
     recognizedAs: "@suss/framework-redis"
   });
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/framework-redis",
+  dependencies: [
+    { ecosystem: "npm", name: "ioredis" },
+    { ecosystem: "npm", name: "iovalkey" },
+    { ecosystem: "npm", name: "redis" }
+  ],
+  reads: "Redis, Valkey and node-redis commands, emits storage-access interactions."
+};
 var index_default = redisFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/requests.d.ts

@@ -0,0 +1 @@
+export { declares, default } from '@suss/client-requests';

package/dist/requests.js

@@ -0,0 +1,54 @@
+// ../client/requests/dist/index.js
+var VERB_FUNCTIONS = {
+  get: "GET",
+  post: "POST",
+  put: "PUT",
+  patch: "PATCH",
+  delete: "DELETE",
+  head: "HEAD",
+  options: "OPTIONS"
+};
+function requestsClient() {
+  return {
+    name: "requests",
+    protocol: "http",
+    discovery: [],
+    clients: [
+      {
+        type: "clientCall",
+        importModule: ["requests"],
+        verbAttributeNames: VERB_FUNCTIONS,
+        // Every one of them takes the URL first, and `url=` is the
+        // keyword for all of them but `request`, which takes `url`
+        // second and still calls it that.
+        url: { position: 0, keyword: "url" },
+        methodCall: {
+          attribute: "request",
+          methodPosition: 0,
+          methodKeyword: "method",
+          urlPosition: 1
+        },
+        receiverConstructors: ["Session"],
+        // What a caller reads off the response it got back. A test on
+        // one of these says which statuses the caller handles.
+        response: {
+          statusCode: ["status_code"],
+          success: ["ok"],
+          body: ["json", "text", "content"],
+          failureDelivery: "response"
+        }
+      }
+    ]
+  };
+}
+var declares = {
+  kind: "client",
+  package: "@suss/client-requests",
+  dependencies: [{ ecosystem: "pypi", name: "requests" }],
+  reads: "requests call sites (Python): the seven verb functions, `requests.request`, and a `Session`, each bound to the method and path the call states."
+};
+var index_default = requestsClient;
+export {
+  declares,
+  index_default as default
+};

package/dist/sqlalchemy.d.ts

@@ -1 +1 @@
-export { default, optionsSchema } from '@suss/framework-sqlalchemy';
+export { declares, default, optionsSchema } from '@suss/framework-sqlalchemy';

package/dist/sqlalchemy.js

@@ -78,8 +78,15 @@ function sqlalchemyFramework(options) {
     rawSql: sqlalchemyRawSql(options)
   };
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/framework-sqlalchemy",
+  dependencies: [{ ecosystem: "pypi", name: "sqlalchemy" }],
+  reads: `SQLAlchemy calls (Python): says which types a query comes back as and which methods write, and the adapter matches a call chain by resolving through a project's own base class to what the method behind it says it returns.`
+};
 var index_default = sqlalchemyFramework;
 export {
+  declares,
   index_default as default,
   optionsSchema
 };

package/dist/ts-rest.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-ts-rest';
+export { declares, default } from '@suss/framework-ts-rest';

package/dist/ts-rest.js

@@ -83,7 +83,14 @@ function tsRestFramework() {
     ]
   };
 }
+var declares = {
+  kind: "framework",
+  package: "@suss/framework-ts-rest",
+  dependencies: [{ ecosystem: "npm", name: "@ts-rest/core" }],
+  reads: "ts-rest providers + clients (contract-backed)."
+};
 var index_default = tsRestFramework;
 export {
+  declares,
   index_default as default
 };

package/dist/zustand.d.ts

@@ -1 +1 @@
-export { default } from '@suss/framework-zustand';
+export { declares, default } from '@suss/framework-zustand';

package/dist/zustand.js

@@ -30,7 +30,14 @@ function zustandFramework() {
     recognizedAs: "@suss/framework-zustand"
   });
 }
+var declares = {
+  kind: "effects",
+  package: "@suss/framework-zustand",
+  dependencies: [{ ecosystem: "npm", name: "zustand" }],
+  reads: "zustand stores: `setState` writes and `getState` reads against the store as a client-side container."
+};
 var index_default = zustandFramework;
 export {
+  declares,
   index_default as default
 };