Skip to content

eng-1863 Relation cross-app contract #1197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maparent wants to merge 1 commit into
base: eng-1984-define-cross-app-schema-contracts
Choose a base branch
from
Open

eng-1863 Relation cross-app contract #1197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/database/src/crossAppContracts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ type CrossAppBase = LocalRef & {
author: Ref;
};

type SpaceRef = DbRef | { url: string; sourceApp: Enums<"Platform"> };

export type LocalOrRemoteRef =
| LocalRef
| {
localId: string;
// infer space from context if absent.
space?: SpaceRef;
}
| {
// A string that contains combined space and localId
rid: string;
};

// A node schema
export type CrossAppNodeSchema = CrossAppBase & {
label: string;
Expand Down Expand Up @@ -72,3 +86,10 @@ export type CrossAppNode = CrossAppBase & {
full: InlineCrossAppTypedContent;
};
};

// A relation instance
export type CrossAppRelation = CrossAppBase & {
relationType: Ref;
source: LocalOrRemoteRef;
destination: LocalOrRemoteRef;
};