@drttix/drt-sdk 1.4.10 → 1.5.0

package/README.md

@@ -1,84 +1,84 @@
-# DRT Public API
-
-A unified NPM package for typed API clients generated from OpenAPI specs.
-This package provides typed access to public services via `fetch`.
-
----
-
-## 📦 Installation
-
-```bash
-npm install @drttix/drt-sdk
-```
-
----
-
-## 📦 Usage
-
-```ts
-import { DRT } from "@drttix/drt-sdk";
-
-DRT.init({
-  shopperGuid: "your-shopper-guid",
-  accountId: "your-account-id",
-  apiKey: "your-api-key",
-});
-
-const theme = await DRT.shopper.account.getTheme();
-```
-
-### Backend serving many shoppers/accounts
-
-By default the SDK is a singleton: one shopperGuid/accountId for the whole
-process, set once via `DRT.init()`. A backend that proxies calls on behalf of
-many different shoppers can opt into `shopperScope: 'per-request'` instead,
-and pass `{ shopperGuid, accountId }` as the last argument to each shopper
-call:
-
-```ts
-import { DRT } from "@drttix/drt-sdk";
-
-DRT.init({ apiKey: "your-api-key", shopperScope: "per-request" });
-
-await DRT.shopper.product.addProduct(productBody, {
-  shopperGuid: req.shopperGuid,
-  accountId: req.accountId,
-});
-```
-
-`apiKey` is still set once at init — it identifies your backend, not the
-shopper. `shopperGuid`/`accountId` are the only values that become
-per-request. Portal and scanner are unaffected and remain singleton-scoped.
-
----
-
-## 🛠️ Local Development (Developer Only)
-
-For SDK contributors testing against a local API server:
-
-```ts
-// Option 1: Use localhost:3000
-process.env.DRT_API_LOCAL = "true";
-
-// Option 2: Use a custom base URL
-process.env.DRT_API_BASE_URL = "http://localhost:8080";
-
-import { DRT } from "@drttix/drt-sdk";
-```
-
-Or via command line:
-
-```bash
-# Use localhost:3000
-DRT_API_LOCAL=true npx tsx test.ts
-
-# Use custom base URL
-DRT_API_BASE_URL=http://localhost:8080 npx tsx test.ts
-```
-
----
-
-Npm run generate
-Npm login
-Increment package.lock version
-Npm publish
+# DRT Public API
+
+A unified NPM package for typed API clients generated from OpenAPI specs.
+This package provides typed access to public services via `fetch`.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @drttix/drt-sdk
+```
+
+---
+
+## 📦 Usage
+
+```ts
+import { DRT } from "@drttix/drt-sdk";
+
+DRT.init({
+  shopperGuid: "your-shopper-guid",
+  accountId: "your-account-id",
+  apiKey: "your-api-key",
+});
+
+const theme = await DRT.shopper.account.getTheme();
+```
+
+### Backend serving many shoppers/accounts
+
+By default the SDK is a singleton: one shopperGuid/accountId for the whole
+process, set once via `DRT.init()`. A backend that proxies calls on behalf of
+many different shoppers can opt into `shopperScope: 'per-request'` instead,
+and pass `{ shopperGuid, accountId }` as the last argument to each shopper
+call:
+
+```ts
+import { DRT } from "@drttix/drt-sdk";
+
+DRT.init({ apiKey: "your-api-key", shopperScope: "per-request" });
+
+await DRT.shopper.product.addProduct(productBody, {
+  shopperGuid: req.shopperGuid,
+  accountId: req.accountId,
+});
+```
+
+`apiKey` is still set once at init — it identifies your backend, not the
+shopper. `shopperGuid`/`accountId` are the only values that become
+per-request. Portal and scanner are unaffected and remain singleton-scoped.
+
+---
+
+## 🛠️ Local Development (Developer Only)
+
+For SDK contributors testing against a local API server:
+
+```ts
+// Option 1: Use localhost:3000
+process.env.DRT_API_LOCAL = "true";
+
+// Option 2: Use a custom base URL
+process.env.DRT_API_BASE_URL = "http://localhost:8080";
+
+import { DRT } from "@drttix/drt-sdk";
+```
+
+Or via command line:
+
+```bash
+# Use localhost:3000
+DRT_API_LOCAL=true npx tsx test.ts
+
+# Use custom base URL
+DRT_API_BASE_URL=http://localhost:8080 npx tsx test.ts
+```
+
+---
+
+Npm run generate
+Npm login
+Increment package.lock version
+Npm publish

package/azure-pipelines.yml

@@ -1,82 +1,82 @@
-trigger:
-    branches:
-        include:
-            - main
-            - master
-    tags:
-        include:
-            - v*
-
-variables:
-    - name: CLOUDFRONT_DISTRIBUTION_ID
-      value: 'E3QF4Y9HVWHQH5'
-
-steps:
-    - task: NodeTool@0
-      displayName: 'Install Node.js'
-      inputs:
-          versionSpec: '18.x'
-
-    - script: |
-          VERSION=$(node -p "require('./package.json').version")
-          echo "##vso[task.setvariable variable=VERSION]$VERSION"
-          echo "Building version: $VERSION"
-      displayName: 'Read version from package.json'
-
-    - task: AWSShellScript@1
-      displayName: 'Check if version already exists'
-      inputs:
-          awsCredentials: 'AWS'
-          regionName: 'us-east-1'
-          scriptType: 'inline'
-          inlineScript: |
-              if aws s3 ls s3://drt-public-assets/sdk/$(VERSION)/ 2>/dev/null; then
-                echo "ERROR: Version $(VERSION) already exists in S3!"
-                echo "Please increment the version in package.json before publishing."
-                exit 1
-              else
-                echo "Version $(VERSION) is new and can be published."
-              fi
-
-    - script: |
-          npm install
-          npm run build:bundle
-      displayName: 'Install dependencies and build bundle'
-
-    - task: AWSShellScript@1
-      displayName: 'Upload versioned bundle'
-      inputs:
-          awsCredentials: 'AWS'
-          regionName: 'us-east-1'
-          scriptType: 'inline'
-          inlineScript: |
-              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/drt-sdk.js s3://drt-public-assets/sdk/$(VERSION)/drt-sdk.js --cache-control "max-age=31536000,public,immutable"
-              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/staging.js s3://drt-public-assets/sdk/$(VERSION)/staging.js --cache-control "max-age=31536000,public,immutable"
-
-    - task: AWSShellScript@1
-      displayName: 'Upload to latest'
-      inputs:
-          awsCredentials: 'AWS'
-          regionName: 'us-east-1'
-          scriptType: 'inline'
-          inlineScript: |
-              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/drt-sdk.js s3://drt-public-assets/sdk/latest/drt-sdk.js --cache-control "max-age=0,no-cache,no-store,must-revalidate"
-              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/staging.js s3://drt-public-assets/sdk/latest/staging.js --cache-control "max-age=0,no-cache,no-store,must-revalidate"
-
-    - task: AWSShellScript@1
-      displayName: 'Upload demo files'
-      inputs:
-          awsCredentials: 'AWS'
-          regionName: 'us-east-1'
-          scriptType: 'inline'
-          inlineScript: |
-              aws s3 sync $(Build.SourcesDirectory)/demo s3://drt-public-assets/sdk/demo --exclude "*" --include "*.html" --delete --cache-control "max-age=0,no-cache,no-store,must-revalidate"
-
-    - task: AWSShellScript@1
-      displayName: 'Invalidate CloudFront cache'
-      inputs:
-          awsCredentials: 'AWS'
-          regionName: 'us-east-1'
-          scriptType: 'inline'
-          inlineScript: |
-              aws cloudfront create-invalidation --distribution-id $(CLOUDFRONT_DISTRIBUTION_ID) --paths "/public/sdk/latest/*" "/public/sdk/demo/*"
+trigger:
+    branches:
+        include:
+            - main
+            - master
+    tags:
+        include:
+            - v*
+
+variables:
+    - name: CLOUDFRONT_DISTRIBUTION_ID
+      value: 'E3QF4Y9HVWHQH5'
+
+steps:
+    - task: NodeTool@0
+      displayName: 'Install Node.js'
+      inputs:
+          versionSpec: '18.x'
+
+    - script: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "##vso[task.setvariable variable=VERSION]$VERSION"
+          echo "Building version: $VERSION"
+      displayName: 'Read version from package.json'
+
+    - task: AWSShellScript@1
+      displayName: 'Check if version already exists'
+      inputs:
+          awsCredentials: 'AWS'
+          regionName: 'us-east-1'
+          scriptType: 'inline'
+          inlineScript: |
+              if aws s3 ls s3://drt-public-assets/sdk/$(VERSION)/ 2>/dev/null; then
+                echo "ERROR: Version $(VERSION) already exists in S3!"
+                echo "Please increment the version in package.json before publishing."
+                exit 1
+              else
+                echo "Version $(VERSION) is new and can be published."
+              fi
+
+    - script: |
+          npm install
+          npm run build:bundle
+      displayName: 'Install dependencies and build bundle'
+
+    - task: AWSShellScript@1
+      displayName: 'Upload versioned bundle'
+      inputs:
+          awsCredentials: 'AWS'
+          regionName: 'us-east-1'
+          scriptType: 'inline'
+          inlineScript: |
+              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/drt-sdk.js s3://drt-public-assets/sdk/$(VERSION)/drt-sdk.js --cache-control "max-age=31536000,public,immutable"
+              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/staging.js s3://drt-public-assets/sdk/$(VERSION)/staging.js --cache-control "max-age=31536000,public,immutable"
+
+    - task: AWSShellScript@1
+      displayName: 'Upload to latest'
+      inputs:
+          awsCredentials: 'AWS'
+          regionName: 'us-east-1'
+          scriptType: 'inline'
+          inlineScript: |
+              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/drt-sdk.js s3://drt-public-assets/sdk/latest/drt-sdk.js --cache-control "max-age=0,no-cache,no-store,must-revalidate"
+              aws s3 cp $(Build.SourcesDirectory)/dist/bundle/staging.js s3://drt-public-assets/sdk/latest/staging.js --cache-control "max-age=0,no-cache,no-store,must-revalidate"
+
+    - task: AWSShellScript@1
+      displayName: 'Upload demo files'
+      inputs:
+          awsCredentials: 'AWS'
+          regionName: 'us-east-1'
+          scriptType: 'inline'
+          inlineScript: |
+              aws s3 sync $(Build.SourcesDirectory)/demo s3://drt-public-assets/sdk/demo --exclude "*" --include "*.html" --delete --cache-control "max-age=0,no-cache,no-store,must-revalidate"
+
+    - task: AWSShellScript@1
+      displayName: 'Invalidate CloudFront cache'
+      inputs:
+          awsCredentials: 'AWS'
+          regionName: 'us-east-1'
+          scriptType: 'inline'
+          inlineScript: |
+              aws cloudfront create-invalidation --distribution-id $(CLOUDFRONT_DISTRIBUTION_ID) --paths "/public/sdk/latest/*" "/public/sdk/demo/*"

package/demo/README.md

@@ -1,28 +1,28 @@
-Quick demo for DRT SDK (ESM files served from `dist/esm`)
-
-Files:
-
-- `default.html` — imports `dist/esm/index.js` without setting a base URL (uses PUBLIC_API by default)
-- `with-base.html` — sets `window.DRT_API_BASE_URL` before importing the SDK to demonstrate custom base
-
-How to run locally:
-
-From the project root, serve the repo with a static server (examples):
-
-```bash
-# using http-server (npm)
-npx http-server -c-1 -p 8080
-
-# or using Python 3
-python -m http.server 8080
-```
-
-Then open in your browser:
-
-- http://localhost:8080/demo/default.html
-- http://localhost:8080/demo/with-base.html
-
-Notes:
-
-- The demo relies on the built `dist/esm` tree produced by `npm run build`.
-- If you want a single-file bundle instead of hosting the ESM tree, I can produce an `iife`/UMD bundle with `esbuild` and a different demo HTML.
+Quick demo for DRT SDK (ESM files served from `dist/esm`)
+
+Files:
+
+- `default.html` — imports `dist/esm/index.js` without setting a base URL (uses PUBLIC_API by default)
+- `with-base.html` — sets `window.DRT_API_BASE_URL` before importing the SDK to demonstrate custom base
+
+How to run locally:
+
+From the project root, serve the repo with a static server (examples):
+
+```bash
+# using http-server (npm)
+npx http-server -c-1 -p 8080
+
+# or using Python 3
+python -m http.server 8080
+```
+
+Then open in your browser:
+
+- http://localhost:8080/demo/default.html
+- http://localhost:8080/demo/with-base.html
+
+Notes:
+
+- The demo relies on the built `dist/esm` tree produced by `npm run build`.
+- If you want a single-file bundle instead of hosting the ESM tree, I can produce an `iife`/UMD bundle with `esbuild` and a different demo HTML.

package/demo/default.html

@@ -1,35 +1,35 @@
-<!doctype html>
-<html>
-    <head>
-        <meta charset="utf-8" />
-        <title>DRT SDK Demo — Default (PUBLIC_API)</title>
-        <link rel="icon" href="data:," />
-    </head>
-    <body>
-        <h1>DRT SDK Demo — Default (PUBLIC_API)</h1>
-        <p>
-            Imports the ESM bundle without setting a base URL — should use
-            PUBLIC_API.
-        </p>
-        <pre id="output"></pre>
-
-        <script type="module">
-            import { DRT } from '/public/sdk/latest/drt-sdk.js';
-
-            const out = document.getElementById('output');
-
-            async function run() {
-                try {
-                    const strings =
-                        await DRT.scanner.scanning.appControllerGetStrings();
-                    out.textContent = JSON.stringify(strings, null, 2);
-                } catch (err) {
-                    console.error(err);
-                    out.textContent = `Request failed: ${err}`;
-                }
-            }
-
-            run();
-        </script>
-    </body>
-</html>
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8" />
+        <title>DRT SDK Demo — Default (PUBLIC_API)</title>
+        <link rel="icon" href="data:," />
+    </head>
+    <body>
+        <h1>DRT SDK Demo — Default (PUBLIC_API)</h1>
+        <p>
+            Imports the ESM bundle without setting a base URL — should use
+            PUBLIC_API.
+        </p>
+        <pre id="output"></pre>
+
+        <script type="module">
+            import { DRT } from '/public/sdk/latest/drt-sdk.js';
+
+            const out = document.getElementById('output');
+
+            async function run() {
+                try {
+                    const strings =
+                        await DRT.scanner.scanning.appControllerGetStrings();
+                    out.textContent = JSON.stringify(strings, null, 2);
+                } catch (err) {
+                    console.error(err);
+                    out.textContent = `Request failed: ${err}`;
+                }
+            }
+
+            run();
+        </script>
+    </body>
+</html>