@undp/carbon-library 1.0.0 → 1.0.2

package/dist/esm/types/Definitions/Enums/company.role.enum.d.ts

@@ -0,0 +1,17 @@
+export declare enum CompanyRole {
+    ACADEMICS = "Academics",
+    SERVICE_PROVIDER = "ServiceProvider",
+    MITIGATION_ACTIVITY_PARTNER = "MitigationActivityParticipant",
+    CARBON_CREDIT_BROKER = "CarbonCreditBroker",
+    VALIDATION_VERIFICATION_ENTITY = "ValidationVerificationEntities",
+    COMMERCIAL_BANKS = "CommercialBanks",
+    INVESTORS = "InvestorsFinanciers",
+    GOV_REGULATOR = "GovernmentRegulators",
+    OBSERVERS = "Observers",
+    CIVIL_SOCIETY_ORG = "CivilSocietyOrganization",
+    CERTIFIER = "Certifier",
+    INTERNAL_ORGANIZATION = "InternationalOrganization",
+    PROGRAMME_DEVELOPER = "ProgrammeDeveloper",
+    MRV = "MRV",
+    GOVERNMENT = "Government"
+}

package/dist/esm/types/Definitions/Enums/company.state.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum CompanyState {
+    SUSPENDED = 0,
+    ACTIVE = 1
+}

package/dist/esm/types/Definitions/Enums/programme.management.columns.enum.d.ts

@@ -0,0 +1,11 @@
+export declare enum ProgrammeManagementColumns {
+    title = 0,
+    company = 1,
+    sector = 2,
+    currentStage = 3,
+    creditIssued = 4,
+    creditBalance = 5,
+    creditTransferred = 6,
+    certifierId = 7,
+    serialNo = 8
+}

package/dist/esm/types/Definitions/Enums/statsCards.type.enum.d.ts

@@ -0,0 +1,18 @@
+export declare enum StatsCardsTypes {
+    PROGRAMMES_PENDING = "Programmes Pending",
+    TRANSFER_REQUEST_RECEIVED = "Pending Transfers Received",
+    PROGRAMMES_UNCERTIFIED = "Programmes Certifiable",
+    TRANSFER_REQUEST_SENT = "Pending Transfers Sent",
+    PROGRAMMES_CERTIFIED = "Programmes Certified",
+    CREDIT_BALANCE = "Credit Balance",
+    CREDIT_CERTIFIED = "Credits Certified",
+    PROGRAMMES = "Programmes",
+    CREDITS = "Credits",
+    CERTIFIED_CREDITS = "Certified Credits",
+    TOTAL_PROGRAMMES = "Total Programmes",
+    TOTAL_PROGRAMMES_SECTOR = "Total Programmes: Sector",
+    TOTAL_CREDITS = "Total Credits",
+    TOTAL_CREDITS_CERTIFIED = "Total Credits Certified",
+    PROGRAMME_LOCATIONS = "Programme Locations",
+    TRANSFER_LOCATIONS_INTERNATIONAL = "Transfer Locations International"
+}

package/dist/esm/types/Definitions/Enums/user.management.columns.enum.d.ts

@@ -0,0 +1,10 @@
+export declare enum UserManagementColumns {
+    logo = 0,
+    name = 1,
+    email = 2,
+    phoneNo = 3,
+    company = 4,
+    companyRole = 5,
+    role = 6,
+    actions = 7
+}

package/dist/esm/types/Definitions/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./Enums/company.management.columns.enum";
+export * from "./Enums/user.management.columns.enum";
+export * from "./Enums/programme.management.columns.enum";
+export * from "./Definitions/userLogin.definitions";
+export * from "./Definitions/userInformationContext.definitions";
+export * from "./Definitions/userForgotPassword.definitions";
+export * from "./Definitions/settings.definitions";
+export * from "./Definitions/programme.definitions";
+export * from "./Definitions/addUser.definitions";
+export * from "./Definitions/connectionContext.definitions";
+export * from "./Definitions/layout.header";
+export * from "./Definitions/layout.sider.definitions";
+export * from "./Definitions/mapComponent.definitions";

package/dist/esm/types/Styles/role.color.constants.d.ts

@@ -0,0 +1,15 @@
+export declare const AdminBGColor = "rgba(255, 166, 166, 0.42)";
+export declare const AdminColor = "#D12800";
+export declare const RootBGColor = "rgba(255, 0, 229, 0.15)";
+export declare const RootColor = "#DB00FF";
+export declare const ManagerBGColor = "rgba(96, 27, 209, 0.13)";
+export declare const ManagerColor = "#75009E";
+export declare const ViewBGColor = "rgba(176, 190, 197, 0.23)";
+export declare const ViewColor = "#707070";
+export declare const GovBGColor = "rgba(185, 226, 244, 0.56)";
+export declare const GovColor = "#16B1FF";
+export declare const DevBGColor = "rgba(254, 241, 173, 0.55)";
+export declare const DevColor = "#FFA070";
+export declare const CertBGColor = "rgba(128, 255, 0, 0.12)";
+export declare const CertColor = "#519E4F";
+export declare const TooltipColor = "#6ACDFF";

package/dist/esm/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Components';
+export * from './Definitions';

package/dist/index.d.ts

@@ -0,0 +1,356 @@
+import { FC, ReactNode } from 'react';
+import { RawAxiosResponseHeaders, AxiosResponseHeaders, AxiosRequestConfig } from 'axios';
+
+declare const CompanyManagementComponent: (props: any) => any;
+
+declare const AddNewCompanyComponent: (props: any) => any;
+
+declare const CompanyProfileComponent: (props: any) => any;
+
+declare const UserManagementComponent: (props: any) => any;
+
+declare const ProgrammeManagementComponent: (props: any) => any;
+
+declare const ProgrammeViewComponent: (props: any) => any;
+
+declare const AddNewUserComponent: (props: any) => any;
+
+declare const UserProfileComponent: (props: any) => any;
+
+declare const Loading: () => any;
+
+interface LegendItemItemProps {
+    text: string;
+    color: string;
+}
+declare const LegendItem: FC<LegendItemItemProps>;
+
+declare enum MapTypes {
+    Mapbox = "Mapbox",
+    None = "None"
+}
+interface MarkerData {
+    id?: number;
+    color?: string;
+    location: number[];
+    element?: any;
+}
+interface MapSourceData {
+    key: string;
+    data: any;
+}
+interface MapPopupData {
+    html: string;
+}
+interface MapComponentProps {
+    mapType: string;
+    center: number[];
+    markers?: MarkerData[];
+    zoom: number;
+    mapSource?: MapSourceData;
+    onClick?: any;
+    showPopupOnClick?: boolean;
+    onMouseMove?: any;
+    layer?: any;
+    height: number;
+    style: string;
+    onRender?: any;
+    accessToken?: any;
+}
+
+declare const MapComponent: (props: MapComponentProps) => any;
+
+declare const MapboxComponent: (props: MapComponentProps) => any;
+
+interface StasticCardItemProps {
+    value: number;
+    title: string;
+    updatedDate: any;
+    icon: any;
+    loading: boolean;
+    companyRole: any;
+}
+declare const StasticCard: FC<StasticCardItemProps>;
+
+declare enum CompanyManagementColumns {
+    logo = 0,
+    name = 1,
+    taxId = 2,
+    companyRole = 3,
+    programmeCount = 4,
+    creditBalance = 5
+}
+
+declare enum UserManagementColumns {
+    logo = 0,
+    name = 1,
+    email = 2,
+    phoneNo = 3,
+    company = 4,
+    companyRole = 5,
+    role = 6,
+    actions = 7
+}
+
+declare enum ProgrammeManagementColumns {
+    title = 0,
+    company = 1,
+    sector = 2,
+    currentStage = 3,
+    creditIssued = 4,
+    creditBalance = 5,
+    creditTransferred = 6,
+    certifierId = 7,
+    serialNo = 8
+}
+
+interface LoginProps {
+    email: string;
+    password: string;
+}
+
+type UserProps = {
+    id: string;
+    userRole: string;
+    companyId: number;
+    companyRole: string;
+    companyLogo: string;
+    companyName: string;
+    companyState: number;
+};
+interface UserContextProps {
+    userInfoState?: UserProps;
+    setUserInfo: (val: UserProps) => void;
+    removeUserInfo: () => void;
+    IsAuthenticated: (tkn?: any) => boolean;
+    isTokenExpired: boolean;
+    setIsTokenExpired: (val: boolean) => void;
+}
+
+interface userForgotPasswordProps {
+    email: string;
+}
+
+declare enum ConfigurationSettingsType {
+    isTransferFrozen = 0
+}
+
+declare class BaseEntity {
+}
+
+declare class ProgrammeTransfer implements BaseEntity {
+    [x: string]: any;
+    requestId?: number;
+    programmeId?: string;
+    initiator?: number;
+    initiatorCompanyId?: number;
+    toCompanyId?: number;
+    toAccount?: string;
+    fromCompanyId?: number;
+    creditAmount?: number;
+    comment?: string;
+    txRef?: string;
+    txTime?: number;
+    status?: CreditTransferStage;
+    isRetirement?: boolean;
+    companyId?: number[];
+    creditOwnerPercentage?: number[];
+    createdTime?: number;
+    retirementType?: RetireType;
+    toCompanyMeta?: any;
+}
+
+declare enum ProgrammeStage {
+    AwaitingAuthorization = "Pending",
+    Authorised = "Authorised",
+    Rejected = "Rejected"
+}
+declare enum Role {
+    Root = "Root",
+    Admin = "Admin",
+    Manager = "Manager",
+    ViewOnly = "ViewOnly"
+}
+declare enum RetireType {
+    CROSS_BORDER = "0",
+    LEGAL_ACTION = "1",
+    OTHER = "2"
+}
+declare enum CreditTransferStage {
+    Pending = "Pending",
+    Approved = "Accepted",
+    Rejected = "Rejected",
+    Cancelled = "Cancelled",
+    Recognised = "Recognised",
+    NotRecognised = "NotRecognised"
+}
+declare enum TxType {
+    CREATE = "0",
+    REJECT = "1",
+    ISSUE = "2",
+    TRANSFER = "3",
+    CERTIFY = "4",
+    RETIRE = "5",
+    REVOKE = "6",
+    FREEZE = "7",
+    AUTH = "8",
+    UNFREEZE = "9"
+}
+declare enum SectoralScope {
+    "Energy Industry" = "1",
+    "Energy Distribution" = "2",
+    "Agriculture" = "15"
+}
+declare enum TypeOfMitigation {
+    AGRICULTURE = "Agriculture",
+    SOLAR = "Solar"
+}
+declare const getStageEnumVal: (value: string) => string;
+declare const getCreditStageVal: (value: string) => string;
+declare const getStageTransferEnumVal: (value: string, transfer: ProgrammeTransfer) => string;
+declare const getStageTagType: (stage: ProgrammeStage) => "error" | "processing" | "default";
+declare const getTransferStageTagType: (stage: CreditTransferStage, transfer: ProgrammeTransfer) => "error" | "processing" | "default" | "success" | "purple" | "orange";
+declare class UnitField {
+    unit: string;
+    value: any;
+    constructor(unit: string, value: any);
+}
+declare enum CompanyRole {
+    CERTIFIER = "Certifier",
+    PROGRAMME_DEVELOPER = "ProgrammeDeveloper",
+    MRV = "MRV",
+    GOVERNMENT = "Government"
+}
+interface ProgrammeProperties {
+    maxInternationalTransferAmount: string;
+    creditingPeriodInYears: number;
+    programmeCostUSD: number;
+    sourceOfFunding: any;
+    grantEquivalentAmount: number;
+    carbonPriceUSDPerTon: number;
+    buyerCountryEligibility: string;
+    geographicalLocation: string[];
+    greenHouseGasses: any[];
+    creditYear: number;
+    programmeMaterials: [];
+    projectMaterial: [];
+}
+interface Programme {
+    programmeId: string;
+    serialNo: string;
+    title: string;
+    sectoralScope: string;
+    sector: string;
+    countryCodeA2: string;
+    currentStage: ProgrammeStage;
+    startTime: number;
+    endTime: number;
+    creditChange: number;
+    creditIssued: number;
+    creditEst: number;
+    creditBalance: number;
+    creditTransferred: number[];
+    creditRetired: number[];
+    creditFrozen: number[];
+    constantVersion: string;
+    proponentTaxVatId: string[];
+    companyId: number[];
+    proponentPercentage: number[];
+    creditOwnerPercentage: number[];
+    certifierId: any[];
+    certifier: any[];
+    company: any[];
+    creditUnit: string;
+    programmeProperties: ProgrammeProperties;
+    agricultureProperties: any;
+    solarProperties: any;
+    txTime: number;
+    createdTime: number;
+    txRef: string;
+    typeOfMitigation: TypeOfMitigation;
+    geographicalLocationCordintes: any;
+}
+declare const getGeneralFields: (programme: Programme) => {
+    title: string;
+    serialNo: string;
+    currentStatus: ProgrammeStage;
+    applicationType: string;
+    sector: string;
+    sectoralScope: string;
+    startDate: any;
+    endDate: any;
+    buyerCountry: string;
+};
+declare const addCommSep: (value: any) => string;
+declare const addCommSepRound: (value: any) => string;
+declare const addRoundNumber: (value: any) => number;
+declare const addSpaces: (text: string) => string;
+declare const getFinancialFields: (programme: Programme) => {
+    programmeCost: string;
+    financingType: string;
+    grantEquivalent: UnitField;
+    carbonPrice: string;
+};
+declare const getCompanyBgColor: (item: string) => "rgba(185, 226, 244, 0.56)" | "rgba(254, 241, 173, 0.55)" | "rgba(128, 255, 0, 0.12)";
+declare const getRetirementTypeString: (retirementType: string | null) => "-" | "CROSS BORDER TRANSFER" | "LEGAL ACTION" | "OTHER" | undefined;
+declare const sumArray: (arrList: any[]) => any;
+
+interface ProgrammeDeveloperCreation {
+    companyName?: string;
+    companyLocation?: string;
+    industry?: string;
+    registrationNo?: string;
+}
+interface UserCreationProps extends ProgrammeDeveloperCreation {
+    name: string;
+    email: string;
+    role: string;
+    city: string;
+    zipCode: string;
+    state: string;
+    country: string;
+    contactNo: string;
+    companyLogo?: string;
+}
+interface CountrySelect {
+    key: string;
+    label: string;
+    value: string;
+}
+
+type Methods = 'get' | 'post' | 'delete' | 'put' | 'patch';
+type ConnectionContextProviderProps = {
+    serverURL: string;
+    children: ReactNode;
+};
+interface Response<T> {
+    data: T;
+    statusText: string;
+    status?: number;
+    headers: RawAxiosResponseHeaders | AxiosResponseHeaders;
+    config?: AxiosRequestConfig;
+    request?: any;
+    message: string;
+}
+type ConnectionProps = {
+    post<T = any, R = Response<T>>(path: string, data?: any, config?: AxiosRequestConfig, extraUrl?: string): Promise<R>;
+    get<T = any, R = Response<T>>(path: string, config?: AxiosRequestConfig): Promise<R>;
+    delete<T = any, R = Response<T>>(path: string, config?: AxiosRequestConfig): Promise<R>;
+    put<T = any, R = Response<T>>(path: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
+    patch<T = any, R = Response<T>>(path: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
+    updateToken: (token?: string) => void;
+    token?: string;
+    removeToken: (tkn?: string) => void;
+};
+
+type HeaderProps = {
+    title?: string;
+    onToggle: (val: boolean) => void;
+};
+
+type LayoutSiderProps = {
+    selectedKey?: string;
+    collapsed?: boolean;
+};
+
+export { AddNewCompanyComponent, AddNewUserComponent, CompanyManagementColumns, CompanyManagementComponent, CompanyProfileComponent, CompanyRole, ConfigurationSettingsType, ConnectionContextProviderProps, ConnectionProps, CountrySelect, CreditTransferStage, HeaderProps, LayoutSiderProps, LegendItem, LegendItemItemProps, Loading, LoginProps, MapComponent, MapComponentProps, MapPopupData, MapSourceData, MapTypes, MapboxComponent, MarkerData, Methods, Programme, ProgrammeDeveloperCreation, ProgrammeManagementColumns, ProgrammeManagementComponent, ProgrammeProperties, ProgrammeStage, ProgrammeViewComponent, Response, RetireType, Role, SectoralScope, StasticCard, StasticCardItemProps, TxType, TypeOfMitigation, UnitField, UserContextProps, UserCreationProps, UserManagementColumns, UserManagementComponent, UserProfileComponent, UserProps, addCommSep, addCommSepRound, addRoundNumber, addSpaces, getCompanyBgColor, getCreditStageVal, getFinancialFields, getGeneralFields, getRetirementTypeString, getStageEnumVal, getStageTagType, getStageTransferEnumVal, getTransferStageTagType, sumArray, userForgotPasswordProps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@undp/carbon-library",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Shared Library of tools for Carbon Credits applications ecosystem for ExO and and HQ/GEF",
   "type": "module",
   "scripts": {
@@ -40,7 +40,8 @@
     "@types/react": "^18.0.25",
     "@types/mapbox-gl": "^2.7.10",
     "@types/luxon": "^3.1.0",
-    "@ant-design/icons": "^4.7.0"
+    "@ant-design/icons": "^4.7.0",
+    "react-mapbox-gl": "^5.1.1"
   },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",