@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
140 lines • 5.68 kB
JavaScript
import { getIdFromLink, getPathFromLink, isResourceValid, ResourceType, } from "../../common/index.js";
import { QueryIterator } from "../../queryIterator.js";
import { Permission } from "./Permission.js";
import { PermissionResponse } from "./PermissionResponse.js";
import { getEmptyCosmosDiagnostics, withDiagnostics } from "../../utils/diagnostics.js";
/**
* Use to create, replace, query, and read all Permissions.
*
* @see {@link Permission} to read, replace, or delete a specific permission by id.
*/
export class Permissions {
/**
* @hidden
* @param user - The parent {@link User}.
*/
constructor(user, clientContext) {
this.user = user;
this.clientContext = clientContext;
}
query(query, options) {
const path = getPathFromLink(this.user.url, ResourceType.permission);
const id = getIdFromLink(this.user.url);
return new QueryIterator(this.clientContext, query, options, (diagnosticNode, innerOptions) => {
return this.clientContext.queryFeed({
path,
resourceType: ResourceType.permission,
resourceId: id,
resultFn: (result) => result.Permissions,
query,
options: innerOptions,
diagnosticNode,
});
});
}
/**
* Read all permissions.
* @example Read all permissions to array.
* ```ts snippet:PermissionsReadAll
* import { CosmosClient } from "@azure/cosmos";
*
* const endpoint = "https://your-account.documents.azure.com";
* const key = "<database account masterkey>";
* const client = new CosmosClient({ endpoint, key });
*
* const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
*
* const { resources: permissionList } = await database.user("user1").permissions.readAll().fetchAll();
* ```
*/
readAll(options) {
return this.query(undefined, options);
}
/**
* Create a permission.
*
* A permission represents a per-User Permission to access a specific resource
* e.g. Item or Container.
* @param body - Represents the body of the permission.
* @example
* ```ts snippet:PermissionsCreate
* import { CosmosClient, PermissionDefinition, PermissionMode } from "@azure/cosmos";
*
* const endpoint = "https://your-account.documents.azure.com";
* const key = "<database account masterkey>";
* const client = new CosmosClient({ endpoint, key });
* const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
* const { user } = await database.users.create({ id: "<user-id>" });
*
* const permissionDefinition: PermissionDefinition = {
* id: "<permission-id>",
* permissionMode: PermissionMode.Read,
* resource: "<resource-url>",
* };
* await user.permissions.create(permissionDefinition);
* ```
*/
async create(body, options) {
return withDiagnostics(async (diagnosticNode) => {
const err = {};
if (!isResourceValid(body, err)) {
throw err;
}
const path = getPathFromLink(this.user.url, ResourceType.permission);
const id = getIdFromLink(this.user.url);
const response = await this.clientContext.create({
body,
path,
resourceType: ResourceType.permission,
resourceId: id,
diagnosticNode,
options,
});
const ref = new Permission(this.user, response.result.id, this.clientContext);
return new PermissionResponse(response.result, response.headers, response.code, ref, getEmptyCosmosDiagnostics());
}, this.clientContext);
}
/**
* Upsert a permission.
* A permission represents a per-User Permission to access a
* specific resource e.g. Item or Container.
* @example
* ```ts snippet:PermissionsUpsert
* import { CosmosClient, PermissionDefinition, PermissionMode } from "@azure/cosmos";
*
* const endpoint = "https://your-account.documents.azure.com";
* const key = "<database account masterkey>";
* const client = new CosmosClient({ endpoint, key });
* const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
* const user = database.user("<user-id>");
* const permissionDefinitionToUpsert: PermissionDefinition = {
* id: "<permission-id>",
* permissionMode: PermissionMode.Read,
* resource: "<resource-url>",
* };
*
* await user.permissions.upsert(permissionDefinitionToUpsert);
* ```
*/
async upsert(body, options) {
return withDiagnostics(async (diagnosticNode) => {
const err = {};
if (!isResourceValid(body, err)) {
throw err;
}
const path = getPathFromLink(this.user.url, ResourceType.permission);
const id = getIdFromLink(this.user.url);
const response = await this.clientContext.upsert({
body,
path,
resourceType: ResourceType.permission,
resourceId: id,
options,
diagnosticNode,
});
const ref = new Permission(this.user, response.result.id, this.clientContext);
return new PermissionResponse(response.result, response.headers, response.code, ref, getEmptyCosmosDiagnostics());
}, this.clientContext);
}
}
//# sourceMappingURL=Permissions.js.map