@rippling/rippling-sdk 0.2.0-alpha.43 → 0.2.0-alpha.44
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.
- package/examples/manifest/dental-practice-management/dental-practice-management.ts +109 -52
- package/examples/manifest/dental-practice-management/manifest.json +83 -25
- package/examples/manifest/gym-membership-management/gym-membership-management.ts +107 -102
- package/examples/manifest/gym-membership-management/manifest.json +64 -32
- package/lib/manifest/_helpers.d.mts +4 -5
- package/lib/manifest/_helpers.d.mts.map +1 -1
- package/lib/manifest/_helpers.d.ts +4 -5
- package/lib/manifest/_helpers.d.ts.map +1 -1
- package/lib/manifest/_helpers.js.map +1 -1
- package/lib/manifest/_helpers.mjs.map +1 -1
- package/lib/manifest/app.d.mts +8 -13
- package/lib/manifest/app.d.mts.map +1 -1
- package/lib/manifest/app.d.ts +8 -13
- package/lib/manifest/app.d.ts.map +1 -1
- package/lib/manifest/app.js +13 -22
- package/lib/manifest/app.js.map +1 -1
- package/lib/manifest/app.mjs +13 -22
- package/lib/manifest/app.mjs.map +1 -1
- package/lib/manifest/sdui-page.d.mts +6 -1
- package/lib/manifest/sdui-page.d.mts.map +1 -1
- package/lib/manifest/sdui-page.d.ts +6 -1
- package/lib/manifest/sdui-page.d.ts.map +1 -1
- package/lib/manifest/sdui-page.js +6 -1
- package/lib/manifest/sdui-page.js.map +1 -1
- package/lib/manifest/sdui-page.mjs +6 -1
- package/lib/manifest/sdui-page.mjs.map +1 -1
- package/package.json +1 -1
- package/src/lib/manifest/_helpers.ts +4 -5
- package/src/lib/manifest/app.ts +18 -27
- package/src/lib/manifest/sdui-page.ts +6 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdui-page.js","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AAG9G,gFAA2E;AAiC3E
|
|
1
|
+
{"version":3,"file":"sdui-page.js","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AAG9G,gFAA2E;AAiC3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAOD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,IAAA,wDAA2B,EACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;SAC3C,CAAC;QACF,IAAI,SAAS,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3C,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;;AA9FH,4BA+FC;AA9FiB,sBAAa,GAAG,WAAoB,CAAC"}
|
|
@@ -15,11 +15,16 @@ import { requireStringComponentField } from "./_existing-component-fields.mjs";
|
|
|
15
15
|
* function: todayScheduleFn,
|
|
16
16
|
* description: 'SDUI list of class sessions for front desk',
|
|
17
17
|
* });
|
|
18
|
+
* const memberListPage = new SduiPage(manifest, {
|
|
19
|
+
* sduiPageId: 'gym_members',
|
|
20
|
+
* name: 'Members',
|
|
21
|
+
* function: memberListFn,
|
|
22
|
+
* });
|
|
18
23
|
*
|
|
19
24
|
* new App(manifest, {
|
|
20
25
|
* apiName: 'gym_membership_management_app',
|
|
21
26
|
* name: 'Gym Membership Management',
|
|
22
|
-
* pages: [
|
|
27
|
+
* pages: [memberListPage, todaySchedulePage],
|
|
23
28
|
* });
|
|
24
29
|
* ```
|
|
25
30
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdui-page.mjs","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"OAAO,EAAE,0BAA0B,EAAuC;OAGnE,EAAE,2BAA2B,EAAE;AAiCtC
|
|
1
|
+
{"version":3,"file":"sdui-page.mjs","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"OAAO,EAAE,0BAA0B,EAAuC;OAGnE,EAAE,2BAA2B,EAAE;AAiCtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAOD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,2BAA2B,CACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,2BAA2B,CAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;SAC3C,CAAC;QACF,IAAI,SAAS,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3C,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;;AA7Fe,sBAAa,GAAG,WAAoB,CAAC"}
|
package/package.json
CHANGED
|
@@ -80,12 +80,11 @@ export type FormulaFieldType = 'TEXT' | 'NUMBER' | 'BOOLEAN' | 'CURRENCY' | 'PER
|
|
|
80
80
|
export type FunctionRuntime = 'cloudflare-js' | 'lambda-deno' | 'lambda-python';
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* Page type inside CUSTOM_APP.
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* wrap a function in an SDUI page instead.
|
|
83
|
+
* Page type emitted inside CUSTOM_APP pages. Apps authored through the manifest
|
|
84
|
+
* SDK expose SDUI page tabs only; wrap custom-object records in an SDUI
|
|
85
|
+
* ObjectListView when you need an object-backed page.
|
|
87
86
|
*/
|
|
88
|
-
export type PageType = '
|
|
87
|
+
export type PageType = 'sdui_page';
|
|
89
88
|
|
|
90
89
|
// ---------------------------------------------------------------------------
|
|
91
90
|
// Summary-field constants (for Field.summary)
|
package/src/lib/manifest/app.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { CustomObject } from './custom-object';
|
|
2
1
|
import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
|
|
3
2
|
import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
|
|
4
3
|
import { SduiPage } from './sdui-page';
|
|
@@ -7,10 +6,10 @@ import { requireStringComponentField } from './_existing-component-fields';
|
|
|
7
6
|
/**
|
|
8
7
|
* A single page entry in an {@link App}.
|
|
9
8
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* Apps host SDUI page tabs. To show custom-object records, create an
|
|
10
|
+
* {@link SduiPage} that renders an SDUI `ObjectListView` for that object.
|
|
12
11
|
*/
|
|
13
|
-
export type AppPage =
|
|
12
|
+
export type AppPage = SduiPage;
|
|
14
13
|
|
|
15
14
|
/**
|
|
16
15
|
* S3 icon reference for an {@link App}.
|
|
@@ -57,9 +56,7 @@ export interface AppProps {
|
|
|
57
56
|
*/
|
|
58
57
|
icon?: AppIcon;
|
|
59
58
|
/**
|
|
60
|
-
*
|
|
61
|
-
* tabs and {@link SduiPage} instances for custom SDUI surfaces. Tab order matches
|
|
62
|
-
* the array order.
|
|
59
|
+
* SDUI pages shown as tabs in the app. Tab order matches the array order.
|
|
63
60
|
*
|
|
64
61
|
* Optional. @default `[]`
|
|
65
62
|
*/
|
|
@@ -67,21 +64,17 @@ export interface AppProps {
|
|
|
67
64
|
}
|
|
68
65
|
|
|
69
66
|
function resolvePage(entry: AppPage): Record<string, any> {
|
|
70
|
-
if (entry instanceof
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
page_type: 'object_page',
|
|
75
|
-
object_rql_name: apiName,
|
|
76
|
-
};
|
|
77
|
-
} else {
|
|
78
|
-
const sduiPageId = entry.getSduiPageId();
|
|
79
|
-
return {
|
|
80
|
-
api_name: sduiPageId,
|
|
81
|
-
page_type: 'sdui_page',
|
|
82
|
-
sdui_page_id: sduiPageId,
|
|
83
|
-
};
|
|
67
|
+
if (!(entry instanceof SduiPage)) {
|
|
68
|
+
throw new Error(
|
|
69
|
+
'App pages must be SduiPage instances. To show a custom object, create an SDUI page that renders ObjectListView.',
|
|
70
|
+
);
|
|
84
71
|
}
|
|
72
|
+
const sduiPageId = entry.getSduiPageId();
|
|
73
|
+
return {
|
|
74
|
+
api_name: sduiPageId,
|
|
75
|
+
page_type: 'sdui_page',
|
|
76
|
+
sdui_page_id: sduiPageId,
|
|
77
|
+
};
|
|
85
78
|
}
|
|
86
79
|
|
|
87
80
|
function cloneJson<T>(value: T): T {
|
|
@@ -92,10 +85,9 @@ function cloneJson<T>(value: T): T {
|
|
|
92
85
|
/**
|
|
93
86
|
* Defines a Rippling app and registers it with the manifest.
|
|
94
87
|
*
|
|
95
|
-
* An app is the top-level navigation container. It groups one or more pages
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* functions, and SDUI pages have been declared.
|
|
88
|
+
* An app is the top-level navigation container. It groups one or more SDUI pages
|
|
89
|
+
* as tabs visible to users. You would normally define the app last in your
|
|
90
|
+
* manifest file, after all objects, functions, and SDUI pages have been declared.
|
|
99
91
|
*
|
|
100
92
|
* @example
|
|
101
93
|
* ```ts
|
|
@@ -104,11 +96,10 @@ function cloneJson<T>(value: T): T {
|
|
|
104
96
|
* name: 'Gym Membership Management',
|
|
105
97
|
* description: 'Members, trainers, schedules, and check-in',
|
|
106
98
|
* appType: 'custom',
|
|
107
|
-
* pages: [
|
|
99
|
+
* pages: [memberListPage, trainerListPage, todaySchedulePage, checkInDeskPage],
|
|
108
100
|
* });
|
|
109
101
|
* ```
|
|
110
102
|
*
|
|
111
|
-
* @see {@link CustomObject} — object-page tab source.
|
|
112
103
|
* @see {@link SduiPage} — SDUI surface tab source.
|
|
113
104
|
*/
|
|
114
105
|
export class App {
|
|
@@ -49,11 +49,16 @@ export interface SduiPageProps {
|
|
|
49
49
|
* function: todayScheduleFn,
|
|
50
50
|
* description: 'SDUI list of class sessions for front desk',
|
|
51
51
|
* });
|
|
52
|
+
* const memberListPage = new SduiPage(manifest, {
|
|
53
|
+
* sduiPageId: 'gym_members',
|
|
54
|
+
* name: 'Members',
|
|
55
|
+
* function: memberListFn,
|
|
56
|
+
* });
|
|
52
57
|
*
|
|
53
58
|
* new App(manifest, {
|
|
54
59
|
* apiName: 'gym_membership_management_app',
|
|
55
60
|
* name: 'Gym Membership Management',
|
|
56
|
-
* pages: [
|
|
61
|
+
* pages: [memberListPage, todaySchedulePage],
|
|
57
62
|
* });
|
|
58
63
|
* ```
|
|
59
64
|
*
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.2.0-alpha.
|
|
1
|
+
export const VERSION = '0.2.0-alpha.44'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.2.0-alpha.
|
|
1
|
+
export declare const VERSION = "0.2.0-alpha.44";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.2.0-alpha.
|
|
1
|
+
export declare const VERSION = "0.2.0-alpha.44";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.VERSION = void 0;
|
|
4
|
-
exports.VERSION = '0.2.0-alpha.
|
|
4
|
+
exports.VERSION = '0.2.0-alpha.44'; // x-release-please-version
|
|
5
5
|
//# sourceMappingURL=version.js.map
|
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.2.0-alpha.
|
|
1
|
+
export const VERSION = '0.2.0-alpha.44'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|