@fireberry/sdk 0.0.2 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireberry/sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,10 +17,6 @@
     "axios",
     "dotenv"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://powerlinksoftware.visualstudio.com/AppPlatform/_git/FireberrySDK"
-  },
   "author": "Itay Zemah @Fireberry",
   "license": "ISC",
   "devDependencies": {

package/dist/jest.config.d.ts

@@ -1,6 +0,0 @@
-declare const _default: {
-    moduleDirectories: string[];
-    preset: string;
-    modulePathIgnorePatterns: string[];
-};
-export default _default;

package/dist/jest.config.js

@@ -1,11 +0,0 @@
-"use strict";
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    moduleDirectories: ['node_modules', 'src'],
-    preset: 'ts-jest',
-    modulePathIgnorePatterns: ['<rootDir>/dist/'],
-};

package/dist/src/context/context.d.ts

@@ -1,13 +0,0 @@
-import { FireberryV2Api } from '../fireberryAPI';
-import { RecordContext } from './record';
-import { UserContext } from './user';
-export declare class Context {
-    recordId?: string;
-    recordType?: number;
-    user: UserContext;
-    record: RecordContext;
-    constructor(fireberryApi: FireberryV2Api, recordDetails?: {
-        recordId: string;
-        recordType: number;
-    });
-}

package/dist/src/context/context.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
-const utils_1 = require("../utils");
-const record_1 = require("./record");
-const user_1 = require("./user");
-class Context {
-    constructor(fireberryApi, recordDetails) {
-        const recordId = (0, utils_1.getParam)('recordId');
-        const recordTypeParam = (0, utils_1.getParam)('recordType');
-        const recordType = recordTypeParam ? parseInt(recordTypeParam) : undefined;
-        this.recordId = recordId;
-        this.recordType = recordType;
-        this.user = new user_1.UserContext(fireberryApi);
-        this.record = new record_1.RecordContext(fireberryApi, {
-            recordId: recordId || (recordDetails === null || recordDetails === void 0 ? void 0 : recordDetails.recordId),
-            recordType: recordType || (recordDetails === null || recordDetails === void 0 ? void 0 : recordDetails.recordType),
-        });
-    }
-}
-exports.Context = Context;

package/dist/src/context/context.record.test.d.ts

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

package/dist/src/context/context.record.test.js

@@ -1,36 +0,0 @@
-"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 });
-const __1 = require("..");
-describe('SDK context', () => {
-    it('throw an error when trying to reach record functions', () => __awaiter(void 0, void 0, void 0, function* () {
-        const fireberry = new __1.FireberrySDK({ tokenId: '9796da37-d499-432d-b698-e8daf41bf7ed' });
-        yield expect(fireberry.context.record.get('name')).rejects.toThrow('Record context is not set. Please set the recordId and recordType before calling this method.');
-        yield expect(fireberry.context.record.all()).rejects.toThrow('Record context is not set. Please set the recordId and recordType before calling this method.');
-    }));
-    it('retrieved a record', () => __awaiter(void 0, void 0, void 0, function* () {
-        const customFieldName = 'pcfSystemField123';
-        const extendCustomObject = { [customFieldName]: 'test' };
-        const fireberry = new __1.FireberrySDK({
-            tokenId: '9796da37-d499-432d-b698-e8daf41bf7ed',
-            currentRecordDetails: { recordId: 'test', recordType: 1 },
-        });
-        const record = Object.assign({ createdBy: 'test', createdByName: 'test', createdOn: new Date(), modifiedBy: 'test', modifiedByName: 'test', modifiedOn: new Date(), ownerId: 'test', ownerName: 'test' }, extendCustomObject);
-        const mockAddListener = jest.spyOn(fireberry.api, 'get');
-        mockAddListener.mockImplementation((_recordType, _recordId) => __awaiter(void 0, void 0, void 0, function* () {
-            return record;
-        }));
-        const specificFieldValue = yield fireberry.context.record.get(customFieldName);
-        expect(specificFieldValue).toBe(extendCustomObject[customFieldName]);
-        const recordResult = yield fireberry.context.record.all();
-        expect(recordResult).toBe(record);
-    }));
-});

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

@@ -1,5 +0,0 @@
-export * from './context';
-export type CurrentRecordDetails = Partial<{
-    recordType: number;
-    recordId: string;
-}>;

package/dist/src/context/index.js

@@ -1,17 +0,0 @@
-"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("./context"), exports);

package/dist/src/context/record.d.ts

@@ -1,9 +0,0 @@
-import { CurrentRecordDetails } from '.';
-import { BusinessObject, FireberryV2Api } from '../fireberryAPI';
-export declare class RecordContext {
-    private fireberryApi;
-    private currentRecord;
-    constructor(fireberryApi: FireberryV2Api, currentRecord: CurrentRecordDetails);
-    get(fieldName: string): Promise<any>;
-    all(): Promise<BusinessObject & any>;
-}

package/dist/src/context/record.js

@@ -1,32 +0,0 @@
-"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.RecordContext = void 0;
-class RecordContext {
-    constructor(fireberryApi, currentRecord) {
-        this.fireberryApi = fireberryApi;
-        this.currentRecord = currentRecord;
-    }
-    get(fieldName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.all())[fieldName];
-        });
-    }
-    all() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.currentRecord.recordId || !this.currentRecord.recordType) {
-                throw new Error('Record context is not set. Please set the recordId and recordType before calling this method.');
-            }
-            return yield this.fireberryApi.get(this.currentRecord.recordType, this.currentRecord.recordId);
-        });
-    }
-}
-exports.RecordContext = RecordContext;

package/dist/src/context/user.d.ts

@@ -1,8 +0,0 @@
-import { FireberryV2Api } from '../fireberryAPI';
-export declare class UserContext {
-    private fireberryApi;
-    private recordType;
-    constructor(fireberryApi: FireberryV2Api);
-    get(fieldName: string): Promise<void>;
-    all(): Promise<void>;
-}

package/dist/src/context/user.js

@@ -1,31 +0,0 @@
-"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.UserContext = void 0;
-class UserContext {
-    constructor(fireberryApi) {
-        this.fireberryApi = fireberryApi;
-        this.recordType = CRM_USER;
-    }
-    // api/v3/record/9/me/:fieldname?
-    get(fieldName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error('Not implemented');
-        });
-    }
-    all() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error('Not implemented');
-        });
-    }
-}
-exports.UserContext = UserContext;
-const CRM_USER = 9;

package/dist/src/fireberry.sdk.d.ts

@@ -1,9 +0,0 @@
-import { Config } from '.';
-import { Context } from './context';
-import { FireberryV2Api } from './fireberryAPI';
-export declare class FireberrySDK {
-    private config?;
-    context: Context;
-    api: FireberryV2Api;
-    constructor(config?: Config | undefined);
-}

package/dist/src/fireberry.sdk.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FireberrySDK = void 0;
-const context_1 = require("./context");
-const fireberryAPI_1 = require("./fireberryAPI");
-class FireberrySDK {
-    constructor(config) {
-        var _a;
-        this.config = config;
-        this.api = new fireberryAPI_1.FireberryV2Api(this.config);
-        this.context = new context_1.Context(this.api, (_a = this.config) === null || _a === void 0 ? void 0 : _a.currentRecordDetails);
-    }
-}
-exports.FireberrySDK = FireberrySDK;

package/dist/src/fireberryAPI/fireberryV2Api.d.ts

@@ -1,14 +0,0 @@
-import { Config } from '..';
-import { AxiosFireberryAPI } from '../utils';
-import { BusinessObject } from './types';
-export declare class FireberryV2Api extends AxiosFireberryAPI {
-    constructor(config?: Config);
-    /**
-     * Retrieves a record by its type and ID.
-     * @param recordType - The type of the record.
-     * @param recordId - The ID of the record.
-     * @returns A Promise that resolves to the retrieved record
-     */
-    get<T extends BusinessObject>(recordType: number, recordId: string): Promise<T>;
-    query(fields: string[], recordType: number, query: string, shouldShowRealValues?: boolean): Promise<import("axios").AxiosResponse<any, any>>;
-}

package/dist/src/fireberryAPI/fireberryV2Api.js

@@ -1,41 +0,0 @@
-"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.FireberryV2Api = void 0;
-const utils_1 = require("../utils");
-class FireberryV2Api extends utils_1.AxiosFireberryAPI {
-    constructor(config) {
-        super(config);
-    }
-    /**
-     * Retrieves a record by its type and ID.
-     * @param recordType - The type of the record.
-     * @param recordId - The ID of the record.
-     * @returns A Promise that resolves to the retrieved record
-     */
-    get(recordType, recordId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.api.get(`/api/v2/record/${recordType}/${recordId}/getrecord`)).data;
-        });
-    }
-    query(fields_1, recordType_1, query_1) {
-        return __awaiter(this, arguments, void 0, function* (fields, recordType, query, shouldShowRealValues = false) {
-            const payload = {
-                recordType: recordType,
-                fields,
-                query,
-                show_real_value: shouldShowRealValues ? 1 : 0,
-            };
-            return yield this.api.post('/api/query', payload);
-        });
-    }
-}
-exports.FireberryV2Api = FireberryV2Api;

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

@@ -1,2 +0,0 @@
-export { FireberryV2Api } from './fireberryV2Api';
-export * from './types';

package/dist/src/fireberryAPI/index.js

@@ -1,20 +0,0 @@
-"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 });
-exports.FireberryV2Api = void 0;
-var fireberryV2Api_1 = require("./fireberryV2Api");
-Object.defineProperty(exports, "FireberryV2Api", { enumerable: true, get: function () { return fireberryV2Api_1.FireberryV2Api; } });
-__exportStar(require("./types"), exports);

package/dist/src/fireberryAPI/types.d.ts

@@ -1,10 +0,0 @@
-export type BusinessObject = {
-    createdBy: string;
-    createdByName: string;
-    createdOn: Date;
-    ownerId: string;
-    ownerName: string;
-    modifiedBy: string;
-    modifiedByName: string;
-    modifiedOn: Date;
-};

package/dist/src/fireberryAPI/types.js

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

package/dist/src/index.d.ts

@@ -1,9 +0,0 @@
-export declare const IS_DEVELOPMENT: boolean;
-export { FireberrySDK } from './fireberry.sdk';
-export type Config = {
-    tokenId: string;
-    currentRecordDetails?: {
-        recordId: string;
-        recordType: number;
-    };
-};

package/dist/src/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FireberrySDK = exports.IS_DEVELOPMENT = void 0;
-exports.IS_DEVELOPMENT = ['development', 'test'].includes(process.env.NODE_ENV);
-var fireberry_sdk_1 = require("./fireberry.sdk");
-Object.defineProperty(exports, "FireberrySDK", { enumerable: true, get: function () { return fireberry_sdk_1.FireberrySDK; } });

package/dist/src/utils/axios.util.d.ts

@@ -1,6 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { Config } from '..';
-export declare abstract class AxiosFireberryAPI {
-    protected api: AxiosInstance;
-    constructor(config?: Config);
-}

package/dist/src/utils/axios.util.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AxiosFireberryAPI = void 0;
-const axios_1 = __importDefault(require("axios"));
-const __1 = require("..");
-class AxiosFireberryAPI {
-    constructor(config) {
-        const baseURL = 'http://win-local';
-        console.log('🚀 ~ AxiosFireberryAPI ~ constructor ~ baseURL:', baseURL);
-        const tokenid = __1.IS_DEVELOPMENT ? config === null || config === void 0 ? void 0 : config.tokenId : undefined;
-        this.api = axios_1.default.create({
-            baseURL,
-            headers: {
-                'Content-Type': 'application/json',
-                tokenid,
-            },
-            withCredentials: true,
-        });
-    }
-}
-exports.AxiosFireberryAPI = AxiosFireberryAPI;

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

@@ -1,2 +0,0 @@
-export * from './axios.util';
-export * from './queryParam.util';

package/dist/src/utils/index.js

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

package/dist/src/utils/queryParam.util.d.ts

@@ -1 +0,0 @@
-export declare function getParam(param: string): string | undefined;

package/dist/src/utils/queryParam.util.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParam = void 0;
-function getParam(param) {
-    if (typeof window !== 'undefined') {
-        const searchParams = new URLSearchParams(window.location.search);
-        return searchParams.get(param) || undefined;
-    }
-}
-exports.getParam = getParam;