terminusdb 12.0.2

package/dist/typescript/lib/connectionConfig.d.ts

@@ -0,0 +1,381 @@
+export = ConnectionConfig;
+/**
+ * @file Terminus DB connection configuration
+ * @license Apache Version 2
+ * @description Object representing the state of a connection to a terminus db - these are:
+ * provides methods for getting and setting connection parameters
+ * @constructor
+ * @param {string} serverUrl - the terminusdb server url
+ * @param {typedef.ParamsObj} [params] - an object with the following connection parameters:
+ */
+declare function ConnectionConfig(serverUrl: string, params?: typedef.ParamsObj): void;
+declare class ConnectionConfig {
+    /**
+     * @file Terminus DB connection configuration
+     * @license Apache Version 2
+     * @description Object representing the state of a connection to a terminus db - these are:
+     * provides methods for getting and setting connection parameters
+     * @constructor
+     * @param {string} serverUrl - the terminusdb server url
+     * @param {typedef.ParamsObj} [params] - an object with the following connection parameters:
+     */
+    constructor(serverUrl: string, params?: typedef.ParamsObj);
+    /**
+       * @type {string}
+       */
+    server: string;
+    baseServer: any;
+    /** @type {typedef.CredentialObj} */
+    remote_auth: typedef.CredentialObj;
+    /** @type {typedef.CredentialObj } */
+    local_auth: typedef.CredentialObj;
+    /** @type {string | boolean} */
+    organizationid: string | boolean;
+    /** @type {string | boolean} */
+    dbid: string | boolean;
+    default_branch_id: string;
+    default_repo_id: string;
+    system_db: string;
+    api_extension: string;
+    branchid: string;
+    repoid: string;
+    /** @type {string | boolean} */
+    refid: string | boolean;
+    /** @type {string | boolean} */
+    connection_error: string | boolean;
+    /**
+     * Creates a new connection config object and copies all the state information from this one into it
+     * @returns {ConnectionConfig}
+     */
+    copy(): ConnectionConfig;
+    /**
+     * updates connection config with new parameters
+     * @param {typedef.ParamsObj}  params - an object with the following connection parameters:
+     */
+    update(params: typedef.ParamsObj): void;
+    /**
+     * Simple gets to retrieve current connection status
+     * Gets the current server url
+     * @returns {string}
+     */
+    serverURL(): string;
+    /**
+     * Simple gets to retrieve current connection status
+     * Gets the current server url
+     * @returns {string}
+     */
+    author(): string;
+    /**
+     * Gets the server connection url
+     * @returns {string}
+     */
+    apiURL(): string;
+    /**
+     * Gets the server connection url info
+     * @returns {string}
+     */
+    apiURLInfo(): string;
+    /**
+     * Gets the current database id
+     * @returns {string | boolean}
+     */
+    db(): string | boolean;
+    /**
+     * Gets the current branch id
+     * @returns {string}
+     */
+    branch(): string;
+    /**
+     * Gets the current commit ref id
+     * @returns {string | boolean}
+     */
+    ref(): string | boolean;
+    /**
+     * Gets the current organization id
+     * @returns {string | boolean}
+     */
+    organization(): string | boolean;
+    /**
+     * Gets the current organization id
+     * @returns {string}
+     */
+    repo(): string;
+    /**
+     *Gets the local Authorization credentials
+     *return {CredentialObj | boolean}
+     */
+    localAuth(): false | typedef.CredentialObj;
+    /**
+     *Gets the local user name
+     *return {string | boolean}
+     */
+    localUser(): string | boolean;
+    /**
+     *Gets the current user name
+     *@param {boolean} [ignoreJwt]
+     *return {string | boolean}
+     */
+    user(ignoreJwt?: boolean): string | boolean;
+    /**
+     * Check the server URL
+     * @param {string} str - the server url string
+     * @returns {string}
+     */
+    parseServerURL(str: string): string;
+    serverUrlEncoding(str: any): any;
+    /**
+     * Clear cursor for connection
+     */
+    clearCursor(): void;
+    /**
+     * @param {string | boolean} errorMessage
+     */
+    setError(errorMessage: string | boolean): void;
+    /**
+     * Set the organization to which the connected db belongs
+     * (not the users organization - set in capabilities)
+     * @param {string | boolean} [orgId]
+     */
+    setOrganization(orgId?: string | boolean): void;
+    /**
+     * Set the local identifier of db
+     * @param {string | boolean} dbId - database Id
+     */
+    setDB(dbId: string | boolean): void;
+    /**
+     * Set the repository type |local|remote|
+     * @param {typedef.RepoType | string} repoId - for the local server - identifier of repo
+     */
+    setRepo(repoId: typedef.RepoType | string): void;
+    /**
+     * @param {string} [branchId] - id of branch
+     */
+    setBranch(branchId?: string): void;
+    /**
+     * Set an Reference ID or Commit ID.
+     * Commit IDs are unique hashes that are created whenever a new commit is recorded
+     * @param {string | boolean} refId - commit reference id
+     */
+    setRef(refId: string | boolean): void;
+    /**
+     * set the local database connection credential
+     * @param {string} [remoteKey] - jwt auth api key
+     * @param {string} [remoteUserID] - remote user id
+     */
+    setRemoteBasicAuth(remoteKey?: string, remoteUserID?: string): void;
+    /**
+     * set the local database connection credential
+     * @param {string} [userKey] - basic auth api key
+     * @param {string} [userId] -  user id
+     * @param {string} [type] - basic|jwt|apikey
+     */
+    setLocalBasicAuth(userKey?: string, userId?: string, type?: string): void;
+    /**
+     * Set the local server connection credential
+     * @param {typedef.CredentialObj} newCredential
+     */
+    setLocalAuth(newCredential: typedef.CredentialObj): void;
+    /**
+     * Set the remote server connection credential
+     * @param {typedef.CredentialObj} newCredential
+     */
+    setRemoteAuth(newCredential: typedef.CredentialObj): void;
+    /**
+     *Gets the remote Authorization credentials
+     *to connect the local db with a remote terminusdb database for push-pull-clone actions
+     *return {CredentialObj| boolean}
+     */
+    remoteAuth(): false | typedef.CredentialObj;
+    /**
+     * Generate the db endpoit url for create / delete db
+     * @returns {string}
+     */
+    dbURL(): string;
+    /**
+     * Generate URL for the user's api endpoint
+     * @param {string} [user] - the user id
+     * @returns {string}
+     */
+    userURL(user?: string): string;
+    /**
+     * Generate URL for the user's organization api endpoint
+     * @param {string} orgId - the organization id
+     * @param {string} [action] - the organization id
+     * @returns {string}
+     */
+    organizationURL(orgId: string, action?: string): string;
+    /**
+     * Generate URL for the user's organization api endpoint
+     * @param {string} orgId - the organization id
+     * @param {string} [action] - the organization id
+     * @returns {string}
+     */
+    userOrganizationsURL(): string;
+    /**
+     * Generate URL for the user's roles api endpoint
+     * @returns {string}
+     */
+    rolesURL(): string;
+    /**
+     * Generate URL to update the user's role api endpoint
+     * @returns {string}
+     */
+    updateRolesURL(): string;
+    /**
+     * Generate URL for create / delete graph api endpoint
+     * @param {string} graphType
+     * @returns {string}
+     */
+    graphURL(graphType: string): string;
+    /**
+     * Generate URL for get / set schema api endpoint
+     * @param {string} graphType
+     * @returns {string}
+     */
+    triplesURL(graphType: string): string;
+    /**
+     * Generate URL for add / get csv api endpoint
+     * @returns {string}
+     */
+    csvURL(): string;
+    /**
+     * Generate URL for woql query api endpoint
+     * @returns {string}
+     */
+    queryURL(): string;
+    /**
+     * Generate URL for get back the commits logs
+     * @returns {string}
+     */
+    log(): string;
+    /**
+     * get the url to update the organization role in the system database
+     * don't change the end point (this is a terminus db server end point)
+     * @returns {string}
+     */
+    updateOrganizationRoleURL(): string;
+    /**
+     * Generate URL for clone db endpoint
+     * @param  {string} [newRepoId] the repository id
+     * @returns {string}
+     */
+    cloneURL(newRepoId?: string): string;
+    /**
+     * URL at which a db can be cloned
+     * @returns {string}
+     */
+    cloneableURL(): string;
+    /**
+     * Generate URL for pull endpoint
+     * @returns {string}
+     */
+    pullURL(): string;
+    /**
+     * Generate URL for pull endpoint
+     * @returns {string}
+     */
+    patchURL(): string;
+    /**
+     * Generate URL for diff endpoint
+     * @returns {string}
+     */
+    diffURL(): string;
+    /**
+     * Generate URL for diff endpoint
+     * @returns {string}
+     */
+    applyURL(): string;
+    /**
+     * Generate url portion consisting of organization/dbid
+     * (unless dbid = system dbname in which case there is no organization)
+     * @property {typedef.DocParamsPost|Object} params
+     */
+    docHistoryURL(params: any): string;
+    /**
+     * Generate URL for fetch endpoint
+     * @param {string} remoteName
+     * @returns {string}
+     */
+    fetchURL(remoteName: string): string;
+    /**
+     * Generate URL for remote endpoint
+     * @param {string} [remoteName] - optional remote name
+     * @returns {string}
+     */
+    remoteURL(remoteName?: string): string;
+    /**
+     * Generate URL for rebase endpoint
+     * @returns {string}
+     */
+    rebaseURL(): string;
+    /**
+     * Generate URL for reset endpoint
+     * @returns {string}
+     */
+    resetURL(): string;
+    /**
+     * Generate URL for push endpoint
+     * @returns {string}
+     */
+    pushURL(): string;
+    /**
+     * Generate URL for branch endpoint
+     * @param {string} branchId - the branch id
+     * @returns {string}
+     */
+    branchURL(branchId: string): string;
+    /**
+     * Generate URL for branch squash endpoint
+     */
+    squashBranchURL(nuid: any): string;
+    /**
+     * Generate URL for branch reset endpoint
+     */
+    resetBranchUrl(nuid: any): string;
+    /**
+     * Generate URL for commit descriptor
+     * @param {string} commitId
+     * @returns {string} a commit pathname
+     */
+    commitDescriptorUrl(commitId: string): string;
+    /**
+     * Generate URL for optimizing db branch
+     */
+    optimizeBranchUrl(branchId: any): string;
+    /**
+     * Generate base db url consisting of server/action/organization/dbid
+     * @param {typedef.ActionType} action
+     * @returns {string}
+     */
+    dbBase(action: typedef.ActionType): string;
+    /**
+     * Generate base branch url consisting of server/action/organization/dbid/branchid
+     * @param {typedef.ActionType} action
+     * @returns {string}
+     */
+    repoBase(action: typedef.ActionType): string;
+    /**
+     * Get database branch Url
+     * Generate base branch url consisting of server/action/organization/dbid/branchid
+     * @param {typedef.ActionType} action
+     * @returns {string}
+     */
+    branchBase(action: typedef.ActionType): string;
+    /**
+     * Generate url portion consisting of organization/dbid
+     * (unless dbid = system dbname in which case there is no organization)
+     * @returns {string|boolean}
+     */
+    dbURLFragment(): string | boolean;
+    /**
+     * Generate url portion consisting of organization/dbid
+     * (unless dbid = system dbname in which case there is no organization)
+     * @property {typedef.DocParamsPost|Object} params
+     */
+    documentURL(params: any): string;
+    prefixesURL(): string;
+    prefixURL(): string;
+    queryParameter(params: any): string;
+    jsonSchemaURL(params: any): string;
+}
+import typedef = require("./typedef");

package/dist/typescript/lib/const.d.ts

@@ -0,0 +1,54 @@
+declare const _exports: Readonly<{
+    POST: "POST";
+    GET: "GET";
+    DELETE: "DELETE";
+    PUT: "PUT";
+    HEAD: "HEAD";
+    QUERY_DOCUMENT: "QUERY_DOCUMENT";
+    SQUASH_BRANCH: "SQUASH_BRANCH";
+    UPDATE_SCHEMA: "UPDATE_SCHEMA";
+    CONNECT: "connect";
+    CREATE_DATABASE: "create_database";
+    READ_DATABASE: "read_database";
+    UPDATE_DATABASE: "update_database";
+    CREATE_USER: "create_user";
+    READ_USER: "read_user";
+    UPDATE_USER: "update_user";
+    CREATE_ORGANIZATION: "create_organization";
+    READ_ORGANIZATION: "read_organization";
+    UPDATE_ORGANIZATION: "update_organization";
+    GET_ROLES: "get_roles";
+    UPDATE_ROLES: "update_roles";
+    CREATE_GRAPH: "create_graph";
+    GET_TRIPLES: "get_triples";
+    INSERT_TRIPLES: "insert_triples";
+    UPDATE_TRIPLES: "update_triples";
+    CLASS_FRAME: "class_frame";
+    WOQL_QUERY: "woql_query";
+    CLONE: "clone";
+    CSV: "csv";
+    WOQL: "woql";
+    FRAME: "frame";
+    PUSH: "push";
+    PULL: "pull";
+    FETCH: "fetch";
+    REBASE: "rebase";
+    RESET: "reset";
+    BRANCH: "branch";
+    REMOTE: "remote";
+    CREATE_REMOTE: "create_remote";
+    GET_REMOTE: "get_remote";
+    UPDATE_REMOTE: "update_remote";
+    DELETE_REMOTE: "delete_remote";
+    RESET_BRANCH: "reset_branch";
+    ADD_CSV: "add_csv";
+    GET_CSV: "get_csv";
+    UPDATE_CSV: "update_csv";
+    MESSAGE: "message";
+    ACTION: "action";
+    INFO: "info";
+    OPTIMIZE_SYSTEM: "optimize_system";
+    GET_DIFF: "getDiff";
+    PATCH: "patch";
+}>;
+export = _exports;

package/dist/typescript/lib/dispatchRequest.d.ts

@@ -0,0 +1,17 @@
+export = DispatchRequest;
+/**
+ * @file Dispatch Request
+ * @license Apache Version 2
+ * @description Functions for dispatching API requests via the axios library.
+ * @param {string} url  API endpoint URL
+ * @param {string} action API action
+ * @param {object} payload data to be transmitted to endpoint
+ * @param {typedef.CredentialObj} local_auth the local authorization object
+ * @param {typedef.CredentialObj} remote_auth the remote authoriuzation object
+ * @param {object} customHeaders all the custom header to add to your call
+ * @param {boolean} [getDataVersion] If true the function will return object having result
+ * and dataVersion.
+ * @param {boolean} [compress] If true, compress the data with gzip if its size is bigger than 1024
+ */
+declare function DispatchRequest(url: string, action: string, payload: object, local_auth: typedef.CredentialObj, remote_auth?: typedef.CredentialObj, customHeaders?: object, getDataVersion?: boolean, compress?: boolean): Promise<any>;
+import typedef = require("./typedef");

package/dist/typescript/lib/errorMessage.d.ts

@@ -0,0 +1,25 @@
+export function apiErrorFormatted(url: any, options: any, err: any): Error;
+export function getErrorAsMessage(url: any, api: any, err: any): string;
+export function getAPIErrorMessage(url: any, api: any, err: any): string;
+export function getAccessDeniedMessage(url: any, api: any, err: any): string;
+export function accessDenied(action: any, db: any, server: any): {
+    status: number;
+    url: any;
+    type: string;
+    action: any;
+    body: string;
+};
+export function getInvalidURIMessage(url: any, call: any): string;
+export function getInvalidParameterMessage(call: any, msg: any): string;
+/**
+ * Utility functions for generating and retrieving error messages
+ * and storing error state
+ */
+export function parseAPIError(response: any): {
+    status: any;
+    type: any;
+    body: any;
+    url: any;
+    headers: any;
+    redirected: any;
+};

package/dist/typescript/lib/query/woqlBuilder.d.ts

@@ -0,0 +1,75 @@
+export = WOQLQuery;
+declare class WOQLQuery extends WOQLQueryExt {
+    /**
+     * @param {typedef.GraphRef} [Graph] - the resource identifier of a graph possible
+     * @param {string|Var} [Subj] - The IRI of a triple’s subject or a variable
+     * @param {string|Var} [Pred] - The IRI of a property or a variable
+     * @param {string|Var} [Obj] - The IRI of a node or a variable, or a literal
+     * @returns {WOQLQuery} - A WOQLQuery which contains the pattern matching expression
+     */
+    /**
+     * Simple composite functions which produce WOQL queries
+     */
+    star(Graph: any, Subj: any, Pred: any, Obj: any): WOQLQueryExt;
+    /**
+     * @param {string|Var} [Subj] - The IRI of a triple’s subject or a variable
+     * @param {string|Var} [Pred] - The IRI of a property or a variable
+     * @param {string|Var} [Obj] - The IRI of a node or a variable, or a literal
+     * @param {typedef.GraphRef} [Graph] - the resource identifier of a graph possible
+     * @returns {WOQLQuery} - A WOQLQuery which contains the pattern matching expression
+     */
+    all(Subj?: string | Var, Pred?: string | Var, Obj?: string | Var, Graph?: typedef.GraphRef): WOQLQuery;
+    /**
+     * Update a pattern matching rule for the triple (Subject, Predicate, oldObjValue) with the
+     * new one (Subject, Predicate, newObjValue)
+     * @param {string|Var} subject - The IRI of a triple’s subject or a variable
+     * @param {string|Var} predicate - The IRI of a property or a variable
+     * @param {string|Var} newObjValue - The value to update or a literal
+     * @param {string|Var} oldObjValue - The old value of the object
+     * @returns {WOQLQuery} A WOQLQuery which contains the a Update Triple Statement
+     */
+    update_triple(subject: string | Var, predicate: string | Var, newObjValue: string | Var, oldObjValue: string | Var): WOQLQuery;
+    /**
+     * @description Update a pattern matching rule for the quad [S, P, O, G]
+     * (Subject, Predicate, Object, Graph)
+     * @param {string} subject - The IRI of a triple’s subject or a variable
+     * @param {string} predicate - The IRI of a property or a variable
+     * @param {string} newObject - The value to update or a literal
+     * @param {string} graph - the resource identifier of a graph possible value are
+     * schema/{main - myschema - *} | instance/{main - myschema - *}  | inference/{main - myschema - *}
+     * @returns {WOQLQuery} A WOQLQuery which contains the a Update Quad Statement
+     */
+    update_quad(subject: string, predicate: string, newObject: string, graph: string): WOQLQuery;
+    /**
+     * Deletes all triples in the passed graph (defaults to instance/main)
+     * @param {typedef.GraphRef} [graphRef] - Resource String identifying the graph from
+     * which all triples will be removed
+     * @returns {WOQLQuery} - A WOQLQuery which contains the deletion expression
+     */
+    nuke(graphRef?: typedef.GraphRef): WOQLQuery;
+    /**
+     * @param {string|Var} node -  The IRI of a node or a variable containing an IRI which will
+     * be the subject of the builder functions
+     * @param {typedef.FuntionType} [type] - Optional type of builder function to build
+     * (default is triple)
+     * @returns {WOQLQuery} - A WOQLQuery which contains the partial Node pattern matching expression
+     */
+    node(node: string | Var, type?: typedef.FuntionType): WOQLQuery;
+    /**
+     * Sets the graph resource ID that will be used for subsequent chained function calls
+     * @param {typedef.GraphRef} [graphRef] Resource String identifying the graph which will
+     * be used for subsequent chained schema calls
+     * @returns {WOQLQuery} A WOQLQuery which contains the partial Graph pattern matching expression
+     */
+    graph(graphRef?: typedef.GraphRef): WOQLQuery;
+    _set_context(ctxt: any): WOQLQuery;
+    /**
+     * @param {string|Var} id - IRI string or variable containing
+     * @param {string|Var} type  -  IRI string or variable containing the IRI of the
+     * @param {typedef.GraphRef} [refGraph] - Optional Graph resource identifier
+     * @returns {WOQLQuery} A WOQLQuery which contains the insert expression
+     */
+    insert(id: string | Var, type: string | Var, refGraph?: typedef.GraphRef): WOQLQuery;
+}
+import WOQLQueryExt = require("./woqlQuery");
+import typedef = require("../typedef");