atlas-crm-api-client 0.0.0-development

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ryan Sonshine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# atlas-crm-api-client
+
+[![npm package][npm-img]][npm-url] [![Build Status][build-img]][build-url]
+[![Downloads][downloads-img]][downloads-url] [![Issues][issues-img]][issues-url]
+[![Code Coverage][codecov-img]][codecov-url]
+[![Commitizen Friendly][commitizen-img]][commitizen-url]
+[![Semantic Release][semantic-release-img]][semantic-release-url]
+
+> AtlasCRM API Client
+
+## Install
+
+```bash
+npm install atlas-crm-api-client
+```
+
+## Usage
+
+```ts
+import { AtlasCrmClient } from "atlas-crm-api-client";
+
+const client = new AtlasCrmClient({
+  clientId: "YOUR_CLIENT_ID",
+  clientSecret: "YOUR_CLIENT_SECRET",
+  workspace: "CRM", // Defaults to CRM
+});
+
+// Grouped by entity type as per Swagger
+const companies = await client.companies.list({ size: 50 });
+const contact = await client.contacts.get("uuid");
+
+// Easy creation with typed fields
+const newCompany = await client.companies.create({
+  "company-name": "Acme Corp",
+  "company-website": "https://acme.com",
+});
+
+// Link Jira issues
+await client.issues.link(newCompany.id, ["PROJ-1", "PROJ-2"]);
+```
+
+## API
+
+### myPackage(input, options?)
+
+#### input
+
+Type: `string`
+
+Lorem ipsum.
+
+#### options
+
+Type: `object`
+
+##### postfix
+
+Type: `string` Default: `rainbows`
+
+Lorem ipsum.
+
+[build-img]: https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml/badge.svg
+[build-url]: https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml
+[downloads-img]: https://img.shields.io/npm/dt/typescript-npm-package-template
+[downloads-url]: https://www.npmtrends.com/typescript-npm-package-template
+[npm-img]: https://img.shields.io/npm/v/typescript-npm-package-template
+[npm-url]: https://www.npmjs.com/package/typescript-npm-package-template
+[issues-img]: https://img.shields.io/github/issues/ryansonshine/typescript-npm-package-template
+[issues-url]: https://github.com/ryansonshine/typescript-npm-package-template/issues
+[codecov-img]: https://codecov.io/gh/ryansonshine/typescript-npm-package-template/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/ryansonshine/typescript-npm-package-template
+[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-url]: https://github.com/semantic-release/semantic-release
+[commitizen-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+[commitizen-url]: http://commitizen.github.io/cz-cli/
+
+---
+
+## Features
+
+- [Semantic Release](https://github.com/semantic-release/semantic-release)
+- [Issue Templates](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/ISSUE_TEMPLATE)
+- [GitHub Actions](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/workflows)
+- [Codecov](https://about.codecov.io/)
+- [VSCode Launch Configurations](https://github.com/ryansonshine/typescript-npm-package-template/blob/main/.vscode/launch.json)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Husky](https://github.com/typicode/husky)
+- [Lint Staged](https://github.com/okonet/lint-staged)
+- [Commitizen](https://github.com/search?q=commitizen)
+- [Jest](https://jestjs.io/)
+- [ESLint](https://eslint.org/)
+- [Prettier](https://prettier.io/)

package/lib/client.d.ts

@@ -0,0 +1,67 @@
+import type { Entity, PaginatedResponse, AtlasCrmConfig, QueryParams, TemplateResponse, LinkResponse, CommentResponse } from './types';
+export declare class AtlasCrmError extends Error {
+    message: string;
+    status?: number | undefined;
+    data?: any;
+    constructor(message: string, status?: number | undefined, data?: any);
+}
+/**
+ * Robust Atlas CRM API Client
+ * Strictly follows Swagger: https://atlascrm.avisi-apps.com/api/1.0/swagger.json
+ */
+export declare class AtlasCrmClient {
+    private baseUrl;
+    private clientId;
+    private clientSecret;
+    private workspace;
+    private accessToken;
+    private tokenExpiry;
+    constructor(config: AtlasCrmConfig);
+    /**
+     * Internal Request Handler
+     */
+    private request;
+    /**
+     * OAuth2 Client Credentials Handshake
+     */
+    authenticate(): Promise<string>;
+    private getValidToken;
+    /**
+     * Generic Entity Operations Factory
+     */
+    private createEntityNamespace;
+    readonly companies: {
+        list: (params?: QueryParams) => Promise<PaginatedResponse<Entity>>;
+        get: (id: string) => Promise<Entity>;
+        create: (fields: Record<string, any>) => Promise<Entity>;
+        update: (id: string, fields: Record<string, any>) => Promise<Entity>;
+        delete: (id: string) => Promise<Entity>;
+        getTemplate: () => Promise<TemplateResponse>;
+    };
+    readonly contacts: {
+        list: (params?: QueryParams) => Promise<PaginatedResponse<Entity>>;
+        get: (id: string) => Promise<Entity>;
+        create: (fields: Record<string, any>) => Promise<Entity>;
+        update: (id: string, fields: Record<string, any>) => Promise<Entity>;
+        delete: (id: string) => Promise<Entity>;
+        getTemplate: () => Promise<TemplateResponse>;
+    };
+    readonly sales: {
+        list: (params?: QueryParams) => Promise<PaginatedResponse<Entity>>;
+        get: (id: string) => Promise<Entity>;
+        create: (fields: Record<string, any>) => Promise<Entity>;
+        update: (id: string, fields: Record<string, any>) => Promise<Entity>;
+        delete: (id: string) => Promise<Entity>;
+        getTemplate: () => Promise<TemplateResponse>;
+    };
+    /**
+     * Advanced endpoints (Issue links, Comments)
+     */
+    readonly issues: {
+        link: (entityId: string, issueIds: string[]) => Promise<LinkResponse>;
+        unlink: (entityId: string, issueIds: string[]) => Promise<LinkResponse>;
+    };
+    readonly comments: {
+        create: (entityId: string, comment: string, accountId: string) => Promise<CommentResponse>;
+    };
+}

package/lib/client.js

@@ -0,0 +1,153 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AtlasCrmClient = exports.AtlasCrmError = void 0;
+class AtlasCrmError extends Error {
+    constructor(message, status, 
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    data) {
+        super(message);
+        this.message = message;
+        this.status = status;
+        this.data = data;
+        this.name = 'AtlasCrmError';
+    }
+}
+exports.AtlasCrmError = AtlasCrmError;
+/**
+ * Robust Atlas CRM API Client
+ * Strictly follows Swagger: https://atlascrm.avisi-apps.com/api/1.0/swagger.json
+ */
+class AtlasCrmClient {
+    constructor(config) {
+        this.accessToken = null;
+        this.tokenExpiry = null;
+        this.companies = this.createEntityNamespace('entity.type/company');
+        this.contacts = this.createEntityNamespace('entity.type/contact');
+        this.sales = this.createEntityNamespace('entity.type/sale');
+        /**
+         * Advanced endpoints (Issue links, Comments)
+         */
+        this.issues = {
+            link: (entityId, issueIds) => this.request('POST', `/api/1.0/workspace/${this.workspace}/entities/${entityId}/issues`, {
+                body: { 'issue-ids': issueIds },
+            }),
+            unlink: (entityId, issueIds) => this.request('DELETE', `/api/1.0/workspace/${this.workspace}/entities/${entityId}/issues`, {
+                body: { 'issue-ids': issueIds },
+            }),
+        };
+        this.comments = {
+            create: (entityId, comment, accountId) => this.request('POST', `/api/1.0/workspace/${this.workspace}/entities/${entityId}/comments`, {
+                body: {
+                    format: 'plain-text',
+                    comment,
+                    'account-id': accountId,
+                },
+            }),
+        };
+        this.baseUrl = (config.baseUrl || 'https://atlascrm.avisi-apps.com').replace(/\/$/, '');
+        this.clientId = config.clientId;
+        this.clientSecret = config.clientSecret;
+        this.workspace = config.workspace || 'CRM';
+    }
+    /**
+     * Internal Request Handler
+     */
+    request(method, path, options = {}, retryCount = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const token = yield this.getValidToken();
+            let url = `${this.baseUrl}${path}`;
+            if (options.params) {
+                const search = new URLSearchParams();
+                Object.entries(options.params).forEach(([k, v]) => {
+                    if (v !== undefined)
+                        search.append(k, String(v));
+                });
+                url += (url.includes('?') ? '&' : '?') + search.toString();
+            }
+            const response = yield fetch(url, {
+                method,
+                headers: {
+                    Authorization: `Bearer ${token}`,
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json',
+                },
+                body: options.body ? JSON.stringify(options.body) : undefined,
+            });
+            // Handle token expiration
+            if (response.status === 401 && retryCount < 1) {
+                this.accessToken = null;
+                return this.request(method, path, options, retryCount + 1);
+            }
+            if (!response.ok) {
+                const errorData = yield response
+                    .json()
+                    .catch(() => ({}));
+                throw new AtlasCrmError(errorData.message || `Request failed with status ${response.status}`, response.status, errorData);
+            }
+            return response.json();
+        });
+    }
+    /**
+     * OAuth2 Client Credentials Handshake
+     */
+    authenticate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const credentials = btoa(`${this.clientId}:${this.clientSecret}`);
+            const response = yield fetch(`${this.baseUrl}/api/1.0/oauth/token`, {
+                method: 'POST',
+                headers: {
+                    Authorization: `Basic ${credentials}`,
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                },
+                body: new URLSearchParams({
+                    grant_type: 'client_credentials',
+                }).toString(),
+            });
+            if (!response.ok) {
+                throw new AtlasCrmError('Authentication failed', response.status);
+            }
+            const data = yield response.json();
+            this.accessToken = data.access_token;
+            this.tokenExpiry = Date.now() + data.expires_in * 1000 - 30000;
+            return data.access_token;
+        });
+    }
+    getValidToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.accessToken && this.tokenExpiry && Date.now() < this.tokenExpiry) {
+                return this.accessToken;
+            }
+            return this.authenticate();
+        });
+    }
+    /**
+     * Generic Entity Operations Factory
+     */
+    createEntityNamespace(type) {
+        const basePath = `/api/1.0/workspace/${this.workspace}/entities`;
+        return {
+            list: (params = {}) => this.request('GET', basePath, {
+                params: Object.assign(Object.assign({}, params), { type }),
+            }),
+            get: (id) => this.request('GET', `${basePath}/${id}`),
+            create: (fields) => this.request('POST', basePath, {
+                body: { type, fields },
+            }),
+            update: (id, fields) => this.request('PUT', `${basePath}/${id}`, {
+                body: { fields },
+            }),
+            delete: (id) => this.request('DELETE', `${basePath}/${id}`),
+            getTemplate: () => this.request('GET', `/api/1.0/workspace/${this.workspace}/template/${type}`),
+        };
+    }
+}
+exports.AtlasCrmClient = AtlasCrmClient;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './client';

package/lib/index.js

@@ -0,0 +1,18 @@
+"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("./types"), exports);
+__exportStar(require("./client"), exports);

package/lib/types.d.ts

@@ -0,0 +1,75 @@
+export declare type EntityType = 'entity.type/company' | 'entity.type/contact' | 'entity.type/sale';
+export interface EntityLinks {
+    self: {
+        href: string;
+    };
+    next?: {
+        href: string;
+    };
+    app?: {
+        href: string;
+    };
+}
+export interface Entity {
+    id: string;
+    type: EntityType;
+    fields: Record<string, any>;
+    _links: EntityLinks;
+}
+export interface Company {
+    name: string;
+    industry?: string;
+    description?: string;
+}
+export interface Contact {
+    firstName: string;
+    lastName: string;
+    position?: string;
+}
+export interface PaginatedResponse<T> {
+    items: T[];
+    total: number;
+    _links: EntityLinks;
+}
+export interface AtlasCrmConfig {
+    baseUrl?: string;
+    clientId: string;
+    clientSecret: string;
+    workspace?: string;
+}
+export interface QueryParams {
+    size?: number;
+    'sort-type'?: 'asc' | 'desc';
+    'sort-by'?: string;
+    cursor?: string;
+    [key: string]: any;
+}
+export interface TemplateField {
+    id: string;
+    label: string;
+    type: string;
+    required: boolean;
+    'default-value'?: string;
+    'allowed-values'?: Record<string, any>;
+    config?: {
+        currency?: string;
+        max?: number;
+        min?: number;
+    };
+}
+export interface TemplateSection {
+    name: string;
+    fields: TemplateField[];
+}
+export interface TemplateResponse {
+    sections: TemplateSection[];
+}
+export declare type LinkResponse = {
+    issue_ids: string[];
+} | {
+    message: string;
+    'invalid-issue-ids': string[];
+} | {
+    message: string;
+};
+export declare type CommentResponse = Record<'id' | 'comment' | 'account-id', string> | Record<string, never>;

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,115 @@
+{
+  "name": "atlas-crm-api-client",
+  "version": "0.0.0-development",
+  "description": "A template for creating npm packages using TypeScript and VSCode",
+  "main": "./lib/index.js",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "clean": "rm -rf ./lib/",
+    "cm": "cz",
+    "lint": "eslint ./src/ --fix",
+    "prepare": "husky install",
+    "semantic-release": "semantic-release",
+    "test:watch": "jest --watch",
+    "test": "jest --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oskarherz/atlas-crm-api-client.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Oskar Herz",
+    "email": "oskarherz@users.noreply.github.com",
+    "url": "https://github.com/oskarherz"
+  },
+  "engines": {
+    "node": ">=12.0"
+  },
+  "keywords": [
+    "typescript",
+    "vscode",
+    "jest",
+    "husky",
+    "commitizen",
+    "semantic-release"
+  ],
+  "devDependencies": {
+    "@ryansonshine/commitizen": "^4.2.8",
+    "@ryansonshine/cz-conventional-changelog": "^3.3.4",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^12.20.11",
+    "@typescript-eslint/eslint-plugin": "^4.22.0",
+    "@typescript-eslint/parser": "^4.22.0",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "husky": "^6.0.0",
+    "jest": "^27.2.0",
+    "lint-staged": "^13.2.1",
+    "prettier": "^2.2.1",
+    "semantic-release": "^21.0.1",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.2.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/@ryansonshine/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "type": "build",
+              "scope": "deps",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "build",
+                "section": "Dependencies and Other Build Updates",
+                "hidden": false
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  }
+}