@proveanything/smartlinks 2.0.45 → 2.0.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 2.0.45 | Generated: 2026-10-06T17:22:34.344Z
3
+ Version: 2.0.47 | Generated: 2026-10-08T12:38:10.855Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -8300,7 +8300,7 @@ interface QueryOrdersRequest {
8300
8300
  itemId: string
8301
8301
  }>
8302
8302
  metadata?: Record<string, any>
8303
- sortBy?: string
8303
+ sortBy?: 'createdAt' | 'updatedAt' | 'status' | 'orderRef' | 'customerId' | 'itemCount' | (string & {})
8304
8304
  sortOrder?: 'asc' | 'desc'
8305
8305
  }
8306
8306
  limit?: number // Optional: Max results (default: 100)
@@ -520,9 +520,27 @@ The mobile admin bundle has its own Vite config: `vite.config.mobile-admin.ts`.
520
520
  ```
521
521
  dist/mobile-admin.umd.js
522
522
  dist/mobile-admin.esm.js
523
- dist/mobile-admin.css (if needed)
523
+ dist/mobile-admin.css the screen's own scoped stylesheet — declare it as mobileAdmin.files.css
524
524
  ```
525
525
 
526
+ ### Styling
527
+
528
+ The component renders **inside Sidekick's page**, not an iframe. Sidekick already has a CSS reset and
529
+ its own styles, and loads your `mobileAdmin.files.css` alongside the bundle. Don't rely on Sidekick's
530
+ classes: they only cover what Sidekick itself uses. Ship your own stylesheet, and keep it to your screen:
531
+
532
+ - **No reset.** Build Tailwind's theme + utilities only (no preflight); Sidekick's reset is already there.
533
+ - **Scoped.** Prefix every rule with a wrapper class your component renders (the example uses
534
+ `.sl-mobile-admin`), and turn `:root` / `html` / `body` into that wrapper, so theme variables and
535
+ rules can't touch Sidekick's UI.
536
+ - **No cascade layers.** Tailwind 4 emits `@layer`; any unlayered rule on the page beats every layered
537
+ one, so unwrap the layers or Sidekick's own utilities win clashes inside your screen.
538
+
539
+ The example app does all three with a small PostCSS step in `vite.config.mobile-admin.ts`
540
+ (`scripts/scope-css.mjs`) over `src/mobile-admin/styles.css`, and shares its theme with the rest of the
541
+ app through `src/tokens.css`. Forge's preview loads the same file, so the screen looks the same there as
542
+ on a phone.
543
+
526
544
  ### Example `vite.config.mobile-admin.ts`
527
545
 
528
546
  ```typescript
package/dist/openapi.yaml CHANGED
@@ -28332,7 +28332,8 @@ components:
28332
28332
  type: object
28333
28333
  additionalProperties: true
28334
28334
  sortBy:
28335
- type: string
28335
+ type: object
28336
+ additionalProperties: true
28336
28337
  sortOrder:
28337
28338
  type: string
28338
28339
  enum:
@@ -201,7 +201,12 @@ export interface QueryOrdersRequest {
201
201
  itemId: string;
202
202
  }>;
203
203
  metadata?: Record<string, any>;
204
- sortBy?: string;
204
+ /**
205
+ * Sort field: `createdAt` (default), `updatedAt`, `status`, `orderRef`, `customerId` or `itemCount`
206
+ * (snake_case works too). Also accepts `"-updatedAt"` (descending) / `"+status"` (ascending) or
207
+ * `"status:asc,createdAt:desc"`. Any other field is a 400 listing the allowed ones.
208
+ */
209
+ sortBy?: 'createdAt' | 'updatedAt' | 'status' | 'orderRef' | 'customerId' | 'itemCount' | (string & {});
205
210
  sortOrder?: 'asc' | 'desc';
206
211
  };
207
212
  limit?: number;
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 2.0.45 | Generated: 2026-10-06T17:22:34.344Z
3
+ Version: 2.0.47 | Generated: 2026-10-08T12:38:10.855Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -8300,7 +8300,7 @@ interface QueryOrdersRequest {
8300
8300
  itemId: string
8301
8301
  }>
8302
8302
  metadata?: Record<string, any>
8303
- sortBy?: string
8303
+ sortBy?: 'createdAt' | 'updatedAt' | 'status' | 'orderRef' | 'customerId' | 'itemCount' | (string & {})
8304
8304
  sortOrder?: 'asc' | 'desc'
8305
8305
  }
8306
8306
  limit?: number // Optional: Max results (default: 100)
@@ -520,9 +520,27 @@ The mobile admin bundle has its own Vite config: `vite.config.mobile-admin.ts`.
520
520
  ```
521
521
  dist/mobile-admin.umd.js
522
522
  dist/mobile-admin.esm.js
523
- dist/mobile-admin.css (if needed)
523
+ dist/mobile-admin.css the screen's own scoped stylesheet — declare it as mobileAdmin.files.css
524
524
  ```
525
525
 
526
+ ### Styling
527
+
528
+ The component renders **inside Sidekick's page**, not an iframe. Sidekick already has a CSS reset and
529
+ its own styles, and loads your `mobileAdmin.files.css` alongside the bundle. Don't rely on Sidekick's
530
+ classes: they only cover what Sidekick itself uses. Ship your own stylesheet, and keep it to your screen:
531
+
532
+ - **No reset.** Build Tailwind's theme + utilities only (no preflight); Sidekick's reset is already there.
533
+ - **Scoped.** Prefix every rule with a wrapper class your component renders (the example uses
534
+ `.sl-mobile-admin`), and turn `:root` / `html` / `body` into that wrapper, so theme variables and
535
+ rules can't touch Sidekick's UI.
536
+ - **No cascade layers.** Tailwind 4 emits `@layer`; any unlayered rule on the page beats every layered
537
+ one, so unwrap the layers or Sidekick's own utilities win clashes inside your screen.
538
+
539
+ The example app does all three with a small PostCSS step in `vite.config.mobile-admin.ts`
540
+ (`scripts/scope-css.mjs`) over `src/mobile-admin/styles.css`, and shares its theme with the rest of the
541
+ app through `src/tokens.css`. Forge's preview loads the same file, so the screen looks the same there as
542
+ on a phone.
543
+
526
544
  ### Example `vite.config.mobile-admin.ts`
527
545
 
528
546
  ```typescript
package/openapi.yaml CHANGED
@@ -28332,7 +28332,8 @@ components:
28332
28332
  type: object
28333
28333
  additionalProperties: true
28334
28334
  sortBy:
28335
- type: string
28335
+ type: object
28336
+ additionalProperties: true
28336
28337
  sortOrder:
28337
28338
  type: string
28338
28339
  enum:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "2.0.45",
3
+ "version": "2.0.47",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",