@verdocs/js-sdk 3.10.21 → 3.10.22

package/VerdocsEndpoint.js

@@ -82,7 +82,7 @@ var VerdocsEndpoint = /** @class */ (function () {
     VerdocsEndpoint.getDefault = function () {
         if (!globalThis[ENDPOINT_KEY]) {
             globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
-            window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY]);
+            window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY].baseURL);
         }
         return globalThis[ENDPOINT_KEY];
     };

package/index.d.ts

@@ -3,7 +3,6 @@
  *
  * - Envelopes - An individual document to be signed. Documents are created from templates.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
- * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
  * - Users - All operations related to authentication and user-related operations.
  * - Utils - General support functions used by the other modules and exported for convenience.
@@ -12,7 +11,6 @@
  */
 export * as Envelopes from './Envelopes';
 export * as Organizations from './Organizations';
-export * as Search from './Search';
 export * as Sessions from './Sessions';
 export * as Templates from './Templates';
 export * as Users from './Users';

package/index.js

@@ -3,7 +3,6 @@
  *
  * - Envelopes - An individual document to be signed. Documents are created from templates.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
- * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
  * - Users - All operations related to authentication and user-related operations.
  * - Utils - General support functions used by the other modules and exported for convenience.
@@ -12,7 +11,6 @@
  */
 export * as Envelopes from './Envelopes';
 export * as Organizations from './Organizations';
-export * as Search from './Search';
 export * as Sessions from './Sessions';
 export * as Templates from './Templates';
 export * as Users from './Users';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.10.21",
+  "version": "3.10.22",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -57,6 +57,7 @@
     "@types/jest": "^29.5.10",
     "axios-mock-adapter": "^1.22.0",
     "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.7.0",
     "prettier": "^3.1.0",
     "ts-jest": "^29.1.1",
     "tslint": "^6.1.3",

package/Search/Content.d.ts

@@ -1,40 +0,0 @@
-/**
- * Verdocs provides a range of search functions to help find and retrieve content. This module provides generic functions intended
- * to locate items across all content types. More specific retrievals may be performed using the various "list" endpoints within
- * each collection (e.g. {@link Envelopes.Envelopes.searchEnvelopes} or {@link Templates.Templates.searchTemplates}).
- *
- * @module
- */
-import { ISavedSearch, ISearchHistory, ISearchParams, ISearchResult } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * Retrieve recent and saved searches. Note that result counts will be limited to a maximum of 20 entries for each
- * type but this may be expanded in the future. Client UI's should self-limit display counts as needed.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const {recent, saved} = await Content.getSearchHistory();
- * ```
- */
-export declare const getSearchHistory: (endpoint: VerdocsEndpoint) => Promise<ISearchHistory>;
-/**
- * Save a search. If a name is re-used, that saved search will be overwritten with the new parameters.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const entry = await Documents.saveSearch('W9 Forms', {q: 'w9', type: 'template});
- * ```
- */
-export declare const saveSearch: (endpoint: VerdocsEndpoint, name: string, params: ISearchParams) => Promise<ISavedSearch>;
-/**
- * Search for documents matching various criteria.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const {result, page, total} = await Documents.search({ ... });
- * ```
- */
-export declare const searchContent: (endpoint: VerdocsEndpoint, params: ISearchParams) => Promise<ISearchResult>;

package/Search/Content.js

@@ -1,92 +0,0 @@
-/**
- * Verdocs provides a range of search functions to help find and retrieve content. This module provides generic functions intended
- * to locate items across all content types. More specific retrievals may be performed using the various "list" endpoints within
- * each collection (e.g. {@link Envelopes.Envelopes.searchEnvelopes} or {@link Templates.Templates.searchTemplates}).
- *
- * @module
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-/**
- * Retrieve recent and saved searches. Note that result counts will be limited to a maximum of 20 entries for each
- * type but this may be expanded in the future. Client UI's should self-limit display counts as needed.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const {recent, saved} = await Content.getSearchHistory();
- * ```
- */
-export var getSearchHistory = function (endpoint) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get('/search/history')
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Save a search. If a name is re-used, that saved search will be overwritten with the new parameters.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const entry = await Documents.saveSearch('W9 Forms', {q: 'w9', type: 'template});
- * ```
- */
-export var saveSearch = function (endpoint, name, params) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/search/saved', { name: name, params: params })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Search for documents matching various criteria.
- *
- * ```typescript
- * import {Content} from '@verdocs/js-sdk/Search';
- *
- * const {result, page, total} = await Documents.search({ ... });
- * ```
- */
-export var searchContent = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/search/content', params)
-                .then(function (r) { return r.data; })];
-    });
-}); };

package/Search/Types.d.ts

@@ -1,124 +0,0 @@
-import { TTemplateSender } from '../Templates/Types';
-import { TEnvelopeStatus } from '../Envelopes/Types';
-export type TMimeType = 'application/pdf' | string;
-/**
- * An individual hit in a document search result. Note that this schema does not precisely match IDocument because fields
- * are optimized for search performance.
- */
-export interface IEnvelopeHit {
-    type: 'envelope';
-    id: string;
-    template_id: string;
-    name: string;
-    profile_id: string;
-    organization_id: string;
-    organization_name: string;
-    status: TEnvelopeStatus;
-    recipient_emails: string[];
-    recipient_names: string[];
-    updated_at: string;
-    canceled_at: string;
-    file_mime: TMimeType;
-    file_name: string;
-    file_page_count: number;
-    file_url: string;
-    certificate_mime: TMimeType;
-    certificate_name: string;
-    certificate_page_count: number;
-    certificate_url: string;
-}
-/**
- * An individual hit in a template search result. Note that this schema does not precisely match ITemplate because fields
- * are optimized for search performance.
- */
-export interface ITemplateHit {
-    type: 'template';
-    id: string;
-    name: string;
-    description: string;
-    profile_id: string;
-    organization_id: string;
-    organization_name: string;
-    page_count: number;
-    is_personal: boolean;
-    is_public: boolean;
-    sender: TTemplateSender;
-    counter: number;
-    star_counter: number;
-    mime: TMimeType;
-    file_name: string;
-    file_url: string;
-    thumbnail_url: string;
-    last_used_at: string;
-    updated_at: string;
-    tags: [];
-}
-/**
- * An individual hit in an organization search result. Note that this schema does not precisely match IOrganization because fields
- * are optimized for search performance.
- */
-export interface IOrganizationHit {
-    type: 'organization';
-    id: string;
-    name: string;
-    slug: string;
-}
-export interface IFacetResultEntry {
-    count: number;
-    highlighted: string;
-    value: string;
-}
-export interface IFacetResult {
-    field_name: string;
-    stats: any;
-    counts: IFacetResultEntry[];
-}
-export interface IHit<T> {
-    document: T;
-    highlights: any[];
-    text_match: number;
-}
-export interface ISearchRequestParams {
-    collection_name: string;
-    per_page: number;
-    q: string;
-}
-export interface ISearchResultCollection<T> {
-    facet_counts: IFacetResult[];
-    page: number;
-    found: number;
-    out_of: number;
-    hits: IHit<T>[];
-    request_params: ISearchRequestParams;
-    search_time_ms: number;
-}
-export interface ISearchResult {
-    documents: ISearchResultCollection<IEnvelopeHit>;
-    myTemplates: ISearchResultCollection<ITemplateHit>;
-    publicTemplates: ISearchResultCollection<ITemplateHit>;
-    organizations: ISearchResultCollection<IOrganizationHit>;
-}
-export interface ISearchParams {
-    q: string;
-}
-export interface IRecentSearch {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    profile_id: string;
-    organization_id: string;
-    params: ISearchParams;
-}
-export interface ISavedSearch {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    profile_id: string;
-    organization_id: string;
-    name: string;
-    params: ISearchParams;
-}
-export interface ISearchHistory {
-    recent: IRecentSearch[];
-    saved: ISavedSearch[];
-}

package/Search/Types.js

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

package/Search/index.d.ts

@@ -1,2 +0,0 @@
-export * as Content from './Content';
-export * as Types from './Types';

package/Search/index.js

@@ -1,2 +0,0 @@
-export * as Content from './Content';
-export * as Types from './Types';