@nevermined-io/commons 0.0.1

package/src/lib/types/DDOTypes.ts

@@ -0,0 +1,149 @@
+import { CreditsConfig, PriceConfig } from './ContractsTypes.js'
+
+export interface Metadata {
+  serviceEndpoint: string
+  main: MetadataMainAttributes
+  agent?: AgentMetadata
+  additionalInformation?: unknown
+  curation: Curation
+  plan?: PlanMetadata
+}
+
+export interface NvmConfigVersions {
+  id: number
+  updated: string
+  checksum: string
+}
+export interface NvmConfig {
+  userId: string
+  userAddress: string
+  appId: string
+  versions: NvmConfigVersions[]
+}
+
+export interface Proof {
+  created: string
+  creator: string
+  signatureValue: string
+  type: string
+}
+
+export interface MetadataMainAttributes {
+  name: string
+  description?: string
+  author?: string
+  dateCreated?: string
+  datePublished?: string
+  license?: string
+  tags?: string[]
+}
+
+/**
+ * Interface describing an asset of type `service`
+ */
+export interface AgentMetadata {
+  /**
+   * Type of Web service
+   */
+  apiType?: 'restful' | 'graphql' | 'rpc' | 'other'
+
+  /**
+   * Authentication required by the API
+   */
+  authentication?: ResourceAuthentication
+
+  /**
+   * List of endpoints of the API exposed by the Agent
+   */
+  endpoints?: ApiEndpoint[]
+
+  /**
+   * List of open endpoints available for the agent. These endpoints are not protected.
+   * This attribute is useful to indicate which endpoints are available for public access (documentation, definitions, etc).
+   */
+  openEndpoints?: string[]
+
+  requiredHeaders?: { [verb: string]: string }[]
+
+  encryptedAttributes?: string
+}
+
+export interface PlanMetadata {
+  isTrialPlan?: boolean
+  productId?: string
+  priceId?: string
+  recurringSubscription?: boolean
+  accessLimit: 'credits' | 'time'
+  fiatPaymentProvider?: 'stripe' | 'braintree'
+}
+
+export interface AgentRegistry {
+  owner: string
+  creator: string
+  url: string
+  lastUpdated: string
+  plans: string[]
+}
+
+export interface PlanRegistry {
+  owner: string
+  lastUpdated: string
+  price: PriceConfig
+  credits: CreditsConfig
+}
+
+export interface ResourceAuthentication {
+  type: ApiAuthenticationType
+
+  user?: string
+  password?: string
+  token?: string
+  encrypted?: boolean
+  privateParameters?: { [name: string]: string }[]
+}
+
+/**
+ * Curation attributes of Assets Metadata.
+ * @see https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metadata/README.md#curation-attributes
+ */
+export interface Curation {
+  /**
+   * Decimal value between 0 and 1. 0 is the default value.
+   * @example 0.93
+   */
+  rating: number
+
+  /**
+   * Number of votes. 0 is the default value.
+   * @example 123
+   */
+  numVotes: number
+
+  /**
+   * Schema applied to calculate the rating.
+   * @example "Binary Voting"
+   */
+  schema?: string
+
+  /**
+   * Flag unsuitable content.
+   * @example true
+   */
+  isListed?: boolean
+}
+
+export enum ApiAuthenticationType {
+  none = 'none',
+  basic = 'basic',
+  bearer = 'bearer',
+  oauth = 'oauth',
+}
+
+export type ApiEndpoint = { [verb: string]: string }
+
+export enum AgentTaskStatus {
+  SUCCESS = 'Success',
+  FAILURE = 'Failure',
+  PENDING = 'Pending',
+  IN_PROGRESS = 'In_Progress',
+}

package/src/lib/types/GeneralTypes.ts

@@ -0,0 +1,31 @@
+export interface Balance {
+  eth: bigint
+  nevermined: bigint
+}
+
+export interface Eip712Data {
+  message: string
+  chainId: number
+}
+
+export interface TypedDataDomain {
+  name: string
+  version: string
+  chainId: number
+}
+
+export interface TypedDataTypes {
+  Nevermined: {
+    name: string
+    type: string
+  }[]
+}
+
+export interface PriceBreakdown {
+  grossCharge: bigint
+  ownerMargin: bigint
+  nvmMargin: bigint
+  stripeFee?: bigint
+  nvmCharge: bigint
+  orgMargin?: bigint
+}

package/src/lib/types/MetadataTypes.ts

@@ -0,0 +1,145 @@
+import { DDO } from '../ddo/DDO.js'
+
+/**
+ * It described the policy to be used when resolving an asset. It has the following options:
+ * * ImmutableFirst - It checks if there is a reference to an immutable data-store (IPFS, Filecoin, etc) on-chain. If that's the case uses the URL to resolve the Metadata. If not try to resolve the metadata using the URL of the Metadata/Marketplace API
+ * * MetadataAPIFirst - Try to resolve the metadata from the Marketplace/Metadata API, if it can't tries to resolve using the immutable url
+ * * OnlyImmutable - Try to resolve the metadata only from the immutable data store URL
+ * * OnlyMetadataAPI - Try to resolve the metadata only from the Metadata API. It gets the metadata api url from the DIDRegistry
+ * * NoRegisry - Gets the metadata from the Metadata API using as endpoint the metadata api url from the SDK config. This method don't gets any on-chain information because assumes the DID is not registered on-chain
+ */
+export enum DIDResolvePolicy {
+  ImmutableFirst = 0,
+  MetadataAPIFirst = 1,
+  OnlyImmutable = 2,
+  OnlyMetadataAPI = 3,
+  NoRegistry = 4,
+}
+
+/**
+ * Where the metadata will be published. Options:
+ * - OnlyMetadataAPI, The metadata will be stored only in the Metadata/Marketplace API
+ * - IPFS, The metadata will be stored in the Metadata/Marketplace API and IPFS
+ * - Filecoin, The metadata will be stored in the Metadata/Marketplace API and Filecoin
+ * - Arweave, The metadata will be stored in the Metadata/Marketplace API and Arweave
+ */
+export enum PublishMetadataOptions {
+  OnlyMetadataAPI = 0,
+  IPFS = 1,
+  Filecoin = 2,
+  Arweave = 3,
+}
+
+/**
+ * It specifies if the DID will be published on-chain initially or not.
+ */
+export enum PublishOnChainOptions {
+  DIDRegistry = 0, // The DID and the reference to the DDO will be stored in the DIDRegistry contract
+  OnlyOffchain = 1, // THE DID won't be stored on-chain and will be lazy-registered when needed
+}
+
+export class AssetPublicationOptions {
+  metadata?: PublishMetadataOptions = PublishMetadataOptions.OnlyMetadataAPI
+  did?: PublishOnChainOptions = PublishOnChainOptions.DIDRegistry
+}
+
+export interface SearchResults {
+  value: number
+  relation: 'eq' | 'gte'
+}
+
+export interface QueryResult {
+  results: DDO[]
+  page: number
+  totalPages: number
+  totalResults: { [jsonPath: string]: any }
+}
+
+export interface MarketplaceResults<Entity> {
+  page: number
+  results: Entity[]
+  total_pages: number
+  total_results: SearchResults
+}
+
+export interface SearchQuery {
+  offset?: number
+  page?: number
+  text?: string
+  query?: unknown
+  sort?: unknown
+  show_unlisted?: boolean
+  appId?: string
+}
+
+export enum PermissionType {
+  Read = 'read',
+  Update = 'update',
+  Delete = 'delete',
+  Admin = 'admin',
+}
+
+export interface NewPermission {
+  userId: string
+  type: PermissionType[]
+  issuer: string
+  holder: string
+}
+
+export interface Permission extends NewPermission {
+  id: string
+  issuanceDate: Date
+}
+
+export enum PaymentMethodsAccepted {
+  Crypto = 'crypto',
+  Fiat = 'fiat',
+  All = 'all',
+  NotSelected = 'notSelected',
+}
+
+export enum State {
+  Disabled = 'disabled',
+  Unconfirmed = 'unconfirmed',
+  Confirmed = 'confirmed',
+}
+
+export interface Stripe {
+  accountId?: string | null
+  isAccountValidated?: boolean
+  accountCreatedAt?: string
+  accountUpdatedAt?: string
+  additionalInformation?: unknown
+}
+
+export interface AdditionalInformation {
+  privyUserId?: string
+  privyWalletId?: string
+}
+
+export interface NewProfile {
+  isListed: boolean
+  state: State
+  addresses: string[]
+  nickname: string
+  name?: string
+  email?: string
+  live?: Stripe
+  sandbox?: Stripe
+  paymentCountry?: string
+  additionalInformation?: unknown
+}
+
+export interface Profile extends NewProfile {
+  userId: string
+  creationDate: Date
+  updateDate: Date
+}
+
+export interface ReducedProfile {
+  userId: string
+  nickname?: string
+  live?: Stripe
+  sandbox?: Stripe
+  additionalInformation?: unknown
+}

package/src/lib/types/TranscoderTypes.ts

@@ -0,0 +1,29 @@
+export enum Flavor {
+  Avatar = 0,
+  Cover = 1,
+  Animation = 2,
+  Image = 3,
+  Video = 4,
+  Audio = 5,
+  Terms = 6,
+  Private = 7,
+  SampleData = 8,
+}
+
+export enum FlavorFolder {
+  Avatars = 'avatars',
+  Covers = 'covers',
+  Animations = 'animations',
+  Images = 'images',
+  Videos = 'videos',
+  Audios = 'audios',
+  Terms = 'terms',
+  Privates = 'private',
+  SampleData = 'sample-data',
+}
+
+export enum TranscodingStatus {
+  Pending = 'Pending',
+  Done = 'Done',
+  Error = 'Error',
+}

package/src/lib/types/index.ts

@@ -0,0 +1,6 @@
+export * from './ContractsTypes.js'
+export * from './DDOTypes.js'
+export * from './GeneralTypes.js'
+export * from './MetadataTypes.js'
+export * from './TranscoderTypes.js'
+export * from './types.js'

package/src/lib/types/types.ts

@@ -0,0 +1,264 @@
+import * as jose from 'jose'
+
+export 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 enum PointsRulesCategory {
+  wau = 'wau',
+  supply = 'supply',
+  purchases = 'purchases',
+  demand = 'demand',
+  curation = 'curation',
+  network = 'network',
+  other = 'other',
+}
+
+export enum PointsRulesRecurrency {
+  unlimitted = 'unlimitted',
+  timeslimitted = 'timeslimitted',
+  onlyonce = 'onlyonce',
+  onceperitem = 'onceperitem',
+  capday = 'capday',
+  capweek = 'capweek',
+  capmonth = 'capmonth',
+  capyear = 'capyear',
+  other = 'other',
+}
+
+export enum PointsEventStatus {
+  Pending = 'Pending',
+  Processed = 'Processed',
+  Failed = 'Failed',
+  Skipped = 'Skipped',
+  Other = 'Other',
+}
+
+export enum NotificationType {
+  SubscriptionReceived = 'SubscriptionReceived',
+  SubscriptionPurchased = 'SubscriptionPurchased',
+  AccountSetup = 'AccountSetup',
+  EmailValidation = 'EmailValidation',
+  Other = 'Other',
+}
+
+export enum NotificationOriginator {
+  Nevermined = 'Nevermined',
+  Other = 'Other',
+}
+
+export enum NotificationReadStatus {
+  Pending = 'Pending',
+  Read = 'Read',
+  Deleted = 'Deleted',
+  Other = 'Other',
+}
+
+export enum NotificationDeliveryStatus {
+  Pending = 'Pending',
+  Sent = 'Sent',
+  Failed = 'Failed',
+  NotRequired = 'NotRequired',
+  Skipped = 'Skipped',
+  Other = 'Other',
+}
+
+export enum EmailChallengeStatus {
+  Pending = 'Pending',
+  Validated = 'Validated',
+  Failed = 'Failed',
+}
+
+export enum PlanTransactionType {
+  Purchase = 'Purchase',
+  Mint = 'Mint',
+  Burn = 'Burn',
+  Transfer = 'Transfer',
+  Error = 'Error',
+  Other = 'Other',
+}
+
+export enum PlanTransactionPaymentType {
+  Crypto = 'Crypto',
+  Fiat = 'Fiat',
+}
+
+export enum CheckoutSessionType {
+  embedded = 'embedded',
+  redirect = 'redirect',
+}
+
+export enum WidgetLayout {
+  Horizontal = 'Horizontal',
+  Vertical = 'Vertical',
+  Reduced = 'Reduced',
+}
+
+export enum StripeEventStatus {
+  Pending = 'Pending',
+  Done = 'Done',
+  Error = 'Error',
+  Ignored = 'Ignored',
+  Other = 'Other',
+}
+
+export enum ResultType {
+  matrix = 'matrix',
+  vector = 'vector',
+  scalar = 'scalar',
+  string = 'string',
+}
+
+export 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 const DEFAULT_PAGE = 1
+export const DEFAULT_OFFSET = 10_000
+
+export interface PaginationOptions {
+  page: number
+  skip: number
+  offset: number
+  sortBy?: string
+  sortOrder?: 'asc' | 'desc'
+}
+
+export enum TaskLogLevel {
+  debug = 'debug',
+  info = 'info',
+  warn = 'warn',
+  error = 'error',
+}
+
+export 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 const NVM_USERID_HEADER = 'NVM-User-id'
+export const NVM_COST_HEADER = 'NVMCreditsConsumed'
+export const DEFAULT_COST_CREDITS = '1'
+
+export enum OrganizationType {
+  Free = 'Free',
+  Premium = 'Premium',
+  Enterprise = 'Enterprise',
+  Other = 'Other',
+}
+
+export enum OrganizationMemberRole {
+  Admin = 'Admin',
+  Member = 'Member',
+}
+
+export interface Branding {
+  // Theme name (e.g., 'default', 'gradient', 'dark', 'ocean', 'sunset', 'custom')
+  themeName?: string
+
+  // Company logo
+  logo?: string
+
+  // Left panel colors
+  leftPanelHeadingTextColor?: string
+  leftPanelBodyTextColor?: string
+  leftPanelBackgroundColor1?: string
+  leftPanelBackgroundColor2?: string
+  leftPanelBackgroundImageUrl?: string // Alternative to background colors
+
+  // Right card colors
+  rightCardTextColor?: string
+  rightCardButtonBackgroundColor?: string
+  rightCardButtonTextColor?: string
+  rightCardBackgroundColor1?: string
+  rightCardBackgroundColor2?: string
+  rightCardBackgroundImageUrl?: string // Alternative to background colors
+}