@docbox-nz/hapi-gateway 0.2.0 → 0.3.0

package/.eslintignore

@@ -1,6 +0,0 @@
-// .eslintignore
-build/*
-dist/*
-public/*
-**/out/*
-**/node_modules/*

package/.eslintrc

@@ -1,131 +0,0 @@
-{
-  "root": true,
-  "env": {
-    "browser": true,
-    "es2021": true,
-  },
-  "plugins": [
-    "perfectionist",
-    "unused-imports",
-    "@typescript-eslint",
-    "prettier"
-  ],
-  "extends": [
-    "airbnb",
-    "airbnb-typescript",
-    "airbnb/hooks",
-    "prettier"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module",
-    "project": "./tsconfig.json",
-  },
-  "settings": {
-    "import/resolver": {
-      "typescript": {
-        "alwaysTryTypes": true,
-      },
-    },
-  },
-  "rules": {
-    "max-classes-per-file": 10,
-    "no-return-await": 0,
-    "@typescript-eslint/return-await": 0,
-    "no-await-in-loop": 0,
-    "no-restricted-syntax": [
-      "error",
-      "ForInStatement",
-      "LabeledStatement",
-      "WithStatement"
-    ],
-    "no-alert": 0,
-    "camelcase": 0,
-    "no-console": 0,
-    "no-continue": 0,
-    "no-unused-vars": 0,
-    "no-param-reassign": 0,
-    "no-underscore-dangle": 0,
-    "no-restricted-exports": 0,
-    "no-promise-executor-return": 0,
-    "import/prefer-default-export": 0,
-    "@typescript-eslint/naming-convention": 0,
-    "jsx-a11y/control-has-associated-label": 0,
-    "@typescript-eslint/no-use-before-define": 0,
-    "@typescript-eslint/no-shadow": 0,
-    "prefer-destructuring": [
-      1,
-      {
-        "object": true,
-        "array": false,
-      },
-    ],
-    "@typescript-eslint/no-unused-vars": [
-      1,
-      {
-        "args": "none",
-        "argsIgnorePattern": "^_",
-        "varsIgnorePattern": "^_",
-        "caughtErrorsIgnorePattern": "^_",
-      },
-    ],
-    // unused-imports
-    // https://www.npmjs.com/package/eslint-plugin-unused-imports
-    "unused-imports/no-unused-imports": 1,
-    "unused-imports/no-unused-vars": [
-      0,
-      {
-        "vars": "all",
-        "varsIgnorePattern": "^_",
-        "args": "after-used",
-        "argsIgnorePattern": "^_",
-      },
-    ],
-    // perfectionist
-    // https://eslint-plugin-perfectionist.azat.io/
-    "perfectionist/sort-named-imports": [
-      1,
-      {
-        "order": "asc",
-        "type": "line-length",
-      },
-    ],
-    "perfectionist/sort-named-exports": [
-      1,
-      {
-        "order": "asc",
-        "type": "line-length",
-      },
-    ],
-    "perfectionist/sort-exports": [
-      1,
-      {
-        "order": "asc",
-        "type": "line-length",
-      },
-    ],
-    "perfectionist/sort-imports": [
-      1,
-      {
-        "order": "asc",
-        "type": "line-length",
-        "newlines-between": "always",
-        "groups": [
-          [
-            "builtin",
-            "external"
-          ],
-          [
-            "parent",
-            "sibling",
-            "index"
-          ],
-        ],
-        "internal-pattern": [
-          "src/**"
-        ],
-      },
-    ],
-  },
-}

package/.prettierignore

@@ -1,11 +0,0 @@
-build/*
-dist/*
-public/*
-**/out/*
-**/.next/*
-**/node_modules/*
-
-package-lock.json
-yarn.lock
-
-.eslintrc

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "printWidth": 100,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "tabWidth": 2
-}

package/dist/api/adminService.d.ts

@@ -1,16 +0,0 @@
-import { DocboxAdminSearchRequest, DocboxSearchResponseAdmin } from '../types';
-import { DocboxClient } from './client';
-export declare class AdminService {
-    private client;
-    constructor(client: DocboxClient);
-    /**
-     * Perform an admin search across multiple document boxes.
-     *
-     * This function will only work on your server handling authentication
-     * you should not allow the frontend to access these endpoints
-     *
-     * @param data Search request data
-     * @returns The search results
-     */
-    search(data: DocboxAdminSearchRequest): Promise<DocboxSearchResponseAdmin>;
-}

package/dist/api/boxService.d.ts

@@ -1,43 +0,0 @@
-import { DocboxSearchRequest, DocboxSearchResponse, DocumentBoxResponse, DocumentBoxScope, DocumentBoxStats } from '../types';
-import { DocboxClient } from './client';
-export declare class BoxService {
-    private client;
-    constructor(client: DocboxClient);
-    /**
-     * Get a document box for a scope
-     *
-     * @param scope Scope of the document box to get
-     * @param createIfMissing Whether to create the document box if it doesn't exist
-     */
-    get(scope: DocumentBoxScope, createIfMissing?: boolean): Promise<DocumentBoxResponse>;
-    /**
-     * Creates a new document box optional returning an existing one if there is one available
-     *
-     * @param scope Scope for the document box to create
-     * @param allowExisting Whether to allow returning an existing document box (If one is present)
-     * @returns The created document box
-     */
-    create(scope: DocumentBoxScope, allowExisting?: boolean): Promise<DocumentBoxResponse>;
-    /**
-     * Delete a specific document vox
-     *
-     * @param scope Scope of the document box to delete
-     * @returns
-     */
-    delete(scope: DocumentBoxScope): Promise<any>;
-    /**
-     * Search within the provided document box
-     *
-     * @param scope The scope of the document box to search
-     * @param data Search request data
-     * @returns The search results
-     */
-    search(scope: DocumentBoxScope, data: DocboxSearchRequest): Promise<DocboxSearchResponse>;
-    /**
-     * Get statistics for the provided document box
-     *
-     * @param scope The scope of the document box
-     * @returns The box stats
-     */
-    stats(scope: DocumentBoxScope): Promise<DocumentBoxStats>;
-}

package/dist/api/client.d.ts

@@ -1,45 +0,0 @@
-import type { AxiosRequestConfig, AxiosInstance } from 'axios';
-import { FileService } from './fileService';
-import { BoxService as DocumentBoxService } from './boxService';
-import { LinkService } from './linkService';
-import { FolderService } from './folderService';
-import { TaskService } from './taskService';
-import { AdminService } from './adminService';
-export declare class DocboxClient {
-    client: AxiosInstance;
-    /**
-     * Document box related operations
-     */
-    documentBox: DocumentBoxService;
-    /**
-     * Task related operations
-     */
-    task: TaskService;
-    /**
-     * File related operations
-     */
-    file: FileService;
-    /**
-     * Link related operations
-     */
-    link: LinkService;
-    /**
-     * Folder related operations
-     */
-    folder: FolderService;
-    /**
-     * Admin related operations
-     */
-    admin: AdminService;
-    /**
-     * Creates a new docbox
-     *
-     * @param client
-     */
-    constructor(client: AxiosInstance);
-    httpGet<T = any, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<T>;
-    httpPost<T = any, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<T>;
-    httpPut<T = any, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<T>;
-    httpPatch<T = any, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<T>;
-    httpDelete<T = any, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<T>;
-}

package/dist/api/docboxFile.d.ts

@@ -1,15 +0,0 @@
-import { DocFile } from '../types/file';
-declare let FileGlobal: {
-    new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag): File;
-    prototype: File;
-};
-/**
- * Wrapper around the browser File type to allow using a docbox file
- * in place when handling already uploaded files in a form
- */
-export declare class DocboxFile extends FileGlobal {
-    file: DocFile;
-    get size(): number;
-    constructor(file: DocFile);
-}
-export {};

package/dist/api/fileService.d.ts

@@ -1,251 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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

@@ -1,115 +0,0 @@
-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>;
-}