Skip to main content

List Packages

Fetch a paginated list of published packages.
query GetPackages($page: Int, $limit: Int) {
  packages(page: $page, limit: $limit) {
    data {
      id
      version
      createdAt
    }
    pagination {
      page
      limit
      total
      pages
    }
  }
}

Parameters

ParameterTypeDefaultDescription
pageInt1Page number
limitInt20Items per page

Example

query {
  packages(page: 1, limit: 10) {
    data {
      id
      version
      createdAt
    }
    pagination {
      total
    }
  }
}
Response:
{
  "data": {
    "packages": {
      "data": [
        {
          "id": "pkg123",
          "version": "2.1.0",
          "createdAt": "2024-01-15T10:30:00Z"
        },
        {
          "id": "pkg122",
          "version": "2.0.0",
          "createdAt": "2024-01-10T14:20:00Z"
        }
      ],
      "pagination": {
        "total": 15
      }
    }
  }
}

Get Package by Version

Fetch a specific package by semantic version.
query GetPackage($version: String!) {
  package(version: $version) {
    id
    version
    components {
      id
      name
      compiled
    }
    assets {
      id
      name
      url
    }
    dependencies {
      projectId
      version
    }
    compiled
    resolved {
      package {
        version
        components
        assets
      }
      dependencies {
        version
        components
        assets
      }
    }
  }
}

Parameters

ParameterTypeRequiredDescription
versionString!YesSemantic version (e.g., “1.0.0”)

Example

query {
  package(version: "1.0.0") {
    id
    version
    components {
      id
      name
    }
    resolved {
      package {
        version
        components
      }
    }
  }
}
Response:
{
  "data": {
    "package": {
      "id": "pkg100",
      "version": "1.0.0",
      "components": [
        {
          "id": "comp123",
          "name": "ProductCard"
        },
        {
          "id": "comp124",
          "name": "ArticleLayout"
        }
      ],
      "resolved": {
        "package": {
          "version": "1.0.0",
          "components": "{\"ProductCard\":\"const body = ...\",\"ArticleLayout\":\"const body = ...\"}"
        }
      }
    }
  }
}

Package Fields

FieldTypeDescription
idID!Unique identifier
versionString!Semantic version
components[Component!]!Components in package
assets[Asset!]Assets bundled with package
dependencies[Dependency!]External package dependencies
compiledStringCompiled package bundle
resolvedResolvedPackageFully resolved package data
createdAtDateTime!Publication timestamp

Resolved Package Data

Use resolved to get all package data in a single request, or use resolvedPackageData for normalized caching.
query {
  package(version: "1.0.0") {
    resolved {
      package {
        id
        version
        components
        assets
      }
      dependencies {
        id
        version
        components
        assets
      }
    }
  }
}