@lasuillard/raindrop-client 0.8.0 → 0.8.1

package/dist/src/client/auth.d.ts

@@ -1,18 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { AuthenticationApi as _AuthenticationApi, ObtainToken, RefreshToken, TokenResponse } from '../generated';
-export declare class AuthenticationApi extends _AuthenticationApi {
-    /**
-     * Wrapper function of {@link _AuthenticationApi.getOrRefreshToken} for token exchange.
-     * @param request {@link ObtainToken} but without `grant_type` field.
-     * @param options Axios request configuration.
-     * @returns API response.
-     */
-    exchangeToken(request: Omit<ObtainToken, "grant_type">, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<TokenResponse, any>>;
-    /**
-     * Wrapper function of {@link _AuthenticationApi.getOrRefreshToken} for token refresh.
-     * @param request {@link RefreshToken} but without `grant_type` field.
-     * @param options Axios request configuration.
-     * @returns API response.
-     */
-    refreshToken(request: Omit<RefreshToken, "grant_type">, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<TokenResponse, any>>;
-}

package/dist/src/client/client.d.ts

@@ -1,25 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { Configuration, FilterApi, HighlightApi, ImportApi, TagApi, UserApi } from '../generated';
-import { AuthenticationApi } from './auth';
-import { CollectionApi } from './collection';
-import { RaindropApi } from './raindrop';
-/**
- * Raindrop API set.
- *
- * You can provide auth credentials via `new Configuration({accessToken: ...})` or headers in Axios instances.
- */
-export declare class Raindrop {
-    /** Axios client instance. If not set, will use default Axios instance. */
-    readonly client: AxiosInstance;
-    /** API global configurations. */
-    readonly configuration: Configuration;
-    readonly auth: AuthenticationApi;
-    readonly user: UserApi;
-    readonly collection: CollectionApi;
-    readonly filter: FilterApi;
-    readonly highlight: HighlightApi;
-    readonly import: ImportApi;
-    readonly raindrop: RaindropApi;
-    readonly tag: TagApi;
-    constructor(configuration?: Configuration, client?: AxiosInstance);
-}

package/dist/src/client/collection.d.ts

@@ -1,14 +0,0 @@
-import { CollectionApi as _CollectionApi, GetChildCollectionsResponse, GetRootCollectionsResponse } from '../generated';
-import { TreeNode } from '../utils/tree';
-type GetRootCollectionsResponseItem = GetRootCollectionsResponse["items"][0];
-type GetChildCollectionsResponseItem = GetChildCollectionsResponse["items"][0];
-export type CollectionItem = GetRootCollectionsResponseItem | GetChildCollectionsResponseItem;
-export declare class CollectionApi extends _CollectionApi {
-    /**
-     * Create structured tree of collections.
-     * @returns Root of tree.
-     * @deprecated This function is deprecated and will be removed in a future release.
-     */
-    getCollectionTree(): Promise<TreeNode<CollectionItem | null>>;
-}
-export {};

package/dist/src/client/index.d.ts

@@ -1 +0,0 @@
-export { Raindrop } from './client';

package/dist/src/client/raindrop.d.ts

@@ -1,23 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { RaindropApi as _RaindropApi, GetRaindropsResponse } from '../generated';
-type RaindropItem = GetRaindropsResponse["items"][0];
-export interface GetAllRaindropsParams {
-    /** Sort option. See https://developer.raindrop.io/v1/raindrops/multiple#common-parameters */
-    sort?: string;
-    /** Size of per page to fetch. Maximum 50 limited by Raindrop.io */
-    pageSize?: number;
-    /** Search query. See details at https://help.raindrop.io/using-search/ */
-    search?: string;
-}
-export declare class RaindropApi extends _RaindropApi {
-    /**
-     * Fetch all raindrops of a collection.
-     * @param collectionId ID of collection.
-     * @param params Request parameters.
-     * @param options Axios request config.
-     * @returns Array of raindrops.
-     * @deprecated This function is deprecated and will be removed in a future release.
-     */
-    getAllRaindrops(collectionId?: number, params?: GetAllRaindropsParams, options?: AxiosRequestConfig<any>): Promise<RaindropItem[]>;
-}
-export {};

package/dist/src/generated/base.d.ts

@@ -1,55 +0,0 @@
-import { Configuration } from './configuration';
-import { AxiosInstance, RawAxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: RawAxiosRequestConfig;
-}
-/**
- *
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    constructor(field: string, msg?: string);
-}
-interface ServerMap {
-    [key: string]: {
-        url: string;
-        description: string;
-    }[];
-}
-/**
- *
- * @export
- */
-export declare const operationServerMap: ServerMap;
-export {};

package/dist/src/generated/common.d.ts

@@ -1,54 +0,0 @@
-import { Configuration } from './configuration';
-import { RequestArgs } from './base';
-import { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
-export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/src/generated/configuration.d.ts

@@ -1,91 +0,0 @@
-/**
- * Raindrop API (Unofficial)
- * **UNOFFICIAL** OpenAPI specification of Raindrop API.  This OpenAPI spec has been made by hand with reference to official documentation because it is not provided by Raindrop.io.  Because official documentation not maintained well, there are very (highly) likely to have mismatch in schemas. As we can\'t inspect and address all issues, schema being updated as we find issues.  Any contributions are welcome. Bug report, schema update, adding descriptions or functions, please don\'t hesitate to create an issue.
- *
- * The version of the OpenAPI document: 0.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
-     */
-    serverIndex?: number;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-    constructor(param?: ConfigurationParameters);
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    isJsonMime(mime: string): boolean;
-}

package/dist/src/generated/index.d.ts

@@ -1,13 +0,0 @@
-/**
- * Raindrop API (Unofficial)
- * **UNOFFICIAL** OpenAPI specification of Raindrop API.  This OpenAPI spec has been made by hand with reference to official documentation because it is not provided by Raindrop.io.  Because official documentation not maintained well, there are very (highly) likely to have mismatch in schemas. As we can\'t inspect and address all issues, schema being updated as we find issues.  Any contributions are welcome. Bug report, schema update, adding descriptions or functions, please don\'t hesitate to create an issue.
- *
- * The version of the OpenAPI document: 0.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export * from './api';
-export * from './configuration';

package/dist/src/index.d.ts

@@ -1,6 +0,0 @@
-import * as client from "./client";
-import * as generated from "./generated";
-import * as utils from "./utils";
-export { client, generated, utils };
-declare const _default: typeof client.Raindrop;
-export default _default;

package/dist/src/utils/index.d.ts

@@ -1,2 +0,0 @@
-import * as tree from "./tree";
-export { tree };

package/dist/src/utils/tree.d.ts

@@ -1,49 +0,0 @@
-/**
- * Generic tree class.
- */
-export declare class TreeNode<T> {
-    private _data;
-    private _parent;
-    private _children;
-    /**
-     * Create tree node.
-     * @param data Node data.
-     * @param children Initial tree children.
-     */
-    constructor(data: T | null, children?: TreeNode<T>[]);
-    get data(): T | null;
-    get parent(): TreeNode<T> | null;
-    set parent(parent: TreeNode<T>);
-    isRoot(): boolean;
-    get children(): TreeNode<T>[];
-    /**
-     * Add children to current node.
-     * @param children Children nodes to append.
-     */
-    addChildren(...children: TreeNode<T>[]): void;
-    /**
-     * Pre-order traverse this tree.
-     * @param callbackFn Function to be called with traversing nodes.
-     */
-    traverse(callbackFn: (node: TreeNode<T>) => void): void;
-}
-/**
- * Interface for building tree, {@link TreeNode}.
- */
-export interface TreeSource<D, T = D> {
-    /** Raw data for referencing. */
-    data: D;
-    /** Get ID of source. */
-    get id(): string;
-    /** Return source' parent ID. Should return `null` if parent is root. */
-    get parent(): string | null;
-    /** Create {@link TreeNode} from current source. */
-    toNode(): TreeNode<T>;
-}
-/**
- * Create the tree from sources.
- * @param data Data of root node.
- * @param source Array of sources.
- * @returns Root node of built tree.
- */
-export declare function makeTree<_, T>(data: T, source: TreeSource<_, T>[]): TreeNode<T>;

package/dist/tests/__typechecks__/checkURLsExist.test-d.d.ts

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

package/dist/tests/__typechecks__/createCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/createRaindrop.test-d.d.ts

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

package/dist/tests/__typechecks__/createRaindrops.test-d.d.ts

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

package/dist/tests/__typechecks__/emptyTrash.test-d.d.ts

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

package/dist/tests/__typechecks__/getAllHighlights.test-d.d.ts

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

package/dist/tests/__typechecks__/getChildCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/getCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/getCurrentUser.test-d.d.ts

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

package/dist/tests/__typechecks__/getFeaturedCovers.test-d.d.ts

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

package/dist/tests/__typechecks__/getFilters.test-d.d.ts

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

package/dist/tests/__typechecks__/getHighlightsInCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/getPublicUserByName.test-d.d.ts

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

package/dist/tests/__typechecks__/getRaindrop.test-d.d.ts

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

package/dist/tests/__typechecks__/getRaindrops.test-d.d.ts

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

package/dist/tests/__typechecks__/getRootCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/getSystemCollectionStats.test-d.d.ts

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

package/dist/tests/__typechecks__/getTagsInCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/importHTMLBookmarkFile.test-d.d.ts

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

package/dist/tests/__typechecks__/mergeCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/parseURL.test-d.d.ts

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

package/dist/tests/__typechecks__/removeAllEmptyCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/removeCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/removeCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/removeRaindrop.test-d.d.ts

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

package/dist/tests/__typechecks__/removeRaindrops.test-d.d.ts

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

package/dist/tests/__typechecks__/removeTagsFromCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/renameOrMergeTags.test-d.d.ts

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

package/dist/tests/__typechecks__/reorderAllCollections.test-d.d.ts

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

package/dist/tests/__typechecks__/searchCovers.test-d.d.ts

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

package/dist/tests/__typechecks__/shareCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/updateCollection.test-d.d.ts

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

package/dist/tests/__typechecks__/updateCurrentUser.test-d.d.ts

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

package/dist/tests/__typechecks__/updateRaindrop.test-d.d.ts

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

package/dist/tests/__typechecks__/updateRaindrops.test-d.d.ts

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

package/dist/tests/__typechecks__/uploadCollectionCover.test-d.d.ts

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

package/dist/tests/__typechecks__/uploadFile.test-d.d.ts

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

package/dist/tests/__typechecks__/uploadRaindropCover.test-d.d.ts

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

package/dist/tests/_helpers/axios.d.ts

@@ -1,11 +0,0 @@
-import { Use } from '@vitest/runner';
-import { AxiosInstance } from 'axios';
-import { default as MockAdapter } from 'axios-mock-adapter';
-import { Raindrop } from '../../src/client';
-export declare function axiosInstance({}: {}, use: Use<AxiosInstance>): Promise<void>;
-export declare function mockAxios({ axiosInstance }: {
-    axiosInstance: AxiosInstance;
-}, use: Use<MockAdapter>): Promise<void>;
-export declare function client({ axiosInstance }: {
-    axiosInstance: AxiosInstance;
-}, use: Use<Raindrop>): Promise<void>;

package/dist/tests/_helpers/common.d.ts

@@ -1,2 +0,0 @@
-import { Task } from '@vitest/runner';
-export declare function taskId(task: Task): string;

package/dist/tests/_helpers/polly.d.ts

@@ -1,5 +0,0 @@
-import { Polly } from '@pollyjs/core';
-import { Task, Use } from '@vitest/runner';
-export declare function polly({ task }: {
-    task: Task;
-}, use: Use<Polly>): Promise<void>;

package/dist/tests/_helpers/raindrop.d.ts

@@ -1,17 +0,0 @@
-import { Task, Use } from '@vitest/runner';
-import { Raindrop } from '../../src/client';
-import { CreateCollectionRequest, CreateCollectionResponse, CreateRaindropRequest, CreateRaindropResponse } from '../../src/generated';
-export declare function resetData({ client }: {
-    client: Raindrop;
-}, use: Use<void>): Promise<void>;
-export declare function setupTools({ task, client }: {
-    task: Task;
-    client: Raindrop;
-}, use: Use<SetupTools>): Promise<void>;
-export declare class SetupTools {
-    task: Task;
-    client: Raindrop;
-    constructor(task: Task, client: Raindrop);
-    createCollection(args?: Partial<CreateCollectionRequest>): Promise<CreateCollectionResponse>;
-    createRaindrop(args?: Partial<CreateRaindropRequest>): Promise<CreateRaindropResponse>;
-}

package/dist/tests/_helpers/typechecks.d.ts

@@ -1,14 +0,0 @@
-import { Task, Use } from '@vitest/runner';
-export interface CreateTest {
-    testId: string;
-    type: string;
-    value: string;
-}
-export interface RegisterHookArgs {
-    type: string;
-}
-export type RegisterHook = (args: RegisterHookArgs) => void;
-export declare function generateTypeTest({ task }: {
-    task: Task;
-}, use: Use<RegisterHook>): Promise<void>;
-export declare function generateAllTests(): Promise<void>;

package/dist/tests/_helpers/utils.d.ts

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

package/dist/tests/_helpers/vitest.d.ts

@@ -1,29 +0,0 @@
-import { Polly } from '@pollyjs/core';
-import { AxiosInstance } from 'axios';
-import { default as MockAdapter } from 'axios-mock-adapter';
-import { Raindrop } from '../../src/client';
-import { polly } from './polly';
-import { SetupTools } from './raindrop';
-import { RegisterHook } from './typechecks';
-export declare const it: import('vitest').TestAPI<{
-    axiosInstance: AxiosInstance;
-    client: Raindrop;
-    mockAxios: MockAdapter;
-    polly: Polly | [typeof polly, {
-        auto: true;
-    }];
-    generateTypeTest: RegisterHook;
-    setupTools: SetupTools;
-    resetData: void;
-}>;
-declare module "vitest" {
-    interface TestContext {
-        axiosInstance: AxiosInstance;
-        mockAxios: MockAdapter;
-        client: Raindrop;
-        polly: Polly;
-        generateTypeTest: RegisterHook;
-        resetData: undefined;
-        setupTools: SetupTools;
-    }
-}

package/dist/tests/client/auth.test.d.ts

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

package/dist/tests/client/client.test.d.ts

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

package/dist/tests/client/collection.test.d.ts

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

package/dist/tests/client/raindrop.test.d.ts

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

package/dist/tests/generated/auth.test.d.ts

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

package/dist/tests/generated/collection.test.d.ts

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

package/dist/tests/generated/filter.test.d.ts

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

package/dist/tests/generated/highlight.test.d.ts

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

package/dist/tests/generated/import.test.d.ts

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

package/dist/tests/generated/raindrop.test.d.ts

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

package/dist/tests/generated/tag.test.d.ts

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

package/dist/tests/generated/user.test.d.ts

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

package/dist/tests/setup.d.ts

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

package/dist/tests/utils/tree.test.d.ts

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