@alis-build/common-es 1.0.3

package/alis/open/iam/v1/role_pb.d.ts

@@ -0,0 +1,95 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts"
+// @generated from file alis/open/iam/v1/role.proto (package alis.open.iam.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Timestamp } from "@alis-build/google-common-protos/google/protobuf/timestamp_pb";
+
+/**
+ * Describes the file alis/open/iam/v1/role.proto.
+ */
+export declare const file_alis_open_iam_v1_role: GenFile;
+
+/**
+ * The definition of a role in the context of a product
+ *
+ * @generated from message alis.open.iam.v1.Role
+ */
+export declare type Role = Message<"alis.open.iam.v1.Role"> & {
+  /**
+   * The name of the role
+   * Format: roles/([a-z][a-zA-Z0-9.]{3,50})
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * The creation time of the Role.
+   *
+   * @generated from field: google.protobuf.Timestamp create_time = 2;
+   */
+  createTime?: Timestamp;
+
+  /**
+   * The last time the Role was updated.
+   *
+   * @generated from field: google.protobuf.Timestamp update_time = 3;
+   */
+  updateTime?: Timestamp;
+
+  /**
+   * Used to perform a consistent read-modify-write.
+   *
+   * @generated from field: bytes etag = 4;
+   */
+  etag: Uint8Array;
+
+  /**
+   * The title of the role
+   *
+   * @generated from field: string title = 5;
+   */
+  title: string;
+
+  /**
+   * The description of the role
+   *
+   * @generated from field: string description = 6;
+   */
+  description: string;
+
+  /**
+   * The permissions that this role grants
+   * Almost always uses the format of the grpc method name
+   * E.g. /alis.open.iam.v1.RolesService/ListRoles and/or /someorg.ab.library.v1.BookService/GetBook
+   *
+   * @generated from field: repeated string permissions = 7;
+   */
+  permissions: string[];
+
+  /**
+   * The proto message types of the resources' policies that this role can be bound to
+   * E.g. alis.open.iam.v1.Role and/or someorg.ab.library.v1.Book
+   *
+   * @generated from field: repeated string resource_types = 8;
+   */
+  resourceTypes: string[];
+
+  /**
+   * Whether the role is given to all users by default.
+   * This is used to group RPCs that are available to any user that has access to the deployment.
+   * If this is true, resource_types must be empty.
+   * The alternative would be to create a role that gets assigned to any new users.
+   *
+   * @generated from field: bool all_users = 9;
+   */
+  allUsers: boolean;
+};
+
+/**
+ * Describes the message alis.open.iam.v1.Role.
+ * Use `create(RoleSchema)` to create a new message.
+ */
+export declare const RoleSchema: GenMessage<Role>;

package/alis/open/iam/v1/role_pb.js

@@ -0,0 +1,19 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts"
+// @generated from file alis/open/iam/v1/role.proto (package alis.open.iam.v1, syntax proto3)
+/* eslint-disable */
+
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_timestamp } from "@alis-build/google-common-protos/google/protobuf/timestamp_pb";
+
+/**
+ * Describes the file alis/open/iam/v1/role.proto.
+ */
+export const file_alis_open_iam_v1_role = /*@__PURE__*/
+  fileDesc("ChthbGlzL29wZW4vaWFtL3YxL3JvbGUucHJvdG8SEGFsaXMub3Blbi5pYW0udjEi6AEKBFJvbGUSDAoEbmFtZRgBIAEoCRIvCgtjcmVhdGVfdGltZRgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLwoLdXBkYXRlX3RpbWUYAyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEgwKBGV0YWcYBCABKAwSDQoFdGl0bGUYBSABKAkSEwoLZGVzY3JpcHRpb24YBiABKAkSEwoLcGVybWlzc2lvbnMYByADKAkSFgoOcmVzb3VyY2VfdHlwZXMYCCADKAkSEQoJYWxsX3VzZXJzGAkgASgIQi5aLG9wZW4uYWxpcy5zZXJ2aWNlcy9wcm90b2J1Zi9hbGlzL29wZW4vaWFtL3YxYgZwcm90bzM", [file_google_protobuf_timestamp]);
+
+/**
+ * Describes the message alis.open.iam.v1.Role.
+ * Use `create(RoleSchema)` to create a new message.
+ */
+export const RoleSchema = /*@__PURE__*/
+  messageDesc(file_alis_open_iam_v1_role, 0);

package/alis/open/iam/v1/user_connect.d.ts

@@ -0,0 +1,327 @@
+// @generated by protoc-gen-connect-es v1.7.0 with parameter "target=js+dts"
+// @generated from file alis/open/iam/v1/user.proto (package alis.open.iam.v1, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { RetrieveRulesRequest, RetrieveRulesResponse, ValidateMessageRequest, ValidateMessageResponse } from "../../validation/v1/validation_pb.js";
+import { MethodKind } from "@bufbuild/protobuf";
+import { GetIamPolicyRequest, SetIamPolicyRequest, TestIamPermissionsRequest, TestIamPermissionsResponse } from "@alis-build/google-common-protos/google/iam/v1/iam_policy_pb.js";
+import { Policy } from "@alis-build/google-common-protos/google/iam/v1/policy_pb.js";
+import { AddIamBindingsRequest, RemoveIamBindingsRequest } from "./iam_pb.js";
+import { BatchRetrieveMaskedUsersRequest, BatchRetrieveMaskedUsersResponse, CreateUserRequest, DeleteUserRequest, EditMyInfoRequest, EditMyMetadataRequest, EditUserInfoRequest, EditUserMetadataRequest, GetUserRequest, ListUsersRequest, ListUsersResponse, LookupUserRequest, LookupUserResponse, MaskedUser, RemoveMyUserRequest, RetrieveMaskedUserRequest, RetrieveMaskedUsersRequest, RetrieveMaskedUsersResponse, RetrieveMyUserRequest, RetrieveUserByEmailRequest, SetUserPictureRequest, SetUserPictureResponse, SyncToGoogleGroupRequest, SyncToGoogleGroupResponse, UpdateUserRequest, User } from "./user_pb.js";
+import { Empty } from "@alis-build/google-common-protos/google/protobuf/empty_pb.js";
+
+/**
+ * UsersService provides RPCs for managing User resources.
+ *
+ * @generated from service alis.open.iam.v1.UsersService
+ */
+export declare const UsersService: {
+  readonly typeName: "alis.open.iam.v1.UsersService",
+  readonly methods: {
+    /**
+     * Validates any proto message that is used directly or indirectly by this service.
+     * Most common use case is to validate request messages from a client-side application.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.ValidateMessage
+     */
+    readonly validateMessage: {
+      readonly name: "ValidateMessage",
+      readonly I: typeof ValidateMessageRequest,
+      readonly O: typeof ValidateMessageResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieves the validation rules for any proto message that is used directly or indirectly by this service.
+     * Serves as live auto-documentation of the validation rules in this service.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RetrieveRules
+     */
+    readonly retrieveRules: {
+      readonly name: "RetrieveRules",
+      readonly I: typeof RetrieveRulesRequest,
+      readonly O: typeof RetrieveRulesResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Gets the IAM policy for a resource implemented in this service.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.GetIamPolicy
+     */
+    readonly getIamPolicy: {
+      readonly name: "GetIamPolicy",
+      readonly I: typeof GetIamPolicyRequest,
+      readonly O: typeof Policy,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Sets the IAM policy for a resource implemented in this service.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.SetIamPolicy
+     */
+    readonly setIamPolicy: {
+      readonly name: "SetIamPolicy",
+      readonly I: typeof SetIamPolicyRequest,
+      readonly O: typeof Policy,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Returns permissions that a caller has on the specified resource.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.TestIamPermissions
+     */
+    readonly testIamPermissions: {
+      readonly name: "TestIamPermissions",
+      readonly I: typeof TestIamPermissionsRequest,
+      readonly O: typeof TestIamPermissionsResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Adds principals or updates the roles existing principals have on an IAM Policy protected resource.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.AddIamBindings
+     */
+    readonly addIamBindings: {
+      readonly name: "AddIamBindings",
+      readonly I: typeof AddIamBindingsRequest,
+      readonly O: typeof Policy,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Removes principals or some of the roles they have on an IAM Policy protected resource.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RemoveIamBindings
+     */
+    readonly removeIamBindings: {
+      readonly name: "RemoveIamBindings",
+      readonly I: typeof RemoveIamBindingsRequest,
+      readonly O: typeof Policy,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Gets information about a User.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.GetUser
+     */
+    readonly getUser: {
+      readonly name: "GetUser",
+      readonly I: typeof GetUserRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Creates a new User.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.CreateUser
+     */
+    readonly createUser: {
+      readonly name: "CreateUser",
+      readonly I: typeof CreateUserRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Updates a User.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.UpdateUser
+     */
+    readonly updateUser: {
+      readonly name: "UpdateUser",
+      readonly I: typeof UpdateUserRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Deletes a User.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.DeleteUser
+     */
+    readonly deleteUser: {
+      readonly name: "DeleteUser",
+      readonly I: typeof DeleteUserRequest,
+      readonly O: typeof Empty,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Lists Users. Results are sorted by name, ascending.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.ListUsers
+     */
+    readonly listUsers: {
+      readonly name: "ListUsers",
+      readonly I: typeof ListUsersRequest,
+      readonly O: typeof ListUsersResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieve a User by their email.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RetrieveUserByEmail
+     */
+    readonly retrieveUserByEmail: {
+      readonly name: "RetrieveUserByEmail",
+      readonly I: typeof RetrieveUserByEmailRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Look up a User based on a search text.
+     *
+     * This method retrieves a set of results, which are Users, based on the request.
+     * The lookup for these Users are done across the given_name, family_name, email and contact number.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.LookupUser
+     */
+    readonly lookupUser: {
+      readonly name: "LookupUser",
+      readonly I: typeof LookupUserRequest,
+      readonly O: typeof LookupUserResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieves the set of Users requested, with only a
+     * subset of the User information returned.
+     *
+     * This is equivalent to a BatchGet method, but only a subset of the User information,
+     * which does not contain any sensitive information such as email or group configurations.
+     *
+     * Differs from the RetrieveMaskedUsers method in that it returns only
+     * the Users that were specified in the request.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.BatchRetrieveMaskedUsers
+     */
+    readonly batchRetrieveMaskedUsers: {
+      readonly name: "BatchRetrieveMaskedUsers",
+      readonly I: typeof BatchRetrieveMaskedUsersRequest,
+      readonly O: typeof BatchRetrieveMaskedUsersResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieves all Users that match the filter criteria, if specified,
+     * with only a subset of the User information.
+     *
+     * This is equivalent to a List method, but only a subset of the User information,
+     * which does not contain any sensitive information such as email or group configurations.
+     *
+     * Differs from the BatchRetrieveMaskedUsers method in that it returns all
+     * the Users that match the filter, if the filter is specified.
+     *
+     * This is useful for displaying a list of Users without revealing sensitive information like email.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RetrieveMaskedUsers
+     */
+    readonly retrieveMaskedUsers: {
+      readonly name: "RetrieveMaskedUsers",
+      readonly I: typeof RetrieveMaskedUsersRequest,
+      readonly O: typeof RetrieveMaskedUsersResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieves a User with some of their details hidden.
+     * This is useful for displaying a User without revealing sensitive information like email.
+     * Both name and email can be used to retrieve the User.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RetrieveMaskedUser
+     */
+    readonly retrieveMaskedUser: {
+      readonly name: "RetrieveMaskedUser",
+      readonly I: typeof RetrieveMaskedUserRequest,
+      readonly O: typeof MaskedUser,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Edits a User's non-auth related information like family name and picture.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.EditUserInfo
+     */
+    readonly editUserInfo: {
+      readonly name: "EditUserInfo",
+      readonly I: typeof EditUserInfoRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Edits a User's metadata
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.EditUserMetadata
+     */
+    readonly editUserMetadata: {
+      readonly name: "EditUserMetadata",
+      readonly I: typeof EditUserMetadataRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Retrieves the currently signed in user.
+     * This is useful for client-side applications to get the signed in user's information.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RetrieveMyUser
+     */
+    readonly retrieveMyUser: {
+      readonly name: "RetrieveMyUser",
+      readonly I: typeof RetrieveMyUserRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Edits the info of the currently signed in user.
+     * This is useful for client-side applications to edit the signed in user's information.
+     * Allows the user to edit their given_name, family_name, picture, contact_number, position, education, linkedin_uri and metadata.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.EditMyInfo
+     */
+    readonly editMyInfo: {
+      readonly name: "EditMyInfo",
+      readonly I: typeof EditMyInfoRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Edits the metadata of the currently signed in user.
+     * This is useful for client-side applications to edit the signed in user's metadata.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.EditMyMetadata
+     */
+    readonly editMyMetadata: {
+      readonly name: "EditMyMetadata",
+      readonly I: typeof EditMyMetadataRequest,
+      readonly O: typeof User,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Removes the currently signed in user.
+     * This is useful if a user wants to delete their account.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.RemoveMyUser
+     */
+    readonly removeMyUser: {
+      readonly name: "RemoveMyUser",
+      readonly I: typeof RemoveMyUserRequest,
+      readonly O: typeof Empty,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Syncs all google User's to the google group configured in the IamConfig.
+     * Will not delete service accounts.
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.SyncToGoogleGroup
+     */
+    readonly syncToGoogleGroup: {
+      readonly name: "SyncToGoogleGroup",
+      readonly I: typeof SyncToGoogleGroupRequest,
+      readonly O: typeof SyncToGoogleGroupResponse,
+      readonly kind: MethodKind.Unary,
+    },
+    /**
+     * Sets the user's profile picture
+     *
+     * @generated from rpc alis.open.iam.v1.UsersService.SetUserPicture
+     */
+    readonly setUserPicture: {
+      readonly name: "SetUserPicture",
+      readonly I: typeof SetUserPictureRequest,
+      readonly O: typeof SetUserPictureResponse,
+      readonly kind: MethodKind.Unary,
+    },
+  }
+};