shipeasy-sdk 3.7.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c492371b226e15657ecdbdafdab11e79cd512d4f46ae412af3b000a203c0f3ec
-  data.tar.gz: a10503e08343510e5b12ebb3c23e9cdc19f05cb5781edb5fac381d7c98f8bc78
+  metadata.gz: 9f974f7f31df4a3c30015d2ec1149d32814f7e54a79fed06fd215bfe4c40bf84
+  data.tar.gz: c165ac01e2f01449538b7bdbaba217fd42c79b63481cacde1071fedaf2bd164e
 SHA512:
-  metadata.gz: 8df684d6629ee574b6e20bbac97c1409b56c00892c739357b980f298203cc7dc7fe1b34bce3f5758e983354c19124a648f1078f4e27bdcc9e383cef5aba5706c
-  data.tar.gz: ca4ff0fcfceca63eaad68696f5e19168b07ca559530adb42747ec9f1138d12750e694b40025094ec0b97952b73bb6dd1d784dc94a3f0669b538693260ed9cf97
+  metadata.gz: 192d9656ff82682fccd90e94ece252f67ddb904e20faa50f13ea16ae291c6eb129aef61da23d3262c90b9b24edcc342ccd178e55c0aec639d4bbabad4a9458eb
+  data.tar.gz: ea186acc91a8dd5bb78956c013e298b8b3decbb9194a5432065ccd4c5d633385ea123998bd5845802b0c2b5e062a80865aa2a58fc3189855ecbba4040147fb23

data/docs/skill/SKILL.md

@@ -126,10 +126,13 @@ rescue => e
 end
 ```
 
-Attach context with `.extras({...})` before `.to`, or inline as
-`.to(outcome, {...})`. To attach it from anywhere without threading it into the
-rescue, buffer it earlier with `Shipeasy.add_extras(order_id: id)` — it merges
-into every see() report later in the same (fiber-local, per-request) scope.
+Attach context inline on the terminal — `.to(outcome, {...})`. Never
+`.causes_the(x).extras({...}).to(y)`: it splits the consequence sentence in half.
+A stray `.extras` **after** `.to` is ignored with a warning (the report already
+shipped), so the extras are dropped. To attach context from anywhere without
+threading it into the rescue, buffer it earlier with
+`Shipeasy.add_extras(order_id: id)` — it merges into every see() report later in
+the same (fiber-local, per-request) scope.
 
 `Shipeasy.see_violation(name)` for non-exception problems;
 `Shipeasy.control_flow_exception(e).because(...)` marks expected control flow

data/lib/shipeasy/admin.rb

@@ -15,7 +15,7 @@
 #     api_key: ENV.fetch("SHIPEASY_ADMIN_KEY"),
 #     project_id: ENV.fetch("SHIPEASY_PROJECT_ID"),
 #   )
-#   admin.gates.list_gates
+#   admin.ops.create_public_bug(title: "Checkout 500s on Safari")
 #
 # Everything under `Shipeasy::Admin::Generated` (lib/shipeasy_admin*) is produced
 # by scripts/gen_admin.sh from the OpenAPI spec and must not be edited by hand.
@@ -37,40 +37,43 @@ module Shipeasy
   module Admin
     # Programmatic client for the Shipeasy Admin REST API. Each resource group is
     # a lazily-constructed, memoized reader whose methods map 1:1 to the OpenAPI
-    # operations: #flags, #configs, #killswitch, #experiments, #universes,
-    # #attributes, #metrics, #events, #ops, #alerts, #projects, #profiles, #keys,
-    # #drafts, #errors, #connectors, #api_keys.
+    # operations.
+    #
+    # This is the LEAN admin surface: the vendored spec is the dedicated
+    # server-SDK contract (marketplace/openapi/spec/openapi-sdk.yaml in the
+    # monorepo), seven operations across three capabilities — file a public
+    # ticket (#ops), toggle a kill switch (#killswitch), manage a flag's
+    # whitelist (#flags). The rest of the admin API (experiments, metrics,
+    # events, configs, i18n, projects, …) is intentionally NOT here; reach it
+    # through the Shipeasy CLI or MCP, which consume the complete spec.
     class Client
       # Friendly reader name => generated Api class.
       APIS = {
         flags: Generated::FlagsApi,
-        configs: Generated::ConfigsApi,
         killswitch: Generated::KillswitchApi,
-        experiments: Generated::ExperimentsApi,
-        universes: Generated::UniversesApi,
-        attributes: Generated::AttributesApi,
-        metrics: Generated::MetricsApi,
-        events: Generated::EventsApi,
         ops: Generated::OpsApi,
-        alerts: Generated::AlertsApi,
-        projects: Generated::ProjectsApi,
-        profiles: Generated::ProfilesApi,
-        keys: Generated::KeysApi,
-        drafts: Generated::DraftsApi,
-        errors: Generated::ErrorsApi,
-        connectors: Generated::ConnectorsApi,
-        api_keys: Generated::APIKeysApi,
       }.freeze
 
+      # Two of the seven operations — #ops.create_public_bug and
+      # #ops.create_public_feature_request — are the PUBLIC ticket intake. They
+      # live on the Shipeasy edge worker and authenticate with a CLIENT key
+      # (`X-SDK-Key`), not the admin key, so pass `client_key:` if you want to
+      # call them. The generated client routes them to the edge host itself.
+      #
       # @param api_key [String] admin SDK key, sent as `Authorization: Bearer <api_key>`.
       # @param project_id [String, nil] optional project id sent as the `X-Project-Id`
       #   header on every request. Operations also accept an explicit `x_project_id:`
       #   argument to override per call.
-      # @param base_url [String] API base URL. Defaults to https://shipeasy.ai
+      # @param base_url [String] admin API base URL. Defaults to https://shipeasy.ai
       #   (the spec's production server); use http://localhost:3000 for local dev.
-      def initialize(api_key:, project_id: nil, base_url: "https://shipeasy.ai")
+      #   The public intake ignores it — it carries its own server list.
+      # @param client_key [String, nil] client SDK key (`sdk_client_…`) carrying the
+      #   `tickets:public_create` scope, sent as `X-SDK-Key` on the two public
+      #   ticket operations. Optional — omit it if you only use the admin ones.
+      def initialize(api_key:, project_id: nil, base_url: "https://shipeasy.ai", client_key: nil)
         config = Generated::Configuration.new
         config.access_token = api_key
+        config.api_key["clientSdkKey"] = client_key if client_key
         scheme, _, host = base_url.rpartition("://")
         config.scheme = scheme unless scheme.empty?
         config.host = host.empty? ? base_url : host

data/lib/shipeasy/engine.rb

@@ -32,7 +32,7 @@ module Shipeasy
       See       = Shipeasy::SDK::See
 
       DEFAULT_BASE_URL = "https://api.shipeasy.ai"
-      # CDN origin serving the static loader scripts (/sdk/bootstrap.js,
+      # CDN origin serving the static loader scripts (/sdk/runtime.js,
       # /sdk/i18n/loader.js) — distinct from the edge API the blobs are fetched from.
       DEFAULT_CDN_BASE = "https://cdn.shipeasy.ai"
 
@@ -470,8 +470,9 @@ module Shipeasy
       end
 
       # Return the cross-platform SSR bootstrap <script> tag for a request:
-      # se-bootstrap.js reads its data-* attributes and hydrates
-      # window.__SE_BOOTSTRAP (and writes the anon cookie). No key is embedded.
+      # /sdk/runtime.js reads its data-* attributes, installs window.shipeasy,
+      # republishes window.__SE_BOOTSTRAP for the npm client SDK and writes the
+      # anon cookie. No key is embedded.
       #
       # Every argument is OPTIONAL and falls back to `Shipeasy.configure`:
       # `user` to an anonymous request, `i18n_profile:` to `config.profile`,
@@ -483,6 +484,7 @@ module Shipeasy
         base = cdn_base(base_url || Shipeasy.config.cdn_base_url)
         attrs = [
           "data-se-bootstrap",
+          "data-se-boot",
           attr("data-flags", JSON.generate(payload["flags"])),
           attr("data-configs", JSON.generate(payload["configs"])),
           attr("data-experiments", JSON.generate(payload["experiments"])),
@@ -493,7 +495,7 @@ module Shipeasy
         attrs << attr("data-anon-id", anon_id) if anon_id && !anon_id.empty?
         data_user = identity_attrs(user)
         attrs << attr("data-user", data_user) if data_user
-        html %(<script src="#{CGI.escapeHTML("#{base}/sdk/bootstrap.js")}" #{attrs.join(' ')}></script>)
+        html %(<script src="#{CGI.escapeHTML("#{base}/sdk/runtime.js")}" #{attrs.join(' ')}></script>)
       end
 
       # Return the i18n loader <script> tag (framework-agnostic; the Rails view

data/lib/shipeasy/sdk/see.rb

@@ -12,16 +12,18 @@
 #
 # Dispatch model (differs from TS, which uses a microtask): `.to(outcome)` is
 # the terminal — it builds the wire event and fire-and-forgets the POST to
-# /collect. `causes_the` and `extras` are chainable setters called *before*
-# `.to`; `.to` also accepts the extras inline as a second arg, so there is no
-# ordering trap to remember:
+# /collect. `causes_the` and `.to` are two halves of one sentence and must stay
+# adjacent, so pass the extras inline on the terminal:
 #
 #   client.see(e).causes_the("checkout").to("use cached prices")
-#   client.see(e).causes_the("checkout").extras({ order_id: oid }).to("use cached prices")
 #   client.see(e).causes_the("checkout").to("use cached prices", { order_id: oid })
 #
+# `extras` remains a chainable setter callable before `.to`, but do NOT wedge it
+# between the subject and the outcome — it splits the consequence in half and is
+# hard to read.
+#
 # `.extras` chained AFTER `.to` is ignored with a warning (the report already
-# went out) — it never raises into the rescue block.
+# went out) — it never raises into the rescue block, but its extras are dropped.
 #
 # To attach context from anywhere in a request without threading it into the
 # rescue block, use the ambient buffer (see `Context` below):

data/lib/shipeasy/sdk/version.rb

@@ -1,5 +1,5 @@
 module Shipeasy
   module SDK
-    VERSION = "3.7.0"
+    VERSION = "4.0.0"
   end
 end