@viewrium/sdk 0.1.0 → 2.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Viewrium, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,144 +1,251 @@
 # @viewrium/sdk
 
-Official JavaScript / TypeScript SDK for the [Viewrium](https://viewrium.com) API. Create and manage 3D models, API keys, and usage records.
+The official JavaScript/TypeScript SDK for the [Viewrium](https://www.viewrium.com) API.
+
+Viewrium is AR and 3D product visualization for furniture retailers: it turns product photos, a
+video, a product page URL or an existing 3D file into catalog images, a GLB model and an
+embeddable 3D/AR viewer. This package is a typed client for the Viewrium `/v1` REST API: create
+products, review and publish them, export images, manage webhooks and API keys, and read usage
+analytics.
+
+- Documentation: https://www.viewrium.com/docs
+- SDK reference: https://www.viewrium.com/docs/sdks/javascript
+- Dashboard: https://www.viewrium.com
 
 ## Install
 
 ```bash
 npm install @viewrium/sdk
-# or
-pnpm add @viewrium/sdk
-# or
-yarn add @viewrium/sdk
 ```
 
-Node 18+, Deno, Bun, browsers, and edge runtimes all supported (uses the global `fetch`).
+The package ships ESM and CommonJS builds with self-contained type declarations. It runs anywhere
+there is a `fetch`: Node 18+, Bun, Deno, edge runtimes and the browser.
 
-## Quickstart
+## Authentication
+
+Every request is authenticated with an API key, sent as `Authorization: Bearer <key>`. The SDK
+sets the header for you.
+
+- **Secret keys (`sk_`)** are for servers. They can do everything their scopes allow. Never ship
+  one to a browser, a mobile app or a public repository.
+- **Publishable keys (`pk_`)** are safe in a browser but are origin-gated and limited to reading a
+  single published product, minting its model ticket and sending analytics beacons. An
+  organization with no allowed domains configured has its publishable keys refused everywhere. They power the
+  [`<viewrium-viewer>` embed](https://www.viewrium.com/docs/embed); use the embed, not this SDK, to
+  show a model on a storefront.
+
+Create keys in the dashboard under **Settings -> Advanced -> API keys**. A secret key is shown
+exactly once, on create. See [Authentication](https://www.viewrium.com/docs/authentication) for
+scopes.
 
 ```ts
-import Viewrium from "@viewrium/sdk";
+import { Viewrium } from "@viewrium/sdk";
 
-const viewrium = new Viewrium(process.env.VIEWRIUM_API_KEY!);
+const client = new Viewrium({ apiKey: process.env.VIEWRIUM_API_KEY! });
+```
+
+Options:
 
-const model = await viewrium.models.create({
-  customId: "sku-1",
-  images: ["https://example.com/img1.jpg", "https://example.com/img2.jpg"],
-  height: 90,
-  tags: ["chair", "summer-2026"],
+```ts
+const client = new Viewrium({
+  apiKey: "sk_live_...",
+  baseUrl: "https://api.viewrium.com", // default; trailing slash stripped
+  fetch: customFetch,                  // optional; defaults to globalThis.fetch
 });
+```
 
-console.log(model.id, model.status);
+`createViewrium({ apiKey })` is equivalent to `new Viewrium({ apiKey })`.
 
-const listing = await viewrium.models.list({ tag: "chair", limit: 20 });
-for (const m of listing.data) {
-  console.log(m.custom_id, m.status);
-}
-```
+## Quickstart
+
+`products.create` is the single generation entrypoint. Supply exactly one source: `image_urls`,
+`video_url`, `source_url` (a product page) or `model_url` (an existing 3D file). Sources are URLs
+that Viewrium fetches, so they must be publicly reachable.
 
-## Configure
+A fresh request **parks**: nothing is written, and you get back the plan, the 3D model verdict, the
+price in credits and a `resume_token`. Posting the token back commits the quote and starts the run.
 
 ```ts
-const viewrium = new Viewrium("sk_live_...", {
-  apiBase: "https://api.viewrium.com",  // default
-  timeoutMs: 60_000,                      // default
-  maxRetries: 3,                          // retries 429 / 5xx, respects Retry-After
+import { Viewrium } from "@viewrium/sdk";
+
+const client = new Viewrium({ apiKey: process.env.VIEWRIUM_API_KEY! });
+
+// 1. Quote
+const quote = await client.products.create({
+  image_urls: [
+    "https://cdn.example.com/chair-front.jpg",
+    "https://cdn.example.com/chair-side.jpg",
+  ],
+  draft: { title: "Oak dining chair", custom_id: "sku-oak-chair", dimensions: { height: 92 } },
 });
+if (quote.status !== "parked") throw new Error("unexpected: already committed");
+console.log(quote.cost.total_credits, quote.plan?.length, quote.model.allowed);
+
+// 2. Commit
+const committed = await client.products.create({ resume_token: quote.resume_token });
+if (committed.status === "parked") throw new Error("a resume always commits");
+
+// 3. Wait for the run (prefer webhooks in production)
+let product = await client.products.retrieve(committed.id);
+while (product.display_status === "generating") {
+  await new Promise((r) => setTimeout(r, 5000));
+  product = await client.products.retrieve(product.id);
+}
+console.log(product.display_status, product.model?.status);
+
+// 4. Publish
+await client.products.update(product.id, { published: true });
 ```
 
-If you omit the first argument, the SDK reads `process.env.VIEWRIUM_API_KEY`. Likewise `process.env.VIEWRIUM_API_BASE` overrides the default base URL.
+A resume may still edit the `draft` (title, price, tags, dimensions). It may not change the order
+or the overrides: the quote is immutable, and changing what gets generated means a new request.
+A `resume_token` expires after 7 days. A `model_url` source never parks; it commits straight away.
+
+See [How generation works](https://www.viewrium.com/docs/generation) and
+[the quote and commit guide](https://www.viewrium.com/docs/guides/quote-and-commit).
 
 ## Resources
 
 | Resource | Methods |
 |---|---|
-| `viewrium.models` | `create`, `createFromImages`, `createFromVideo`, `retrieve`, `list`, `modify`, `delete`, `listEvents` |
-| `viewrium.apiKeys` | `create`, `list`, `delete` |
-| `viewrium.usage` | `retrieve` |
-| `viewrium.tags` | `list` |
+| `client.products` | `create`, `list`, `retrieve`, `update`, `delete`, `batchDelete`, `publish`, `tags`, `review`, `updateImage`, `updateModel`, `rescale`, `createTicket`, `order`, `export` |
+| `client.apiKeys` | `list`, `create`, `revoke` |
+| `client.usage` | `get` |
+| `client.webhooks` | `list`, `create`, `retrieve`, `update`, `delete`, `listDeliveries` |
+| `client.projects` | `list`, `retrieve` |
+| `client.beacon` | `send` |
+| `client` | `health()` |
+
+Request and response types (`ProductCreateParams`, `ProductCreateResult`, `ProductParked`,
+`Product`, `PlannedView`, `ModelPlan`, `ProductCost`, `Usage`, `WebhookEndpoint`, and so on) are
+exported and derived from the API's OpenAPI schema.
 
-## Uploading files
+### Showing a model: tickets
 
-`createFromImages` and `createFromVideo` accept `Blob`, `File`, or (in Node) a filesystem path string.
+No response carries a URL for a 3D model file - not the product, not a webhook. The only way to a
+model's bytes is a **ticket**: a single-use URL that serves the GLB once and expires within a
+minute (60 s for `view`, 30 s for `ar`). Mint one right before the viewer loads, from the server,
+and hand the URL straight to the page; never store it.
 
 ```ts
-import { readFile } from "node:fs/promises";
-
-// Node: filesystem path (easiest)
-const model = await viewrium.models.createFromImages(
-  ["./chair-front.jpg", "./chair-side.jpg", "./chair-back.jpg"],
-  { customId: "sku-1", height: 90, tags: ["chair"] },
-);
-
-// Anywhere: Blob/File (from a browser `<input type=file>` or `fetch` response)
-const response = await fetch("https://example.com/chair.mp4");
-const blob = await response.blob();
-const model2 = await viewrium.models.createFromVideo(blob, {
-  customId: "sku-2",
-  height: 92,
+const ticket = await client.products.createTicket(productId, {
+  kind: "view",
+  origin: "https://shop.example.com", // the page that will load the model; an allowed domain
 });
+// ticket.url -> the page's viewer `src`; ticket.expires_at -> when it stops working
 ```
 
-## Sizing
+A `view` ticket streams only to a request from its `origin`. An `ar` ticket is for Android's Scene
+Viewer, which downloads the file outside the page: mint it on the AR tap. Minting is rate limited
+per IP and per product (429).
 
-Pass `height` plus optional `sizeUnit` (`"cm"` or `"in"`, default `"cm"`). The server normalizes to cm before storing. Explicit `height` wins over scraped values; if neither is present, the model renders unscaled.
+### Listing and filtering
 
 ```ts
-await viewrium.models.create({
-  images: [...],
-  height: 35,
-  sizeUnit: "in",   // stored as 88.9 cm
+const page = await client.products.list({
+  status: ["published"],
+  tag: ["chairs"],
+  q: "oak",
+  limit: 50,
+  sort: "created_at",
+  order: "desc",
 });
+for (const product of page.data) {
+  console.log(product.id, product.title, product.display_status);
+}
 ```
 
+`products.tags` and `products.export` take the same filters.
+
+### Exporting images
+
+`products.export` resolves to a ZIP of finished images as a `Blob` (the 3D model is never
+included). When more images need finishing than one request can do, it resolves to a queued answer
+instead: the images are finished in the background, a download link is emailed, and the same call
+returns the archive once they are done.
+
+```ts
+const archive = await client.products.export({ tag: ["chairs"] });
+if (archive instanceof Blob) {
+  // write it out
+} else {
+  console.log(`finishing ${archive.to_finish} images; a link goes to ${archive.notify_email}`);
+}
+```
+
+### Analytics
+
+```ts
+const usage = await client.usage.get({
+  start: "2026-06-01T00:00:00Z",
+  end: "2026-09-01T00:00:00Z",
+  granularity: "day",
+  group_by: "product",
+});
+for (const row of usage.by_product ?? []) {
+  console.log(row.title, row.totals);
+}
+```
+
+Traffic from your own team is excluded unless you pass `include_internal: true`.
+
 ## Errors
 
+Non-2xx responses throw a `ViewriumError` subclass. Every error exposes `status`, `code`,
+`message` and `details` from the API's error envelope.
+
 ```ts
 import {
-  ViewriumError,      // base class
-  AuthError,          // 401 or missing key
-  NotFoundError,      // 404
-  ValidationError,    // 400 / 409 / 422
-  RateLimitError,     // 429 (has .retryAfter)
-  APIError,           // 5xx / other
+  ViewriumError,
+  AuthenticationError,
+  PaymentRequiredError,
+  ConflictError,
+  RateLimitError,
+  ConnectionError,
 } from "@viewrium/sdk";
 
 try {
-  await viewrium.models.retrieve("not-a-real-id");
+  await client.products.create({ image_urls: ["https://cdn.example.com/chair.jpg"] });
 } catch (err) {
-  if (err instanceof NotFoundError) {
-    // ...
+  if (err instanceof AuthenticationError) {
+    // 401: missing or invalid key
+  } else if (err instanceof PaymentRequiredError) {
+    // 402: the plan does not allow this; err.details.reason says why
+  } else if (err instanceof ConflictError) {
+    // 409: e.g. a duplicate custom_id or a replayed resume_token
   } else if (err instanceof RateLimitError) {
-    console.log("retry after", err.retryAfter, "seconds");
-  } else {
-    throw err;
+    // 429: rate limited, or code "quota_exceeded" when credits run out
+  } else if (err instanceof ConnectionError) {
+    // the request never reached the API
+  } else if (err instanceof ViewriumError) {
+    console.log(err.status, err.code, err.message, err.details);
   }
 }
 ```
 
-All `ViewriumError` subclasses carry `.statusCode` and `.responseBody`.
-
-## Retries
-
-Requests retry automatically on `429` and `5xx` responses up to `maxRetries` times, using `Retry-After` when the server provides it and exponential backoff otherwise. Network errors also retry.
-
-## TypeScript
-
-Full types ship with the package. All response shapes (`Model`, `ApiKey`, `UsageSummary`, `TagSummary`, ...) and request params (`ModelCreateParams`, `ModelUpdateParams`, ...) are exported.
-
-## Custom `fetch`
-
-For testing or custom transports, pass your own `fetch`:
-
-```ts
-const viewrium = new Viewrium("sk_live_...", {
-  fetch: async (url, init) => {
-    // intercept, log, proxy, etc.
-    return globalThis.fetch(url, init);
-  },
-});
-```
+| HTTP | Error |
+|---|---|
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 402 | `PaymentRequiredError` |
+| 403 | `PermissionError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 422 | `UnprocessableEntityError` |
+| 429 | `RateLimitError` |
+| 5xx | `ServerError` |
+| none | `ConnectionError` |
+
+The SDK does not retry. On a `RateLimitError`, back off and retry with an exponential delay.
+
+## Links
+
+- [Quickstart](https://www.viewrium.com/docs/quickstart)
+- [JavaScript SDK reference](https://www.viewrium.com/docs/sdks/javascript)
+- [Webhooks](https://www.viewrium.com/docs/webhooks)
+- [API reference](https://www.viewrium.com/docs/api-reference)
+- Support: support@viewrium.com
 
 ## License
 
-Apache 2.0.
+Apache-2.0