@lessly/sdk-app 0.3.0 → 0.4.0

package/docs/recipes/sdk-usage.md

@@ -18,10 +18,14 @@ const sdk = createLesslyApp({
   // getCsrfToken defaults to reading the `lessly_csrf` cookie; override for SSR/tests.
 });
 
-const { domains } = await sdk.tracking.domains.list({ page: 1 });
-await sdk.tracking.domains.create({ host: 'links.example.com' });
+const connectors = await sdk.organization.connectors.list({ productId: 'prod_123' });
+await sdk.organization.product.create({ name: 'Acme' });
 ```
 
+> The exact namespaces you see depend on the live catalog — see
+> [Namespaces and subpath imports](#namespaces-and-subpath-imports). The calls
+> above use `organization`; substitute the namespace/resource you need.
+
 `productId` is the active product — read it from your `./App` props or the
 `X-Product-Id` header (see APP-005), never decoded from a token.
 
@@ -35,7 +39,7 @@ distinguish platform-defined failure reasons:
 import { LesslyApiError } from '@lessly/sdk-app';
 
 try {
-  await sdk.tracking.domains.create({ host: 'links.example.com' });
+  await sdk.organization.product.create({ name: 'Acme' });
 } catch (err) {
   if (err instanceof LesslyApiError) {
     if (err.status === 409) {
@@ -57,14 +61,14 @@ instance explicitly:
 // React example — works the same with any @tanstack/*-query adapter.
 import { useQuery, useMutation } from '@tanstack/react-query';
 import {
-  trackingDomainsListQueryOptions,
-  trackingDomainsCreateMutationOptions,
-} from '@lessly/sdk-app/tracking';
-
-function Domains() {
-  const { data } = useQuery(trackingDomainsListQueryOptions(sdk, { page: 1 }));
-  const create = useMutation(trackingDomainsCreateMutationOptions(sdk));
-  // create.mutate({ host: 'links.example.com' })
+  organizationConnectorsListQueryOptions,
+  organizationProductCreateMutationOptions,
+} from '@lessly/sdk-app/organization';
+
+function Connectors() {
+  const { data } = useQuery(organizationConnectorsListQueryOptions(sdk, { productId: 'prod_123' }));
+  const create = useMutation(organizationProductCreateMutationOptions(sdk));
+  // create.mutate({ name: 'Acme' })
 }
 ```
 
@@ -73,7 +77,7 @@ so they also work directly with `queryClient.ensureQueryData(...)` and friends
 — useful for prefetching outside a component, e.g. in a route loader:
 
 ```ts
-await queryClient.ensureQueryData(trackingDomainsListQueryOptions(sdk, { page: 1 }));
+await queryClient.ensureQueryData(organizationConnectorsListQueryOptions(sdk, { productId: 'prod_123' }));
 ```
 
 Prefer these factories over hand-rolling calls against `sdk.<namespace>...`
@@ -83,12 +87,18 @@ it automatically when you run `npm i @lessly/sdk-app@latest`.
 
 ## Namespaces and subpath imports
 
-The SDK is organized by namespace (`tracking`, `mail`, `playground`, ...). Call
-operations off `sdk.<namespace>.<resource>.<action>(...)`, and import that
+The SDK is organized by namespace (currently `organization` and `playground`).
+Call operations off `sdk.<namespace>.<resource>.<action>(...)`, and import that
 namespace's option factories from the matching subpath,
 `@lessly/sdk-app/<namespace>` — not the package root. This keeps each App's
 bundle limited to the namespaces it actually uses.
 
+The available namespaces track the live catalog and **grow as platform
+extensions migrate to `@lessly/tools`** — a namespace appears here only once its
+tools carry a REST binding. Run `npm i @lessly/sdk-app@latest` to pick up newly
+migrated namespaces. To see exactly what a given version exposes, check its
+subpaths in `package.json` `exports`, or the `manifest.gen.ts` namespace list.
+
 ## What not to do
 
 - Don't `fetch` a platform host directly, and don't use any other HTTP client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lessly/sdk-app",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "sideEffects": false,
   "engines": {
@@ -39,6 +39,11 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./deployment": {
+      "types": "./dist/deployment/index.d.ts",
+      "import": "./dist/deployment/index.js",
+      "require": "./dist/deployment/index.cjs"
+    },
     "./organization": {
       "types": "./dist/organization/index.d.ts",
       "import": "./dist/organization/index.js",
@@ -49,5 +54,6 @@
       "import": "./dist/playground/index.js",
       "require": "./dist/playground/index.cjs"
     }
-  }
+  },
+  "sdkContentHash": "sha256:11f8d92935d26f553961ebfbafc4c032fbab2060ab5ad9c22b353899cff359a5"
 }