@coveo/push-api-client 3.0.116 → 3.0.122

package/dist/definitions/help/fileConsumer.d.ts

@@ -1,31 +1,31 @@
-import { BatchUpdateDocuments, UploadBatchCallbackData, ConcurrentProcessing, ParseDocumentOptions } from '../interfaces';
-import type { Response } from 'undici';
-export type SuccessfulUploadCallback = (data: UploadBatchCallbackData) => void;
-export type FailedUploadCallback = (err: unknown, value: UploadBatchCallbackData) => void;
-/**
- * Util class to help injesting documents through a list of files and uploading generated document batches.
- */
-export declare class FileConsumer {
-    private upload;
-    private processingConfig;
-    private static maxContentLength;
-    private _totalDocumentCount?;
-    private _remainingDocumentCount?;
-    private cbSuccess;
-    private cbFail;
-    /**
-     * Creates an instance of FileConsumer.
-     * @param {(batch: BatchUpdateDocuments) => Promise<Response>} upload the upload operation to apply to every document batch
-     * @param {Required<ConcurrentProcessing>} processingConfig
-     */
-    constructor(upload: (batch: BatchUpdateDocuments) => Promise<Response>, processingConfig: Required<ConcurrentProcessing>);
-    consume(files: string[], options?: ParseDocumentOptions): Promise<void>;
-    onSuccess(callback: SuccessfulUploadCallback): void;
-    onError(callback: FailedUploadCallback): void;
-    private splitByChunkAndUpload;
-    set expectedDocumentCount(count: number);
-    private getRemainingDocumentCount;
-    private uploadBatch;
-    private getProgress;
-    private get accumulator();
-}
+import { BatchUpdateDocuments, UploadBatchCallbackData, ConcurrentProcessing, ParseDocumentOptions } from '../interfaces';
+import type { Response } from 'undici';
+export type SuccessfulUploadCallback = (data: UploadBatchCallbackData) => void;
+export type FailedUploadCallback = (err: unknown, value: UploadBatchCallbackData) => void;
+/**
+ * Util class to help injesting documents through a list of files and uploading generated document batches.
+ */
+export declare class FileConsumer {
+    private upload;
+    private processingConfig;
+    private static maxContentLength;
+    private _totalDocumentCount?;
+    private _remainingDocumentCount?;
+    private cbSuccess;
+    private cbFail;
+    /**
+     * Creates an instance of FileConsumer.
+     * @param {(batch: BatchUpdateDocuments) => Promise<Response>} upload the upload operation to apply to every document batch
+     * @param {Required<ConcurrentProcessing>} processingConfig
+     */
+    constructor(upload: (batch: BatchUpdateDocuments) => Promise<Response>, processingConfig: Required<ConcurrentProcessing>);
+    consume(files: string[], options?: ParseDocumentOptions): Promise<void>;
+    onSuccess(callback: SuccessfulUploadCallback): void;
+    onError(callback: FailedUploadCallback): void;
+    private splitByChunkAndUpload;
+    set expectedDocumentCount(count: number);
+    private getRemainingDocumentCount;
+    private uploadBatch;
+    private getProgress;
+    private get accumulator();
+}

package/dist/definitions/help/fileConsumer.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/definitions/help/fileContainer.d.ts

@@ -1,8 +1,8 @@
-import type { Response } from 'undici';
-import { BatchUpdateDocuments } from '../interfaces';
-export interface FileContainerResponse {
-    uploadUri: string;
-    fileId: string;
-    requiredHeaders: Record<string, string>;
-}
-export declare const uploadContentToFileContainer: (fileContainer: FileContainerResponse, batch: BatchUpdateDocuments) => Promise<Response>;
+import type { Response } from 'undici';
+import { BatchUpdateDocuments } from '../interfaces';
+export interface FileContainerResponse {
+    uploadUri: string;
+    fileId: string;
+    requiredHeaders: Record<string, string>;
+}
+export declare const uploadContentToFileContainer: (fileContainer: FileContainerResponse, batch: BatchUpdateDocuments) => Promise<Response>;

package/dist/definitions/help/fileContainer.spec.d.ts

@@ -1 +1 @@
-import 'fetch-undici-polyfill';
+import 'fetch-undici-polyfill';

package/dist/definitions/help/function.d.ts

@@ -1 +1 @@
-export declare const noop: () => void;
+export declare const noop: () => void;

package/dist/definitions/help/generator.d.ts

@@ -1,11 +1,11 @@
-type PromiseGenerator<T> = Generator<Promise<T>, void, unknown> | AsyncGenerator<T, void, unknown>;
-/**
- * Consumes a generator or an async generator function concurrently
- *
- * @template T
- * @param {() => PromiseGenerator<T>} generator The generator function to consume.
- * @param {number} maxConcurrent The number of maximum concurrent workers.
- * @param {(worker: number, promiseValue: Awaited<T>) => void} [callback] A callback function that runs after each iteration of the iterator. It takes in argument the promise resolved value as well as the worker (ID) assigned to fulfill that promise.
- */
-export declare const consumeGenerator: <T>(generator: () => PromiseGenerator<T>, maxConcurrent: number, callback?: ((worker: number, promiseValue: Awaited<T>) => void) | undefined) => Promise<(void | Awaited<T>)[]>;
-export {};
+type PromiseGenerator<T> = Generator<Promise<T>, void, unknown> | AsyncGenerator<T, void, unknown>;
+/**
+ * Consumes a generator or an async generator function concurrently
+ *
+ * @template T
+ * @param {() => PromiseGenerator<T>} generator The generator function to consume.
+ * @param {number} maxConcurrent The number of maximum concurrent workers.
+ * @param {(worker: number, promiseValue: Awaited<T>) => void} [callback] A callback function that runs after each iteration of the iterator. It takes in argument the promise resolved value as well as the worker (ID) assigned to fulfill that promise.
+ */
+export declare const consumeGenerator: <T>(generator: () => PromiseGenerator<T>, maxConcurrent: number, callback?: ((worker: number, promiseValue: Awaited<T>) => void) | undefined) => Promise<(void | Awaited<T>)[]>;
+export {};

package/dist/definitions/help/generator.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/definitions/help/urlUtils.d.ts

@@ -1,27 +1,27 @@
-/// <reference types="node" />
-import { PlatformUrlOptions } from '..';
-export interface URLBuilder {
-    baseAPIURLForUpdate: URL;
-    fileContainerUrl: URL;
-}
-declare abstract class BaseUrlBuilder {
-    private organizationId;
-    private options;
-    protected constructor(organizationId: string, options: Required<PlatformUrlOptions>);
-    protected get platformURL(): string;
-    get fileContainerUrl(): import("url").URL;
-    abstract get baseAPIURLForUpdate(): URL;
-}
-export declare class PushUrlBuilder extends BaseUrlBuilder implements URLBuilder {
-    private sourceId;
-    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
-    get baseURL(): import("url").URL;
-    get baseAPIURLForUpdate(): import("url").URL;
-}
-export declare class StreamUrlBuilder extends BaseUrlBuilder implements URLBuilder {
-    private sourceId;
-    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
-    get baseStreamURL(): import("url").URL;
-    get baseAPIURLForUpdate(): import("url").URL;
-}
-export {};
+/// <reference types="node" />
+import { PlatformUrlOptions } from '..';
+export interface URLBuilder {
+    baseAPIURLForUpdate: URL;
+    fileContainerUrl: URL;
+}
+declare abstract class BaseUrlBuilder {
+    private organizationId;
+    private options;
+    protected constructor(organizationId: string, options: Required<PlatformUrlOptions>);
+    protected get platformURL(): string;
+    get fileContainerUrl(): import("url").URL;
+    abstract get baseAPIURLForUpdate(): URL;
+}
+export declare class PushUrlBuilder extends BaseUrlBuilder implements URLBuilder {
+    private sourceId;
+    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
+    get baseURL(): import("url").URL;
+    get baseAPIURLForUpdate(): import("url").URL;
+}
+export declare class StreamUrlBuilder extends BaseUrlBuilder implements URLBuilder {
+    private sourceId;
+    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
+    get baseStreamURL(): import("url").URL;
+    get baseAPIURLForUpdate(): import("url").URL;
+}
+export {};

package/dist/definitions/help/urlUtils.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/definitions/index.d.ts

@@ -1,14 +1,14 @@
-export * from './document';
-export * from './validation/transformers/transformer';
-export * as errors from './errors';
-export { PushSource } from './source/push';
-export { CatalogSource } from './source/catalog';
-export { SuccessfulUploadCallback, FailedUploadCallback, } from './help/fileConsumer';
-export { UploadBatchCallbackData, BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, } from './interfaces';
-export { FieldAnalyser } from './fieldAnalyser/fieldAnalyser';
-export { DocumentBuilder } from './documentBuilder';
-export * from './securityIdentityBuilder';
-export { PlatformEnvironment, Region, PlatformUrlOptions } from './environment';
-export { SourceVisibility } from '@coveo/platform-client';
-export { PermissionSetBuilder } from './permissionSetBuilder';
-export { parseAndGetDocumentBuilderFromJSONDocument } from './validation/parseFile';
+export * from './document';
+export * from './validation/transformers/transformer';
+export * as errors from './errors';
+export { PushSource } from './source/push';
+export { CatalogSource } from './source/catalog';
+export { SuccessfulUploadCallback, FailedUploadCallback, } from './help/fileConsumer';
+export { UploadBatchCallbackData, BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, } from './interfaces';
+export { FieldAnalyser } from './fieldAnalyser/fieldAnalyser';
+export { DocumentBuilder } from './documentBuilder';
+export * from './securityIdentityBuilder';
+export { PlatformEnvironment, Region, PlatformUrlOptions } from './environment';
+export { SourceVisibility } from '@coveo/platform-client';
+export { PermissionSetBuilder } from './permissionSetBuilder';
+export { parseAndGetDocumentBuilderFromJSONDocument } from './validation/parseFile';

package/dist/definitions/interfaces.d.ts

@@ -1,70 +1,70 @@
-/// <reference types="node" />
-import type { Response } from 'undici';
-import { PathLike } from 'fs';
-import type { DocumentBuilder } from './documentBuilder';
-import type { Transformer } from './validation/transformers/transformer';
-export interface BatchUpdateDocuments {
-    addOrUpdate: DocumentBuilder[];
-    delete: {
-        documentId: string;
-        deleteChildren: boolean;
-    }[];
-}
-/**
- * @param {number} remainingDocumentCount Number of remaining documents to upload. This value decreases each time a new batch is uploaded
- * @param {number} totalDocumentCount Total number documents to upload
- */
-export interface UploadProgress {
-    remainingDocumentCount: number;
-    totalDocumentCount: number;
-}
-/**
- *
- * @param {string[]} files Files from which the documentBuilders were generated
- * @param {DocumentBuilder[]} batch List of the uploaded DocumentBuilders
- * @param {UploadProgress} progress Progress of the upload process
- * @param {Response} res fetch response
- */
-export interface UploadBatchCallbackData {
-    files: string[];
-    batch: DocumentBuilder[];
-    progress?: UploadProgress;
-    res?: Response;
-}
-export interface BatchUpdateDocumentsOptions {
-    /**
-     * Whether to create the missing fields required in the index based on the document batch metadata.
-     *
-     * Make sure your API key is granted the privilege to EDIT fields before using this option.
-     * See https://docs.coveo.com/en/1707#fields-domain
-     *
-     * @default true
-     */
-    createFields?: boolean;
-}
-export interface ParseDocumentOptions {
-    /**
-     * The {@link Transformer} to apply to the fields found in the parsed documents.
-     * If not specified, no transformation will be applied to the field names.
-     * A Transformer is useful to prevent getting errors whenever some of field names contain special characters or any other element not supported by the Platform.
-     *
-     * For a list of built-in transformers, use {@link BuiltInTransformers}.
-     *
-     * @default BuiltInTransformers.identity
-     */
-    fieldNameTransformer?: Transformer;
-    /**
-     * Callback to execute everytime a new {@link DocumentBuilder} is created
-     */
-    callback?: (docBuilder: DocumentBuilder, documentPath: PathLike) => void;
-}
-export interface ConcurrentProcessing {
-    /**
-     * The maximum number of requests to send concurrently to the Coveo platform.
-     * Increasing this value will increase the speed at which documents are pushed but will also consume more memory.
-     *
-     * @default 10
-     */
-    maxConcurrent?: number;
-}
-export type BatchUpdateDocumentsFromFiles = BatchUpdateDocumentsOptions & ConcurrentProcessing & ParseDocumentOptions;
+/// <reference types="node" />
+import type { Response } from 'undici';
+import { PathLike } from 'fs';
+import type { DocumentBuilder } from './documentBuilder';
+import type { Transformer } from './validation/transformers/transformer';
+export interface BatchUpdateDocuments {
+    addOrUpdate: DocumentBuilder[];
+    delete: {
+        documentId: string;
+        deleteChildren: boolean;
+    }[];
+}
+/**
+ * @param {number} remainingDocumentCount Number of remaining documents to upload. This value decreases each time a new batch is uploaded
+ * @param {number} totalDocumentCount Total number documents to upload
+ */
+export interface UploadProgress {
+    remainingDocumentCount: number;
+    totalDocumentCount: number;
+}
+/**
+ *
+ * @param {string[]} files Files from which the documentBuilders were generated
+ * @param {DocumentBuilder[]} batch List of the uploaded DocumentBuilders
+ * @param {UploadProgress} progress Progress of the upload process
+ * @param {Response} res fetch response
+ */
+export interface UploadBatchCallbackData {
+    files: string[];
+    batch: DocumentBuilder[];
+    progress?: UploadProgress;
+    res?: Response;
+}
+export interface BatchUpdateDocumentsOptions {
+    /**
+     * Whether to create the missing fields required in the index based on the document batch metadata.
+     *
+     * Make sure your API key is granted the privilege to EDIT fields before using this option.
+     * See https://docs.coveo.com/en/1707#fields-domain
+     *
+     * @default true
+     */
+    createFields?: boolean;
+}
+export interface ParseDocumentOptions {
+    /**
+     * The {@link Transformer} to apply to the fields found in the parsed documents.
+     * If not specified, no transformation will be applied to the field names.
+     * A Transformer is useful to prevent getting errors whenever some of field names contain special characters or any other element not supported by the Platform.
+     *
+     * For a list of built-in transformers, use {@link BuiltInTransformers}.
+     *
+     * @default BuiltInTransformers.identity
+     */
+    fieldNameTransformer?: Transformer;
+    /**
+     * Callback to execute everytime a new {@link DocumentBuilder} is created
+     */
+    callback?: (docBuilder: DocumentBuilder, documentPath: PathLike) => void;
+}
+export interface ConcurrentProcessing {
+    /**
+     * The maximum number of requests to send concurrently to the Coveo platform.
+     * Increasing this value will increase the speed at which documents are pushed but will also consume more memory.
+     *
+     * @default 10
+     */
+    maxConcurrent?: number;
+}
+export type BatchUpdateDocumentsFromFiles = BatchUpdateDocumentsOptions & ConcurrentProcessing & ParseDocumentOptions;

package/dist/definitions/localtest.d.ts

@@ -1 +1 @@
-import 'dotenv/config';
+import 'dotenv/config';

package/dist/definitions/permissionSetBuilder.d.ts

@@ -1,34 +1,34 @@
-import { PermissionSet } from '@coveo/platform-client';
-import { SecurityIdentityBuilder } from './securityIdentityBuilder';
-export type PermissionSection = keyof Pick<PermissionSet, 'allowedPermissions' | 'deniedPermissions'>;
-export declare class PermissionSetBuilder {
-    private permissionSet;
-    /**
-     * Builds a Permission Set Model
-     *
-     * See[Simple Permission Model Definition](https://docs.coveo.com/en/107/index-content/simple-permission-model-definition-examples)
-     * @param {boolean} allowAnonymous Whether to allow anonymous users in this permission set
-     */
-    constructor(allowAnonymous: boolean);
-    /**
-     * Set allowed identities on the document. See {@link PermissionSet}
-     *
-     * When the {@link PermissionsSetBuilder} class is instanciated with `allowAnonymous` property set to `true`, calling this method is redundant, and can therefore be omitted.
-     * @param securityIdentityBuilder The allowed security identities to add to the permission set
-     * @returns
-     */
-    withAllowedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
-    /**
-     * Set denied identities on the document. See {@link PermissionSet}
-     *
-     * @param securityIdentityBuilder The denied security identities to add to the permission set
-     * @returns
-     */
-    withDeniedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build(): PermissionSet;
-    private setPermission;
-}
+import { PermissionSet } from '@coveo/platform-client';
+import { SecurityIdentityBuilder } from './securityIdentityBuilder';
+export type PermissionSection = keyof Pick<PermissionSet, 'allowedPermissions' | 'deniedPermissions'>;
+export declare class PermissionSetBuilder {
+    private permissionSet;
+    /**
+     * Builds a Permission Set Model
+     *
+     * See[Simple Permission Model Definition](https://docs.coveo.com/en/107/index-content/simple-permission-model-definition-examples)
+     * @param {boolean} allowAnonymous Whether to allow anonymous users in this permission set
+     */
+    constructor(allowAnonymous: boolean);
+    /**
+     * Set allowed identities on the document. See {@link PermissionSet}
+     *
+     * When the {@link PermissionsSetBuilder} class is instanciated with `allowAnonymous` property set to `true`, calling this method is redundant, and can therefore be omitted.
+     * @param securityIdentityBuilder The allowed security identities to add to the permission set
+     * @returns
+     */
+    withAllowedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
+    /**
+     * Set denied identities on the document. See {@link PermissionSet}
+     *
+     * @param securityIdentityBuilder The denied security identities to add to the permission set
+     * @returns
+     */
+    withDeniedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build(): PermissionSet;
+    private setPermission;
+}

package/dist/definitions/permissionSetBuilder.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/definitions/securityIdentityBuilder.d.ts

@@ -1,105 +1,105 @@
-import { Permission, PermissionIdentityType } from '@coveo/platform-client';
-/**
- * Build a security identity. See {@link Permission}.
- */
-export interface SecurityIdentityBuilder {
-    build(): Permission | Permission[];
-}
-/**
- * Build any {@link PermissionIdentityType}.
- *
- * Instead of using this class directly, use one of:
- * - {@link UserSecurityIdentityBuilder}
- * - {@link GroupSecurityIdentityBuilder}
- * - {@link VirtualGroupSecurityIdentityBuilder}
- */
-export declare class AnySecurityIdentityBuilder implements SecurityIdentityBuilder {
-    private securityIdentity;
-    /**
-     * @param identityType  The type of the identity.
-     * Valid values:
-     * - `UNKNOWN`
-     * - `USER` : Defines a single user.
-     * - `GROUP` : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
-     * - `VIRTUAL_GROUP` : Defines a group that doesn't exist within the indexed system. Mechanically, a `VIRTUAL_GROUP` is identical to a `GROUP`.
-     *
-     * @param identity The name of the security identity.
-     * Examples:
-     * - `asmith@example.com`
-     * - `SampleTeam2`
-     *
-     * @param securityProvider The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
-     */
-    constructor(identityType: PermissionIdentityType, identity: string, securityProvider?: string);
-    /**
-     * Build and return the security identity.
-     * @returns
-     */
-    build(): Permission;
-}
-/**
- * Build a security identity of type `USER`.
- *
- * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-export declare class UserSecurityIdentityBuilder implements SecurityIdentityBuilder {
-    private user;
-    private securityProvider;
-    /**
-     * Pass either a single user, or an array of user to create multiple identities.
-     * @param {(string | string[])} user  The user identity or identities
-     * @param {string} [securityProvider='Email Security Provider'] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
-     */
-    constructor(user: string | string[], securityProvider?: string);
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build(): Permission | Permission[];
-}
-/**
- * Build a security identity of type `GROUP`.
- *
- * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-export declare class GroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
-    private group;
-    private securityProvider?;
-    /**
-     * Pass either a single `group`, or an array of `group` to create multiple identities.
-     * @param {(string | string[])} group
-     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
-     */
-    constructor(group: string | string[], securityProvider?: string | undefined);
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build(): Permission | Permission[];
-}
-/**
- * Build a security identity of type `VIRTUAL_GROUP`.
- *
- * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
- *
- * See {@link Permission}.
- */
-export declare class VirtualGroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
-    private virtualGroup;
-    private securityProvider?;
-    /**
-     * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
-     * @param {(string | string[])} virtualGroup
-     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
-     */
-    constructor(virtualGroup: string | string[], securityProvider?: string | undefined);
-    /**
-     * Build and return the security identity or identities.
-     * @returns
-     */
-    build(): Permission | Permission[];
-}
+import { Permission, PermissionIdentityType } from '@coveo/platform-client';
+/**
+ * Build a security identity. See {@link Permission}.
+ */
+export interface SecurityIdentityBuilder {
+    build(): Permission | Permission[];
+}
+/**
+ * Build any {@link PermissionIdentityType}.
+ *
+ * Instead of using this class directly, use one of:
+ * - {@link UserSecurityIdentityBuilder}
+ * - {@link GroupSecurityIdentityBuilder}
+ * - {@link VirtualGroupSecurityIdentityBuilder}
+ */
+export declare class AnySecurityIdentityBuilder implements SecurityIdentityBuilder {
+    private securityIdentity;
+    /**
+     * @param identityType  The type of the identity.
+     * Valid values:
+     * - `UNKNOWN`
+     * - `USER` : Defines a single user.
+     * - `GROUP` : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
+     * - `VIRTUAL_GROUP` : Defines a group that doesn't exist within the indexed system. Mechanically, a `VIRTUAL_GROUP` is identical to a `GROUP`.
+     *
+     * @param identity The name of the security identity.
+     * Examples:
+     * - `asmith@example.com`
+     * - `SampleTeam2`
+     *
+     * @param securityProvider The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
+     */
+    constructor(identityType: PermissionIdentityType, identity: string, securityProvider?: string);
+    /**
+     * Build and return the security identity.
+     * @returns
+     */
+    build(): Permission;
+}
+/**
+ * Build a security identity of type `USER`.
+ *
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+export declare class UserSecurityIdentityBuilder implements SecurityIdentityBuilder {
+    private user;
+    private securityProvider;
+    /**
+     * Pass either a single user, or an array of user to create multiple identities.
+     * @param {(string | string[])} user  The user identity or identities
+     * @param {string} [securityProvider='Email Security Provider'] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
+     */
+    constructor(user: string | string[], securityProvider?: string);
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build(): Permission | Permission[];
+}
+/**
+ * Build a security identity of type `GROUP`.
+ *
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+export declare class GroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
+    private group;
+    private securityProvider?;
+    /**
+     * Pass either a single `group`, or an array of `group` to create multiple identities.
+     * @param {(string | string[])} group
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
+     */
+    constructor(group: string | string[], securityProvider?: string | undefined);
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build(): Permission | Permission[];
+}
+/**
+ * Build a security identity of type `VIRTUAL_GROUP`.
+ *
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
+ *
+ * See {@link Permission}.
+ */
+export declare class VirtualGroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
+    private virtualGroup;
+    private securityProvider?;
+    /**
+     * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
+     * @param {(string | string[])} virtualGroup
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
+     */
+    constructor(virtualGroup: string | string[], securityProvider?: string | undefined);
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build(): Permission | Permission[];
+}

package/dist/definitions/securityIdentityBuilder.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};