@osdk/foundry.pack 2.37.0 → 2.39.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 (22) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/build/browser/_components.d.ts +121 -27
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +30 -4
  5. package/build/browser/_errors.d.ts.map +1 -1
  6. package/build/browser/index.d.ts +2 -2
  7. package/build/browser/index.d.ts.map +1 -1
  8. package/build/browser/public/Document.d.ts +15 -0
  9. package/build/browser/public/Document.d.ts.map +1 -1
  10. package/build/browser/public/Document.js +13 -0
  11. package/build/browser/public/Document.js.map +1 -1
  12. package/build/esm/_components.d.ts +121 -27
  13. package/build/esm/_components.d.ts.map +1 -1
  14. package/build/esm/_errors.d.ts +30 -4
  15. package/build/esm/_errors.d.ts.map +1 -1
  16. package/build/esm/index.d.ts +2 -2
  17. package/build/esm/index.d.ts.map +1 -1
  18. package/build/esm/public/Document.d.ts +15 -0
  19. package/build/esm/public/Document.d.ts.map +1 -1
  20. package/build/esm/public/Document.js +13 -0
  21. package/build/esm/public/Document.js.map +1 -1
  22. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # @osdk/foundry.pack
2
2
 
3
+ ## 2.39.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 840b37a: Update Gotham and Foundry sdks
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [840b37a]
12
+ - @osdk/foundry.filesystem@2.39.0
13
+ - @osdk/foundry.core@2.39.0
14
+
15
+ ## 2.38.0
16
+
17
+ ### Minor Changes
18
+
19
+ - 549beb2: Bump SDKs and add Notepad namespace
20
+
21
+ ### Patch Changes
22
+
23
+ - Updated dependencies [549beb2]
24
+ - @osdk/foundry.filesystem@2.38.0
25
+ - @osdk/foundry.core@2.38.0
26
+
3
27
  ## 2.37.0
4
28
 
5
29
  ### Minor Changes
package/build/browser/_components.d.ts CHANGED
@@ -56,37 +56,10 @@ discretionary access.
56
56
  */
57
57
  export interface AllPrincipal {
58
58
  }
59
- /**
60
- * Update sent by client to apply to internal Y.Doc on server.
61
- *
62
- * Log Safety: UNSAFE
63
- */
64
- export interface ApplyYjsUpdate {
65
- yjsUpdate: YjsUpdate;
66
- clientId: ClientId;
67
- description?: DocumentEditDescription;
68
- }
69
59
  /**
70
60
  * Log Safety: SAFE
71
61
  */
72
62
  export type ClientId = string;
73
- /**
74
- * Update broadcast to all clients after being applied on server.
75
- *
76
- * Log Safety: UNSAFE
77
- */
78
- export interface CollaborativeUpdate {
79
- update: CollaborativeUpdateContents;
80
- clientId: ClientId;
81
- }
82
- /**
83
- * Union type to allow broadcasting different collaborative message types.
84
- *
85
- * Log Safety: UNSAFE
86
- */
87
- export type CollaborativeUpdateContents = {
88
- type: "yjsUpdate";
89
- } & YjsUpdate;
90
63
  /**
91
64
  * Log Safety: UNSAFE
92
65
  */
@@ -104,6 +77,14 @@ export interface CreateDocumentTypeRequest {
104
77
  parentFolderRid: _Filesystem.FolderRid;
105
78
  name: DocumentTypeName;
106
79
  }
80
+ /**
81
+ * Log Safety: UNSAFE
82
+ */
83
+ export interface CustomPresenceEvent {
84
+ userId: _Core.UserId;
85
+ clientId: ClientId;
86
+ eventData: any;
87
+ }
107
88
  /**
108
89
  * Union of all security principals usable within disjunctive security conditions.
109
90
  These principals are used to grant additional role access beyond mandatory security.
@@ -176,12 +157,44 @@ export type DocumentName = LooselyBrandedString<"DocumentName">;
176
157
  * Log Safety: SAFE
177
158
  */
178
159
  export type DocumentOntologyRid = LooselyBrandedString<"DocumentOntologyRid">;
160
+ /**
161
+ * Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.
162
+ Note that just because a user is not present on a particular document does not mean that they are overall
163
+ "offline" -- they may have other documents or non-document applications open in the platform.
164
+ *
165
+ * Log Safety: SAFE
166
+ */
167
+ export interface DocumentPresenceChangeEvent {
168
+ userId: _Core.UserId;
169
+ status: UserPresence;
170
+ }
171
+ /**
172
+ * Update sent by client to apply to internal Y.Doc on server.
173
+ *
174
+ * Log Safety: UNSAFE
175
+ */
176
+ export interface DocumentPublishMessage {
177
+ yjsUpdate: YjsUpdate;
178
+ editId: EditId;
179
+ clientId: ClientId;
180
+ description?: DocumentEditDescription;
181
+ }
179
182
  /**
180
183
  * Identifier for an PACK Document.
181
184
  *
182
185
  * Log Safety: SAFE
183
186
  */
184
187
  export type DocumentRid = LooselyBrandedString<"DocumentRid">;
188
+ /**
189
+ * Log Safety: UNSAFE
190
+ */
191
+ export interface DocumentSearchQuery {
192
+ documentName?: string;
193
+ }
194
+ /**
195
+ * Log Safety: UNSAFE
196
+ */
197
+ export type DocumentSearchResponse = Array<Document>;
185
198
  /**
186
199
  * Log Safety: UNSAFE
187
200
  */
@@ -210,6 +223,59 @@ export type DocumentTypeName = LooselyBrandedString<"DocumentTypeName">;
210
223
  * Log Safety: SAFE
211
224
  */
212
225
  export type DocumentTypeRid = LooselyBrandedString<"DocumentTypeRid">;
226
+ /**
227
+ * Update broadcast to all clients after being applied on server.
228
+ *
229
+ * Log Safety: UNSAFE
230
+ */
231
+ export interface DocumentUpdate {
232
+ update?: YjsUpdate;
233
+ clientId: ClientId;
234
+ revisionId: RevisionId;
235
+ baseRevisionId: RevisionId;
236
+ editIds: Array<EditId>;
237
+ }
238
+ /**
239
+ * Union type to allow broadcasting different collaborative message types.
240
+ *
241
+ * Log Safety: UNSAFE
242
+ */
243
+ export type DocumentUpdateMessage = ({
244
+ type: "update";
245
+ } & DocumentUpdate) | ({
246
+ type: "error";
247
+ } & ErrorMessage);
248
+ /**
249
+ * A request from client to subscribe to a document's collaborative updates,
250
+ required on a subscription request to /documents/{documentId}/updates
251
+ *
252
+ * Log Safety: SAFE
253
+ */
254
+ export interface DocumentUpdateSubscriptionRequest {
255
+ clientId: ClientId;
256
+ lastRevisionId?: RevisionId;
257
+ }
258
+ /**
259
+ * A unique identifier for an edit to an AppKit Document.
260
+ *
261
+ * Log Safety: SAFE
262
+ */
263
+ export type EditId = LooselyBrandedString<"EditId">;
264
+ /**
265
+ * Log Safety: SAFE
266
+ */
267
+ export type ErrorCode = "INTERNAL_ERROR" | "REVISION_TOO_OLD";
268
+ /**
269
+ * Message sent to clients when an error occurs. The subscription may not remain in a valid state after this
270
+ message and should be reopened.
271
+ *
272
+ * Log Safety: SAFE
273
+ */
274
+ export interface ErrorMessage {
275
+ code: ErrorCode;
276
+ errorInstanceId: string;
277
+ args: Record<string, string>;
278
+ }
213
279
  /**
214
280
  * A unique identifier for this activity event.
215
281
  *
@@ -240,12 +306,40 @@ export type MarkingId = string;
240
306
  * Log Safety: UNSAFE
241
307
  */
242
308
  export type MarkingPrincipal = LooselyBrandedString<"MarkingPrincipal">;
309
+ /**
310
+ * Log Safety: UNSAFE
311
+ */
312
+ export type PresenceCollaborativeUpdate = ({
313
+ type: "presenceChangeEvent";
314
+ } & DocumentPresenceChangeEvent) | ({
315
+ type: "customPresenceEvent";
316
+ } & CustomPresenceEvent);
317
+ /**
318
+ * A unique incrementing identifier that represents the order of edits applied by the server.
319
+ *
320
+ * Log Safety: SAFE
321
+ */
322
+ export type RevisionId = string;
323
+ /**
324
+ * Log Safety: UNSAFE
325
+ */
326
+ export interface SearchDocumentsRequest {
327
+ documentTypeName: DocumentTypeName;
328
+ limit?: number;
329
+ searchQuery?: DocumentSearchQuery;
330
+ }
243
331
  /**
244
332
  * A Foundry User ID.
245
333
  *
246
334
  * Log Safety: SAFE
247
335
  */
248
336
  export type UserId = string;
337
+ /**
338
+ * A user's presence on a document
339
+ *
340
+ * Log Safety: SAFE
341
+ */
342
+ export type UserPresence = "PRESENT" | "NOT_PRESENT";
249
343
  /**
250
344
  * Log Safety: UNSAFE
251
345
  */
package/build/browser/_components.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,GAC/C,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,CAAC;AAEpD;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;;;;;;KAOK;AACL,MAAM,WAAW,YAAY;CAAG;AAEhC;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,2BAA2B,CAAC;IACpC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GAAG,SAAS,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,sBAAsB,GAC9B,CAAC;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,YAAY,CAAC,GAChC,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,6BAA6B,CAAC,GACrD,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,4BAA4B,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,WAAW,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACvC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,yBAAyB,CAAC;IACrC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,eAAe,CAAC;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,GAAG,CAAC;IACV,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,GAAG,CAAC;CACX"}
1
+ {"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,GAC/C,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,CAAC;AAEpD;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;;;;;;KAOK;AACL,MAAM,WAAW,YAAY;CAAG;AAEhC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;CAChB;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,sBAAsB,GAC9B,CAAC;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,YAAY,CAAC,GAChC,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,6BAA6B,CAAC,GACrD,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,4BAA4B,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,WAAW,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACvC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE9E;;;;;;KAMK;AACL,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,yBAAyB,CAAC;IACrC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,eAAe,CAAC;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,UAAU,CAAC;IAC3B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAC7B,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,cAAc,CAAC,GACrC,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,YAAY,CAAC,CAAC;AAEvC;;;;;KAKK;AACL,MAAM,WAAW,iCAAiC;IAChD,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAE9D;;;;;KAKK;AACL,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAAG,2BAA2B,CAAC,GAC/D,CAAC;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAAG,mBAAmB,CAAC,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,GAAG,CAAC;IACV,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,GAAG,CAAC;CACX"}
package/build/browser/_errors.d.ts CHANGED
@@ -3,14 +3,14 @@ export type LooselyBrandedString<T extends string> = string & {
3
3
  };
4
4
  /**
5
5
  * The user does not have permission to create documents of the given type in
6
- the given ontology, or the document type does not exist in the ontology.
6
+ the given ontology, or the Document Type does not exist in the ontology.
7
7
  *
8
8
  * Log Safety: UNSAFE
9
9
  */
10
10
  export interface CreateDocumentNotSupported {
11
11
  errorCode: "PERMISSION_DENIED";
12
12
  errorName: "CreateDocumentNotSupported";
13
- errorDescription: "The user does not have permission to create documents of the given type in the given ontology, or the document type does not exist in the ontology.";
13
+ errorDescription: "The user does not have permission to create documents of the given type in the given ontology, or the Document Type does not exist in the ontology.";
14
14
  errorInstanceId: string;
15
15
  parameters: {
16
16
  ontologyRid: unknown;
@@ -56,17 +56,43 @@ export interface DocumentNotFound {
56
56
  };
57
57
  }
58
58
  /**
59
- * This document type name already exists for the given ontology.
59
+ * This Document Type Name already exists for the given ontology.
60
60
  *
61
61
  * Log Safety: UNSAFE
62
62
  */
63
63
  export interface DocumentTypeAlreadyExists {
64
64
  errorCode: "CONFLICT";
65
65
  errorName: "DocumentTypeAlreadyExists";
66
- errorDescription: "This document type name already exists for the given ontology.";
66
+ errorDescription: "This Document Type Name already exists for the given ontology.";
67
67
  errorInstanceId: string;
68
68
  parameters: {
69
69
  documentTypeName: unknown;
70
70
  };
71
71
  }
72
+ /**
73
+ * The Document Type Name does not exist, or the user does not have permission to view the Document Type.
74
+ *
75
+ * Log Safety: UNSAFE
76
+ */
77
+ export interface DocumentTypeNameNotFound {
78
+ errorCode: "PERMISSION_DENIED";
79
+ errorName: "DocumentTypeNameNotFound";
80
+ errorDescription: "The Document Type Name does not exist, or the user does not have permission to view the Document Type.";
81
+ errorInstanceId: string;
82
+ parameters: {
83
+ documentTypeName: unknown;
84
+ };
85
+ }
86
+ /**
87
+ * Could not search the Document.
88
+ *
89
+ * Log Safety: SAFE
90
+ */
91
+ export interface SearchDocumentsPermissionDenied {
92
+ errorCode: "PERMISSION_DENIED";
93
+ errorName: "SearchDocumentsPermissionDenied";
94
+ errorDescription: "Could not search the Document.";
95
+ errorInstanceId: string;
96
+ parameters: {};
97
+ }
72
98
  //# sourceMappingURL=_errors.d.ts.map
package/build/browser/_errors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,qJAAqJ,CAAC;IACxJ,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,oCAAoC,CAAC;IAChD,gBAAgB,EAAE,oCAAoC,CAAC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EAAE,wCAAwC,CAAC;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,2BAA2B,CAAC;IACvC,gBAAgB,EACd,gEAAgE,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH"}
1
+ {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,qJAAqJ,CAAC;IACxJ,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,oCAAoC,CAAC;IAChD,gBAAgB,EAAE,oCAAoC,CAAC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EAAE,wCAAwC,CAAC;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,2BAA2B,CAAC;IACvC,gBAAgB,EACd,gEAAgE,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,0BAA0B,CAAC;IACtC,gBAAgB,EACd,wGAAwG,CAAC;IAC3G,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB"}
package/build/browser/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export type { ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ApplyYjsUpdate, ClientId, CollaborativeUpdate, CollaborativeUpdateContents, CreateDocumentRequest, CreateDocumentTypeRequest, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, Document, DocumentDiscretionarySecurity, DocumentEditDescription, DocumentMandatorySecurity, DocumentName, DocumentOntologyRid, DocumentRid, DocumentSecurity, DocumentType, DocumentTypeName, DocumentTypeRid, EventId, FolderRid, GroupId, MarkingId, MarkingPrincipal, UserId, VersionedEventData, YjsUpdate, } from "./_components.js";
2
- export type { CreateDocumentNotSupported, CreateDocumentPermissionDenied, CreateDocumentTypePermissionDenied, DocumentNotFound, DocumentTypeAlreadyExists, } from "./_errors.js";
1
+ export type { ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ClientId, CreateDocumentRequest, CreateDocumentTypeRequest, CustomPresenceEvent, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, Document, DocumentDiscretionarySecurity, DocumentEditDescription, DocumentMandatorySecurity, DocumentName, DocumentOntologyRid, DocumentPresenceChangeEvent, DocumentPublishMessage, DocumentRid, DocumentSearchQuery, DocumentSearchResponse, DocumentSecurity, DocumentType, DocumentTypeName, DocumentTypeRid, DocumentUpdate, DocumentUpdateMessage, DocumentUpdateSubscriptionRequest, EditId, ErrorCode, ErrorMessage, EventId, FolderRid, GroupId, MarkingId, MarkingPrincipal, PresenceCollaborativeUpdate, RevisionId, SearchDocumentsRequest, UserId, UserPresence, VersionedEventData, YjsUpdate, } from "./_components.js";
2
+ export type { CreateDocumentNotSupported, CreateDocumentPermissionDenied, CreateDocumentTypePermissionDenied, DocumentNotFound, DocumentTypeAlreadyExists, DocumentTypeNameNotFound, SearchDocumentsPermissionDenied, } from "./_errors.js";
3
3
  export * as Documents from "./public/Document.js";
4
4
  export * as DocumentTypes from "./public/DocumentType.js";
5
5
  //# sourceMappingURL=index.d.ts.map
package/build/browser/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,mBAAmB,EACnB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,6BAA6B,EAC7B,4BAA4B,EAC5B,QAAQ,EACR,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,SAAS,EACT,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,MAAM,EACN,kBAAkB,EAClB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,0BAA0B,EAC1B,8BAA8B,EAC9B,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,sBAAsB,EACtB,6BAA6B,EAC7B,4BAA4B,EAC5B,QAAQ,EACR,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,mBAAmB,EACnB,2BAA2B,EAC3B,sBAAsB,EACtB,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,qBAAqB,EACrB,iCAAiC,EACjC,MAAM,EACN,SAAS,EACT,YAAY,EACZ,OAAO,EACP,SAAS,EACT,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,MAAM,EACN,YAAY,EACZ,kBAAkB,EAClB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,0BAA0B,EAC1B,8BAA8B,EAC9B,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC"}
package/build/browser/public/Document.d.ts CHANGED
@@ -30,4 +30,19 @@ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldCl
30
30
  preview?: _Core.PreviewMode | undefined;
31
31
  }
32
32
  ]): Promise<_Pack.Document>;
33
+ /**
34
+ * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query
35
+ * is provided, filters the results based on the user's query.
36
+ *
37
+ * @alpha
38
+ *
39
+ * Required Scopes: [api:pack-read]
40
+ * URL: /v2/pack/documents/search
41
+ */
42
+ export declare function search($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
43
+ $body: _Pack.SearchDocumentsRequest,
44
+ $queryParams?: {
45
+ preview?: _Core.PreviewMode | undefined;
46
+ }
47
+ ]): Promise<_Pack.DocumentSearchResponse>;
33
48
  //# sourceMappingURL=Document.d.ts.map
package/build/browser/public/Document.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../../src/public/Document.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAWhD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,qBAAqB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,KAAK,CAAC,WAAW;IAE7B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB"}
1
+ {"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../../src/public/Document.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAWhD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,qBAAqB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,KAAK,CAAC,WAAW;IAE7B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,sBAAsB;IACnC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAEvC"}
package/build/browser/public/Document.js CHANGED
@@ -39,4 +39,17 @@ const _get = [0, "/v2/pack/documents/{0}", 2];
39
39
  export function get($ctx, ...args) {
40
40
  return $foundryPlatformFetch($ctx, _get, ...args);
41
41
  }
42
+ const _search = [1, "/v2/pack/documents/search", 3];
43
+ /**
44
+ * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query
45
+ * is provided, filters the results based on the user's query.
46
+ *
47
+ * @alpha
48
+ *
49
+ * Required Scopes: [api:pack-read]
50
+ * URL: /v2/pack/documents/search
51
+ */
52
+ export function search($ctx, ...args) {
53
+ return $foundryPlatformFetch($ctx, _search, ...args);
54
+ }
42
55
  //# sourceMappingURL=Document.js.map
package/build/browser/public/Document.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Document.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get"],"sources":["Document.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/pack/documents\", 3];\n/**\n * Creates a new Document.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-write]\n * URL: /v2/pack/documents\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/pack/documents/{0}\", 2];\n/**\n * Get the Document with the specified id.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/{documentId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAC5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD","ignoreList":[]}
1
+ {"version":3,"file":"Document.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_search","search"],"sources":["Document.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/pack/documents\", 3];\n/**\n * Creates a new Document.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-write]\n * URL: /v2/pack/documents\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/pack/documents/{0}\", 2];\n/**\n * Get the Document with the specified id.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/{documentId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _search = [1, \"/v2/pack/documents/search\", 3];\n/**\n * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query\n * is provided, filters the results based on the user's query.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/search\n */\nexport function search($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _search, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAC5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,OAAO,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AACnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,OAAO,EAAE,GAAGH,IAAI,CAAC;AACxD","ignoreList":[]}
package/build/esm/_components.d.ts CHANGED
@@ -56,37 +56,10 @@ discretionary access.
56
56
  */
57
57
  export interface AllPrincipal {
58
58
  }
59
- /**
60
- * Update sent by client to apply to internal Y.Doc on server.
61
- *
62
- * Log Safety: UNSAFE
63
- */
64
- export interface ApplyYjsUpdate {
65
- yjsUpdate: YjsUpdate;
66
- clientId: ClientId;
67
- description?: DocumentEditDescription;
68
- }
69
59
  /**
70
60
  * Log Safety: SAFE
71
61
  */
72
62
  export type ClientId = string;
73
- /**
74
- * Update broadcast to all clients after being applied on server.
75
- *
76
- * Log Safety: UNSAFE
77
- */
78
- export interface CollaborativeUpdate {
79
- update: CollaborativeUpdateContents;
80
- clientId: ClientId;
81
- }
82
- /**
83
- * Union type to allow broadcasting different collaborative message types.
84
- *
85
- * Log Safety: UNSAFE
86
- */
87
- export type CollaborativeUpdateContents = {
88
- type: "yjsUpdate";
89
- } & YjsUpdate;
90
63
  /**
91
64
  * Log Safety: UNSAFE
92
65
  */
@@ -104,6 +77,14 @@ export interface CreateDocumentTypeRequest {
104
77
  parentFolderRid: _Filesystem.FolderRid;
105
78
  name: DocumentTypeName;
106
79
  }
80
+ /**
81
+ * Log Safety: UNSAFE
82
+ */
83
+ export interface CustomPresenceEvent {
84
+ userId: _Core.UserId;
85
+ clientId: ClientId;
86
+ eventData: any;
87
+ }
107
88
  /**
108
89
  * Union of all security principals usable within disjunctive security conditions.
109
90
  These principals are used to grant additional role access beyond mandatory security.
@@ -176,12 +157,44 @@ export type DocumentName = LooselyBrandedString<"DocumentName">;
176
157
  * Log Safety: SAFE
177
158
  */
178
159
  export type DocumentOntologyRid = LooselyBrandedString<"DocumentOntologyRid">;
160
+ /**
161
+ * Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.
162
+ Note that just because a user is not present on a particular document does not mean that they are overall
163
+ "offline" -- they may have other documents or non-document applications open in the platform.
164
+ *
165
+ * Log Safety: SAFE
166
+ */
167
+ export interface DocumentPresenceChangeEvent {
168
+ userId: _Core.UserId;
169
+ status: UserPresence;
170
+ }
171
+ /**
172
+ * Update sent by client to apply to internal Y.Doc on server.
173
+ *
174
+ * Log Safety: UNSAFE
175
+ */
176
+ export interface DocumentPublishMessage {
177
+ yjsUpdate: YjsUpdate;
178
+ editId: EditId;
179
+ clientId: ClientId;
180
+ description?: DocumentEditDescription;
181
+ }
179
182
  /**
180
183
  * Identifier for an PACK Document.
181
184
  *
182
185
  * Log Safety: SAFE
183
186
  */
184
187
  export type DocumentRid = LooselyBrandedString<"DocumentRid">;
188
+ /**
189
+ * Log Safety: UNSAFE
190
+ */
191
+ export interface DocumentSearchQuery {
192
+ documentName?: string;
193
+ }
194
+ /**
195
+ * Log Safety: UNSAFE
196
+ */
197
+ export type DocumentSearchResponse = Array<Document>;
185
198
  /**
186
199
  * Log Safety: UNSAFE
187
200
  */
@@ -210,6 +223,59 @@ export type DocumentTypeName = LooselyBrandedString<"DocumentTypeName">;
210
223
  * Log Safety: SAFE
211
224
  */
212
225
  export type DocumentTypeRid = LooselyBrandedString<"DocumentTypeRid">;
226
+ /**
227
+ * Update broadcast to all clients after being applied on server.
228
+ *
229
+ * Log Safety: UNSAFE
230
+ */
231
+ export interface DocumentUpdate {
232
+ update?: YjsUpdate;
233
+ clientId: ClientId;
234
+ revisionId: RevisionId;
235
+ baseRevisionId: RevisionId;
236
+ editIds: Array<EditId>;
237
+ }
238
+ /**
239
+ * Union type to allow broadcasting different collaborative message types.
240
+ *
241
+ * Log Safety: UNSAFE
242
+ */
243
+ export type DocumentUpdateMessage = ({
244
+ type: "update";
245
+ } & DocumentUpdate) | ({
246
+ type: "error";
247
+ } & ErrorMessage);
248
+ /**
249
+ * A request from client to subscribe to a document's collaborative updates,
250
+ required on a subscription request to /documents/{documentId}/updates
251
+ *
252
+ * Log Safety: SAFE
253
+ */
254
+ export interface DocumentUpdateSubscriptionRequest {
255
+ clientId: ClientId;
256
+ lastRevisionId?: RevisionId;
257
+ }
258
+ /**
259
+ * A unique identifier for an edit to an AppKit Document.
260
+ *
261
+ * Log Safety: SAFE
262
+ */
263
+ export type EditId = LooselyBrandedString<"EditId">;
264
+ /**
265
+ * Log Safety: SAFE
266
+ */
267
+ export type ErrorCode = "INTERNAL_ERROR" | "REVISION_TOO_OLD";
268
+ /**
269
+ * Message sent to clients when an error occurs. The subscription may not remain in a valid state after this
270
+ message and should be reopened.
271
+ *
272
+ * Log Safety: SAFE
273
+ */
274
+ export interface ErrorMessage {
275
+ code: ErrorCode;
276
+ errorInstanceId: string;
277
+ args: Record<string, string>;
278
+ }
213
279
  /**
214
280
  * A unique identifier for this activity event.
215
281
  *
@@ -240,12 +306,40 @@ export type MarkingId = string;
240
306
  * Log Safety: UNSAFE
241
307
  */
242
308
  export type MarkingPrincipal = LooselyBrandedString<"MarkingPrincipal">;
309
+ /**
310
+ * Log Safety: UNSAFE
311
+ */
312
+ export type PresenceCollaborativeUpdate = ({
313
+ type: "presenceChangeEvent";
314
+ } & DocumentPresenceChangeEvent) | ({
315
+ type: "customPresenceEvent";
316
+ } & CustomPresenceEvent);
317
+ /**
318
+ * A unique incrementing identifier that represents the order of edits applied by the server.
319
+ *
320
+ * Log Safety: SAFE
321
+ */
322
+ export type RevisionId = string;
323
+ /**
324
+ * Log Safety: UNSAFE
325
+ */
326
+ export interface SearchDocumentsRequest {
327
+ documentTypeName: DocumentTypeName;
328
+ limit?: number;
329
+ searchQuery?: DocumentSearchQuery;
330
+ }
243
331
  /**
244
332
  * A Foundry User ID.
245
333
  *
246
334
  * Log Safety: SAFE
247
335
  */
248
336
  export type UserId = string;
337
+ /**
338
+ * A user's presence on a document
339
+ *
340
+ * Log Safety: SAFE
341
+ */
342
+ export type UserPresence = "PRESENT" | "NOT_PRESENT";
249
343
  /**
250
344
  * Log Safety: UNSAFE
251
345
  */
package/build/esm/_components.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,GAC/C,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,CAAC;AAEpD;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;;;;;;KAOK;AACL,MAAM,WAAW,YAAY;CAAG;AAEhC;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,2BAA2B,CAAC;IACpC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GAAG,SAAS,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,sBAAsB,GAC9B,CAAC;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,YAAY,CAAC,GAChC,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,6BAA6B,CAAC,GACrD,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,4BAA4B,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,WAAW,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACvC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,yBAAyB,CAAC;IACrC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,eAAe,CAAC;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,GAAG,CAAC;IACV,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,GAAG,CAAC;CACX"}
1
+ {"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,KAAK,WAAW,MAAM,0BAA0B,CAAC;AAE7D,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,GAC/C,CAAC;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG,eAAe,CAAC,CAAC;AAEpD;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;KAKK;AACL,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;;;;;;KAOK;AACL,MAAM,WAAW,YAAY;CAAG;AAEhC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;CAChB;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,sBAAsB,GAC9B,CAAC;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,YAAY,CAAC,GAChC,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,6BAA6B,CAAC,GACrD,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,4BAA4B,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,WAAW,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;IAC/B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACtC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACvC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE9E;;;;;;KAMK;AACL,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,yBAAyB,CAAC;IACrC,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,eAAe,CAAC;IACrB,IAAI,EAAE,gBAAgB,CAAC;IACvB,eAAe,EAAE,WAAW,CAAC,SAAS,CAAC;CACxC;AAED;;;;;KAKK;AACL,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,UAAU,CAAC;IAC3B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAC7B,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,cAAc,CAAC,GACrC,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,YAAY,CAAC,CAAC;AAEvC;;;;;KAKK;AACL,MAAM,WAAW,iCAAiC;IAChD,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAE9D;;;;;KAKK;AACL,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAAG,2BAA2B,CAAC,GAC/D,CAAC;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAAG,mBAAmB,CAAC,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,GAAG,CAAC;IACV,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,GAAG,CAAC;CACX"}
package/build/esm/_errors.d.ts CHANGED
@@ -3,14 +3,14 @@ export type LooselyBrandedString<T extends string> = string & {
3
3
  };
4
4
  /**
5
5
  * The user does not have permission to create documents of the given type in
6
- the given ontology, or the document type does not exist in the ontology.
6
+ the given ontology, or the Document Type does not exist in the ontology.
7
7
  *
8
8
  * Log Safety: UNSAFE
9
9
  */
10
10
  export interface CreateDocumentNotSupported {
11
11
  errorCode: "PERMISSION_DENIED";
12
12
  errorName: "CreateDocumentNotSupported";
13
- errorDescription: "The user does not have permission to create documents of the given type in the given ontology, or the document type does not exist in the ontology.";
13
+ errorDescription: "The user does not have permission to create documents of the given type in the given ontology, or the Document Type does not exist in the ontology.";
14
14
  errorInstanceId: string;
15
15
  parameters: {
16
16
  ontologyRid: unknown;
@@ -56,17 +56,43 @@ export interface DocumentNotFound {
56
56
  };
57
57
  }
58
58
  /**
59
- * This document type name already exists for the given ontology.
59
+ * This Document Type Name already exists for the given ontology.
60
60
  *
61
61
  * Log Safety: UNSAFE
62
62
  */
63
63
  export interface DocumentTypeAlreadyExists {
64
64
  errorCode: "CONFLICT";
65
65
  errorName: "DocumentTypeAlreadyExists";
66
- errorDescription: "This document type name already exists for the given ontology.";
66
+ errorDescription: "This Document Type Name already exists for the given ontology.";
67
67
  errorInstanceId: string;
68
68
  parameters: {
69
69
  documentTypeName: unknown;
70
70
  };
71
71
  }
72
+ /**
73
+ * The Document Type Name does not exist, or the user does not have permission to view the Document Type.
74
+ *
75
+ * Log Safety: UNSAFE
76
+ */
77
+ export interface DocumentTypeNameNotFound {
78
+ errorCode: "PERMISSION_DENIED";
79
+ errorName: "DocumentTypeNameNotFound";
80
+ errorDescription: "The Document Type Name does not exist, or the user does not have permission to view the Document Type.";
81
+ errorInstanceId: string;
82
+ parameters: {
83
+ documentTypeName: unknown;
84
+ };
85
+ }
86
+ /**
87
+ * Could not search the Document.
88
+ *
89
+ * Log Safety: SAFE
90
+ */
91
+ export interface SearchDocumentsPermissionDenied {
92
+ errorCode: "PERMISSION_DENIED";
93
+ errorName: "SearchDocumentsPermissionDenied";
94
+ errorDescription: "Could not search the Document.";
95
+ errorInstanceId: string;
96
+ parameters: {};
97
+ }
72
98
  //# sourceMappingURL=_errors.d.ts.map
package/build/esm/_errors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,qJAAqJ,CAAC;IACxJ,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,oCAAoC,CAAC;IAChD,gBAAgB,EAAE,oCAAoC,CAAC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EAAE,wCAAwC,CAAC;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,2BAA2B,CAAC;IACvC,gBAAgB,EACd,gEAAgE,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH"}
1
+ {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,qJAAqJ,CAAC;IACxJ,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,oCAAoC,CAAC;IAChD,gBAAgB,EAAE,oCAAoC,CAAC;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EAAE,wCAAwC,CAAC;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,2BAA2B,CAAC;IACvC,gBAAgB,EACd,gEAAgE,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,0BAA0B,CAAC;IACtC,gBAAgB,EACd,wGAAwG,CAAC;IAC3G,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EAAE,gCAAgC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB"}
package/build/esm/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export type { ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ApplyYjsUpdate, ClientId, CollaborativeUpdate, CollaborativeUpdateContents, CreateDocumentRequest, CreateDocumentTypeRequest, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, Document, DocumentDiscretionarySecurity, DocumentEditDescription, DocumentMandatorySecurity, DocumentName, DocumentOntologyRid, DocumentRid, DocumentSecurity, DocumentType, DocumentTypeName, DocumentTypeRid, EventId, FolderRid, GroupId, MarkingId, MarkingPrincipal, UserId, VersionedEventData, YjsUpdate, } from "./_components.js";
2
- export type { CreateDocumentNotSupported, CreateDocumentPermissionDenied, CreateDocumentTypePermissionDenied, DocumentNotFound, DocumentTypeAlreadyExists, } from "./_errors.js";
1
+ export type { ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ClientId, CreateDocumentRequest, CreateDocumentTypeRequest, CustomPresenceEvent, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, Document, DocumentDiscretionarySecurity, DocumentEditDescription, DocumentMandatorySecurity, DocumentName, DocumentOntologyRid, DocumentPresenceChangeEvent, DocumentPublishMessage, DocumentRid, DocumentSearchQuery, DocumentSearchResponse, DocumentSecurity, DocumentType, DocumentTypeName, DocumentTypeRid, DocumentUpdate, DocumentUpdateMessage, DocumentUpdateSubscriptionRequest, EditId, ErrorCode, ErrorMessage, EventId, FolderRid, GroupId, MarkingId, MarkingPrincipal, PresenceCollaborativeUpdate, RevisionId, SearchDocumentsRequest, UserId, UserPresence, VersionedEventData, YjsUpdate, } from "./_components.js";
2
+ export type { CreateDocumentNotSupported, CreateDocumentPermissionDenied, CreateDocumentTypePermissionDenied, DocumentNotFound, DocumentTypeAlreadyExists, DocumentTypeNameNotFound, SearchDocumentsPermissionDenied, } from "./_errors.js";
3
3
  export * as Documents from "./public/Document.js";
4
4
  export * as DocumentTypes from "./public/DocumentType.js";
5
5
  //# sourceMappingURL=index.d.ts.map
package/build/esm/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,mBAAmB,EACnB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,6BAA6B,EAC7B,4BAA4B,EAC5B,QAAQ,EACR,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,SAAS,EACT,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,MAAM,EACN,kBAAkB,EAClB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,0BAA0B,EAC1B,8BAA8B,EAC9B,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,sBAAsB,EACtB,6BAA6B,EAC7B,4BAA4B,EAC5B,QAAQ,EACR,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACZ,mBAAmB,EACnB,2BAA2B,EAC3B,sBAAsB,EACtB,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,qBAAqB,EACrB,iCAAiC,EACjC,MAAM,EACN,SAAS,EACT,YAAY,EACZ,OAAO,EACP,SAAS,EACT,OAAO,EACP,SAAS,EACT,gBAAgB,EAChB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,MAAM,EACN,YAAY,EACZ,kBAAkB,EAClB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,0BAA0B,EAC1B,8BAA8B,EAC9B,kCAAkC,EAClC,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC"}
package/build/esm/public/Document.d.ts CHANGED
@@ -30,4 +30,19 @@ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldCl
30
30
  preview?: _Core.PreviewMode | undefined;
31
31
  }
32
32
  ]): Promise<_Pack.Document>;
33
+ /**
34
+ * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query
35
+ * is provided, filters the results based on the user's query.
36
+ *
37
+ * @alpha
38
+ *
39
+ * Required Scopes: [api:pack-read]
40
+ * URL: /v2/pack/documents/search
41
+ */
42
+ export declare function search($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
43
+ $body: _Pack.SearchDocumentsRequest,
44
+ $queryParams?: {
45
+ preview?: _Core.PreviewMode | undefined;
46
+ }
47
+ ]): Promise<_Pack.DocumentSearchResponse>;
33
48
  //# sourceMappingURL=Document.d.ts.map
package/build/esm/public/Document.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../../src/public/Document.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAWhD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,qBAAqB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,KAAK,CAAC,WAAW;IAE7B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB"}
1
+ {"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../../src/public/Document.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAWhD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,qBAAqB;IAClC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,KAAK,CAAC,WAAW;IAE7B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAEzB;AASD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,KAAK,CAAC,sBAAsB;IACnC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAEvC"}
package/build/esm/public/Document.js CHANGED
@@ -39,4 +39,17 @@ const _get = [0, "/v2/pack/documents/{0}", 2];
39
39
  export function get($ctx, ...args) {
40
40
  return $foundryPlatformFetch($ctx, _get, ...args);
41
41
  }
42
+ const _search = [1, "/v2/pack/documents/search", 3];
43
+ /**
44
+ * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query
45
+ * is provided, filters the results based on the user's query.
46
+ *
47
+ * @alpha
48
+ *
49
+ * Required Scopes: [api:pack-read]
50
+ * URL: /v2/pack/documents/search
51
+ */
52
+ export function search($ctx, ...args) {
53
+ return $foundryPlatformFetch($ctx, _search, ...args);
54
+ }
42
55
  //# sourceMappingURL=Document.js.map
package/build/esm/public/Document.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Document.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get"],"sources":["Document.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/pack/documents\", 3];\n/**\n * Creates a new Document.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-write]\n * URL: /v2/pack/documents\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/pack/documents/{0}\", 2];\n/**\n * Get the Document with the specified id.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/{documentId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAC5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD","ignoreList":[]}
1
+ {"version":3,"file":"Document.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_search","search"],"sources":["Document.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v2/pack/documents\", 3];\n/**\n * Creates a new Document.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-write]\n * URL: /v2/pack/documents\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v2/pack/documents/{0}\", 2];\n/**\n * Get the Document with the specified id.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/{documentId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _search = [1, \"/v2/pack/documents/search\", 3];\n/**\n * Loads all PACK Documents visible to the user of the provided Document Type Name. If a search query\n * is provided, filters the results based on the user's query.\n *\n * @alpha\n *\n * Required Scopes: [api:pack-read]\n * URL: /v2/pack/documents/search\n */\nexport function search($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _search, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAC5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,OAAO,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AACnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,OAAO,EAAE,GAAGH,IAAI,CAAC;AACxD","ignoreList":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/foundry.pack",
3
- "version": "2.37.0",
3
+ "version": "2.39.0",
4
4
  "license": "Apache-2.0",
5
5
  "repository": {
6
6
  "type": "git",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@osdk/shared.client": "^1.0.1",
23
23
  "@osdk/shared.client2": "^1.0.0",
24
- "@osdk/foundry.core": "2.37.0",
24
+ "@osdk/foundry.core": "2.39.0",
25
25
  "@osdk/shared.net.platformapi": "~1.5.0",
26
- "@osdk/foundry.filesystem": "2.37.0"
26
+ "@osdk/foundry.filesystem": "2.39.0"
27
27
  },
28
28
  "devDependencies": {
29
29
  "typescript": "^5.5.4",
@@ -46,7 +46,7 @@
46
46
  "sls": {
47
47
  "dependencies": {
48
48
  "com.palantir.foundry.api:api-gateway": {
49
- "minVersion": "1.1343.0",
49
+ "minVersion": "1.1361.0",
50
50
  "maxVersion": "1.x.x",
51
51
  "optional": false
52
52
  }