@omni-co/embed 0.12.0 → 0.12.2

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 (2) hide show
  1. package/README.md +64 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -143,14 +143,29 @@ type EmbedSsoDashboardProps = {
143
143
  entity?: string;
144
144
 
145
145
  /**
146
- * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
146
+ * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
147
+ * or "NO_ACCESS".
147
148
  *
148
149
  * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
149
150
  * EDITOR: the user will have the ability to manage content in the entity folder.
150
151
  * VIEWER: the user will only be able to view content in the entity folder.
152
+ * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
153
+ * entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
154
+ * to the top-level entity folder.
151
155
  */
152
156
  entityFolderContentRole?: EmbedEntityFolderContentRoles;
153
157
 
158
+ /**
159
+ * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
160
+ * or "NO_ACCESS".
161
+ *
162
+ * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
163
+ * EDITOR: all users in the group have the ability to manage content in the entity folder.
164
+ * VIEWER: all users in the group are restricted to just view content in the entity folder.
165
+ * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
166
+ */
167
+ entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
168
+
154
169
  // Required identifier to associate the external user with an automatically generated internal Omni user.
155
170
  externalId: string;
156
171
 
@@ -280,14 +295,29 @@ type EmbedSsoWorkbookProps = {
280
295
  entity?: string;
281
296
 
282
297
  /**
283
- * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
298
+ * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
299
+ * or "NO_ACCESS".
284
300
  *
285
301
  * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
286
302
  * EDITOR: the user will have the ability to manage content in the entity folder.
287
303
  * VIEWER: the user will only be able to view content in the entity folder.
304
+ * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
305
+ * entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
306
+ * to the top-level entity folder.
288
307
  */
289
308
  entityFolderContentRole?: EmbedEntityFolderContentRoles;
290
309
 
310
+ /**
311
+ * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
312
+ * or "NO_ACCESS".
313
+ *
314
+ * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
315
+ * EDITOR: all users in the group have the ability to manage content in the entity folder.
316
+ * VIEWER: all users in the group are restricted to just view content in the entity folder.
317
+ * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
318
+ */
319
+ entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
320
+
291
321
  // Required identifier to associate the external user with an
292
322
  // automatically generated internal Omni user.
293
323
  externalId: string;
@@ -393,14 +423,29 @@ type EmbedSsoContentDiscoveryProps = {
393
423
  entity?: string;
394
424
 
395
425
  /**
396
- * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
426
+ * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
427
+ * or "NO_ACCESS".
397
428
  *
398
429
  * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
399
430
  * EDITOR: the user will have the ability to manage content in the entity folder.
400
431
  * VIEWER: the user will only be able to view content in the entity folder.
432
+ * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
433
+ * entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
434
+ * to the top-level entity folder.
401
435
  */
402
436
  entityFolderContentRole?: EmbedEntityFolderContentRoles;
403
437
 
438
+ /**
439
+ * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
440
+ * or "NO_ACCESS".
441
+ *
442
+ * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
443
+ * EDITOR: all users in the group have the ability to manage content in the entity folder.
444
+ * VIEWER: all users in the group are restricted to just view content in the entity folder.
445
+ * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
446
+ */
447
+ entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
448
+
404
449
  // Required identifier to associate the external user with an
405
450
  // automatically generated internal Omni user.
406
451
  externalId: string;
@@ -522,14 +567,29 @@ type CreateSessionTokenProps = {
522
567
  entity?: string;
523
568
 
524
569
  /**
525
- * Optional content role setting for the entity folder. Can be one of "MANAGER", "EDITOR", or "VIEWER".
570
+ * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
571
+ * or "NO_ACCESS".
526
572
  *
527
573
  * MANAGER: the user will have the ability to manage content and content permissions of the entity folder.
528
574
  * EDITOR: the user will have the ability to manage content in the entity folder.
529
575
  * VIEWER: the user will only be able to view content in the entity folder.
576
+ * NO_ACCESS: the user will have no access to content in the top-level entity folder. Note that the
577
+ * entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
578
+ * to the top-level entity folder.
530
579
  */
531
580
  entityFolderContentRole?: EmbedEntityFolderContentRoles;
532
581
 
582
+ /**
583
+ * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
584
+ * or "NO_ACCESS".
585
+ *
586
+ * MANAGER: all users in the group will have the ability to manage content and content permissions of the entity folder.
587
+ * EDITOR: all users in the group have the ability to manage content in the entity folder.
588
+ * VIEWER: all users in the group are restricted to just view content in the entity folder.
589
+ * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
590
+ */
591
+ entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
592
+
533
593
  // Required identifier to associate the external user with an automatically generated internal Omni user.
534
594
  externalId: string;
535
595
 
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.12.0",
2
+ "version": "0.12.2",
3
3
  "license": "MIT",
4
4
  "name": "@omni-co/embed",
5
5
  "author": "Nate Agrin <nate@exploreomni.com>",