mindoodb-app-sdk 0.0.6 → 0.0.7
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/README.md
CHANGED
|
@@ -57,7 +57,7 @@ npm install mindoodb-app-sdk
|
|
|
57
57
|
The fastest way to start building is to clone the **example app**, run it locally, and connect it to Haven:
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
git clone https://github.com/
|
|
60
|
+
git clone https://github.com/klehmann/mindoodb-app-example.git
|
|
61
61
|
cd mindoodb-app-example
|
|
62
62
|
npm install
|
|
63
63
|
npm run dev:local
|
|
@@ -73,9 +73,9 @@ Then, in Haven:
|
|
|
73
73
|
|
|
74
74
|
From here, **fork or duplicate** the example project to start building your own app while exploring the platform in a running Haven client.
|
|
75
75
|
|
|
76
|
-
The example app is also deployed at **https://
|
|
76
|
+
The example app is also deployed at **https://app-example.mindoodb.com** so you can register it in Haven without running anything locally.
|
|
77
77
|
|
|
78
|
-
> See the [mindoodb-app-example README](https://github.com/
|
|
78
|
+
> See the [mindoodb-app-example README](https://github.com/klehmann/mindoodb-app-example) for the full project walkthrough.
|
|
79
79
|
|
|
80
80
|
## Quick start (from scratch)
|
|
81
81
|
|
|
@@ -494,7 +494,7 @@ See [`TESTING.md`](./TESTING.md) for setup instructions and Vitest examples.
|
|
|
494
494
|
|
|
495
495
|
MindooDB Apps are standard web applications -- deploy them anywhere you can serve static files.
|
|
496
496
|
|
|
497
|
-
**Cloudflare Pages / Workers** is one of the easiest options. The [example app](https://github.com/
|
|
497
|
+
**Cloudflare Pages / Workers** is one of the easiest options. The [example app](https://github.com/klehmann/mindoodb-app-example) is deployed this way at https://app-example.mindoodb.com using a simple `wrangler.jsonc` configuration:
|
|
498
498
|
|
|
499
499
|
```bash
|
|
500
500
|
npm run build
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { M as MindooDBAppAttachmentPreviewMode, a as MindooDBAppBridge } from './types-
|
|
2
|
-
export { b as MindooDBAppAttachmentApi, c as MindooDBAppAttachmentChunk, d as MindooDBAppAttachmentInfo, e as MindooDBAppAttachmentPreviewOptions, f as
|
|
1
|
+
import { M as MindooDBAppAttachmentPreviewMode, a as MindooDBAppBridge } from './types-u5bAeQwY.js';
|
|
2
|
+
export { b as MindooDBAppAttachmentApi, c as MindooDBAppAttachmentChunk, d as MindooDBAppAttachmentInfo, e as MindooDBAppAttachmentPreviewOptions, f as MindooDBAppAttachmentPreviewSession, g as MindooDBAppBridgeConnectMessage, h as MindooDBAppBridgeConnectOptions, i as MindooDBAppBridgeConnectedMessage, j as MindooDBAppBridgeErrorPayload, k as MindooDBAppBridgePortMessage, l as MindooDBAppBridgeRpcError, m as MindooDBAppBridgeRpcMessage, n as MindooDBAppBridgeRpcRequest, o as MindooDBAppBridgeRpcSuccess, p as MindooDBAppBridgeStreamAbortRequest, q as MindooDBAppBridgeStreamAck, r as MindooDBAppBridgeStreamCloseRequest, s as MindooDBAppBridgeStreamError, t as MindooDBAppBridgeStreamMessage, u as MindooDBAppBridgeStreamOpenResult, v as MindooDBAppBridgeStreamReadRequest, w as MindooDBAppBridgeStreamWriteRequest, x as MindooDBAppBridgeThemeChangedMessage, y as MindooDBAppBridgeViewportChangedMessage, z as MindooDBAppCapability, A as MindooDBAppConfiguredViewCategorizationStyle, B as MindooDBAppConfiguredViewColumn, C as MindooDBAppConfiguredViewColumnRole, D as MindooDBAppConfiguredViewExpressionMode, E as MindooDBAppConfiguredViewFieldExpression, F as MindooDBAppConfiguredViewFilterDefinition, G as MindooDBAppConfiguredViewFilterMode, H as MindooDBAppConfiguredViewFilterRule, I as MindooDBAppConfiguredViewFormulaExpression, J as MindooDBAppConfiguredViewFormulaFilterDefinition, K as MindooDBAppConfiguredViewPreviewMode, L as MindooDBAppConfiguredViewRuleFilterDefinition, N as MindooDBAppConfiguredViewRuleMatchMode, O as MindooDBAppConfiguredViewRuleOperator, P as MindooDBAppConfiguredViewValueExpression, Q as MindooDBAppCreateDocumentInput, R as MindooDBAppCreateViewInput, S as MindooDBAppDatabase, T as MindooDBAppDatabaseInfo, U as MindooDBAppDocument, V as MindooDBAppDocumentApi, W as MindooDBAppDocumentHistoryEntry, X as MindooDBAppDocumentListQuery, Y as MindooDBAppDocumentListResult, Z as MindooDBAppDocumentSummary, _ as MindooDBAppHistoricalDocument, $ as MindooDBAppHistoryQuery, a0 as MindooDBAppHostTheme, a1 as MindooDBAppLaunchContext, a2 as MindooDBAppReadableAttachmentStream, a3 as MindooDBAppResolvedViewDefinition, a4 as MindooDBAppResolvedViewSource, a5 as MindooDBAppRuntime, a6 as MindooDBAppSession, a7 as MindooDBAppThemeMode, a8 as MindooDBAppUpdateDocumentInput, a9 as MindooDBAppViewHandle, aa as MindooDBAppViewport, ab as MindooDBAppWritableAttachmentStream } from './types-u5bAeQwY.js';
|
|
3
3
|
export { MindooDBAppBooleanExpression, MindooDBAppExpression, MindooDBAppFilterDefinition, MindooDBAppViewCategoryChildrenPageRequest, MindooDBAppViewColumn, MindooDBAppViewColumnRole, MindooDBAppViewDefinition, MindooDBAppViewExpansionState, MindooDBAppViewExpressionBase, MindooDBAppViewExpressionDatePart, MindooDBAppViewExpressionOperation, MindooDBAppViewFieldExpression, MindooDBAppViewIfExpression, MindooDBAppViewLetExpression, MindooDBAppViewLiteralExpression, MindooDBAppViewLookupByPath, MindooDBAppViewOperationExpression, MindooDBAppViewOriginExpression, MindooDBAppViewPageRequest, MindooDBAppViewPageResult, MindooDBAppViewRow, MindooDBAppViewSortDirection, MindooDBAppViewTotalMode, MindooDBAppViewValueExpressionRef, MindooDBAppViewVariableExpression, createViewLanguage } from 'mindoodb-view-language';
|
|
4
4
|
|
|
5
5
|
/**
|
package/dist/index.js
CHANGED
|
@@ -607,6 +607,12 @@ var MindooDBAppDatabaseImpl = class {
|
|
|
607
607
|
});
|
|
608
608
|
return new MindooDBAppWritableAttachmentStreamImpl(this.rpc, result.streamId);
|
|
609
609
|
},
|
|
610
|
+
preparePreviewSession: async (docId, attachmentName, options) => await this.rpc.call("attachments.preparePreviewSession", {
|
|
611
|
+
databaseId: this.databaseId,
|
|
612
|
+
docId,
|
|
613
|
+
attachmentName,
|
|
614
|
+
timestamp: options?.timestamp
|
|
615
|
+
}),
|
|
610
616
|
openPreview: async (docId, attachmentName, options) => await this.rpc.call("attachments.openPreview", {
|
|
611
617
|
databaseId: this.databaseId,
|
|
612
618
|
docId,
|
package/dist/testing/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { a1 as MindooDBAppLaunchContext, T as MindooDBAppDatabaseInfo, V as MindooDBAppDocumentApi, a9 as MindooDBAppViewHandle, b as MindooDBAppAttachmentApi, a as MindooDBAppBridge, a6 as MindooDBAppSession, n as MindooDBAppBridgeRpcRequest, a0 as MindooDBAppHostTheme, aa as MindooDBAppViewport, k as MindooDBAppBridgePortMessage } from '../types-u5bAeQwY.js';
|
|
2
2
|
import { MindooDBAppViewDefinition } from 'mindoodb-view-language';
|
|
3
3
|
|
|
4
4
|
type MaybePromise<T> = T | Promise<T>;
|
package/dist/testing/index.js
CHANGED
|
@@ -361,6 +361,12 @@ function createDatabaseHandle(definition) {
|
|
|
361
361
|
async openWriteStream(_docId, _attachmentName, _contentType) {
|
|
362
362
|
return createDefaultWritableAttachmentStream();
|
|
363
363
|
},
|
|
364
|
+
async preparePreviewSession(_docId, _attachmentName, _options) {
|
|
365
|
+
return {
|
|
366
|
+
sessionId: "preview-session-1",
|
|
367
|
+
previewUrl: "about:blank"
|
|
368
|
+
};
|
|
369
|
+
},
|
|
364
370
|
async openPreview(_docId, _attachmentName, _options) {
|
|
365
371
|
return { ok: true };
|
|
366
372
|
}
|
|
@@ -745,6 +751,12 @@ function createFakeBridgeHost(options = {}) {
|
|
|
745
751
|
String(params.attachmentName),
|
|
746
752
|
typeof params.timestamp === "number" ? { timestamp: params.timestamp } : void 0
|
|
747
753
|
);
|
|
754
|
+
case "attachments.preparePreviewSession":
|
|
755
|
+
return await state.getDatabase(String(params.databaseId)).attachments.preparePreviewSession(
|
|
756
|
+
String(params.docId),
|
|
757
|
+
String(params.attachmentName),
|
|
758
|
+
typeof params.timestamp === "number" ? { timestamp: params.timestamp } : void 0
|
|
759
|
+
);
|
|
748
760
|
case "views.getDefinition":
|
|
749
761
|
return await (await resolveViewHandle(String(params.viewId))).getDefinition();
|
|
750
762
|
case "views.refresh":
|
|
@@ -126,6 +126,11 @@ interface MindooDBAppAttachmentPreviewOptions {
|
|
|
126
126
|
/** Historical snapshot timestamp previously obtained from `documents.history.getAtTimestamp()`. */
|
|
127
127
|
timestamp?: number;
|
|
128
128
|
}
|
|
129
|
+
/** Resolved Haven preview session prepared for opening in a separate tab or window. */
|
|
130
|
+
interface MindooDBAppAttachmentPreviewSession {
|
|
131
|
+
sessionId: string;
|
|
132
|
+
previewUrl: string;
|
|
133
|
+
}
|
|
129
134
|
/** Database entry visible to the app during launch and database listing. */
|
|
130
135
|
interface MindooDBAppDatabaseInfo {
|
|
131
136
|
id: string;
|
|
@@ -361,6 +366,7 @@ interface MindooDBAppAttachmentApi {
|
|
|
361
366
|
}>;
|
|
362
367
|
openReadStream(docId: string, attachmentName: string): Promise<MindooDBAppReadableAttachmentStream>;
|
|
363
368
|
openWriteStream(docId: string, attachmentName: string, contentType?: string): Promise<MindooDBAppWritableAttachmentStream>;
|
|
369
|
+
preparePreviewSession(docId: string, attachmentName: string, options?: MindooDBAppAttachmentPreviewOptions): Promise<MindooDBAppAttachmentPreviewSession>;
|
|
364
370
|
openPreview(docId: string, attachmentName: string, options?: MindooDBAppAttachmentPreviewOptions): Promise<{
|
|
365
371
|
ok: true;
|
|
366
372
|
}>;
|
|
@@ -387,4 +393,4 @@ interface MindooDBAppBridge {
|
|
|
387
393
|
connect(options?: MindooDBAppBridgeConnectOptions): Promise<MindooDBAppSession>;
|
|
388
394
|
}
|
|
389
395
|
|
|
390
|
-
export type {
|
|
396
|
+
export type { MindooDBAppHistoryQuery as $, MindooDBAppConfiguredViewCategorizationStyle as A, MindooDBAppConfiguredViewColumn as B, MindooDBAppConfiguredViewColumnRole as C, MindooDBAppConfiguredViewExpressionMode as D, MindooDBAppConfiguredViewFieldExpression as E, MindooDBAppConfiguredViewFilterDefinition as F, MindooDBAppConfiguredViewFilterMode as G, MindooDBAppConfiguredViewFilterRule as H, MindooDBAppConfiguredViewFormulaExpression as I, MindooDBAppConfiguredViewFormulaFilterDefinition as J, MindooDBAppConfiguredViewPreviewMode as K, MindooDBAppConfiguredViewRuleFilterDefinition as L, MindooDBAppAttachmentPreviewMode as M, MindooDBAppConfiguredViewRuleMatchMode as N, MindooDBAppConfiguredViewRuleOperator as O, MindooDBAppConfiguredViewValueExpression as P, MindooDBAppCreateDocumentInput as Q, MindooDBAppCreateViewInput as R, MindooDBAppDatabase as S, MindooDBAppDatabaseInfo as T, MindooDBAppDocument as U, MindooDBAppDocumentApi as V, MindooDBAppDocumentHistoryEntry as W, MindooDBAppDocumentListQuery as X, MindooDBAppDocumentListResult as Y, MindooDBAppDocumentSummary as Z, MindooDBAppHistoricalDocument as _, MindooDBAppBridge as a, MindooDBAppHostTheme as a0, MindooDBAppLaunchContext as a1, MindooDBAppReadableAttachmentStream as a2, MindooDBAppResolvedViewDefinition as a3, MindooDBAppResolvedViewSource as a4, MindooDBAppRuntime as a5, MindooDBAppSession as a6, MindooDBAppThemeMode as a7, MindooDBAppUpdateDocumentInput as a8, MindooDBAppViewHandle as a9, MindooDBAppViewport as aa, MindooDBAppWritableAttachmentStream as ab, MindooDBAppAttachmentApi as b, MindooDBAppAttachmentChunk as c, MindooDBAppAttachmentInfo as d, MindooDBAppAttachmentPreviewOptions as e, MindooDBAppAttachmentPreviewSession as f, MindooDBAppBridgeConnectMessage as g, MindooDBAppBridgeConnectOptions as h, MindooDBAppBridgeConnectedMessage as i, MindooDBAppBridgeErrorPayload as j, MindooDBAppBridgePortMessage as k, MindooDBAppBridgeRpcError as l, MindooDBAppBridgeRpcMessage as m, MindooDBAppBridgeRpcRequest as n, MindooDBAppBridgeRpcSuccess as o, MindooDBAppBridgeStreamAbortRequest as p, MindooDBAppBridgeStreamAck as q, MindooDBAppBridgeStreamCloseRequest as r, MindooDBAppBridgeStreamError as s, MindooDBAppBridgeStreamMessage as t, MindooDBAppBridgeStreamOpenResult as u, MindooDBAppBridgeStreamReadRequest as v, MindooDBAppBridgeStreamWriteRequest as w, MindooDBAppBridgeThemeChangedMessage as x, MindooDBAppBridgeViewportChangedMessage as y, MindooDBAppCapability as z };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mindoodb-app-sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "MindooDB app SDK for building apps that connect to the Haven host bridge",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"author": "Mindoo GmbH",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"prepublishOnly": "npm run build && npm run test"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"mindoodb-view-language": "0.0.
|
|
43
|
+
"mindoodb-view-language": "0.0.7"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@types/node": "^25.5.0",
|