@docbox-nz/hapi-gateway 0.2.0 → 0.3.0

package/dist/types/link.d.ts

@@ -1,136 +0,0 @@
-import { EditHistoryMetadataLinkValue, EditHistoryMetadataMoveToFolder, EditHistoryMetadataRename, EditHistoryType, FolderId, ISODate, LinkId } from './shared';
-import { User } from './user';
-/**
- * Link stored within docbox
- */
-export interface DocLink {
-    /**
-     * Unique ID of the link
-     */
-    id: LinkId;
-    /**
-     * Name of the link
-     */
-    name: string;
-    /**
-     * URL value of the link
-     */
-    value: string;
-    /**
-     * ID of the folder this link is stored within.
-     */
-    folder_id: FolderId;
-    /**
-     * Timestamp of when the link was created
-     */
-    created_at: ISODate;
-    /**
-     * User who created the link if the user was known
-     * at the point of creation
-     */
-    created_by: User | null;
-    /**
-     * Timestamp of when the link was last modified
-     */
-    last_modified_at: ISODate | null;
-    /**
-     * User who last modified the link if the user was
-     * known at the point of modification
-     *
-     * NOTE: This is the user for the most recent modification, not the
-     * most recent modification with a user
-     */
-    last_modified_by: User | null;
-}
-/**
- * Entry within an edit history for a file
- */
-export interface DocLinkEditHistoryBase {
-    /**
-     * ID of the specific entry
-     */
-    id: string;
-    /**
-     * ID of the link the edit history belongs to
-     */
-    link_id: LinkId;
-    /**
-     * User who performed the edit, if available at the
-     * time of the edit
-     */
-    user: User | null;
-    /**
-     * Timestamp the edit was performed at
-     */
-    created_at: ISODate;
-}
-export type DocLinkEditHistoryData = {
-    type: EditHistoryType.MoveToFolder;
-    metadata: EditHistoryMetadataMoveToFolder;
-} | {
-    type: EditHistoryType.Rename;
-    metadata: EditHistoryMetadataRename;
-} | {
-    type: EditHistoryType.LinkValue;
-    metadata: EditHistoryMetadataLinkValue;
-};
-export type DocLinkEditHistory = DocLinkEditHistoryBase & DocLinkEditHistoryData;
-/**
- * Metadata resolved from looking up a website
- */
-export interface LinkMetadata {
-    /**
-     * Website <title/> tag contents if available
-     */
-    title: string | null;
-    /**
-     * OGP metadata title if available
-     */
-    og_title: string | null;
-    /**
-     * OGP metadata description if available
-     */
-    og_description: string | null;
-    /**
-     * Whether a favicon was determined to be available
-     */
-    favicon: boolean;
-    /**
-     * Whether an OGP image was determined to be available
-     */
-    image: boolean;
-}
-export interface CreateLink {
-    /**
-     * Name of the link
-     */
-    name: string;
-    /**
-     * URL value of the link
-     */
-    value: string;
-    /**
-     * ID of the folder to create the link within
-     */
-    folder_id: FolderId;
-}
-export interface UpdateLink {
-    /**
-     * Optional new name of the link.
-     *
-     * leave undefined or specify null to not update this field
-     */
-    name?: string | null;
-    /**
-     * Optional new folder to move the link to.
-     *
-     * leave undefined or specify null to not update this field
-     */
-    folder_id?: FolderId | null;
-    /**
-     * Optional new URL value for the link
-     *
-     * leave undefined or specify null to not update this field
-     */
-    value?: string | null;
-}

package/dist/types/search.d.ts

@@ -1,177 +0,0 @@
-import { DocFile } from './file';
-import { DocFolder, FolderPathSegment } from './folder';
-import { DocLink } from './link';
-import { DocboxItemId, DocumentBoxScope, FolderId, UserId } from './shared';
-/**
- * Possible search result item types
- */
-export declare enum SearchResultItemType {
-    FILE = "File",
-    FOLDER = "Folder",
-    LINK = "Link"
-}
-export type DocboxSearchResultData = ({
-    type: SearchResultItemType.FILE;
-} & DocFile) | ({
-    type: SearchResultItemType.FOLDER;
-} & DocFolder) | ({
-    type: SearchResultItemType.LINK;
-} & DocLink);
-export type DocboxSearchResult = {
-    /**
-     * Score the search result obtained
-     */
-    score: number;
-    /**
-     * Matches within pages of the content
-     */
-    page_matches: PageMatch[];
-    /**
-     * Resolved path to the item
-     */
-    path: FolderPathSegment[];
-    /**
-     * Total number of search "hits"
-     */
-    total_hits: number;
-} & DocboxSearchResultData;
-export type DocboxSearchResultAdmin = DocboxSearchResult & {
-    scope: DocumentBoxScope;
-};
-export interface DocboxSearchResponse {
-    /**
-     * Total number of hits
-     */
-    total_hits: number;
-    /**
-     * Results from the search
-     */
-    results: DocboxSearchResult[];
-}
-export interface DocboxFileSearchResponse {
-    /**
-     * Total number of hits
-     */
-    total_hits: number;
-    /**
-     * Results from the search
-     */
-    results: PageMatch[];
-}
-export interface DocboxSearchResponseAdmin {
-    /**
-     * Total number of hits
-     */
-    total_hits: number;
-    /**
-     * Results from the search
-     */
-    results: DocboxSearchResultAdmin[];
-}
-export interface PageMatch {
-    /**
-     * Page number
-     */
-    page: number;
-    /**
-     * Matched content results
-     */
-    matches: string[];
-}
-export type DocboxAdminSearchRequest = DocboxSearchRequest & {
-    scopes: DocumentBoxScope[];
-};
-export interface DocboxFileSearchRequest {
-    /**
-     * Search query to search for
-     */
-    query?: string | null;
-    /**
-     * Number of results to skip
-     */
-    offset?: number;
-    /**
-     * Maximum number of results to return
-     */
-    limit?: number;
-}
-export interface DocboxSearchRequest {
-    /**
-     * Search query to search for
-     */
-    query?: string | null;
-    /**
-     * Whether to use neural searching
-     */
-    neural?: boolean;
-    /**
-     * Mime type to filter search by
-     */
-    mime?: string | null;
-    /**
-     * Whether to include the item name when searching
-     */
-    include_name?: boolean;
-    /**
-     * Whether to perform full text search over the contents
-     * of files, links, ...etc
-     */
-    include_content?: boolean;
-    /**
-     * Filter to a specific created at range
-     */
-    created_at?: DateRange | null;
-    /**
-     * Filter to a specific date modified range
-     */
-    modified?: DateRange | null;
-    /**
-     * Filter to a specific user who created
-     */
-    created_by?: UserId | null;
-    /**
-     * Filter to only results within the children of a specific
-     * folder by ID
-     */
-    folder_id?: FolderId | null;
-    /**
-     * Filter results to only results for a specific item
-     *
-     * (i.e searching full text within a specific file)
-     *
-     * @deprecated Use dedicated file search API instead
-     */
-    item_id?: DocboxItemId | null;
-    /**
-     * Number of results to obtain
-     */
-    size?: number;
-    /**
-     * Number of results to skip
-     */
-    offset?: number;
-    /**
-     * Number of pages of content results to obtain
-     */
-    max_pages?: number;
-    /**
-     * Number of pages of content results to skip
-     *
-     * @deprecated Use dedicated file search API instead
-     */
-    pages_offset?: number;
-}
-/**
- * Searchable date range, must have either a start
- * or end date or both, cannot be both null
- */
-export interface DateRange {
-    /**
-     * Start date, leave undefined/null for the beginning of time
-     */
-    start?: string | null;
-    /**
-     * End date, leave undefined/null for the end of time
-     */
-    end?: string | null;
-}

package/dist/types/shared.d.ts

@@ -1,94 +0,0 @@
-/**
- * Alias of a string representing a user ID
- */
-export type UserId = string;
-/**
- * Alias of a string representing a tenant ID
- */
-export type TenantId = string;
-/**
- * Alias of a string representing a file ID
- */
-export type FileId = string;
-/**
- * Alias of a string representing a generated file ID
- */
-export type GeneratedFileId = string;
-/**
- * Alias of a string representing a folder ID
- */
-export type FolderId = string;
-/**
- * Alias of a string representing a link ID
- */
-export type LinkId = string;
-/**
- * Alias of a string representing a document box scope
- */
-export type DocumentBoxScope = string;
-/**
- * Alias of any docbox item ID (File, Folder, Link)
- */
-export type DocboxItemId = FileId | FolderId | LinkId;
-/**
- * Alias for a string representing a ISO date
- *
- * @example
- * This can be turned into a date using;
- * ```
- * const date = new Date(value);
- * ```
- */
-export type ISODate = string;
-export declare enum EditHistoryType {
-    MoveToFolder = "MoveToFolder",
-    Rename = "Rename",
-    LinkValue = "LinkValue"
-}
-/**
- * Edit history metadata for moving something from
- * one folder to another
- *
- * Can be seen on: Files, Folders, and Links
- */
-export interface EditHistoryMetadataMoveToFolder {
-    /**
-     * ID of the original folder before moving
-     */
-    original_id: string;
-    /**
-     * ID of the folder after moving
-     */
-    target_id: string;
-}
-/**
- * Edit history metadata for renaming something
- *
- * Can be seen on: Files, Folders, and Links
- */
-export interface EditHistoryMetadataRename {
-    /**
-     * Name of the file before renaming
-     */
-    original_name: string;
-    /**
-     * Name of the file after renaming
-     */
-    new_name: string;
-}
-/**
- * Edit history metadata for changing the value of
- * a link
- *
- * Can be seen on: Link
- */
-export interface EditHistoryMetadataLinkValue {
-    /**
-     * Previous URL value of the link
-     */
-    previous_value: string;
-    /**
-     * New URL value of the link
-     */
-    new_value: string;
-}

package/dist/types/user.d.ts

@@ -1,20 +0,0 @@
-import { UserId } from './shared';
-/**
- * User within the docbox database
- */
-export interface User {
-    /**
-     * ID of the user
-     */
-    id: UserId;
-    /**
-     * Name of the user if this is known
-     * (Based on the last modification performed)
-     */
-    name: string | null;
-    /**
-     * Image ID of the user if this is known
-     * (Based on the last modification performed)
-     */
-    image_id: string | null;
-}

package/rollup.config.js

@@ -1,36 +0,0 @@
-import typescript from 'rollup-plugin-typescript2';
-import nodeResolve from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
-import json from '@rollup/plugin-json';
-
-export default [
-    // Node builds
-    {
-        external: ['@hapi/hapi'],
-        input: 'src/index.ts',
-        output: [
-            {
-                file: 'dist/index.node.cjs',
-                format: 'cjs',
-                sourcemap: true
-            },
-            {
-                file: 'dist/index.node.esm.js',
-                format: 'esm',
-                sourcemap: true
-            }
-        ],
-        plugins: [
-            json(),
-            nodeResolve({
-                browser: false,
-                preferBuiltins: true
-            }),
-            commonjs(),
-            typescript({
-                tsconfig: './tsconfig.json'
-            }),
-        ]
-    }
-
-];