[skyflow-bharti]

Detect support and vault api in flowvault sdk

[github-actions]

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

[github-actions]

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

[github-actions]

Public API surface changes

Compared with main. In the diffs, - lines were removed
from the public API and + lines were added. Removals and signature
changes are breaking for consumers.

skyflow-node: 728 added, 381 removed (base report read from its old location api-report/skyflow-node.api.md)

Show diff

--- base/skyflow-node.api.md
+++ pr/skyflow-node.api.md
@@ -13,6 +13,17 @@
     apiKey: string;
 }
 
+// @public
+interface Audio_2 {
+    // (undocumented)
+    bleep?: Bleep;
+    // (undocumented)
+    outputProcessedAudio?: boolean;
+    // (undocumented)
+    outputTranscription?: OutputTranscriptionType;
+}
+export { Audio_2 as Audio }
+
 // @public (undocumented)
 export type BearerTokenOptions = {
     ctx?: string | Record<string, any>;
@@ -22,24 +33,49 @@
     tokenUri?: string;
 };
 
-// @public (undocumented)
-export class Bleep {
+// @public
+export interface Bleep {
     // (undocumented)
-    getFrequency(): number | undefined;
+    frequency?: number;
     // (undocumented)
-    getGain(): number | undefined;
+    gain?: number;
     // (undocumented)
-    getStartPadding(): number | undefined;
+    startPadding?: number;
     // (undocumented)
-    getStopPadding(): number | undefined;
-    // (undocumented)
-    setFrequency(frequency: number): void;
-    // (undocumented)
-    setGain(gain: number): void;
+    stopPadding?: number;
+}
+
+// @public
+export class CheckGuardrailsRequest {
+    constructor(text: string, fields?: CheckGuardrailsRequestFields);
     // (undocumented)
-    setStartPadding(startPadding: number): void;
+    get checkToxicity(): boolean | undefined;
+    set checkToxicity(value: boolean | undefined);
     // (undocumented)
-    setStopPadding(stopPadding: number): void;
+    get denyTopics(): string[] | undefined;
+    set denyTopics(value: string[] | undefined);
+    get text(): string;
+    set text(value: string);
+}
+
+// @public
+export interface CheckGuardrailsRequestFields {
+    checkToxicity?: boolean;
+    denyTopics?: string[];
+}
+
+// @public
+export class CheckGuardrailsResponse {
+    constructor(input: {
+        text: string | null;
+        validation: GuardrailsValidation;
+        toxic: boolean | null;
+        deniedTopic: boolean | null;
+    });
+    readonly deniedTopic: boolean | null;
+    readonly text: string | null;
+    readonly toxic: boolean | null;
+    readonly validation: GuardrailsValidation;
 }
 
 // @public (undocumented)
@@ -55,203 +91,191 @@
 // @public (undocumented)
 export type Credentials = TokenCredentials | PathCredentials | StringCredentials | ApiKeyCredentials;
 
-// @public (undocumented)
-export class DeidentifyFileOptions {
-    constructor();
+// @public
+export interface CustomType {
+    deidentificationType?: DeidentificationType;
+    destination?: string;
+    includePrefix?: IncludePrefix;
     // (undocumented)
-    getAllowRegexList(): string[] | undefined;
+    label?: string;
     // (undocumented)
-    getBleep(): Bleep | undefined;
+    match?: string[];
+    prefixOverride?: string;
+}
+
+// @public
+export enum DeidentificationType {
     // (undocumented)
-    getEntities(): string[] | undefined;
+    ENTITY_ONLY = "ENTITY_ONLY",
     // (undocumented)
-    getMaskingMethod(): MaskingMethod | undefined;
+    ENTITY_UNIQUE_COUNTER = "ENTITY_UNIQUE_COUNTER",
     // (undocumented)
-    getMaxResolution(): number | undefined;
+    MASK = "MASK",
     // (undocumented)
-    getOutputDirectory(): string | undefined;
+    UNKNOWN = "UNKNOWN",
     // (undocumented)
-    getOutputOcrText(): boolean | undefined;
+    VAULT_TOKEN = "VAULT_TOKEN"
+}
+
+// @public
+export enum DeidentifyFileDataFormat {
     // (undocumented)
-    getOutputProcessedAudio(): boolean | undefined;
+    BMP = "BMP",
     // (undocumented)
-    getOutputProcessedImage(): boolean | undefined;
+    CSV = "CSV",
     // (undocumented)
-    getOutputTranscription(): DetectOutputTranscription | undefined;
+    DCM = "DCM",
     // (undocumented)
-    getPixelDensity(): number | undefined;
+    DOC = "DOC",
     // (undocumented)
-    getRestrictRegexList(): string[] | undefined;
+    DOCX = "DOCX",
     // (undocumented)
-    getTokenFormat(): TokenFormat | undefined;
+    GIF = "GIF",
     // (undocumented)
-    getTransformations(): Transformations | undefined;
+    JPEG = "JPEG",
     // (undocumented)
-    getWaitTime(): number | undefined;
+    JPG = "JPG",
     // (undocumented)
-    setAllowRegexList(allowRegexList: string[]): void;
+    JSON = "JSON",
     // (undocumented)
-    setBleep(bleep: Bleep | undefined): void;
+    JSONL = "JSONL",
     // (undocumented)
-    setEntities(entities: DetectEntities[]): void;
+    MP3 = "MP3",
     // (undocumented)
-    setMaskingMethod(maskingMethod: MaskingMethod | undefined): void;
+    PDF = "PDF",
     // (undocumented)
-    setMaxResolution(maxResolution: number | undefined): void;
+    PNG = "PNG",
     // (undocumented)
-    setOutputDirectory(outputDirectory: string | undefined): void;
+    PPT = "PPT",
     // (undocumented)
-    setOutputOcrText(outputOcrText: boolean | undefined): void;
+    PPTX = "PPTX",
     // (undocumented)
-    setOutputProcessedAudio(outputProcessedAudio: boolean | undefined): void;
+    TIF = "TIF",
     // (undocumented)
-    setOutputProcessedImage(value: boolean | undefined): void;
+    TIFF = "TIFF",
     // (undocumented)
-    setOutputTranscription(outputTranscription: DetectOutputTranscription | undefined): void;
+    TXT = "TXT",
     // (undocumented)
-    setPixelDensity(pixelDensity: number | undefined): void;
+    WAV = "WAV",
     // (undocumented)
-    setRestrictRegexList(restrictRegexList: string[]): void;
+    XLS = "XLS",
     // (undocumented)
-    setTokenFormat(tokenFormat: TokenFormat): void;
+    XLSX = "XLSX",
     // (undocumented)
-    setTransformations(transformations: Transformations): void;
+    XML = "XML",
     // (undocumented)
-    setWaitTime(waitTime: number | undefined): void;
+    ZIP = "ZIP"
 }
 
-// @public (undocumented)
+// @public
 export class DeidentifyFileRequest {
-    constructor(file: FileInput);
-    // (undocumented)
-    getFile(): FileInput;
-    // (undocumented)
-    setFile(file: FileInput): void;
-}
-
-// @public (undocumented)
-export class DeidentifyFileResponse {
-    constructor(input: {
-        fileBase64?: string;
-        file?: File;
-        type?: string;
-        extension?: string;
-        wordCount?: number;
-        charCount?: number;
-        sizeInKb?: number;
-        durationInSeconds?: number;
-        pageCount?: number;
-        slideCount?: number;
-        entities?: Array<{
-            file: string;
-            extension: string;
-        }>;
-        runId?: string;
-        status?: string;
-        errors?: Array<SkyflowRecordError> | null;
-    });
-    // (undocumented)
-    charCount?: number;
+    constructor(fields?: DeidentifyFileRequestFields);
     // (undocumented)
-    durationInSeconds?: number;
+    get configuration(): DetectConfiguration | undefined;
+    set configuration(value: DetectConfiguration | undefined);
     // (undocumented)
-    entities?: Array<{
-        file: string;
-        extension: string;
-    }>;
+    get configurationId(): string | undefined;
+    set configurationId(value: string | undefined);
     // (undocumented)
-    errors: Array<SkyflowRecordError> | null;
-    // (undocumented)
-    extension?: string;
-    // (undocumented)
-    file?: File;
-    // (undocumented)
-    fileBase64?: string;
-    // (undocumented)
-    pageCount?: number;
+    get dataFormat(): DeidentifyFileDataFormat | undefined;
+    set dataFormat(value: DeidentifyFileDataFormat | undefined);
+    // Warning: (ae-forgotten-export) The symbol "DeidentifyFileSource" needs to be exported by the entry point index.d.ts
+    //
     // (undocumented)
-    runId?: string;
+    get dataSource(): DeidentifyFileSource | undefined;
+    set dataSource(value: DeidentifyFileSource | undefined);
     // (undocumented)
-    sizeInKb?: number;
+    get file(): File | undefined;
+    set file(value: File | undefined);
     // (undocumented)
-    slideCount?: number;
+    get filePath(): string | undefined;
+    set filePath(value: string | undefined);
     // (undocumented)
-    status?: string;
+    get outputDirectory(): string | undefined;
+    set outputDirectory(value: string | undefined);
     // (undocumented)
-    type?: string;
+    get pollOptions(): PollOptions | undefined;
+    set pollOptions(value: PollOptions | undefined);
     // (undocumented)
-    wordCount?: number;
+    get value(): string | undefined;
+    set value(value: string | undefined);
 }
 
-// @public (undocumented)
-export class DeidentifyTextOptions {
-    // (undocumented)
-    getAllowRegexList(): string[] | undefined;
+// @public
+export interface DeidentifyFileRequestFields {
+    configuration?: DetectConfiguration;
+    configurationId?: string;
+    dataFormat?: DeidentifyFileDataFormat;
+    dataSource?: DeidentifyFileSource;
+    file?: File;
+    filePath?: string;
+    outputDirectory?: string;
+    pollOptions?: PollOptions;
+    value?: string;
+}
+
+// @public
+export class DeidentifyFileResponse implements DetectRunFields {
+    constructor(input: DetectRunFields);
     // (undocumented)
-    getEntities(): DetectEntities[] | undefined;
+    readonly message: string | null;
     // (undocumented)
-    getRestrictRegexList(): string[] | undefined;
+    readonly metrics: Metrics | null;
     // (undocumented)
-    getTokenFormat(): TokenFormat | undefined;
+    readonly output: FileOutput[];
     // (undocumented)
-    getTransformations(): Transformations | undefined;
+    readonly outputType: DeidentifyFileSource | null;
     // (undocumented)
-    setAllowRegexList(allowRegexList: string[]): void;
+    readonly runId: string | null;
     // (undocumented)
-    setEntities(entities: DetectEntities[]): void;
+    readonly status: DetectRunStatus | null;
+}
+
+// @public
+export enum DeidentifySourceType {
     // (undocumented)
-    setRestrictRegexList(restrictRegexList: string[]): void;
+    BASE64 = "BASE64",
     // (undocumented)
-    setTokenFormat(tokenFormat: TokenFormat): void;
+    PRESIGNED_URL = "PRESIGNED_URL",
     // (undocumented)
-    setTransformations(transformations: Transformations): void;
+    SKYFLOW_ID = "SKYFLOW_ID"
 }
 
-// @public (undocumented)
-export class DeidentifyTextRequest {
-    constructor(text: string);
+// @public
+export class DeidentifyStringRequest {
+    constructor(text: string, fields?: DeidentifyStringRequestFields);
+    // (undocumented)
+    get configuration(): DetectConfiguration | undefined;
+    set configuration(value: DetectConfiguration | undefined);
     // (undocumented)
+    get configurationId(): string | undefined;
+    set configurationId(value: string | undefined);
     get text(): string;
     set text(value: string);
 }
 
-// @public (undocumented)

... 1190 more lines. The full reports are in the `api-surface-reports` workflow artifact.

skyflow-flowvault-node: 2591 added, 0 removed (no report on the base branch, so every line is new)

Show diff

--- base/skyflow-flowvault-node.api.md
+++ pr/skyflow-flowvault-node.api.md
@@ -0,0 +1,2591 @@
+## API Report File for "skyflow-flowvault-node"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export const API_KEY: {
+    readonly PREFIX: "sky-";
+};
+
+// @public (undocumented)
+export interface ApiKeyCredentials {
+    // (undocumented)
+    apiKey: string;
+}
+
+// @public
+interface Audio_2 {
+    // (undocumented)
+    bleep?: Bleep;
+    // (undocumented)
+    outputProcessedAudio?: boolean;
+    // (undocumented)
+    outputTranscription?: OutputTranscriptionType;
+}
+export { Audio_2 as Audio }
+
+// @public (undocumented)
+export interface AuthInfo {
+    // (undocumented)
+    key: string;
+    // (undocumented)
+    type: AuthType;
+}
+
+// @public (undocumented)
+export enum AuthType {
+    // (undocumented)
+    API_KEY = "API_KEY",
+    // (undocumented)
+    TOKEN = "TOKEN"
+}
+
+// @public (undocumented)
+export const BAD_REQUEST = "Bad Request";
+
+// @public (undocumented)
+export class BaseDeleteFilesRequest {
+}
+
+// @public (undocumented)
+export class BaseDeleteFilesResponse {
+}
+
+// @public (undocumented)
+export class BaseDeleteRequest {
+}
+
+// @public (undocumented)
+export class BaseDeleteResponse {
+}
+
+// @public (undocumented)
+export abstract class BaseDetectController<TClient extends DetectClientLike = DetectClientLike> {
+    constructor(client: TClient);
+    checkGuardrails(request: CheckGuardrailsRequest): Promise<CheckGuardrailsResponse>;
+    // (undocumented)
+    protected readonly client: TClient;
+    deidentifyFile(request: DeidentifyFileRequest): Promise<DeidentifyFileResponse>;
+    deidentifyString(request: DeidentifyStringRequest): Promise<DeidentifyStringResponse>;
+    protected static enumOrNull<E extends string>(values: Record<string, E>, value: string | null | undefined): E | null;
+    // Warning: (ae-forgotten-export) The symbol "FilesV2" needs to be exported by the entry point index.d.ts
+    protected files(): FilesV2;
+    getRun(request: GetRunRequest): Promise<GetRunResponse>;
+    // Warning: (ae-forgotten-export) The symbol "GuardrailsV2" needs to be exported by the entry point index.d.ts
+    protected guardrails(): GuardrailsV2;
+    // (undocumented)
+    protected get logLevel(): LogLevel;
+    reidentifyFile(request: ReidentifyFileRequest): Promise<ReidentifyFileResponse>;
+    reidentifyString(request: ReidentifyStringRequest): Promise<ReidentifyStringResponse>;
+    protected sleeper(): ((millis: number) => Promise<void>) | undefined;
+    // Warning: (ae-forgotten-export) The symbol "StringsV2" needs to be exported by the entry point index.d.ts
+    protected strings(): StringsV2;
+    protected abstract toDeidentifySource(value: string | null | undefined): DeidentifyFileSource | null;
+    protected abstract toReidentifySource(value: string | null | undefined): ReidentifyFileSource | null;
+}
+
+// @public (undocumented)
+export class BaseDetokenizeRequest {
+}
+
+// @public (undocumented)
+export class BaseDetokenizeResponse {
+}
+
+// @public (undocumented)
+export class BaseFileUploadRequest {
+}
+
+// @public (undocumented)
+export class BaseFileUploadResponse {
+}
+
+// @public (undocumented)
+export class BaseGetRequest {
+}
+
+// @public (undocumented)
+export class BaseGetResponse {
+}
+
+// @public (undocumented)
+export class BaseGetTokensRequest {
+}
+
+// @public (undocumented)
+export class BaseGetTokensResponse {
+}
+
+// @public (undocumented)
+export class BaseInsertRequest {
+}
+
+// @public (undocumented)
+export class BaseInsertResponse {
+}
+
+// @public (undocumented)
+export class BaseInvokeConnectionRequest {
+}
+
+// @public (undocumented)
+export class BaseInvokeConnectionResponse {
+}
+
+// @public (undocumented)
+export class BaseOptions {
+    // (undocumented)
+    getRequestHeaders(): Record<string, string> | undefined;
+    // (undocumented)
+    setRequestHeaders(h: Record<string, string>): void;
+}
+
+// @public (undocumented)
+export class BaseQueryRequest {
+}
+
+// @public (undocumented)
+export class BaseQueryResponse {
+}
+
+// @public (undocumented)
+export abstract class BaseSkyflow<TEntry extends BaseVaultEntry> {
+    // (undocumented)
+    addVaultConfig(config: VaultConfig): void;
+    protected applyCredentials(): void;
+    protected applyLogLevel(): void;
+    protected abstract buildVaultEntry(config: VaultConfig): TEntry;
+    // (undocumented)
+    protected commonCredentials?: Credentials;
+    // (undocumented)
+    getLogLevel(): LogLevel;
+    // (undocumented)
+    getSkyflowCredentials(): Credentials | undefined;
+    // (undocumented)
+    getVaultConfig(vaultId: string): VaultConfig;
+    protected initializeSkyflow(config: SkyflowConfig): void;
+    // (undocumented)
+    protected logLevel: LogLevel;
+    // (undocumented)
+    removeVaultConfig(vaultId: string): void;
+    protected resolveVaultEntry(vaultId?: string): TEntry;
+    // (undocumented)
+    setLogLevel(logLevel: LogLevel): void;
+    // (undocumented)
+    protected throwErrorForUnknownVaultId(id: string): void;
+    // (undocumented)
+    protected throwErrorIfVaultIdExists(id: string): void;
+    // (undocumented)
+    updateLogLevel(logLevel: LogLevel): this;
+    // (undocumented)
+    updateSkyflowCredentials(credentials: Credentials): void;
+    // (undocumented)
+    updateVaultConfig(config: VaultConfig): void;
+    // (undocumented)
+    protected vaultClients: {
+        [vaultId: string]: TEntry;
+    };
+}
+
+// @public (undocumented)
+export class BaseTokenizeRequest {
+}
+
+// @public (undocumented)
+export class BaseTokenizeResponse {
+}
+
+// @public (undocumented)
+export class BaseUpdateRequest {
+}
+
+// @public (undocumented)
+export class BaseUpdateResponse {
+}
+
+// @public (undocumented)
+export class BaseUploadFilesRequest {
+}
+
+// @public (undocumented)
+export class BaseUploadFilesResponse {
+}
+
+// @public
+export interface BaseVaultClientLike {
+    // (undocumented)
+    setLogLevel(logLevel: LogLevel): void;
+    // (undocumented)
+    updateClientConfig(url: string, vaultId: string, individualCredentials?: Credentials, skyflowCredentials?: Credentials, logLevel?: LogLevel): void;
+    // (undocumented)
+    updateSkyflowCredentials(credentials?: Credentials): void;
+}
+
+// @public
+export interface BaseVaultEntry<TClient extends BaseVaultClientLike = BaseVaultClientLike> {
+    // (undocumented)
+    client: TClient;
+    // (undocumented)
+    config: VaultConfig;
+}
+
+// @public (undocumented)
+export type BearerTokenOptions = {
+    ctx?: string | Record<string, any>;
+    roleIDs?: string[];
+    roleIds?: string[];
+    logLevel?: LogLevel;
+    tokenUri?: string;
+};
+
+// @public
+export interface Bleep {
+    // (undocumented)
+    frequency?: number;
+    // (undocumented)
+    gain?: number;
+    // (undocumented)
+    startPadding?: number;
+    // (undocumented)
+    stopPadding?: number;
+}
+
+// @public (undocumented)
+export const BOOLEAN_STRING: {
+    readonly TRUE: "true";
+};
+
+// @public
+export class CheckGuardrailsRequest {
+    constructor(text: string, fields?: CheckGuardrailsRequestFields);
+    // (undocumented)
+    get checkToxicity(): boolean | undefined;
+    set checkToxicity(value: boolean | undefined);
+    // (undocumented)
+    get denyTopics(): string[] | undefined;
+    set denyTopics(value: string[] | undefined);
+    get text(): string;
+    set text(value: string);
+}
+
+// @public
+export interface CheckGuardrailsRequestFields {
+    checkToxicity?: boolean;
+    denyTopics?: string[];
+}
+
+// @public
+export class CheckGuardrailsResponse {
+    constructor(input: {
+        text: string | null;
+        validation: GuardrailsValidation;
+        toxic: boolean | null;
+        deniedTopic: boolean | null;
+    });
+    readonly deniedTopic: boolean | null;
+    readonly text: string | null;
+    readonly toxic: boolean | null;
+    readonly validation: GuardrailsValidation;
+}
+
+// @public
+export interface ColumnRedaction {
+    // (undocumented)
+    columnName: string;
+    // (undocumented)
+    redaction: string;
+}
+
+// @public (undocumented)
+export const CONFIG: {
+    readonly LOGLEVEL: "loglevel";
+    readonly CREDENTIALS: "credentials";
+    readonly VAULT_ID: "vaultId";
+    readonly CONNECTION_ID: "connectionId";
+    readonly VAULT: "vault";
+    readonly CONNECTION: "connection";
+};
+
+// @public (undocumented)
+export interface ConnectionConfig {
+    // (undocumented)
+    connectionId: string;
+    // (undocumented)
+    connectionUrl: string;
+    // (undocumented)
+    credentials?: Credentials;
+}
+
+// @public (undocumented)
+export const CONTENT_TYPE: {
+    readonly APPLICATION_JSON: "application/json";
+    readonly APPLICATION_X_WWW_FORM_URLENCODED: "application/x-www-form-urlencoded";
+    readonly TEXT_PLAIN: "text/plain";
+    readonly MULTIPART_FORM_DATA: "multipart/form-data";
+    readonly TEXT_XML: "text/xml";
+    readonly APPLICATION_XML: "application/xml";
+    readonly TEXT_HTML: "text/html";
+};
+
+// @public (undocumented)
+export const CONTROLLER_TYPES: {
+    DETECT: string;
+    VAULT: string;
+    CONNECTION: string;
+};
+
+// @public (undocumented)
+export type Credentials = TokenCredentials | PathCredentials | StringCredentials | ApiKeyCredentials;
+
+// @public
+export enum CustomHeaderKey {
+    // (undocumented)
+    REQUEST_ID_HEADER = "x-request-id",
+    // (undocumented)
+    SKYFLOW_ACCOUNT_ID = "x-skyflow-account-id",

... 2244 more lines. The full reports are in the `api-surface-reports` workflow artifact.