@abyss-project/tools 1.0.0

package/dist/constants/index.d.ts

@@ -0,0 +1,5 @@
+export * from './memo.constants';
+export * from './atlas.constants';
+export * from './board.constants';
+export * from './short-link.constants';
+export * from './user-tag.constants';

package/dist/constants/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./memo.constants"), exports);
+__exportStar(require("./atlas.constants"), exports);
+__exportStar(require("./board.constants"), exports);
+__exportStar(require("./short-link.constants"), exports);
+__exportStar(require("./user-tag.constants"), exports);

package/dist/constants/memo.constants.d.ts

@@ -0,0 +1,3 @@
+export declare const MIN_MEMO_TITLE_LENGTH = 3;
+export declare const MAX_MEMO_TITLE_LENGTH = 100;
+export declare const MAX_MEMO_CONTENT_LENGTH = 10000;

package/dist/constants/memo.constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_MEMO_CONTENT_LENGTH = exports.MAX_MEMO_TITLE_LENGTH = exports.MIN_MEMO_TITLE_LENGTH = void 0;
+exports.MIN_MEMO_TITLE_LENGTH = 3;
+exports.MAX_MEMO_TITLE_LENGTH = 100;
+exports.MAX_MEMO_CONTENT_LENGTH = 10000;

package/dist/constants/short-link.constants.d.ts

@@ -0,0 +1,8 @@
+export declare const MIN_SHORT_LINK_PAGE = 1;
+export declare const MIN_SHORT_LINK_LIMIT = 1;
+export declare const MAX_SHORT_LINK_LIMIT = 500;
+export declare const MAX_SHORT_LINK_TITLE_LENGTH = 255;
+export declare const MAX_SHORT_LINK_DESCRIPTION_LENGTH = 1000;
+export declare const MIN_SHORT_LINK_MAX_CLICKS = 1;
+export declare const MIN_SHORT_LINK_SLUG_LENGTH = 3;
+export declare const MAX_SHORT_LINK_SLUG_LENGTH = 50;

package/dist/constants/short-link.constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_SHORT_LINK_SLUG_LENGTH = exports.MIN_SHORT_LINK_SLUG_LENGTH = exports.MIN_SHORT_LINK_MAX_CLICKS = exports.MAX_SHORT_LINK_DESCRIPTION_LENGTH = exports.MAX_SHORT_LINK_TITLE_LENGTH = exports.MAX_SHORT_LINK_LIMIT = exports.MIN_SHORT_LINK_LIMIT = exports.MIN_SHORT_LINK_PAGE = void 0;
+exports.MIN_SHORT_LINK_PAGE = 1;
+exports.MIN_SHORT_LINK_LIMIT = 1;
+exports.MAX_SHORT_LINK_LIMIT = 500;
+exports.MAX_SHORT_LINK_TITLE_LENGTH = 255;
+exports.MAX_SHORT_LINK_DESCRIPTION_LENGTH = 1000;
+exports.MIN_SHORT_LINK_MAX_CLICKS = 1;
+exports.MIN_SHORT_LINK_SLUG_LENGTH = 3;
+exports.MAX_SHORT_LINK_SLUG_LENGTH = 50;

package/dist/constants/user-tag.constants.d.ts

@@ -0,0 +1,3 @@
+export declare const MIN_USER_TAG_NAME_LENGTH = 1;
+export declare const MAX_USER_TAG_NAME_LENGTH = 50;
+export declare const MAX_USER_TAG_COLOR_LENGTH = 7;

package/dist/constants/user-tag.constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_USER_TAG_COLOR_LENGTH = exports.MAX_USER_TAG_NAME_LENGTH = exports.MIN_USER_TAG_NAME_LENGTH = void 0;
+exports.MIN_USER_TAG_NAME_LENGTH = 1;
+exports.MAX_USER_TAG_NAME_LENGTH = 50;
+exports.MAX_USER_TAG_COLOR_LENGTH = 7;

package/dist/index.d.ts

@@ -0,0 +1,262 @@
+import { IAxiosRetryConfig } from 'axios-retry';
+import * as abyssAdminApi from './api/abyss.admin.api';
+import * as boardApi from './api/board.api';
+import * as boardColumnApi from './api/board-column.api';
+import * as boardCardApi from './api/board-card.api';
+import * as boardLabelApi from './api/board-label.api';
+import * as boardCardCommentApi from './api/board-card-comment.api';
+import * as boardCardChecklistApi from './api/board-card-checklist.api';
+import * as boardCardDocumentApi from './api/board-card-document.api';
+import * as drawApi from './api/draw.api';
+import * as drawPublicApi from './api/draw.public.api';
+import * as retrospectiveApi from './api/retrospective.api';
+import * as retrospectiveCardApi from './api/retrospective-card.api';
+import * as retrospectiveMemberApi from './api/retrospective-member.api';
+import * as retrospectiveSectionApi from './api/retrospective-section.api';
+import * as retrospectivePublicApi from './api/retrospective.public.api';
+import * as atlasApi from './api/atlas.api';
+import * as atlasGroupApi from './api/atlas-group.api';
+import * as atlasPageApi from './api/atlas-page.api';
+import * as atlasDocumentApi from './api/atlas-document.api';
+import * as atlasPublicApi from './api/atlas.public.api';
+import * as memoApi from './api/memo.api';
+import * as shortLinkApiModule from './api/short-link.api';
+import * as shortLinkAdminApiModule from './api/short-link.admin.api';
+import * as shortLinkPublicApiModule from './api/short-link.public.api';
+import * as metricsApi from './api/metrics.api';
+import * as userTagApi from './api/user-tag.api';
+export * from './api';
+export * from './types';
+export * from './utils';
+export * from './constants';
+export * from './server-sent-events';
+export declare const API_KEY_HEADER = "abyss-tools-api-key";
+export declare const ADMIN_TOKEN_HEADER = "abyss-admin-token";
+type CoreConfig = {
+    token?: string;
+    apiKey?: string;
+    adminToken?: string;
+    baseURL?: string;
+};
+type AbyssToolsCoreSDK = {
+    abyss: {
+        admin: {
+            activateUserService: typeof abyssAdminApi.activateUserServiceAbyssAdmin;
+            deleteUser: typeof abyssAdminApi.deleteUserAbyssAdmin;
+            syncOrganization: typeof abyssAdminApi.syncOrganizationAbyssAdmin;
+            deleteOrganization: typeof abyssAdminApi.deleteOrganizationAbyssAdmin;
+            syncProject: typeof abyssAdminApi.syncProjectAbyssAdmin;
+            deleteProject: typeof abyssAdminApi.deleteProjectAbyssAdmin;
+        };
+    };
+    board: {
+        getBoard: typeof boardApi.getBoard;
+        getBySlugBoard: typeof boardApi.getBySlugBoard;
+        listBoard: typeof boardApi.listBoard;
+        listBoardProject: typeof boardApi.listBoardProject;
+        deleteBoard: typeof boardApi.deleteBoard;
+        updateBoard: typeof boardApi.updateBoard;
+        createBoard: typeof boardApi.createBoard;
+        createForProjectBoard: typeof boardApi.createForProjectBoard;
+        getNextCardPreviewBoard: typeof boardApi.getNextCardPreviewBoard;
+    };
+    boardColumn: {
+        getBoardColumn: typeof boardColumnApi.getBoardColumn;
+        deleteBoardColumn: typeof boardColumnApi.deleteBoardColumn;
+        updateBoardColumn: typeof boardColumnApi.updateBoardColumn;
+        createBoardColumn: typeof boardColumnApi.createBoardColumn;
+    };
+    boardCard: {
+        getBoardCard: typeof boardCardApi.getBoardCard;
+        getAllBoardCard: typeof boardCardApi.getAllBoardCard;
+        deleteBoardCard: typeof boardCardApi.deleteBoardCard;
+        updateBoardCard: typeof boardCardApi.updateBoardCard;
+        restoreBoardCard: typeof boardCardApi.restoreBoardCard;
+        createBoardCard: typeof boardCardApi.createBoardCard;
+        addMemberBoardCard: typeof boardCardApi.addMemberBoardCard;
+        removeMemberBoardCard: typeof boardCardApi.removeMemberBoardCard;
+        moveToBoardBoardCard: typeof boardCardApi.moveToBoardBoardCard;
+        searchBoardCard: typeof boardCardApi.searchBoardCard;
+    };
+    boardLabel: {
+        getBoardLabel: typeof boardLabelApi.getBoardLabel;
+        deleteBoardLabel: typeof boardLabelApi.deleteBoardLabel;
+        updateBoardLabel: typeof boardLabelApi.updateBoardLabel;
+        createBoardLabel: typeof boardLabelApi.createBoardLabel;
+        addBoardLabel: typeof boardLabelApi.addBoardLabel;
+        removeBoardLabel: typeof boardLabelApi.removeBoardLabel;
+        listBoardLabels: typeof boardLabelApi.listBoardLabels;
+    };
+    boardCardComment: {
+        getBoardCardComment: typeof boardCardCommentApi.getBoardCardComment;
+        deleteBoardCardComment: typeof boardCardCommentApi.deleteBoardCardComment;
+        updateBoardCardComment: typeof boardCardCommentApi.updateBoardCardComment;
+        createBoardCardComment: typeof boardCardCommentApi.createBoardCardComment;
+    };
+    boardCardChecklist: {
+        getBoardCardChecklist: typeof boardCardChecklistApi.getBoardCardChecklist;
+        deleteBoardCardChecklist: typeof boardCardChecklistApi.deleteBoardCardChecklist;
+        updateBoardCardChecklist: typeof boardCardChecklistApi.updateBoardCardChecklist;
+        createBoardCardChecklist: typeof boardCardChecklistApi.createBoardCardChecklist;
+        addRowBoardCardChecklist: typeof boardCardChecklistApi.addRowBoardCardChecklist;
+        removeRowBoardCardChecklist: typeof boardCardChecklistApi.removeRowBoardCardChecklist;
+        updateRowBoardCardChecklist: typeof boardCardChecklistApi.updateRowBoardCardChecklist;
+    };
+    boardCardDocument: {
+        getBoardCardDocument: typeof boardCardDocumentApi.getBoardCardDocument;
+        deleteBoardCardDocument: typeof boardCardDocumentApi.deleteBoardCardDocument;
+        getUploadPreSignedUrlBoardCardDocument: typeof boardCardDocumentApi.getUploadPreSignedUrlBoardCardDocument;
+        cloudImportBoardCardDocument: typeof boardCardDocumentApi.cloudImportBoardCardDocument;
+    };
+    draw: {
+        paginateDraw: typeof drawApi.paginateDraw;
+        paginateProjectDraw: typeof drawApi.paginateProjectDraw;
+        getDraw: typeof drawApi.getDraw;
+        deleteDraw: typeof drawApi.deleteDraw;
+        updateDraw: typeof drawApi.updateDraw;
+        createDraw: typeof drawApi.createDraw;
+        createForProjectDraw: typeof drawApi.createForProjectDraw;
+        public: {
+            getDrawPublic: typeof drawPublicApi.getDrawPublic;
+            deleteDrawPublic: typeof drawPublicApi.deleteDrawPublic;
+            updateDrawPublic: typeof drawPublicApi.updateDrawPublic;
+            createDrawPublic: typeof drawPublicApi.createDrawPublic;
+        };
+    };
+    retrospective: {
+        getRetrospective: typeof retrospectiveApi.getRetrospective;
+        paginateProjectRetrospective: typeof retrospectiveApi.paginateProjectRetrospective;
+        paginateRetrospective: typeof retrospectiveApi.paginateRetrospective;
+        createForProjectRetrospective: typeof retrospectiveApi.createForProjectRetrospective;
+        createRetrospective: typeof retrospectiveApi.createRetrospective;
+        updateRetrospective: typeof retrospectiveApi.updateRetrospective;
+        deleteRetrospective: typeof retrospectiveApi.deleteRetrospective;
+        public: {
+            getRetrospectivePublic: typeof retrospectivePublicApi.getRetrospectivePublic;
+            updateRetrospectivePublic: typeof retrospectivePublicApi.updateRetrospectivePublic;
+            createSectionRetrospectivePublic: typeof retrospectivePublicApi.createSectionRetrospectivePublic;
+            updateSectionRetrospectivePublic: typeof retrospectivePublicApi.updateSectionRetrospectivePublic;
+            deleteSectionRetrospectivePublic: typeof retrospectivePublicApi.deleteSectionRetrospectivePublic;
+            joinMemberRetrospectivePublic: typeof retrospectivePublicApi.joinMemberRetrospectivePublic;
+            updateMemberRetrospectivePublic: typeof retrospectivePublicApi.updateMemberRetrospectivePublic;
+            createCardRetrospectivePublic: typeof retrospectivePublicApi.createCardRetrospectivePublic;
+            updateCardRetrospectivePublic: typeof retrospectivePublicApi.updateCardRetrospectivePublic;
+            deleteCardRetrospectivePublic: typeof retrospectivePublicApi.deleteCardRetrospectivePublic;
+        };
+    };
+    retrospectiveCard: {
+        getRetrospectiveCard: typeof retrospectiveCardApi.getRetrospectiveCard;
+        paginateRetrospectiveCard: typeof retrospectiveCardApi.paginateRetrospectiveCard;
+        createRetrospectiveCard: typeof retrospectiveCardApi.createRetrospectiveCard;
+        updateRetrospectiveCard: typeof retrospectiveCardApi.updateRetrospectiveCard;
+        deleteRetrospectiveCard: typeof retrospectiveCardApi.deleteRetrospectiveCard;
+    };
+    retrospectiveMember: {
+        getRetrospectiveMember: typeof retrospectiveMemberApi.getRetrospectiveMember;
+        listRetrospectiveMember: typeof retrospectiveMemberApi.listRetrospectiveMember;
+        joinRetrospectiveMember: typeof retrospectiveMemberApi.joinRetrospectiveMember;
+        updateRetrospectiveMember: typeof retrospectiveMemberApi.updateRetrospectiveMember;
+    };
+    retrospectiveSection: {
+        getRetrospectiveSection: typeof retrospectiveSectionApi.getRetrospectiveSection;
+        paginateRetrospectiveSection: typeof retrospectiveSectionApi.paginateRetrospectiveSection;
+        createRetrospectiveSection: typeof retrospectiveSectionApi.createRetrospectiveSection;
+        updateRetrospectiveSection: typeof retrospectiveSectionApi.updateRetrospectiveSection;
+        deleteRetrospectiveSection: typeof retrospectiveSectionApi.deleteRetrospectiveSection;
+    };
+    atlas: {
+        paginateAtlas: typeof atlasApi.paginateAtlas;
+        paginateProjectAtlas: typeof atlasApi.paginateProjectAtlas;
+        getAtlas: typeof atlasApi.getAtlas;
+        deleteAtlas: typeof atlasApi.deleteAtlas;
+        updateAtlas: typeof atlasApi.updateAtlas;
+        createAtlas: typeof atlasApi.createAtlas;
+        createForProjectAtlas: typeof atlasApi.createForProjectAtlas;
+        public: {
+            getAtlasPublic: typeof atlasPublicApi.getAtlasPublic;
+            getPageAtlasPublic: typeof atlasPublicApi.getPageAtlasPublic;
+            searchContentAtlasPublic: typeof atlasPublicApi.searchContentAtlasPublic;
+        };
+    };
+    atlasGroup: {
+        paginateAtlasGroup: typeof atlasGroupApi.paginateAtlasGroup;
+        getAtlasGroup: typeof atlasGroupApi.getAtlasGroup;
+        deleteAtlasGroup: typeof atlasGroupApi.deleteAtlasGroup;
+        updateAtlasGroup: typeof atlasGroupApi.updateAtlasGroup;
+        createAtlasGroup: typeof atlasGroupApi.createAtlasGroup;
+    };
+    atlasPage: {
+        paginateAtlasPage: typeof atlasPageApi.paginateAtlasPage;
+        getAtlasPage: typeof atlasPageApi.getAtlasPage;
+        deleteAtlasPage: typeof atlasPageApi.deleteAtlasPage;
+        updateAtlasPage: typeof atlasPageApi.updateAtlasPage;
+        createAtlasPage: typeof atlasPageApi.createAtlasPage;
+        updateAtlasPageContent: typeof atlasPageApi.updateAtlasPageContent;
+        searchAtlasContent: typeof atlasPageApi.searchAtlasContent;
+        getAtlasPageContentHistory: typeof atlasPageApi.getAtlasPageContentHistory;
+        restoreAtlasPageContent: typeof atlasPageApi.restoreAtlasPageContent;
+    };
+    atlasDocument: {
+        getAtlasDocument: typeof atlasDocumentApi.getAtlasDocument;
+        deleteAtlasDocument: typeof atlasDocumentApi.deleteAtlasDocument;
+        getUploadPreSignedUrlAtlasDocument: typeof atlasDocumentApi.getUploadPreSignedUrlAtlasDocument;
+        paginateAtlasDocument: typeof atlasDocumentApi.paginateAtlasDocument;
+        listAtlasDocument: typeof atlasDocumentApi.listAtlasDocument;
+    };
+    memo: {
+        paginateMemo: typeof memoApi.paginateMemo;
+        paginateProjectMemo: typeof memoApi.paginateProjectMemo;
+        getMemo: typeof memoApi.getMemo;
+        deleteMemo: typeof memoApi.deleteMemo;
+        updateMemo: typeof memoApi.updateMemo;
+        createMemo: typeof memoApi.createMemo;
+        createForProjectMemo: typeof memoApi.createForProjectMemo;
+    };
+    shortLink: {
+        get: typeof shortLinkApiModule.shortLinkApi.get;
+        paginate: typeof shortLinkApiModule.shortLinkApi.paginate;
+        paginateProject: typeof shortLinkApiModule.shortLinkApi.paginateProject;
+        create: typeof shortLinkApiModule.shortLinkApi.create;
+        createForProject: typeof shortLinkApiModule.shortLinkApi.createForProject;
+        update: typeof shortLinkApiModule.shortLinkApi.update;
+        delete: typeof shortLinkApiModule.shortLinkApi.delete;
+        getStats: typeof shortLinkApiModule.shortLinkApi.getStats;
+        getClicks: typeof shortLinkApiModule.shortLinkApi.getClicks;
+        admin: {
+            paginate: typeof shortLinkAdminApiModule.shortLinkAdminApi.paginate;
+            get: typeof shortLinkAdminApiModule.shortLinkAdminApi.get;
+            update: typeof shortLinkAdminApiModule.shortLinkAdminApi.update;
+            delete: typeof shortLinkAdminApiModule.shortLinkAdminApi.delete;
+        };
+        public: {
+            createAnonymous: typeof shortLinkPublicApiModule.shortLinkPublicApi.createAnonymous;
+            redirect: typeof shortLinkPublicApiModule.shortLinkPublicApi.redirect;
+            getStats: typeof shortLinkPublicApiModule.shortLinkPublicApi.getStats;
+            getClicks: typeof shortLinkPublicApiModule.shortLinkPublicApi.getClicks;
+            renew: typeof shortLinkPublicApiModule.shortLinkPublicApi.renew;
+        };
+    };
+    metrics: {
+        getOrganizationToolsMetrics: typeof metricsApi.getOrganizationToolsMetrics;
+    };
+    userTag: {
+        listUserTag: typeof userTagApi.listUserTag;
+        createUserTag: typeof userTagApi.createUserTag;
+        updateUserTag: typeof userTagApi.updateUserTag;
+        deleteUserTag: typeof userTagApi.deleteUserTag;
+        assignTag: typeof userTagApi.assignTag;
+        unassignTag: typeof userTagApi.unassignTag;
+        getUserTagStats: typeof userTagApi.getUserTagStats;
+        getEntityTags: typeof userTagApi.getEntityTags;
+    };
+};
+export declare class AbyssToolsCore {
+    private static config;
+    static axios: import("axios").AxiosInstance;
+    private static _sdk;
+    static get sdk(): AbyssToolsCoreSDK;
+    private static buildSDK;
+    static enableAxiosRetry(axiosRetryConfig?: IAxiosRetryConfig): void;
+    static setConfig(config: CoreConfig): void;
+    static getConfig(): CoreConfig;
+}