backlog-js 0.12.3 → 0.12.6

package/dist/types/error.d.ts

@@ -0,0 +1,37 @@
+export declare class BacklogError extends Error {
+    private _name;
+    private _url;
+    private _status;
+    private _body;
+    private _response;
+    constructor(name: BacklogErrorNameType, response: Response, body?: {
+        errors: BacklogErrorMessage[];
+    });
+    get name(): BacklogErrorNameType;
+    get url(): string;
+    get status(): number;
+    get body(): {
+        errors: BacklogErrorMessage[];
+    };
+    get response(): Response;
+}
+export declare class BacklogApiError extends BacklogError {
+    constructor(response: Response, body?: {
+        errors: BacklogErrorMessage[];
+    });
+}
+export declare class BacklogAuthError extends BacklogError {
+    constructor(response: Response, body?: {
+        errors: BacklogErrorMessage[];
+    });
+}
+export declare class UnexpectedError extends BacklogError {
+    constructor(response: Response);
+}
+export interface BacklogErrorMessage {
+    message: string;
+    code: number;
+    errorInfo: string;
+    moreInfo: string;
+}
+export declare type BacklogErrorNameType = 'BacklogApiError' | 'BacklogAuthError' | 'UnexpectedError';

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+import Backlog from './backlog';
+import OAuth2 from './oauth2';
+import * as Option from './option';
+import * as Entity from './entity';
+import * as Error from './error';
+export { Backlog, OAuth2, Option, Entity, Error };

package/dist/types/oauth2.d.ts

@@ -0,0 +1,21 @@
+import * as Option from './option';
+import * as Entity from './entity';
+export default class OAuth2 {
+    private credentials;
+    private timeout?;
+    constructor(credentials: Option.OAuth2.Credentials, timeout?: number);
+    getAuthorizationURL(options: {
+        host: string;
+        redirectUri?: string;
+        state?: string;
+    }): string;
+    getAccessToken(options: {
+        host: string;
+        code: string;
+        redirectUri?: string;
+    }): Promise<Entity.OAuth2.AccessToken>;
+    refreshAccessToken(options: {
+        host: string;
+        refreshToken: string;
+    }): Promise<Entity.OAuth2.AccessToken>;
+}

package/dist/types/option.d.ts

@@ -0,0 +1,455 @@
+export declare type Order = "asc" | "desc";
+export declare enum ActivityType {
+    Undefined = -1,
+    IssueCreated = 1,
+    IssueUpdated = 2,
+    IssueCommented = 3,
+    IssueDeleted = 4,
+    WikiCreated = 5,
+    WikiUpdated = 6,
+    WikiDeleted = 7,
+    FileAdded = 8,
+    FileUpdated = 9,
+    FileDeleted = 10,
+    SvnCommitted = 11,
+    GitPushed = 12,
+    GitRepositoryCreated = 13,
+    IssueMultiUpdated = 14,
+    ProjectUserAdded = 15,
+    ProjectUserRemoved = 16,
+    NotifyAdded = 17,
+    PullRequestAdded = 18,
+    PullRequestUpdated = 19,
+    PullRequestCommented = 20,
+    PullRequestMerged = 21
+}
+export declare namespace Notification {
+    interface GetNotificationsParams {
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface GetNotificationsCountParams {
+        alreadyRead: boolean;
+        resourceAlreadyRead: boolean;
+    }
+}
+export declare namespace Space {
+    interface GetActivitiesParams {
+        activityTypeId?: ActivityType[];
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface PutSpaceNotificationParams {
+        content: string;
+    }
+}
+export declare namespace User {
+    interface PostUserParams {
+        userId: string;
+        password: string;
+        name: string;
+        mailAddress: string;
+        roleType: RoleType;
+    }
+    interface PatchUserParams {
+        password?: string;
+        name?: string;
+        mailAddress?: string;
+        roleType?: RoleType;
+    }
+    enum RoleType {
+        Admin = 1,
+        User = 2,
+        Reporter = 3,
+        Viewer = 4,
+        GuestReporter = 5,
+        GuestViewer = 6
+    }
+    interface GetUserActivitiesParams {
+        activityTypeId?: ActivityType[];
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface GetUserStarsParams {
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface GetUserStarsCountParams {
+        since?: string;
+        until?: string;
+    }
+    interface GetRecentlyViewedParams {
+        order?: Order;
+        offset?: number;
+        count?: number;
+    }
+}
+export declare namespace Group {
+    interface GetGroupsParams {
+        order?: Order;
+        offset?: number;
+        count?: number;
+    }
+    interface PostGroupsParams {
+        name: string;
+        members?: string[];
+    }
+    interface PatchGroupParams {
+        name?: string;
+        members?: string[];
+    }
+}
+export declare namespace Team {
+    interface GetTeamsParams {
+        order?: Order;
+        offset?: number;
+        count?: number;
+    }
+    interface PatchTeamParams {
+        name?: string;
+        members?: number[];
+    }
+}
+export declare namespace Project {
+    type TextFormattingRule = "backlog" | "markdown";
+    interface PostProjectParams {
+        name: string;
+        key: string;
+        chartEnabled: boolean;
+        projectLeaderCanEditProjectLeader?: boolean;
+        subtaskingEnabled: boolean;
+        textFormattingRule: TextFormattingRule;
+    }
+    interface PatchProjectParams {
+        name?: string;
+        key?: string;
+        chartEnabled?: boolean;
+        subtaskingEnabled?: boolean;
+        projectLeaderCanEditProjectLeader?: boolean;
+        textFormattingRule?: TextFormattingRule;
+        archived?: boolean;
+    }
+    interface GetProjectsParams {
+        archived?: boolean;
+        all?: boolean;
+    }
+    interface DeleteProjectUsersParams {
+        userId: number;
+    }
+    interface PostProjectAdministrators {
+        userId: number;
+    }
+    interface DeleteProjectAdministrators {
+        userId: number;
+    }
+    type IssueTypeColor = "#e30000" | "#990000" | "#934981" | "#814fbc" | "#2779ca" | "#007e9a" | "#7ea800" | "#ff9200" | "#ff3265" | "#666665";
+    interface PostIssueTypeParams {
+        name: string;
+        color: IssueTypeColor;
+    }
+    interface PatchIssueTypeParams {
+        name?: string;
+        color?: IssueTypeColor;
+    }
+    interface DeleteIssueTypeParams {
+        substituteIssueTypeId: number;
+    }
+    interface PostCategoriesParams {
+        name: string;
+    }
+    interface PatchCategoriesParams {
+        name: string;
+    }
+    interface PostVersionsParams {
+        name: string;
+        description: string;
+        startDate: string;
+        releaseDueDate: string;
+    }
+    interface PatchVersionsParams {
+        name: string;
+        description?: string;
+        startDate?: string;
+        releaseDueDate?: string;
+        archived?: boolean;
+    }
+    interface PostCustomFieldParams {
+        typeId: FieldType;
+        name: string;
+        applicableIssueTypes?: number[];
+        description?: string;
+        required?: boolean;
+    }
+    interface PostCustomFieldWithNumericParams extends PostCustomFieldParams {
+        min?: number;
+        max?: number;
+        initialValue?: number;
+        unit?: string;
+    }
+    interface PostCustomFieldWithDateParams extends PostCustomFieldParams {
+        min?: string;
+        max?: string;
+        initialValueType?: number;
+        initialDate?: string;
+        initialShift?: number;
+    }
+    interface PostCustomFieldWithListParams extends PostCustomFieldParams {
+        items?: string[];
+        allowInput?: boolean;
+        allowAddItem?: boolean;
+    }
+    interface PatchCustomFieldParams {
+        name?: string;
+        applicableIssueTypes?: number[];
+        description?: string;
+        required?: boolean;
+    }
+    interface PatchCustomFieldWithNumericParams extends PatchCustomFieldParams {
+        min?: number;
+        max?: number;
+        initialValue?: number;
+        unit?: string;
+    }
+    interface PatchCustomFieldWithDateParams extends PatchCustomFieldParams {
+        min?: string;
+        max?: string;
+        initialValueType?: number;
+        initialDate?: string;
+        initialShift?: number;
+    }
+    interface PatchCustomFieldWithListParams extends PatchCustomFieldParams {
+        items?: string[];
+        allowInput?: boolean;
+        allowAddItem?: boolean;
+    }
+    interface PostCustomFieldItemParams {
+        name: string;
+    }
+    interface PatchCustomFieldItemParams {
+        name: string;
+    }
+    interface GetSharedFilesParams {
+        order?: Order;
+        offset?: number;
+        count?: number;
+    }
+    interface PostWebhookParams {
+        name?: string;
+        description?: string;
+        hookUrl?: string;
+        allEvent?: boolean;
+        activityTypeIds?: number[];
+    }
+    interface PatchWebhookParams {
+        name?: string;
+        description?: string;
+        hookUrl?: string;
+        allEvent?: boolean;
+        activityTypeIds?: number[];
+    }
+    enum FieldType {
+        Text = 1,
+        TextArea = 2,
+        Numeric = 3,
+        Date = 4,
+        SingleList = 5,
+        MultipleList = 6,
+        CheckBox = 7,
+        Radio = 8
+    }
+    interface PostStarParams {
+        issueId?: number;
+        commentId?: number;
+        wikiId?: number;
+        pullRequestId?: number;
+        pullRequestCommentId?: number;
+    }
+    type ProjectStatusColor = "#ea2c00" | "#e87758" | "#e07b9a" | "#868cb7" | "#3b9dbd" | "#4caf93" | "#b0be3c" | "#eda62a" | "#f42858" | "#393939";
+    interface PostStatusParams {
+        name: string;
+        color: ProjectStatusColor;
+    }
+    interface PatchStatusParams {
+        name?: string;
+        color?: ProjectStatusColor;
+    }
+}
+export declare namespace Issue {
+    interface PostIssueParams {
+        projectId: number;
+        summary: string;
+        priorityId: number;
+        issueTypeId: number;
+        parentIssueId?: number;
+        description?: string;
+        startDate?: string;
+        dueDate?: string;
+        estimatedHours?: number;
+        actualHours?: number;
+        categoryId?: number[];
+        versionId?: number[];
+        milestoneId?: number[];
+        assigneeId?: number;
+        notifiedUserId?: number[];
+        attachmentId?: number[];
+        [customField_: string]: any;
+    }
+    interface PatchIssueParams {
+        summary?: string;
+        parentIssueId?: number;
+        description?: string;
+        statusId?: number;
+        resolutionId?: number;
+        startDate?: string;
+        dueDate?: string;
+        estimatedHours?: number;
+        actualHours?: number;
+        issueTypeId?: number;
+        categoryId?: number[];
+        versionId?: number[];
+        milestoneId?: number[];
+        priorityId?: number;
+        assigneeId?: number;
+        notifiedUserId?: number[];
+        attachmentId?: number[];
+        comment?: string;
+        [customField_: string]: any;
+    }
+    interface GetIssuesParams {
+        projectId?: number[];
+        issueTypeId?: number[];
+        categoryId?: number[];
+        versionId?: number[];
+        milestoneId?: number[];
+        statusId?: number[];
+        priorityId?: number[];
+        assigneeId?: number[];
+        createdUserId?: number[];
+        resolutionId?: number[];
+        parentChild?: ParentChildType;
+        attachment?: boolean;
+        sharedFile?: boolean;
+        sort?: SortKey;
+        order?: Order;
+        offset?: number;
+        count?: number;
+        createdSince?: string;
+        createdUntil?: string;
+        updatedSince?: string;
+        updatedUntil?: string;
+        startDateSince?: string;
+        startDateUntil?: string;
+        dueDateSince?: string;
+        dueDateUntil?: string;
+        id?: number[];
+        parentIssueId?: number[];
+        keyword?: string;
+        [customField_: string]: any;
+    }
+    enum ParentChildType {
+        All = 0,
+        NotChild = 1,
+        Child = 2,
+        NotChildNotParent = 3,
+        Parent = 4
+    }
+    type SortKey = "issueType" | "category" | "version" | "milestone" | "summary" | "status" | "priority" | "attachment" | "sharedFile" | "created" | "createdUser" | "updated" | "updatedUser" | "assignee" | "startDate" | "dueDate" | "estimatedHours" | "actualHours" | "childIssue";
+    interface GetIssueCommentsParams {
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface PostIssueCommentsParams {
+        content: string;
+        notifiedUserId?: number[];
+        attachmentId?: number[];
+    }
+    interface PatchIssueCommentParams {
+        content: string;
+    }
+    interface IssueCommentNotifications {
+        notifiedUserId: number[];
+    }
+    interface LinkIssueSharedFilesParams {
+        fileId: number[];
+    }
+}
+export declare namespace PullRequest {
+    interface GetPullRequestsParams {
+        statusId?: number[];
+        assigneeId?: number[];
+        issueId?: number[];
+        createdUserId?: number[];
+        offset?: number;
+        count?: number;
+    }
+    interface PostPullRequestParams {
+        summary: string;
+        description: string;
+        base: string;
+        branch: string;
+        issueId?: number;
+        assigneeId?: number;
+        notifiedUserId?: number[];
+        attachmentId?: number[];
+    }
+    interface PatchPullRequestParams {
+        summary?: string;
+        description?: string;
+        issueId?: number;
+        assigneeId?: number;
+        notifiedUserId?: number[];
+        comment?: string[];
+    }
+    interface GetPullRequestCommentsParams {
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+    interface PostPullRequestCommentsParams {
+        content: string;
+        notifiedUserId?: number[];
+    }
+    interface PatchPullRequestCommentsParams {
+        content: string;
+    }
+}
+export declare namespace Wiki {
+    interface GetWikiParams {
+        projectIdOrKey: string | number;
+        keyword?: string;
+    }
+    interface PostWikiParams {
+        projectId: number;
+        name: string;
+        content: string;
+        mailNotify?: boolean;
+    }
+    interface PatchWikiParams {
+        name?: string;
+        content?: string;
+        mailNotify?: boolean;
+    }
+    interface GetWikisHistoryParams {
+        minId?: number;
+        maxId?: number;
+        count?: number;
+        order?: Order;
+    }
+}
+export declare namespace OAuth2 {
+    interface Credentials {
+        clientId: string;
+        clientSecret: string;
+    }
+}

package/dist/types/request.d.ts

@@ -0,0 +1,27 @@
+export default class Request {
+    private configure;
+    constructor(configure: {
+        host: string;
+        apiKey?: string;
+        accessToken?: string;
+        timeout?: number;
+    });
+    get<T>(path: string, params?: any): Promise<T>;
+    post<T>(path: string, params?: any): Promise<T>;
+    put<T>(path: string, params: any): Promise<T>;
+    patch<T>(path: string, params: any): Promise<T>;
+    delete<T>(path: string, params?: any): Promise<T>;
+    request(options: {
+        method: string;
+        path: string;
+        params?: Params | FormData;
+    }): Promise<Response>;
+    checkStatus(response: Response): Promise<Response>;
+    parseJSON<T>(response: Response): Promise<T>;
+    private toQueryString;
+    get webAppBaseURL(): string;
+    get restBaseURL(): string;
+}
+export declare type Params = {
+    [index: string]: number | string | number[] | string[];
+};

package/package.json

@@ -1,51 +1,53 @@
 {
   "name": "backlog-js",
-  "version": "0.12.3",
+  "version": "0.12.6",
   "description": "Backlog API v2 client for browser and node",
-  "main": "dist/backlog.js",
+  "main": "dist/backlog.min.js",
+  "types": "dist/types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git://github.com/nulab/backlog-js.git"
   },
   "scripts": {
-    "test": "npx mocha --timeout 10000 --require espower-typescript/guess test/test*.ts",
-    "test-cov": "npx istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec dist/test/**/test*.js",
+    "test": "mocha --timeout 10000 --require espower-typescript/guess test/test*.ts",
+    "test-cov": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec dist/test/**/test*.js",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
-    "build": "npx npm run build-tsc && npm run build-dist && npm run build-minify",
-    "build-dist": "npx browserify --standalone Backlog dist/src/index.js -o dist/backlog.js",
-    "build-minify": "npx uglifyjs dist/backlog.js -o dist/backlog.min.js",
-    "build-tsc": "npx tsc --removeComments",
-    "build-tsd": "npx tsc -d",
+    "clean": "/bin/rm -rf dist",
+    "build": "npm run clean && npm run build-tsc && npm run copy-dts && npm run build-dist && npm run build-minify",
+    "build-dist": "browserify --standalone Backlog dist/src/index.js -o dist/backlog.js",
+    "build-minify": "uglifyjs dist/backlog.js -o dist/backlog.min.js",
+    "build-tsc": "tsc --declaration",
+    "copy-dts": "mkdir -p dist/types && cp -r dist/src/*.d.ts dist/types",
     "changelog": "ghch -w -F markdown -N ${VERSION}"
   },
   "author": "vvatanabe",
   "license": "MIT",
   "dependencies": {
-    "qs": "^6.10.1"
+    "qs": "^6.10.3"
   },
   "devDependencies": {
     "@types/dotenv": "^6.1.1",
-    "@types/empower": "^1.2.31",
-    "@types/isomorphic-fetch": "0.0.35",
-    "@types/mocha": "^8.2.2",
+    "@types/empower": "^1.2.32",
+    "@types/isomorphic-fetch": "0.0.36",
+    "@types/mocha": "^9.1.1",
     "@types/nock": "^10.0.3",
-    "@types/node": "^15.6.1",
-    "@types/power-assert": "^1.5.3",
-    "@types/power-assert-formatter": "^1.4.29",
-    "@types/qs": "^6.9.6",
+    "@types/node": "^17.0.31",
+    "@types/power-assert": "^1.5.8",
+    "@types/power-assert-formatter": "^1.4.30",
+    "@types/qs": "^6.9.7",
     "browserify": "^17.0.0",
-    "coveralls": "^3.1.0",
-    "dotenv": "^10.0.0",
+    "coveralls": "^3.1.1",
+    "dotenv": "^16.0.0",
     "es6-promise": "^4.2.8",
     "espower-typescript": "^10.0.0",
     "isomorphic-fetch": "^3.0.0",
     "isomorphic-form-data": "^2.0.0",
     "istanbul": "^0.4.5",
-    "mocha": "^8.4.0",
-    "nock": "^13.0.11",
+    "mocha": "^10.0.0",
+    "nock": "^13.2.4",
     "power-assert": "^1.6.1",
-    "typescript": "^4.3.2",
-    "uglify-js": "^3.13.8"
+    "typescript": "^4.6.4",
+    "uglify-js": "^3.15.4"
   },
   "keywords": [
     "nulab",