@invoiceleaf/integration-sdk 1.0.0

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.
Files changed (50) hide show
  1. package/README.md +317 -0
  2. package/dist/context/IntegrationContext.d.ts +102 -0
  3. package/dist/context/IntegrationContext.d.ts.map +1 -0
  4. package/dist/context/IntegrationContext.js +2 -0
  5. package/dist/context/IntegrationContext.js.map +1 -0
  6. package/dist/context/index.d.ts +3 -0
  7. package/dist/context/index.d.ts.map +1 -0
  8. package/dist/context/index.js +3 -0
  9. package/dist/context/index.js.map +1 -0
  10. package/dist/context/types.d.ts +109 -0
  11. package/dist/context/types.d.ts.map +1 -0
  12. package/dist/context/types.js +5 -0
  13. package/dist/context/types.js.map +1 -0
  14. package/dist/helpers/defineHandler.d.ts +116 -0
  15. package/dist/helpers/defineHandler.d.ts.map +1 -0
  16. package/dist/helpers/defineHandler.js +42 -0
  17. package/dist/helpers/defineHandler.js.map +1 -0
  18. package/dist/helpers/defineIntegration.d.ts +32 -0
  19. package/dist/helpers/defineIntegration.d.ts.map +1 -0
  20. package/dist/helpers/defineIntegration.js +69 -0
  21. package/dist/helpers/defineIntegration.js.map +1 -0
  22. package/dist/index.d.ts +33 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +36 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/types/actions.d.ts +41 -0
  27. package/dist/types/actions.d.ts.map +1 -0
  28. package/dist/types/actions.js +2 -0
  29. package/dist/types/actions.js.map +1 -0
  30. package/dist/types/index.d.ts +6 -0
  31. package/dist/types/index.d.ts.map +1 -0
  32. package/dist/types/index.js +6 -0
  33. package/dist/types/index.js.map +1 -0
  34. package/dist/types/manifest.d.ts +71 -0
  35. package/dist/types/manifest.d.ts.map +1 -0
  36. package/dist/types/manifest.js +2 -0
  37. package/dist/types/manifest.js.map +1 -0
  38. package/dist/types/schema.d.ts +88 -0
  39. package/dist/types/schema.d.ts.map +1 -0
  40. package/dist/types/schema.js +2 -0
  41. package/dist/types/schema.js.map +1 -0
  42. package/dist/types/triggers.d.ts +54 -0
  43. package/dist/types/triggers.d.ts.map +1 -0
  44. package/dist/types/triggers.js +2 -0
  45. package/dist/types/triggers.js.map +1 -0
  46. package/dist/types/ui.d.ts +180 -0
  47. package/dist/types/ui.d.ts.map +1 -0
  48. package/dist/types/ui.js +2 -0
  49. package/dist/types/ui.js.map +1 -0
  50. package/package.json +54 -0
@@ -0,0 +1,180 @@
1
+ import type { JsonSchema } from './schema.js';
2
+ /**
3
+ * Page definition - defines custom UI pages.
4
+ */
5
+ export interface PageDefinition {
6
+ /** Unique identifier */
7
+ id: string;
8
+ /** Display name */
9
+ name: string;
10
+ /** Route path */
11
+ route: string;
12
+ /** Page title */
13
+ title?: string;
14
+ /** Page description */
15
+ description?: string;
16
+ /** Action ID to fetch page data */
17
+ dataSource?: string;
18
+ /** Page layout */
19
+ layout: PageLayout;
20
+ }
21
+ export interface PageLayout {
22
+ /** Layout type */
23
+ type: 'dashboard' | 'form' | 'table' | 'custom';
24
+ /** Number of grid columns */
25
+ columns?: number;
26
+ /** Widgets on the page */
27
+ widgets: Widget[];
28
+ }
29
+ /**
30
+ * Widget types for UI rendering.
31
+ */
32
+ export type Widget = MetricWidget | ChartWidget | TableWidget | FormWidget | ActionButtonWidget | TextWidget | AlertWidget;
33
+ export interface BaseWidget {
34
+ /** Unique identifier */
35
+ id?: string;
36
+ /** Widget type */
37
+ type: string;
38
+ /** Grid column span (CSS grid-column) */
39
+ gridColumn?: string;
40
+ /** Grid row span (CSS grid-row) */
41
+ gridRow?: string;
42
+ }
43
+ export interface MetricWidget extends BaseWidget {
44
+ type: 'metric';
45
+ /** Display title */
46
+ title?: string;
47
+ /** Value or data binding (e.g., "{{totalRevenue}}") */
48
+ value: string | number;
49
+ /** Value format */
50
+ format?: 'number' | 'currency' | 'percentage';
51
+ /** Currency code for currency format */
52
+ currency?: string;
53
+ /** Description text */
54
+ description?: string;
55
+ /** Icon (emoji or icon name) */
56
+ icon?: string;
57
+ /** Custom color */
58
+ color?: string;
59
+ /** Trend indicator */
60
+ trend?: {
61
+ direction: 'up' | 'down' | 'neutral';
62
+ value?: number;
63
+ label?: string;
64
+ };
65
+ }
66
+ export interface ChartWidget extends BaseWidget {
67
+ type: 'chart';
68
+ /** Display title */
69
+ title?: string;
70
+ /** Description */
71
+ description?: string;
72
+ /** Chart type */
73
+ chartType: 'line' | 'bar' | 'pie' | 'donut' | 'area';
74
+ /** Data source binding */
75
+ dataSource: string;
76
+ /** X-axis field */
77
+ xField?: string;
78
+ /** Y-axis field */
79
+ yField?: string;
80
+ /** Data series configuration */
81
+ series?: ChartSeries[];
82
+ }
83
+ export interface ChartSeries {
84
+ /** Data key */
85
+ dataKey: string;
86
+ /** Display name */
87
+ name?: string;
88
+ /** Series color */
89
+ color?: string;
90
+ }
91
+ export interface TableWidget extends BaseWidget {
92
+ type: 'table';
93
+ /** Display title */
94
+ title?: string;
95
+ /** Description */
96
+ description?: string;
97
+ /** Data source binding */
98
+ dataSource: string;
99
+ /** Column definitions */
100
+ columns?: TableColumn[];
101
+ /** Enable search */
102
+ search?: boolean;
103
+ /** Enable pagination */
104
+ pagination?: boolean;
105
+ /** Row actions */
106
+ actions?: TableAction[];
107
+ }
108
+ export interface TableColumn {
109
+ /** Data key */
110
+ key?: string;
111
+ /** Display label */
112
+ label?: string;
113
+ /** Value format */
114
+ format?: 'text' | 'number' | 'currency' | 'date' | 'datetime' | 'percentage';
115
+ /** Enable sorting */
116
+ sortable?: boolean;
117
+ /** Column width */
118
+ width?: string;
119
+ }
120
+ export interface TableAction {
121
+ /** Action ID */
122
+ id: string;
123
+ /** Display label */
124
+ label: string;
125
+ /** Icon */
126
+ icon?: string;
127
+ /** Confirmation message */
128
+ confirmMessage?: string;
129
+ }
130
+ export interface FormWidget extends BaseWidget {
131
+ type: 'form';
132
+ /** Display title */
133
+ title?: string;
134
+ /** Description */
135
+ description?: string;
136
+ /** Form schema (JSON Schema) */
137
+ schema?: JsonSchema;
138
+ /** Submit action ID */
139
+ submitAction?: string;
140
+ /** Submit button label */
141
+ submitLabel?: string;
142
+ }
143
+ export interface ActionButtonWidget extends BaseWidget {
144
+ type: 'actionButton';
145
+ /** Button label */
146
+ label: string;
147
+ /** Action ID to trigger */
148
+ actionId: string;
149
+ /** Button variant */
150
+ variant?: 'primary' | 'secondary' | 'danger' | 'outline';
151
+ /** Icon */
152
+ icon?: string;
153
+ /** Description */
154
+ description?: string;
155
+ /** Confirmation message */
156
+ confirmMessage?: string;
157
+ /** Disabled state */
158
+ disabled?: boolean;
159
+ }
160
+ export interface TextWidget extends BaseWidget {
161
+ type: 'text';
162
+ /** Display title */
163
+ title?: string;
164
+ /** Text content or data binding */
165
+ content: string;
166
+ /** Content format */
167
+ format?: 'plain' | 'markdown';
168
+ }
169
+ export interface AlertWidget extends BaseWidget {
170
+ type: 'alert';
171
+ /** Alert type */
172
+ alertType: 'info' | 'success' | 'warning' | 'error';
173
+ /** Alert title */
174
+ title?: string;
175
+ /** Alert message */
176
+ message: string;
177
+ /** Dismissible */
178
+ dismissible?: boolean;
179
+ }
180
+ //# sourceMappingURL=ui.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../src/types/ui.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IAEd,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,kBAAkB;IAClB,MAAM,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,kBAAkB;IAClB,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAEhD,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,YAAY,GACZ,WAAW,GACX,WAAW,GACX,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,WAAW,UAAU;IACzB,wBAAwB;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,QAAQ,CAAC;IAEf,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,uDAAuD;IACvD,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB,mBAAmB;IACnB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,YAAY,CAAC;IAE9C,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,sBAAsB;IACtB,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,OAAO,CAAC;IAEd,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iBAAiB;IACjB,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAErD,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IAEnB,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gCAAgC;IAChC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAEhB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,OAAO,CAAC;IAEd,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IAEnB,yBAAyB;IACzB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IAExB,oBAAoB;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,wBAAwB;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,kBAAkB;IAClB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;IAE7E,qBAAqB;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAC;IAEX,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,2BAA2B;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,IAAI,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gCAAgC;IAChC,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,uBAAuB;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,cAAc,CAAC;IAErB,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IAEd,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IAEjB,qBAAqB;IACrB,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEzD,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,2BAA2B;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,IAAI,EAAE,MAAM,CAAC;IAEb,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,qBAAqB;IACrB,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,OAAO,CAAC;IAEd,iBAAiB;IACjB,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;IAEpD,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,kBAAkB;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ui.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ui.js","sourceRoot":"","sources":["../../src/types/ui.ts"],"names":[],"mappings":""}
package/package.json ADDED
@@ -0,0 +1,54 @@
1
+ {
2
+ "name": "@invoiceleaf/integration-sdk",
3
+ "version": "1.0.0",
4
+ "description": "SDK for building InvoiceLeaf integrations",
5
+ "keywords": [
6
+ "invoiceleaf",
7
+ "integration",
8
+ "sdk",
9
+ "plugin"
10
+ ],
11
+ "license": "MIT",
12
+ "author": "InvoiceLeaf <support@invoiceleaf.com>",
13
+ "homepage": "https://docs.invoiceleaf.com/integrations",
14
+ "repository": {
15
+ "type": "git",
16
+ "url": "git+https://github.com/invoiceleaf/integration-sdk.git"
17
+ },
18
+ "type": "module",
19
+ "main": "./dist/index.js",
20
+ "module": "./dist/index.js",
21
+ "types": "./dist/index.d.ts",
22
+ "exports": {
23
+ ".": {
24
+ "types": "./dist/index.d.ts",
25
+ "import": "./dist/index.js"
26
+ },
27
+ "./types": {
28
+ "types": "./dist/types/index.d.ts",
29
+ "import": "./dist/types/index.js"
30
+ }
31
+ },
32
+ "files": [
33
+ "dist",
34
+ "README.md"
35
+ ],
36
+ "scripts": {
37
+ "build": "tsc",
38
+ "dev": "tsc --watch",
39
+ "prepublishOnly": "npm run build",
40
+ "lint": "eslint src --ext .ts",
41
+ "typecheck": "tsc --noEmit"
42
+ },
43
+ "devDependencies": {
44
+ "@types/node": "^20.11.0",
45
+ "eslint": "^8.56.0",
46
+ "@typescript-eslint/eslint-plugin": "^7.0.0",
47
+ "@typescript-eslint/parser": "^7.0.0",
48
+ "typescript": "^5.3.3"
49
+ },
50
+ "peerDependencies": {},
51
+ "engines": {
52
+ "node": ">=18.0.0"
53
+ }
54
+ }