@docbox-nz/hapi-gateway 0.1.0

package/dist/api/fileService.d.ts

@@ -0,0 +1,251 @@
+import { DocboxFileSearchRequest, DocboxFileSearchResponse, DocumentBoxScope, FileId, FileResponse, FolderId, GeneratedFileType, PresignedStatusResponse, UpdateFile, UploadFileResponse } from '../types';
+import { DocboxClient } from './client';
+import { DocFile, DocFileEditHistory, DocGeneratedFile as GeneratedFile, PresignedUploadFileRequest, PresignedUploadOptions, PresignedUploadResponse, UploadFileRequest } from '../types/file';
+import 'formdata-polyfill';
+export declare class FileService {
+    private client;
+    constructor(client: DocboxClient);
+    /**
+     * Get a URL to a raw version of a file
+     *
+     * @param scope Scope the file is within
+     * @param id ID of the file
+     * @returns The file URL
+     */
+    rawURL(scope: DocumentBoxScope, id: string): string;
+    /**
+     * Get a URL to a raw version of a file with an additional
+     * cosmetic name shown in browser viewers
+     *
+     * @param scope Scope the file is within
+     * @param id ID of the file
+     * @param name Name to provide the file
+     * @returns The file URL
+     */
+    rawNamedURL(scope: DocumentBoxScope, id: string, name: string): string;
+    /**
+     * Get a URL to a generated version of a file
+     *
+     * @param scope Scope the file is within
+     * @param id ID of the main file
+     * @param type Type of generated file to get
+     * @returns The URL to the generated file
+     */
+    generatedRawURL(scope: string, id: string, type: string): string;
+    /**
+     * Get a URL to a generated version of a file with an additional
+     * cosmetic name shown in browser viewers
+     *
+     * @param scope Scope the file is within
+     * @param id ID of the main file
+     * @param type Type of generated file to get
+     * @param name Name to provide the file
+     * @returns The URL to the generated file
+     */
+    generatedRawNamedURL(scope: string, id: string, type: string, name: string): string;
+    /**
+     * Direct upload
+     *
+     * @deprecated When behind the proxy service this will often encounter timeout issues
+     * its recommended you use another upload method
+     *
+     * Prefer {@link FileService.uploadAsync}
+     *
+     * @param scope Scope to upload the file into
+     * @param name Name of the file
+     * @param folder_id Folder to store the file in
+     * @param file File to store
+     * @returns File upload response
+     */
+    upload(scope: DocumentBoxScope, name: string, folder_id: FolderId, file: File): Promise<UploadFileResponse>;
+    /**
+     * Asynchronous direct upload
+     *
+     * (File is uploaded directly but processed asynchronously)
+     *
+     * If you are handling reasonably sized files prefer {@link FileService.uploadPresigned} to
+     * prevent running into browser timeouts as the file is transferred between services
+     *
+     * @param request Upload request data
+     * @returns The uploaded file response
+     */
+    uploadAsync(request: UploadFileRequest): Promise<UploadFileResponse>;
+    /**
+     * Performs a pre-signed file upload
+     *
+     * @param scope Scope to upload the file into
+     * @param folderId ID of the folder to store the file within
+     * @param file File to upload
+     * @param options Request options
+     * @returns File upload response
+     */
+    uploadPresigned(scope: DocumentBoxScope, folderId: FolderId, file: File, options?: PresignedUploadOptions): Promise<FileResponse>;
+    performPresignedUpload(file: File, presigned: PresignedUploadResponse, options?: PresignedUploadOptions): Promise<void>;
+    /**
+     * Creates a new presigned upload
+     *
+     * @param scope Scope to upload the file within
+     * @param request The presigned upload request
+     * @returns The presigned upload details
+     */
+    createPresignedUpload(scope: DocumentBoxScope, request: PresignedUploadFileRequest): Promise<PresignedUploadResponse>;
+    /**
+     * Request the status of a presigned upload task
+     *
+     * @param scope Scope the upload file task is within
+     * @param taskId ID of the uploading task
+     * @param abort Abort handle to abort the request
+     * @returns The task status
+     */
+    presignedStatus(scope: DocumentBoxScope, taskId: string, abort?: AbortController): Promise<PresignedStatusResponse>;
+    /**
+     * Polls for the completion of a presigned upload task
+     *
+     * @param scope Scope the upload file task is within
+     * @param task_id ID of the uploading task
+     * @param interval Rate at which to poll for completion
+     * @param abort Abort handle that can abort the polling
+     * @returns The uploaded file response
+     */
+    presignedFinished(scope: DocumentBoxScope, task_id: string, interval?: number, abort?: AbortController): Promise<FileResponse>;
+    /**
+     * Request the details of a file using its ID and scope
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file
+     * @returns The full file details
+     */
+    get(scope: DocumentBoxScope, file_id: FileId): Promise<FileResponse>;
+    /**
+     * Search within the contents of a file
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file
+     * @param request The search request
+     * @returns The full file details
+     */
+    search(scope: DocumentBoxScope, file_id: FileId, request: DocboxFileSearchRequest): Promise<DocboxFileSearchResponse>;
+    /**
+     * Request children of the file, in the case of .eml email files this
+     * would provide a list of files for the attachments associated with
+     * the email
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to find the children of
+     * @returns The files that are children
+     */
+    children(scope: DocumentBoxScope, file_id: FileId): Promise<DocFile[]>;
+    /**
+     * Request the history of edits to the file
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to get the history for
+     * @returns The edit history
+     */
+    editHistory(scope: DocumentBoxScope, file_id: FileId): Promise<DocFileEditHistory[]>;
+    /**
+     * Update the details about the file
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to update
+     * @param data The updates to perform
+     */
+    update(scope: DocumentBoxScope, file_id: FileId, data: UpdateFile): Promise<void>;
+    /**
+     * Gets the raw file contents of the provided file
+     *
+     * On node this returns an {@link ArrayBuffer} not a blob
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to retrieve
+     * @returns The raw contents of the file
+     */
+    raw(scope: DocumentBoxScope, file_id: FileId): Promise<Blob>;
+    /**
+     * Gets the raw file contents of the provided file
+     *
+     * This function is the same as {@link FileService.raw} just
+     * it has the correct return type for Node
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to retrieve
+     * @returns The raw contents of the file
+     */
+    rawNode(scope: DocumentBoxScope, file_id: FileId): Promise<ArrayBuffer>;
+    /**
+     * Gets the raw file contents of the provided file in
+     * JSON format (Will only work if the actual file is JSON)
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to retrieve
+     * @returns The JSON contents of the file
+     */
+    json(scope: DocumentBoxScope, file_id: FileId): Promise<any>;
+    /**
+     * Gets the raw file contents of the provided file as text
+     * (Will only work if the actual file is text)
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to retrieve
+     * @returns The text contents of the file
+     */
+    text(scope: DocumentBoxScope, file_id: FileId): Promise<string>;
+    /**
+     * Deletes a file
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to delete
+     */
+    delete(scope: DocumentBoxScope, file_id: FileId): Promise<void>;
+    /**
+     * Gets a generated file details
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to query
+     * @param type Type of the generated file
+     * @returns The generated file details
+     */
+    generated(scope: DocumentBoxScope, file_id: FileId, type: GeneratedFileType): Promise<GeneratedFile>;
+    /**
+     * Gets a generated file raw contents
+     *
+     * On node this returns an {@link ArrayBuffer} not a blob
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to query
+     * @param type Type of the generated file
+     * @returns The Blob/ArrayBuffer content of the file (Blob within a browser, ArrayBuffer on node)
+     */
+    generatedRaw(scope: DocumentBoxScope, file_id: FileId, type: GeneratedFileType): Promise<Blob>;
+    /**
+     * Gets a generated file raw contents
+     *
+     * This function is the same as {@link FileService.generatedRaw} just
+     * it has the correct return type for Node and will only return an
+     * ArrayBuffer
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to query
+     * @param type Type of the generated file
+     * @returns The ArrayBuffer content of the generated file
+     */
+    generatedRawNode(scope: DocumentBoxScope, file_id: FileId, type: GeneratedFileType): Promise<ArrayBuffer>;
+    /**
+     * Gets a generated file raw contents as text
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to query
+     * @param type Type of the generated file
+     * @returns The text content of the generated file
+     */
+    generatedText(scope: DocumentBoxScope, file_id: FileId, type: GeneratedFileType): Promise<string>;
+    /**
+     * Gets a generated file raw contents as JSON
+     *
+     * @param scope Scope the file resides within
+     * @param file_id ID of the file to query
+     * @param type Type of the generated file
+     * @returns The JSON content of the generated file
+     */
+    generatedJson(scope: DocumentBoxScope, file_id: FileId, type: GeneratedFileType): Promise<any>;
+}

package/dist/api/folderService.d.ts

@@ -0,0 +1,45 @@
+import { CreateFolder, DocFolderEditHistory, DocumentBoxScope, FolderId, FolderResponse, UpdateFolder } from '../types';
+import { DocboxClient } from './client';
+export declare class FolderService {
+    private client;
+    constructor(client: DocboxClient);
+    /**
+     * Create a new folder
+     *
+     * @param scope Scope to create the folder within
+     * @param data Configuration for creating the folder
+     * @returns The created folder
+     */
+    create(scope: DocumentBoxScope, data: CreateFolder): Promise<FolderResponse>;
+    /**
+     * Loads a specific folder
+     *
+     * @param scope Scope the folder resides within
+     * @param folder_id ID of the folder to request
+     * @returns The resolved folder
+     */
+    get(scope: DocumentBoxScope, folder_id: FolderId): Promise<FolderResponse>;
+    /**
+     * Update a folder details
+     *
+     * @param scope Scope the folder resides within
+     * @param folder_id ID of the folder to update
+     * @param data The folder update data
+     */
+    update(scope: DocumentBoxScope, folder_id: FolderId, data: UpdateFolder): Promise<void>;
+    /**
+     * Deletes the provided folder
+     *
+     * @param scope Scope the folder resides within
+     * @param folder_id ID of the folder to delete
+     */
+    delete(scope: DocumentBoxScope, folder_id: FolderId): Promise<void>;
+    /**
+     * Load the edit history of a folder
+     *
+     * @param scope Scope the folder resides within
+     * @param folder_id ID of the folder to query
+     * @returns The folder edit history
+     */
+    editHistory(scope: DocumentBoxScope, folder_id: FolderId): Promise<DocFolderEditHistory[]>;
+}

package/dist/api/linkService.d.ts

@@ -0,0 +1,115 @@
+import { CreateLink, DocumentBoxScope, DocLinkEditHistory, LinkId, LinkMetadata, UpdateLink, DocLink } from '../types';
+import { DocboxClient } from './client';
+export declare class LinkService {
+    private client;
+    constructor(client: DocboxClient);
+    /**
+     * Get a link to the favicon image for the provided link
+     *
+     * @param scope Scope the link resides within
+     * @param id ID of the link to request
+     * @returns The favicon image URL
+     */
+    faviconURL(scope: string, id: string): string;
+    /**
+     * Get a link to the OGP image for the provided link
+     *
+     * @param scope Scope the link resides within
+     * @param id ID of the link to request
+     * @returns The OGP image URL
+     */
+    imageURL(scope: string, id: string): string;
+    /**
+     * Creates a new link within the provided document box
+     *
+     * @param scope Scope to create the link within
+     * @param data Link creation data
+     * @returns The created link
+     */
+    create(scope: DocumentBoxScope, data: CreateLink): Promise<DocLink>;
+    /**
+     * Request a specific link by ID
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns The requested link
+     */
+    get(scope: DocumentBoxScope, link_id: LinkId): Promise<DocLink>;
+    /**
+     * Requests metadata for the link. This will make a request to the site at
+     * the link value to extract metadata from the website itself such as title,
+     * and OGP metadata
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns The link website metadata
+     */
+    metadata(scope: DocumentBoxScope, link_id: LinkId): Promise<LinkMetadata>;
+    /**
+     * Get the raw favicon content for a link
+     *
+     * On node this returns an {@link ArrayBuffer} not a blob
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns The link raw favicon
+     */
+    favicon(scope: DocumentBoxScope, link_id: LinkId): Promise<Blob>;
+    /**
+     * Get the raw favicon content for a link
+     *
+     * This function is the same as {@link LinkService.favicon} just
+     * it has the correct return type for Node and will only return an
+     * ArrayBuffer
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns The link raw favicon
+     */
+    faviconNode(scope: DocumentBoxScope, link_id: LinkId): Promise<ArrayBuffer>;
+    /**
+     * Get the raw social image for a link
+     *
+     * On node this returns an {@link ArrayBuffer} not a blob
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns The link raw social image
+     */
+    image(scope: DocumentBoxScope, link_id: LinkId): Promise<Blob>;
+    /**
+     * Get the raw social image for a link
+     *
+     * This function is the same as {@link LinkService.image} just
+     * it has the correct return type for Node and will only return an
+     * ArrayBuffer
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns
+     */
+    imageNode(scope: DocumentBoxScope, link_id: LinkId): Promise<ArrayBuffer>;
+    /**
+     * Get the edit history for a link
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @returns Edit history for the link
+     */
+    editHistory(scope: DocumentBoxScope, link_id: LinkId): Promise<DocLinkEditHistory[]>;
+    /**
+     * Updates a link
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     * @param data The update request
+     */
+    update(scope: DocumentBoxScope, link_id: LinkId, data: UpdateLink): Promise<void>;
+    /**
+     * Deletes the provided link
+     *
+     * @param scope Scope the link resides within
+     * @param link_id ID of the link to request
+     */
+    delete(scope: DocumentBoxScope, link_id: LinkId): Promise<void>;
+}

package/dist/api/taskService.d.ts

@@ -0,0 +1,23 @@
+import { DocboxTask, DocumentBoxScope } from '../types';
+import { DocboxClient } from './client';
+export declare class TaskService {
+    private client;
+    constructor(client: DocboxClient);
+    /**
+     * Get the current status of a specific task
+     *
+     * @param scope
+     * @param task_id
+     * @returns
+     */
+    get(scope: DocumentBoxScope, task_id: string, abort?: AbortController): Promise<DocboxTask>;
+    /**
+     * Polls for the completion of a task
+     *
+     * @param scope
+     * @param task_id
+     * @param abort
+     * @returns
+     */
+    finished<T>(scope: DocumentBoxScope, task_id: string, interval?: number, abort?: AbortController): Promise<T>;
+}

package/dist/api/utils.d.ts

@@ -0,0 +1 @@
+export declare function sleep(timeout: number): Promise<unknown>;

package/dist/error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Create an axios response error interceptor to strip the
+ * sensitive internal docbox URL from error responses
+ *
+ * Also lifts the docbox error messages out of the response
+ * body onto the returned error for better HAPI error reporting
+ *
+ * @param docboxURL URL of the docbox server
+ * @returns The request handler
+ */
+export declare function createHandleAxiosError(docboxURL: string): (error: any) => any;