@proveanything/smartlinks 1.4.4 → 1.4.5

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: 1.4.4 | Generated: 2026-02-20T22:46:39.365Z
3
+ Version: 1.4.5 | Generated: 2026-02-21T09:35:56.076Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -832,9 +832,20 @@ interface AppBundle {
832
832
  }
833
833
  ```
834
834
 
835
- **AppWidgetDefinition** (interface)
835
+ **AppManifestFiles** (interface)
836
836
  ```typescript
837
- interface AppWidgetDefinition {
837
+ interface AppManifestFiles {
838
+ js: {
839
+ umd: string;
840
+ esm?: string;
841
+ };
842
+ css?: string;
843
+ }
844
+ ```
845
+
846
+ **AppWidgetComponent** (interface)
847
+ ```typescript
848
+ interface AppWidgetComponent {
838
849
  name: string;
839
850
  description?: string;
840
851
  sizes?: Array<'compact' | 'standard' | 'large' | string>;
@@ -842,12 +853,13 @@ interface AppWidgetDefinition {
842
853
  required?: string[];
843
854
  optional?: string[];
844
855
  };
856
+ settings?: Record<string, any>;
845
857
  }
846
858
  ```
847
859
 
848
- **AppContainerDefinition** (interface)
860
+ **AppContainerComponent** (interface)
849
861
  ```typescript
850
- interface AppContainerDefinition {
862
+ interface AppContainerComponent {
851
863
  name: string;
852
864
  description?: string;
853
865
  props?: {
@@ -868,8 +880,17 @@ interface AppManifest {
868
880
  platformRevision?: string;
869
881
  appId: string;
870
882
  };
871
- widgets?: AppWidgetDefinition[];
872
- containers?: AppContainerDefinition[];
883
+ * Filename of the admin configuration JSON (e.g. "app.admin.json").
884
+ * Present when the app ships an admin UI config.
885
+ admin?: string;
886
+ widgets?: {
887
+ files: AppManifestFiles;
888
+ components: AppWidgetComponent[];
889
+ };
890
+ containers?: {
891
+ files: AppManifestFiles;
892
+ components: AppContainerComponent[];
893
+ };
873
894
  setup?: {
874
895
  description?: string;
875
896
  questions?: Array<{
@@ -934,6 +955,7 @@ interface CollectionAppWidget {
934
955
  manifest: AppManifest;
935
956
  widget: AppBundle;
936
957
  container: AppBundle | null;
958
+ admin: string | null;
937
959
  }
938
960
  ```
939
961
 
@@ -6,15 +6,15 @@
6
6
  * for inline content first and fall back to loading the URL.
7
7
  *
8
8
  * if (bundle.source) {
9
- * // inline JS create a Blob URL or inject directly
9
+ * // inline JS create a Blob URL or inject directly
10
10
  * } else if (bundle.js) {
11
11
  * // load from URL
12
12
  * }
13
13
  */
14
14
  export interface AppBundle {
15
- /** URL to the JavaScript file load if `source` is absent */
15
+ /** URL to the JavaScript file load if `source` is absent */
16
16
  js: string | null;
17
- /** URL to the CSS file load if `styles` is absent */
17
+ /** URL to the CSS file load if `styles` is absent */
18
18
  css: string | null;
19
19
  /** Inlined JavaScript source (present when server bundles it inline) */
20
20
  source?: string;
@@ -22,10 +22,20 @@ export interface AppBundle {
22
22
  styles?: string;
23
23
  }
24
24
  /**
25
- * A single widget defined in the manifest.
26
- * Presence of the `widgets` array means a widget bundle exists for this app.
25
+ * The files section inside a widgets or containers block.
27
26
  */
28
- export interface AppWidgetDefinition {
27
+ export interface AppManifestFiles {
28
+ js: {
29
+ /** UMD bundle � used for script-tag / dynamic loading */
30
+ umd: string;
31
+ /** ESM bundle � used for native ES module loading */
32
+ esm?: string;
33
+ };
34
+ /** CSS file � absent if the bundle ships no styles */
35
+ css?: string;
36
+ }
37
+ /** A single widget component defined in the manifest */
38
+ export interface AppWidgetComponent {
29
39
  name: string;
30
40
  description?: string;
31
41
  sizes?: Array<'compact' | 'standard' | 'large' | string>;
@@ -33,13 +43,11 @@ export interface AppWidgetDefinition {
33
43
  required?: string[];
34
44
  optional?: string[];
35
45
  };
46
+ /** JSON-Schema-style settings the widget accepts */
47
+ settings?: Record<string, any>;
36
48
  }
37
- /**
38
- * A single container defined in the manifest.
39
- * Presence of the `containers` array means a container bundle exists for this app.
40
- * Containers are full-page / embedded components (larger than widgets, no iframe needed).
41
- */
42
- export interface AppContainerDefinition {
49
+ /** A single container component defined in the manifest */
50
+ export interface AppContainerComponent {
43
51
  name: string;
44
52
  description?: string;
45
53
  props?: {
@@ -48,7 +56,7 @@ export interface AppContainerDefinition {
48
56
  };
49
57
  }
50
58
  /**
51
- * SmartLinks App Manifest the app.manifest.json structure.
59
+ * SmartLinks App Manifest the app.manifest.json structure.
52
60
  */
53
61
  export interface AppManifest {
54
62
  $schema?: string;
@@ -59,10 +67,21 @@ export interface AppManifest {
59
67
  platformRevision?: string;
60
68
  appId: string;
61
69
  };
62
- /** Presence means a widget bundle (widgets.umd.js / widgets.css) exists */
63
- widgets?: AppWidgetDefinition[];
64
- /** Presence means a container bundle (containers.umd.js / containers.css) exists */
65
- containers?: AppContainerDefinition[];
70
+ /**
71
+ * Filename of the admin configuration JSON (e.g. "app.admin.json").
72
+ * Present when the app ships an admin UI config.
73
+ */
74
+ admin?: string;
75
+ /** Widget bundle definition. Presence means a widget bundle exists for this app. */
76
+ widgets?: {
77
+ files: AppManifestFiles;
78
+ components: AppWidgetComponent[];
79
+ };
80
+ /** Container bundle definition. Presence means a container bundle exists. */
81
+ containers?: {
82
+ files: AppManifestFiles;
83
+ components: AppContainerComponent[];
84
+ };
66
85
  setup?: {
67
86
  description?: string;
68
87
  questions?: Array<{
@@ -133,10 +152,12 @@ export interface AppManifest {
133
152
  export interface CollectionAppWidget {
134
153
  appId: string;
135
154
  manifest: AppManifest;
136
- /** Widget bundle always present (apps without widgets are excluded from the response) */
155
+ /** Widget bundle always present (apps without widgets are excluded from the response) */
137
156
  widget: AppBundle;
138
- /** Container bundle null when the app has no containers */
157
+ /** Container bundle null when the app has no containers */
139
158
  container: AppBundle | null;
159
+ /** URL to the admin configuration JSON � null when the app has no admin config */
160
+ admin: string | null;
140
161
  }
141
162
  /**
142
163
  * Response from GET /api/v1/public/collection/:collectionId/widgets
@@ -1,6 +1,6 @@
1
1
  # Smartlinks API Summary
2
2
 
3
- Version: 1.4.4 | Generated: 2026-02-20T22:46:39.365Z
3
+ Version: 1.4.5 | Generated: 2026-02-21T09:35:56.076Z
4
4
 
5
5
  This is a concise summary of all available API functions and types.
6
6
 
@@ -832,9 +832,20 @@ interface AppBundle {
832
832
  }
833
833
  ```
834
834
 
835
- **AppWidgetDefinition** (interface)
835
+ **AppManifestFiles** (interface)
836
836
  ```typescript
837
- interface AppWidgetDefinition {
837
+ interface AppManifestFiles {
838
+ js: {
839
+ umd: string;
840
+ esm?: string;
841
+ };
842
+ css?: string;
843
+ }
844
+ ```
845
+
846
+ **AppWidgetComponent** (interface)
847
+ ```typescript
848
+ interface AppWidgetComponent {
838
849
  name: string;
839
850
  description?: string;
840
851
  sizes?: Array<'compact' | 'standard' | 'large' | string>;
@@ -842,12 +853,13 @@ interface AppWidgetDefinition {
842
853
  required?: string[];
843
854
  optional?: string[];
844
855
  };
856
+ settings?: Record<string, any>;
845
857
  }
846
858
  ```
847
859
 
848
- **AppContainerDefinition** (interface)
860
+ **AppContainerComponent** (interface)
849
861
  ```typescript
850
- interface AppContainerDefinition {
862
+ interface AppContainerComponent {
851
863
  name: string;
852
864
  description?: string;
853
865
  props?: {
@@ -868,8 +880,17 @@ interface AppManifest {
868
880
  platformRevision?: string;
869
881
  appId: string;
870
882
  };
871
- widgets?: AppWidgetDefinition[];
872
- containers?: AppContainerDefinition[];
883
+ * Filename of the admin configuration JSON (e.g. "app.admin.json").
884
+ * Present when the app ships an admin UI config.
885
+ admin?: string;
886
+ widgets?: {
887
+ files: AppManifestFiles;
888
+ components: AppWidgetComponent[];
889
+ };
890
+ containers?: {
891
+ files: AppManifestFiles;
892
+ components: AppContainerComponent[];
893
+ };
873
894
  setup?: {
874
895
  description?: string;
875
896
  questions?: Array<{
@@ -934,6 +955,7 @@ interface CollectionAppWidget {
934
955
  manifest: AppManifest;
935
956
  widget: AppBundle;
936
957
  container: AppBundle | null;
958
+ admin: string | null;
937
959
  }
938
960
  ```
939
961
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@proveanything/smartlinks",
3
- "version": "1.4.4",
3
+ "version": "1.4.5",
4
4
  "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",