@hyperscale0/sdk 3.1.0 → 3.2.1

package/README.md

@@ -1,25 +1,74 @@
 # @hyperscale0/sdk
 
 One client for every Hyperscale Product. Platform types ship with the package.
-Instrument fields and public action inputs come from the admitted Build at runtime.
+Object kinds, fields and action availability come from the admitted Build at runtime.
 
 ```js
 import { createClient } from "@hyperscale0/sdk";
 
+const productId = process.env.HYPERSCALE_PRODUCT_ID;
 const client = createClient({
   apiKey: process.env.HYPERSCALE_API_KEY,
-  productId: process.env.HYPERSCALE_PRODUCT_ID,
+  productId,
 });
-const { instruments, actions } = await client.discover();
+const discovery = await client.call("product.objects.discover", { productId });
+// Choose a kind and supply metadata according to its createSchema.
+const kind = discovery.kinds[0].kind;
+const object = await client.call(
+  "product.objects.create",
+  { productId, kind },
+  {
+    idempotencyKey: "object-create-001",
+  },
+);
+const available = await client.call("product.objects.actions", {
+  productId,
+  kind,
+  objectId: object.objectId,
+});
+```
+
+Choose the intended action by name. Check `availability.status` and collect its
+`requiredNow` fields and requirements against `fieldsSchema` and `inputSchema`.
+After that review, execute it with the complete context returned by the server:
+
+```js
+const action = available.actions.find((item) => item.name === chosenActionName);
+if (!action || action.availability.status !== "available") {
+  throw new Error("The selected action is unavailable");
+}
+const result = await client.call(
+  "product.objects.execute",
+  {
+    productId,
+    kind,
+    objectId: object.objectId,
+    action: action.name,
+    expectedRevision: available.revision,
+    productBuildId: action.productBuildId,
+    digest: action.digest,
+    target: action.target,
+    fields: collectedFields,
+    input: collectedInput,
+  },
+  { idempotencyKey: "object-action-001" },
+);
 ```
 
-Use `client.call(operationName, input, { idempotencyKey })` for platform operations.
-Their names and types match the operation descriptors.
+`chosenActionName`, `collectedFields` and `collectedInput` are application inputs
+from that review. Object creation does not create an agreement or move money.
+Use `product.objects.list` and `product.objects.retrieve` to read stored objects.
+These six operations use the descriptor-backed generic operation transport in
+`client.call`. Names and types match the operation descriptors.
+
+Copy the whole target, including `instanceId` when present. Refresh availability
+after a revision or Build conflict. Reuse the same key and body for an uncertain
+request. The client never retries a mutation automatically.
 
-Call `client.act(name, input, { idempotencyKey })` with an action name and input
-from discovery. Reuse the same idempotency key and input when retrying a request.
-The client never retries a mutation automatically. Keys stay in your environment.
-Set `baseUrl` and `environment` to select an estate and sandbox or live plane.
+Low-level `instruments()`, `actions()` and `act()` remain for admitted inspection
+and operations. Instrument creation stays internal to object attachment execution.
+Keys stay in your environment. Set `baseUrl` and `environment` to select an estate
+and sandbox or live plane.
 
 Security: https://hyperscale0.ai/security
 

package/client.d.ts

@@ -8,7 +8,7 @@ export type * from "./platform.js";
 import type {
   sandbox_rehearsal_createOutput,
   payment_reminder_delivery_retrieveOutput,
-} from "../../generated/sdk/tenant_portal.ts";
+} from "./portal.js";
 
 export interface ClientOptions {
   apiKey?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperscale0/sdk",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "type": "module",
   "sideEffects": false,
   "license": "LicenseRef-Hyperscale-Proprietary",
@@ -22,5 +22,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1ffed3f20362cb9e934d527f1df3e9d35585347c"
+  "gitHead": "3b813081ba55675872e8d00fe853549a0ffe174d"
 }