Cerbos JavaScript SDK
    Preparing search index...

    Module @cerbos/hub - v0.5.1

    @cerbos/hub

    npm

    Client library for interacting with Cerbos Hub from server-side Node.js applications.

    • Node.js 20+
    $ npm install @cerbos/hub
    
    import { readFile } from "node:fs/promises";

    import { credentialsFromEnv, StoresClient } from "@cerbos/hub";

    const stores = new StoresClient({ credentials: credentialsFromEnv() });

    const { newStoreVersion } = await stores.modifyFiles({
    storeId: "MWPKEMFX3CK1",
    operations: [
    {
    addOrUpdate: {
    path: "policy.yaml",
    contents: await readFile("path/to/policy.yaml"),
    },
    },
    ],
    });

    For more details, see the StoresClient class documentation.

    This package is ESM-only, but may be required from CommonJS modules in Node.js versions 20.19.5+, 22.15+, and 24+.

    Enumerations

    FileErrorCause

    Classes

    CannotModifyGitConnectedStore
    ConditionUnsatisfied
    MissingCredentials
    NoUsableFiles
    OperationDiscarded
    StoresClient
    ValidationFailure

    Interfaces

    ChangeDetails
    ChangeOriginGit
    ChangeOriginInternal
    ClientOptions
    Credentials
    File
    FileError
    FileFilter
    FileModificationCondition
    FileOperationAddOrUpdate
    FileOperationDelete
    GetFilesRequest
    GetFilesResponse
    ListFilesRequest
    ListFilesResponse
    ModifyFilesRequest
    ModifyFilesResponse
    ReplaceFilesContentsUnzipped
    ReplaceFilesContentsZipped
    ReplaceFilesRequest
    ReplaceFilesResponse
    StringMatchContains
    StringMatchEquals
    StringMatchIn
    Uploader

    Type aliases

    ChangeOrigin
    FileOperation
    ReplaceFilesContents
    StringMatch

    Functions

    bytesToString
    changeOriginIsChangeOriginGit
    changeOriginIsChangeOriginInternal
    credentialsFromEnv
    fileOperationIsFileOperationAddOrUpdate
    fileOperationIsFileOperationDelete
    replaceFilesContentsIsReplaceFilesContentsUnzipped
    replaceFilesContentsIsReplaceFilesContentsZipped
    stringMatchIsStringMatchContains
    stringMatchIsStringMatchEquals
    stringMatchIsStringMatchIn
    stringToBytes