@nevermined-io/commons 0.0.1

package/dist/lib/types/types.d.ts

@@ -0,0 +1,228 @@
+import * as jose from 'jose';
+export declare enum AuthRoles {
+    Admin = "admin"
+}
+export interface AuthUser {
+    userId: string;
+    address: string;
+    hash: string;
+    roles?: AuthRoles[];
+    nvmApiKey?: jose.JWTPayload;
+}
+export interface Request<G> {
+    hostname: string;
+    body?: G;
+    query?: G;
+    params?: G;
+    client: {
+        localPort: number;
+    };
+    protocol: string;
+    url: string;
+    user?: AuthUser;
+}
+export type DistinctPlans = {
+    page: number;
+    totalPages: number;
+    totalResults: number;
+    results: any[];
+};
+export declare enum PointsRulesCategory {
+    wau = "wau",
+    supply = "supply",
+    purchases = "purchases",
+    demand = "demand",
+    curation = "curation",
+    network = "network",
+    other = "other"
+}
+export declare enum PointsRulesRecurrency {
+    unlimitted = "unlimitted",
+    timeslimitted = "timeslimitted",
+    onlyonce = "onlyonce",
+    onceperitem = "onceperitem",
+    capday = "capday",
+    capweek = "capweek",
+    capmonth = "capmonth",
+    capyear = "capyear",
+    other = "other"
+}
+export declare enum PointsEventStatus {
+    Pending = "Pending",
+    Processed = "Processed",
+    Failed = "Failed",
+    Skipped = "Skipped",
+    Other = "Other"
+}
+export declare enum NotificationType {
+    SubscriptionReceived = "SubscriptionReceived",
+    SubscriptionPurchased = "SubscriptionPurchased",
+    AccountSetup = "AccountSetup",
+    EmailValidation = "EmailValidation",
+    Other = "Other"
+}
+export declare enum NotificationOriginator {
+    Nevermined = "Nevermined",
+    Other = "Other"
+}
+export declare enum NotificationReadStatus {
+    Pending = "Pending",
+    Read = "Read",
+    Deleted = "Deleted",
+    Other = "Other"
+}
+export declare enum NotificationDeliveryStatus {
+    Pending = "Pending",
+    Sent = "Sent",
+    Failed = "Failed",
+    NotRequired = "NotRequired",
+    Skipped = "Skipped",
+    Other = "Other"
+}
+export declare enum EmailChallengeStatus {
+    Pending = "Pending",
+    Validated = "Validated",
+    Failed = "Failed"
+}
+export declare enum PlanTransactionType {
+    Purchase = "Purchase",
+    Mint = "Mint",
+    Burn = "Burn",
+    Transfer = "Transfer",
+    Error = "Error",
+    Other = "Other"
+}
+export declare enum PlanTransactionPaymentType {
+    Crypto = "Crypto",
+    Fiat = "Fiat"
+}
+export declare enum CheckoutSessionType {
+    embedded = "embedded",
+    redirect = "redirect"
+}
+export declare enum WidgetLayout {
+    Horizontal = "Horizontal",
+    Vertical = "Vertical",
+    Reduced = "Reduced"
+}
+export declare enum StripeEventStatus {
+    Pending = "Pending",
+    Done = "Done",
+    Error = "Error",
+    Ignored = "Ignored",
+    Other = "Other"
+}
+export declare enum ResultType {
+    matrix = "matrix",
+    vector = "vector",
+    scalar = "scalar",
+    string = "string"
+}
+export declare enum ApiKeyTxType {
+    NewPlan = "NewPlan",
+    NewAgent = "NewAgent",
+    EditPlan = "EditPlan",
+    EditAgent = "EditAgent",
+    Purchase = "Purchase",
+    Download = "Download",
+    AccessHit = "AccessHit",
+    Mint = "Mint",
+    Burn = "Burn",
+    AgentExecution = "AgentExecution",
+    Other = "Other"
+}
+export interface Metric {
+    consumer: string;
+    did: string;
+    endpoint: string;
+    job: string;
+    namespace: string;
+    owner: string;
+    access_date: Date;
+}
+export interface AccessHistory {
+    date: string;
+    owner: string;
+    consumer: string;
+    endpoint: string;
+}
+export interface LineItem {
+    planId: string;
+    currency: string;
+    name: string;
+    price: number;
+    quantity: number;
+    description?: string;
+    imageUrl?: string;
+}
+export interface StripeLineItem {
+    price_data: {
+        currency: string;
+        product_data: {
+            name: string;
+            description?: string;
+            images?: string[];
+            metadata?: [string, string];
+        };
+        unit_amount_decimal: number;
+    };
+    quantity: number;
+}
+export declare const DEFAULT_PAGE = 1;
+export declare const DEFAULT_OFFSET = 10000;
+export interface PaginationOptions {
+    page: number;
+    skip: number;
+    offset: number;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}
+export declare enum TaskLogLevel {
+    debug = "debug",
+    info = "info",
+    warn = "warn",
+    error = "error"
+}
+export declare enum PaymentPlanTypes {
+    expirable = "expirable",
+    credits = "credits"
+}
+export interface OrderResult {
+    txHash: `0x${string}`;
+    planId: bigint;
+    planReceiver: `0x${string}`;
+    currency: string;
+    totalAmount: bigint;
+    numCredits: bigint;
+    paymentMethod: PlanTransactionPaymentType;
+    tokenAddress?: `0x${string}`;
+}
+export declare const NVM_USERID_HEADER = "NVM-User-id";
+export declare const NVM_COST_HEADER = "NVMCreditsConsumed";
+export declare const DEFAULT_COST_CREDITS = "1";
+export declare enum OrganizationType {
+    Free = "Free",
+    Premium = "Premium",
+    Enterprise = "Enterprise",
+    Other = "Other"
+}
+export declare enum OrganizationMemberRole {
+    Admin = "Admin",
+    Member = "Member"
+}
+export interface Branding {
+    themeName?: string;
+    logo?: string;
+    leftPanelHeadingTextColor?: string;
+    leftPanelBodyTextColor?: string;
+    leftPanelBackgroundColor1?: string;
+    leftPanelBackgroundColor2?: string;
+    leftPanelBackgroundImageUrl?: string;
+    rightCardTextColor?: string;
+    rightCardButtonBackgroundColor?: string;
+    rightCardButtonTextColor?: string;
+    rightCardBackgroundColor1?: string;
+    rightCardBackgroundColor2?: string;
+    rightCardBackgroundImageUrl?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/lib/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,oBAAY,SAAS;IACnB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IACnB,SAAS,CAAC,EAAE,IAAI,CAAC,UAAU,CAAA;CAC5B;AAED,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,CAAC,CAAA;IACR,KAAK,CAAC,EAAE,CAAC,CAAA;IACT,MAAM,CAAC,EAAE,CAAC,CAAA;IACV,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,QAAQ,CAAA;CAChB;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,GAAG,EAAE,CAAA;CACf,CAAA;AAED,oBAAY,mBAAmB;IAC7B,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,qBAAqB;IAC/B,UAAU,eAAe;IACzB,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,iBAAiB;IAC3B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,gBAAgB;IAC1B,oBAAoB,yBAAyB;IAC7C,qBAAqB,0BAA0B;IAC/C,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IACnC,KAAK,UAAU;CAChB;AAED,oBAAY,sBAAsB;IAChC,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB;AAED,oBAAY,sBAAsB;IAChC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,0BAA0B;IACpC,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,oBAAoB;IAC9B,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,oBAAY,0BAA0B;IACpC,MAAM,WAAW;IACjB,IAAI,SAAS;CACd;AAED,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,oBAAY,YAAY;IACtB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED,oBAAY,iBAAiB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,oBAAY,YAAY;IACtB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,cAAc,mBAAmB;IACjC,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,IAAI,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,YAAY,EAAE;YACZ,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,CAAC,EAAE,MAAM,CAAA;YACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;YACjB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAC5B,CAAA;QACD,mBAAmB,EAAE,MAAM,CAAA;KAC5B,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,eAAO,MAAM,YAAY,IAAI,CAAA;AAC7B,eAAO,MAAM,cAAc,QAAS,CAAA;AAEpC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;CAC3B;AAED,oBAAY,YAAY;IACtB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,oBAAY,gBAAgB;IAC1B,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,KAAK,MAAM,EAAE,CAAA;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,0BAA0B,CAAA;IACzC,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CAC7B;AAED,eAAO,MAAM,iBAAiB,gBAAgB,CAAA;AAC9C,eAAO,MAAM,eAAe,uBAAuB,CAAA;AACnD,eAAO,MAAM,oBAAoB,MAAM,CAAA;AAEvC,oBAAY,gBAAgB;IAC1B,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB;AAED,oBAAY,sBAAsB;IAChC,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,QAAQ;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAGlB,IAAI,CAAC,EAAE,MAAM,CAAA;IAGb,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,2BAA2B,CAAC,EAAE,MAAM,CAAA;IAGpC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,8BAA8B,CAAC,EAAE,MAAM,CAAA;IACvC,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,2BAA2B,CAAC,EAAE,MAAM,CAAA;CACrC"}

package/dist/lib/types/types.js

@@ -0,0 +1,152 @@
+export var AuthRoles;
+(function (AuthRoles) {
+    AuthRoles["Admin"] = "admin";
+})(AuthRoles || (AuthRoles = {}));
+export var PointsRulesCategory;
+(function (PointsRulesCategory) {
+    PointsRulesCategory["wau"] = "wau";
+    PointsRulesCategory["supply"] = "supply";
+    PointsRulesCategory["purchases"] = "purchases";
+    PointsRulesCategory["demand"] = "demand";
+    PointsRulesCategory["curation"] = "curation";
+    PointsRulesCategory["network"] = "network";
+    PointsRulesCategory["other"] = "other";
+})(PointsRulesCategory || (PointsRulesCategory = {}));
+export var PointsRulesRecurrency;
+(function (PointsRulesRecurrency) {
+    PointsRulesRecurrency["unlimitted"] = "unlimitted";
+    PointsRulesRecurrency["timeslimitted"] = "timeslimitted";
+    PointsRulesRecurrency["onlyonce"] = "onlyonce";
+    PointsRulesRecurrency["onceperitem"] = "onceperitem";
+    PointsRulesRecurrency["capday"] = "capday";
+    PointsRulesRecurrency["capweek"] = "capweek";
+    PointsRulesRecurrency["capmonth"] = "capmonth";
+    PointsRulesRecurrency["capyear"] = "capyear";
+    PointsRulesRecurrency["other"] = "other";
+})(PointsRulesRecurrency || (PointsRulesRecurrency = {}));
+export var PointsEventStatus;
+(function (PointsEventStatus) {
+    PointsEventStatus["Pending"] = "Pending";
+    PointsEventStatus["Processed"] = "Processed";
+    PointsEventStatus["Failed"] = "Failed";
+    PointsEventStatus["Skipped"] = "Skipped";
+    PointsEventStatus["Other"] = "Other";
+})(PointsEventStatus || (PointsEventStatus = {}));
+export var NotificationType;
+(function (NotificationType) {
+    NotificationType["SubscriptionReceived"] = "SubscriptionReceived";
+    NotificationType["SubscriptionPurchased"] = "SubscriptionPurchased";
+    NotificationType["AccountSetup"] = "AccountSetup";
+    NotificationType["EmailValidation"] = "EmailValidation";
+    NotificationType["Other"] = "Other";
+})(NotificationType || (NotificationType = {}));
+export var NotificationOriginator;
+(function (NotificationOriginator) {
+    NotificationOriginator["Nevermined"] = "Nevermined";
+    NotificationOriginator["Other"] = "Other";
+})(NotificationOriginator || (NotificationOriginator = {}));
+export var NotificationReadStatus;
+(function (NotificationReadStatus) {
+    NotificationReadStatus["Pending"] = "Pending";
+    NotificationReadStatus["Read"] = "Read";
+    NotificationReadStatus["Deleted"] = "Deleted";
+    NotificationReadStatus["Other"] = "Other";
+})(NotificationReadStatus || (NotificationReadStatus = {}));
+export var NotificationDeliveryStatus;
+(function (NotificationDeliveryStatus) {
+    NotificationDeliveryStatus["Pending"] = "Pending";
+    NotificationDeliveryStatus["Sent"] = "Sent";
+    NotificationDeliveryStatus["Failed"] = "Failed";
+    NotificationDeliveryStatus["NotRequired"] = "NotRequired";
+    NotificationDeliveryStatus["Skipped"] = "Skipped";
+    NotificationDeliveryStatus["Other"] = "Other";
+})(NotificationDeliveryStatus || (NotificationDeliveryStatus = {}));
+export var EmailChallengeStatus;
+(function (EmailChallengeStatus) {
+    EmailChallengeStatus["Pending"] = "Pending";
+    EmailChallengeStatus["Validated"] = "Validated";
+    EmailChallengeStatus["Failed"] = "Failed";
+})(EmailChallengeStatus || (EmailChallengeStatus = {}));
+export var PlanTransactionType;
+(function (PlanTransactionType) {
+    PlanTransactionType["Purchase"] = "Purchase";
+    PlanTransactionType["Mint"] = "Mint";
+    PlanTransactionType["Burn"] = "Burn";
+    PlanTransactionType["Transfer"] = "Transfer";
+    PlanTransactionType["Error"] = "Error";
+    PlanTransactionType["Other"] = "Other";
+})(PlanTransactionType || (PlanTransactionType = {}));
+export var PlanTransactionPaymentType;
+(function (PlanTransactionPaymentType) {
+    PlanTransactionPaymentType["Crypto"] = "Crypto";
+    PlanTransactionPaymentType["Fiat"] = "Fiat";
+})(PlanTransactionPaymentType || (PlanTransactionPaymentType = {}));
+export var CheckoutSessionType;
+(function (CheckoutSessionType) {
+    CheckoutSessionType["embedded"] = "embedded";
+    CheckoutSessionType["redirect"] = "redirect";
+})(CheckoutSessionType || (CheckoutSessionType = {}));
+export var WidgetLayout;
+(function (WidgetLayout) {
+    WidgetLayout["Horizontal"] = "Horizontal";
+    WidgetLayout["Vertical"] = "Vertical";
+    WidgetLayout["Reduced"] = "Reduced";
+})(WidgetLayout || (WidgetLayout = {}));
+export var StripeEventStatus;
+(function (StripeEventStatus) {
+    StripeEventStatus["Pending"] = "Pending";
+    StripeEventStatus["Done"] = "Done";
+    StripeEventStatus["Error"] = "Error";
+    StripeEventStatus["Ignored"] = "Ignored";
+    StripeEventStatus["Other"] = "Other";
+})(StripeEventStatus || (StripeEventStatus = {}));
+export var ResultType;
+(function (ResultType) {
+    ResultType["matrix"] = "matrix";
+    ResultType["vector"] = "vector";
+    ResultType["scalar"] = "scalar";
+    ResultType["string"] = "string";
+})(ResultType || (ResultType = {}));
+export var ApiKeyTxType;
+(function (ApiKeyTxType) {
+    ApiKeyTxType["NewPlan"] = "NewPlan";
+    ApiKeyTxType["NewAgent"] = "NewAgent";
+    ApiKeyTxType["EditPlan"] = "EditPlan";
+    ApiKeyTxType["EditAgent"] = "EditAgent";
+    ApiKeyTxType["Purchase"] = "Purchase";
+    ApiKeyTxType["Download"] = "Download";
+    ApiKeyTxType["AccessHit"] = "AccessHit";
+    ApiKeyTxType["Mint"] = "Mint";
+    ApiKeyTxType["Burn"] = "Burn";
+    ApiKeyTxType["AgentExecution"] = "AgentExecution";
+    ApiKeyTxType["Other"] = "Other";
+})(ApiKeyTxType || (ApiKeyTxType = {}));
+export const DEFAULT_PAGE = 1;
+export const DEFAULT_OFFSET = 10_000;
+export var TaskLogLevel;
+(function (TaskLogLevel) {
+    TaskLogLevel["debug"] = "debug";
+    TaskLogLevel["info"] = "info";
+    TaskLogLevel["warn"] = "warn";
+    TaskLogLevel["error"] = "error";
+})(TaskLogLevel || (TaskLogLevel = {}));
+export var PaymentPlanTypes;
+(function (PaymentPlanTypes) {
+    PaymentPlanTypes["expirable"] = "expirable";
+    PaymentPlanTypes["credits"] = "credits";
+})(PaymentPlanTypes || (PaymentPlanTypes = {}));
+export const NVM_USERID_HEADER = 'NVM-User-id';
+export const NVM_COST_HEADER = 'NVMCreditsConsumed';
+export const DEFAULT_COST_CREDITS = '1';
+export var OrganizationType;
+(function (OrganizationType) {
+    OrganizationType["Free"] = "Free";
+    OrganizationType["Premium"] = "Premium";
+    OrganizationType["Enterprise"] = "Enterprise";
+    OrganizationType["Other"] = "Other";
+})(OrganizationType || (OrganizationType = {}));
+export var OrganizationMemberRole;
+(function (OrganizationMemberRole) {
+    OrganizationMemberRole["Admin"] = "Admin";
+    OrganizationMemberRole["Member"] = "Member";
+})(OrganizationMemberRole || (OrganizationMemberRole = {}));

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@nevermined-io/commons",
+  "version": "0.0.1",
+  "type": "module",
+  "private": false,
+  "main": "../dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './lib/types/index.js'
+export * from './lib/ddo/index.js'
+export * from './lib/constants/index.js'
+export { DDO } from './lib/ddo/DDO.js'

package/src/lib/constants/AssetConstants.ts

@@ -0,0 +1,7 @@
+export const NETWORK_FEE_DENOMINATOR = 10000n
+
+// The type of the encryption methods supported for the private data included in the metadata
+export type EncryptionMethod = 'PSK-RSA' | 'PSK-ECDSA'
+
+// The default encryption method
+export const DEFAULT_ENCRYPTION_METHOD = 'PSK-RSA' as EncryptionMethod

package/src/lib/constants/index.ts

@@ -0,0 +1,2 @@
+export { DEFAULT_ENCRYPTION_METHOD, NETWORK_FEE_DENOMINATOR } from './AssetConstants.js'
+export type { EncryptionMethod } from './AssetConstants.js'

package/src/lib/ddo/DDO.ts

@@ -0,0 +1,121 @@
+import { CreditsConfig, DIDAgent, Plan, PriceConfig } from '../types/ContractsTypes.js'
+import { Metadata, NvmConfig } from '../types/DDOTypes.js'
+
+const jsonReplacer = (_key: string, value: unknown) => {
+  // Modify the value or return undefined to exclude the property
+  return typeof value === 'bigint' ? value.toString() : value
+}
+
+// Union type for registry
+type Registry = DIDAgent | Plan
+
+export class DDO {
+  /**
+   * Serializes the DDO object.
+   * @param ddo - The {@link DDO} to be serialized.
+   * @returns DDO serialized.
+   */
+  public static serialize(ddo: DDO): string {
+    return JSON.stringify(ddo, jsonReplacer, 2)
+  }
+
+  /**
+   * Deserializes the DDO object.
+   * @param ddoString - The serialized {@link DDO} to be deserialized.
+   * @returns The deserialized {@link DDO}.
+   */
+  public static deserialize(ddoString: string): DDO {
+    const ddo = JSON.parse(ddoString)
+
+    return new DDO(ddo)
+  }
+
+  /**
+   * DID, decentralizes ID.
+   */
+  public id = ''
+
+  // public didSeed = ''
+
+  public ['@context'] = 'https://w3id.org/did/v1'
+
+  public _nvm: NvmConfig = { userId: '', userAddress: '', appId: '', versions: [] }
+
+  public created: string = new Date().toISOString().replace(/\.[0-9]{3}/, '')
+
+  public updated?: string
+
+  public metadata: Metadata = {
+    serviceEndpoint: '',
+    main: {
+      name: '',
+      description: '',
+      dateCreated: '',
+      datePublished: '',
+      license: '',
+      tags: [],
+    },
+    curation: {
+      numVotes: 0,
+      rating: 0,
+      schema: '',
+      isListed: true,
+    },
+  }
+
+  public registry: Registry
+
+  public constructor(ddo: Partial<DDO> = {}) {
+    Object.assign(this, ddo, {
+      created: (ddo && ddo.created) || new Date().toISOString().replace(/\.[0-9]{3}/, ''),
+    })
+  }
+}
+
+export class AgentDDO extends DDO {
+  public override registry: DIDAgent = {
+    owner: '0x',
+    creator: '0x',
+    url: '',
+    lastUpdated: 0n,
+    plans: [],
+  }
+
+  public constructor(ddo: Partial<AgentDDO> = {}) {
+    super(ddo)
+  }
+
+  public static getInstance(userId: string, userAddress: string, appId?: string): AgentDDO {
+    return new AgentDDO({
+      id: '',
+      _nvm: { userId, userAddress, appId: appId || '', versions: [] },
+      registry: { owner: '0x', creator: '0x', url: '', lastUpdated: 0n, plans: [] },
+    })
+  }
+}
+
+export class PlanDDO extends DDO {
+  public override registry: Plan = {
+    owner: '0x',
+    price: {} as PriceConfig,
+    credits: {} as CreditsConfig,
+    lastUpdated: 0n,
+  }
+
+  public constructor(ddo: Partial<PlanDDO> = {}) {
+    super(ddo)
+  }
+
+  public static getInstance(userId: string, userAddress: string, appId?: string): PlanDDO {
+    return new PlanDDO({
+      id: '',
+      _nvm: { userId, userAddress, appId: appId || '', versions: [] },
+      registry: {
+        owner: '0x',
+        price: {} as PriceConfig,
+        credits: {} as CreditsConfig,
+        lastUpdated: 0n,
+      },
+    })
+  }
+}

package/src/lib/ddo/index.ts

@@ -0,0 +1 @@
+export * from './DDO.js'

package/src/lib/types/ContractsTypes.ts

@@ -0,0 +1,113 @@
+import { Address } from 'viem'
+
+/// Different types of redemptions criterias that can be used when redeeming credits
+/// @notice 0 - ONLY_GLOBAL_ROLE, 1 - ONLY_OWNER, 2 - ROLE_AND_OWNER
+/// If ONLY_GLOBAL_ROLE it means the credits can be redeemed only by an account with the `CREDITS_BURNER_ROLE`
+/// If ONLY_OWNER it means the credits can be redeemed only by the owner of the Plan
+/// If ONLY_PLAN_ROLE it means the credits can be redeemed by an account with specifics grants for the plan
+/// If OWNER_OR_GLOBAL_ROLE means Only the owner OR accounts with CREDITS_BURNER_ROLE can redeem
+/// If ONLY_SUBSCRIBER means only the subscriber (the one who holds the credits NFT) can redeem
+export enum RedemptionType {
+  ONLY_GLOBAL_ROLE,
+  ONLY_OWNER,
+  ONLY_PLAN_ROLE,
+  OWNER_OR_GLOBAL_ROLE,
+  ONLY_SUBSCRIBER,
+}
+
+export interface DIDAgent {
+  // The owner of the asset
+  owner: Address
+  // Asset original creator, this can't be modified after the asset is registered
+  creator: Address
+  // URL to the metadata associated to the DID
+  url: string
+  // When was the DID last updated
+  lastUpdated: bigint
+  // Array of plans that can be used to purchase access to the asset
+  plans: bigint[]
+}
+
+/// Definition of the price configuration for a plan
+export interface PriceConfig {
+  /**
+   * @notice Indicates if the price is in cryptocurrency (true) or fiat currency (false)
+   */
+  isCrypto: boolean
+  /**
+   * @notice Indicates if the price is in cryptocurrency (true) or fiat currency (false)
+   */
+  tokenAddress?: Address
+  /**
+   * The amounts to be paid for the plan
+   * @notice only if the price is not calculated by a smart contract
+   */
+  amounts: bigint[]
+  /**
+   * The receivers of the payments of the plan
+   * @notice only if the price is not calculated by a smart contract
+   */
+  receivers: string[]
+  /**
+   * The address of the smart contract that calculates the price
+   */
+  externalPriceAddress?: Address
+  /**
+   * The address of the fee controller contract, if any
+   * @notice if not given, the fee controller is the default one
+   */
+  feeController?: Address
+  /**
+   * @notice The template contract address associated with the plan
+   */
+  templateAddress?: Address
+}
+
+/// Definition of the credits configuration for a plan
+export interface CreditsConfig {
+  /**
+   * @notice Indicates if the redemption amount is fixed (true) or dynamic (false)
+   */
+  isRedemptionAmountFixed: boolean
+  /**
+   * How the credits can be redeemed
+   */
+  redemptionType: RedemptionType
+  /**
+   * Whether the credits burn proof signed by the user is required
+   */
+  proofRequired: boolean
+  /**
+   * The duration of the credits in seconds
+   */
+  durationSecs: bigint
+  /**
+   * The amount of credits that are granted when purchasing the plan
+   */
+  amount: bigint
+  /**
+   * The minimum number of credits redeemed when using the plan
+   */
+  minAmount: bigint
+  /**
+   * The maximum number of credits redeemed when using the plan
+   * @notice only if isRedemptionAmountFixed is false
+   */
+  maxAmount: bigint
+  /**
+   * The address of the NFT contract that represents the plan's credits
+   */
+  nftAddress?: Address
+}
+
+/// Definition of a plan
+export class Plan {
+  // The owner of the Plan
+  owner: Address
+  // The price configuration of the plan
+  price: PriceConfig
+  // The credits configuration of the plan
+  credits: CreditsConfig
+  // The timestamp of the last time the plan definition was updated
+  lastUpdated: bigint
+}