@superdoc-dev/sdk 1.1.0 → 1.2.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.
@@ -38,6 +38,18 @@ export interface DocFindParams {
38
38
  storyType: "endnote";
39
39
  noteId: string;
40
40
  });
41
+ select?: ({
42
+ type: "text";
43
+ pattern: string;
44
+ mode?: "contains" | "regex";
45
+ caseSensitive?: boolean;
46
+ }) | ({
47
+ type: "node";
48
+ nodeType?: string;
49
+ kind?: "block" | "inline";
50
+ }) | ({
51
+ type: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "endnoteRef" | "crossRef" | "indexEntry" | "citation" | "authorityEntry" | "sequenceField" | "tab" | "lineBreak";
52
+ });
41
53
  within?: {
42
54
  kind: "block";
43
55
  nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
@@ -9117,7 +9129,30 @@ export interface DocDiffApplyParams {
9117
9129
  export interface DocOpenParams {
9118
9130
  doc?: string;
9119
9131
  sessionId?: string;
9120
- collaboration?: Record<string, unknown> | unknown[];
9132
+ collaboration?: ({
9133
+ providerType: "y-websocket" | "hocuspocus";
9134
+ url: string;
9135
+ documentId?: string;
9136
+ tokenEnv?: string;
9137
+ syncTimeoutMs?: number;
9138
+ onMissing?: "seedFromDoc" | "blank" | "error";
9139
+ bootstrapSettlingMs?: number;
9140
+ }) | ({
9141
+ providerType: "liveblocks";
9142
+ roomId: string;
9143
+ publicApiKey: string;
9144
+ syncTimeoutMs?: number;
9145
+ onMissing?: "seedFromDoc" | "blank" | "error";
9146
+ bootstrapSettlingMs?: number;
9147
+ }) | ({
9148
+ providerType: "liveblocks";
9149
+ roomId: string;
9150
+ authEndpoint: string;
9151
+ authHeadersEnv?: string;
9152
+ syncTimeoutMs?: number;
9153
+ onMissing?: "seedFromDoc" | "blank" | "error";
9154
+ bootstrapSettlingMs?: number;
9155
+ });
9121
9156
  collabDocumentId?: string;
9122
9157
  collabUrl?: string;
9123
9158
  contentOverride?: string;
@@ -14409,7 +14444,8 @@ export type DocOpenResult = {
14409
14444
  };
14410
14445
  dirty?: boolean;
14411
14446
  collaboration?: {
14412
- documentId?: string;
14447
+ providerType: "y-websocket" | "hocuspocus" | "liveblocks";
14448
+ documentId: string;
14413
14449
  url?: string;
14414
14450
  };
14415
14451
  bootstrap?: {
@@ -14468,7 +14504,8 @@ export type DocStatusResult = {
14468
14504
  revision?: number;
14469
14505
  };
14470
14506
  collaboration?: {
14471
- documentId?: string;
14507
+ providerType: "y-websocket" | "hocuspocus" | "liveblocks";
14508
+ documentId: string;
14472
14509
  url?: string;
14473
14510
  };
14474
14511
  openedAt?: string;
@@ -14501,6 +14538,11 @@ export type DocSessionListResult = {
14501
14538
  sessionType?: string;
14502
14539
  dirty?: boolean;
14503
14540
  revision?: number;
14541
+ collaboration?: {
14542
+ providerType: "y-websocket" | "hocuspocus" | "liveblocks";
14543
+ documentId: string;
14544
+ url?: string;
14545
+ };
14504
14546
  }>;
14505
14547
  total?: number;
14506
14548
  };
@@ -14571,6 +14613,18 @@ export interface DocFindBoundParams {
14571
14613
  storyType: "endnote";
14572
14614
  noteId: string;
14573
14615
  });
14616
+ select?: ({
14617
+ type: "text";
14618
+ pattern: string;
14619
+ mode?: "contains" | "regex";
14620
+ caseSensitive?: boolean;
14621
+ }) | ({
14622
+ type: "node";
14623
+ nodeType?: string;
14624
+ kind?: "block" | "inline";
14625
+ }) | ({
14626
+ type: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt" | "run" | "bookmark" | "comment" | "hyperlink" | "footnoteRef" | "endnoteRef" | "crossRef" | "indexEntry" | "citation" | "authorityEntry" | "sequenceField" | "tab" | "lineBreak";
14627
+ });
14574
14628
  within?: {
14575
14629
  kind: "block";
14576
14630
  nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
@@ -22917,7 +22971,7 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
22917
22971
  getHtml: (params?: DocGetHtmlParams, options?: InvokeOptions) => Promise<DocGetHtmlResult>;
22918
22972
  markdownToFragment: (params: DocMarkdownToFragmentParams, options?: InvokeOptions) => Promise<DocMarkdownToFragmentResult>;
22919
22973
  info: (params?: DocInfoParams, options?: InvokeOptions) => Promise<DocInfoResult>;
22920
- clearContent: (params?: DocClearContentParams, options?: InvokeOptions) => Promise<unknown>;
22974
+ clearContent: (params?: DocClearContentParams, options?: InvokeOptions) => Promise<DocClearContentResult>;
22921
22975
  insert: (params?: DocInsertParams, options?: InvokeOptions) => Promise<DocInsertResult>;
22922
22976
  replace: (params?: DocReplaceParams, options?: InvokeOptions) => Promise<DocReplaceResult>;
22923
22977
  delete: (params?: DocDeleteParams, options?: InvokeOptions) => Promise<unknown>;
@@ -23068,16 +23122,16 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
23068
23122
  setLevelLayout: (params: DocListsSetLevelLayoutParams, options?: InvokeOptions) => Promise<DocListsSetLevelLayoutResult>;
23069
23123
  };
23070
23124
  comments: {
23071
- create: (params?: DocCommentsCreateParams, options?: InvokeOptions) => Promise<unknown>;
23072
- patch: (params?: DocCommentsPatchParams, options?: InvokeOptions) => Promise<unknown>;
23073
- delete: (params: DocCommentsDeleteParams, options?: InvokeOptions) => Promise<unknown>;
23125
+ create: (params?: DocCommentsCreateParams, options?: InvokeOptions) => Promise<DocCommentsCreateResult>;
23126
+ patch: (params?: DocCommentsPatchParams, options?: InvokeOptions) => Promise<DocCommentsPatchResult>;
23127
+ delete: (params: DocCommentsDeleteParams, options?: InvokeOptions) => Promise<DocCommentsDeleteResult>;
23074
23128
  get: (params: DocCommentsGetParams, options?: InvokeOptions) => Promise<DocCommentsGetResult>;
23075
23129
  list: (params?: DocCommentsListParams, options?: InvokeOptions) => Promise<DocCommentsListResult>;
23076
23130
  };
23077
23131
  trackChanges: {
23078
23132
  list: (params?: DocTrackChangesListParams, options?: InvokeOptions) => Promise<DocTrackChangesListResult>;
23079
23133
  get: (params: DocTrackChangesGetParams, options?: InvokeOptions) => Promise<DocTrackChangesGetResult>;
23080
- decide: (params: DocTrackChangesDecideParams, options?: InvokeOptions) => Promise<unknown>;
23134
+ decide: (params: DocTrackChangesDecideParams, options?: InvokeOptions) => Promise<DocTrackChangesDecideResult>;
23081
23135
  };
23082
23136
  query: {
23083
23137
  match: (params: DocQueryMatchParams, options?: InvokeOptions) => Promise<DocQueryMatchResult>;
@@ -23394,7 +23448,7 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
23394
23448
  getHtml: (params?: DocGetHtmlBoundParams, options?: InvokeOptions) => Promise<DocGetHtmlResult>;
23395
23449
  markdownToFragment: (params: DocMarkdownToFragmentBoundParams, options?: InvokeOptions) => Promise<DocMarkdownToFragmentResult>;
23396
23450
  info: (params?: DocInfoBoundParams, options?: InvokeOptions) => Promise<DocInfoResult>;
23397
- clearContent: (params?: DocClearContentBoundParams, options?: InvokeOptions) => Promise<unknown>;
23451
+ clearContent: (params?: DocClearContentBoundParams, options?: InvokeOptions) => Promise<DocClearContentResult>;
23398
23452
  insert: (params?: DocInsertBoundParams, options?: InvokeOptions) => Promise<DocInsertResult>;
23399
23453
  replace: (params?: DocReplaceBoundParams, options?: InvokeOptions) => Promise<DocReplaceResult>;
23400
23454
  delete: (params?: DocDeleteBoundParams, options?: InvokeOptions) => Promise<unknown>;
@@ -23545,16 +23599,16 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
23545
23599
  setLevelLayout: (params: DocListsSetLevelLayoutBoundParams, options?: InvokeOptions) => Promise<DocListsSetLevelLayoutResult>;
23546
23600
  };
23547
23601
  comments: {
23548
- create: (params?: DocCommentsCreateBoundParams, options?: InvokeOptions) => Promise<unknown>;
23549
- patch: (params?: DocCommentsPatchBoundParams, options?: InvokeOptions) => Promise<unknown>;
23550
- delete: (params: DocCommentsDeleteBoundParams, options?: InvokeOptions) => Promise<unknown>;
23602
+ create: (params?: DocCommentsCreateBoundParams, options?: InvokeOptions) => Promise<DocCommentsCreateResult>;
23603
+ patch: (params?: DocCommentsPatchBoundParams, options?: InvokeOptions) => Promise<DocCommentsPatchResult>;
23604
+ delete: (params: DocCommentsDeleteBoundParams, options?: InvokeOptions) => Promise<DocCommentsDeleteResult>;
23551
23605
  get: (params: DocCommentsGetBoundParams, options?: InvokeOptions) => Promise<DocCommentsGetResult>;
23552
23606
  list: (params?: DocCommentsListBoundParams, options?: InvokeOptions) => Promise<DocCommentsListResult>;
23553
23607
  };
23554
23608
  trackChanges: {
23555
23609
  list: (params?: DocTrackChangesListBoundParams, options?: InvokeOptions) => Promise<DocTrackChangesListResult>;
23556
23610
  get: (params: DocTrackChangesGetBoundParams, options?: InvokeOptions) => Promise<DocTrackChangesGetResult>;
23557
- decide: (params: DocTrackChangesDecideBoundParams, options?: InvokeOptions) => Promise<unknown>;
23611
+ decide: (params: DocTrackChangesDecideBoundParams, options?: InvokeOptions) => Promise<DocTrackChangesDecideResult>;
23558
23612
  };
23559
23613
  query: {
23560
23614
  match: (params: DocQueryMatchBoundParams, options?: InvokeOptions) => Promise<DocQueryMatchResult>;