Create AllUsers Principal and deprecate Anyone Principal (#3091)

coda · Oct 22, 2024 · 940ab93 · 940ab93
1 parent 1724cb1
commit 940ab93
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 7 deletions.
diff --git a/dist/bundle.d.ts b/dist/bundle.d.ts
diff --git a/dist/schema.d.ts b/dist/schema.d.ts
diff --git a/dist/schema.js b/dist/schema.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@codahq/packs-sdk",
-  "version": "1.8.1-prerelease.3",
+  "version": "1.8.1-prerelease.4",
   "license": "MIT",
   "workspaces": [
     "dev/eslint"

diff --git a/schema.ts b/schema.ts
@@ -1386,7 +1386,12 @@ export interface ObjectSchemaDefinition<K extends string, L extends string>
 export enum PrincipalType {
   User = 'user',
   Group = 'group',
+  /**
+   * @deprecated
+   * @hidden
+   */
   Anyone = 'anyone',
+  AllUsers = 'allUsers',
   Domain = 'domain',
 }
 
@@ -1426,22 +1431,35 @@ export interface DomainPrincipal {
 /**
  * This represents a principal corresponding to anyone
  *
- * Generally this would apply to an entity where anyone with access to the url can view the item
+ * Generally this would apply to an entity where anyone with access to the url can view the item.
+ * Deprecated in favor of {@link AllUsersPrincipal}. Will be removed in a future SDK version.
  *
  * TODO(sam): Unhide this
+ * @deprecated
  * @hidden
  */
 export interface AnyonePrincipal {
   type: PrincipalType.Anyone;
 }
 
+/**
+ * This represents a principal corresponding to anyone who has access to the external system.
+ *
+ * This corresponds to any user who appears in the sync table with role {@link TableRole.Users}
+ *
+ * TODO(sam): Unhide this
+ * @hidden
+ */
+export interface AllUsersPrincipal {
+  type: PrincipalType.AllUsers;
+}
 /**
  * This represents a principal that can be granted access.
  *
  * TODO(sam): Unhide this
  * @hidden
  */
-type Principal = UserPrincipal | GroupPrincipal | AnyonePrincipal | DomainPrincipal;
+type Principal = UserPrincipal | GroupPrincipal | AnyonePrincipal | DomainPrincipal | AllUsersPrincipal;
 
 /**
  * The type of permission.