@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
173 lines (172 loc) • 6.52 kB
JavaScript
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var Permissions_exports = {};
__export(Permissions_exports, {
Permissions: () => Permissions
});
module.exports = __toCommonJS(Permissions_exports);
var import_common = require("../../common/index.js");
var import_queryIterator = require("../../queryIterator.js");
var import_Permission = require("./Permission.js");
var import_PermissionResponse = require("./PermissionResponse.js");
var import_diagnostics = require("../../utils/diagnostics.js");
class Permissions {
/**
* @hidden
* @param user - The parent {@link User}.
*/
constructor(user, clientContext) {
this.user = user;
this.clientContext = clientContext;
}
query(query, options) {
const path = (0, import_common.getPathFromLink)(this.user.url, import_common.ResourceType.permission);
const id = (0, import_common.getIdFromLink)(this.user.url);
return new import_queryIterator.QueryIterator(this.clientContext, query, options, (diagnosticNode, innerOptions) => {
return this.clientContext.queryFeed({
path,
resourceType: import_common.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(void 0, 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 (0, import_diagnostics.withDiagnostics)(async (diagnosticNode) => {
const err = {};
if (!(0, import_common.isResourceValid)(body, err)) {
throw err;
}
const path = (0, import_common.getPathFromLink)(this.user.url, import_common.ResourceType.permission);
const id = (0, import_common.getIdFromLink)(this.user.url);
const response = await this.clientContext.create({
body,
path,
resourceType: import_common.ResourceType.permission,
resourceId: id,
diagnosticNode,
options
});
const ref = new import_Permission.Permission(this.user, response.result.id, this.clientContext);
return new import_PermissionResponse.PermissionResponse(
response.result,
response.headers,
response.code,
ref,
(0, import_diagnostics.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 (0, import_diagnostics.withDiagnostics)(async (diagnosticNode) => {
const err = {};
if (!(0, import_common.isResourceValid)(body, err)) {
throw err;
}
const path = (0, import_common.getPathFromLink)(this.user.url, import_common.ResourceType.permission);
const id = (0, import_common.getIdFromLink)(this.user.url);
const response = await this.clientContext.upsert({
body,
path,
resourceType: import_common.ResourceType.permission,
resourceId: id,
options,
diagnosticNode
});
const ref = new import_Permission.Permission(this.user, response.result.id, this.clientContext);
return new import_PermissionResponse.PermissionResponse(
response.result,
response.headers,
response.code,
ref,
(0, import_diagnostics.getEmptyCosmosDiagnostics)()
);
}, this.clientContext);
}
}
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
Permissions
});