Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        AddScopeMemberRequest: { githubLogin: string };
        Authorization: {
            code: string;
            expiresAt: string;
            permissions: (
                | { permission: "package/publish"; scope: string }
                | { package: string; permission: "package/publish"; scope: string }
                | {
                    package: string;
                    permission: "package/publish";
                    scope: string;
                    tarballHash: string;
                    version: string;
                }
            )[];
        };
        AuthorizationExchangeRequest: { exchangeToken: string; verifier: string };
        AuthorizationExchangeResponse: {
            token: string;
            user: {
                avatarUrl: string;
                createdAt: string;
                email?: string;
                githubId?: number;
                id: string;
                inviteCount?: number;
                isBlocked?: boolean;
                isStaff?: boolean;
                name: string;
                scopeLimit?: number;
                scopeUsage?: number;
                updatedAt: string;
            };
        };
        CreateAuthorizationRequest: {
            challenge: string;
            permissions?: (
                | { permission: "package/publish"; scope: string }
                | { package: string; permission: "package/publish"; scope: string }
                | {
                    package: string;
                    permission: "package/publish";
                    scope: string;
                    tarballHash: string;
                    version: string;
                }
            )[];
        };
        CreateAuthorizationResponse: {
            code: string;
            exchangeToken: string;
            expiresAt: string;
            pollInterval: number;
            verificationUrl?: string;
        };
        CreatePackageRequest: { package: string };
        CreateScopeRequest: { scope?: string };
        Dependency: {
            constraint: string;
            kind: "jsr" | "npm";
            name: string;
            path: string;
        };
        Dependent: {
            name: string;
            scope: string;
            totalVersions: number;
            versions?: string[];
        };
        Error: { code: string; message: string };
        GitHubRepository: { name?: string; owner?: string };
        Package: {
            createdAt: string;
            description: string;
            githubRepository?: { name?: string; owner?: string };
            name: string;
            runtimeCompat?: {
                browser?: null | boolean;
                bun?: null | boolean;
                deno?: null | boolean;
                node?: null | boolean;
                workerd?: null | boolean;
            };
            scope: string;
            score?: number;
            updatedAt: string;
        };
        PackageName: string;
        PackageScore: {
            allEntrypointsDocs: boolean;
            allFastCheck: boolean;
            atLeastOneRuntimeCompatible: boolean;
            hasDescription: boolean;
            hasProvenance: boolean;
            hasReadme: boolean;
            hasReadmeExamples: boolean;
            multipleRuntimesCompatible: boolean;
            percentageDocumentedSymbols: number;
            total?: number;
        };
        PackageVersion: {
            createdAt: string;
            package?: string;
            rekorLogId?: string;
            scope: string;
            updatedAt: string;
            version: string;
            yanked: boolean;
        };
        Permission: | { permission: "package/publish"; scope: string }
        | { package: string; permission: "package/publish"; scope: string }
        | {
            package: string;
            permission: "package/publish";
            scope: string;
            tarballHash: string;
            version: string;
        };
        PublishingTask: {
            createdAt: string;
            error: null
            | { code?: string; message?: string };
            id: string;
            packageName: string;
            packageScope: string;
            packageVersion: string;
            status: "pending" | "processing" | "processed" | "success" | "failure";
            updatedAt: string;
            userId: never;
        };
        RuntimeCompat: {
            browser?: null
            | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
        Scope: {
            createdAt: string;
            creator?: {
                avatarUrl: string;
                createdAt: string;
                email?: string;
                githubId?: number;
                id: string;
                inviteCount?: number;
                isBlocked?: boolean;
                isStaff?: boolean;
                name: string;
                scopeLimit?: number;
                scopeUsage?: number;
                updatedAt: string;
            };
            ghActionsVerifyActor?: boolean;
            quotas?: {
                newPackagePerWeekLimit?: number;
                newPackagePerWeekUsage?: number;
                packageLimit?: number;
                packageUsage?: number;
                publishAttemptsPerWeekLimit?: number;
                publishAttemptsPerWeekUsage?: number;
            };
            requirePublishingFromCI?: boolean;
            scope: string;
            updatedAt: string;
        };
        ScopeInvite: {
            createdAt: string;
            inviter: {
                avatarUrl: string;
                createdAt: string;
                email?: string;
                githubId?: number;
                id: string;
                inviteCount?: number;
                isBlocked?: boolean;
                isStaff?: boolean;
                name: string;
                scopeLimit?: number;
                scopeUsage?: number;
                updatedAt: string;
            };
            scope: string;
            targetUser: {
                avatarUrl: string;
                createdAt: string;
                email?: string;
                githubId?: number;
                id: string;
                inviteCount?: number;
                isBlocked?: boolean;
                isStaff?: boolean;
                name: string;
                scopeLimit?: number;
                scopeUsage?: number;
                updatedAt: string;
            };
            updatedAt: string;
        };
        ScopeMember: {
            createdAt: string;
            isAdmin: boolean;
            scope: string;
            updatedAt: string;
            user: {
                avatarUrl: string;
                createdAt: string;
                email?: string;
                githubId?: number;
                id: string;
                inviteCount?: number;
                isBlocked?: boolean;
                isStaff?: boolean;
                name: string;
                scopeLimit?: number;
                scopeUsage?: number;
                updatedAt: string;
            };
        };
        ScopeName: string;
        Stats: {
            featured: {
                createdAt: string;
                description: string;
                githubRepository?: { name?: string; owner?: string };
                name: string;
                runtimeCompat?: {
                    browser?: null | boolean;
                    bun?: null | boolean;
                    deno?: null | boolean;
                    node?: null | boolean;
                    workerd?: null | boolean;
                };
                scope: string;
                score?: number;
                updatedAt: string;
            }[];
            newest: {
                createdAt: string;
                description: string;
                githubRepository?: { name?: string; owner?: string };
                name: string;
                runtimeCompat?: {
                    browser?: null | boolean;
                    bun?: null | boolean;
                    deno?: null | boolean;
                    node?: null | boolean;
                    workerd?: null | boolean;
                };
                scope: string;
                score?: number;
                updatedAt: string;
            }[];
            updated: {
                createdAt: string;
                package?: string;
                rekorLogId?: string;
                scope: string;
                updatedAt: string;
                version: string;
                yanked: boolean;
            }[];
        };
        UpdatePackageRequest: | { description: string }
        | { githubRepository: null | { owner: string; repo: string } }
        | {
            runtimeCompat: {
                browser?: null | boolean;
                bun?: null | boolean;
                deno?: null | boolean;
                node?: null | boolean;
                workerd?: null | boolean;
            };
        }
        | { isArchived: boolean };
        UpdatePackageVersionRequest: { yanked: boolean };
        UpdateScopeMemberRequest: { isAdmin: boolean };
        UpdateScopeRequest:
            | { ghActionsVerifyActor: boolean }
            | { requirePublishingFromCI: boolean };
        User: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
        UserId: string;
        Version: string;
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    AddScopeMemberRequest: { githubLogin: string };
    Authorization: {
        code: string;
        expiresAt: string;
        permissions: (
            | { permission: "package/publish"; scope: string }
            | { package: string; permission: "package/publish"; scope: string }
            | {
                package: string;
                permission: "package/publish";
                scope: string;
                tarballHash: string;
                version: string;
            }
        )[];
    };
    AuthorizationExchangeRequest: { exchangeToken: string; verifier: string };
    AuthorizationExchangeResponse: {
        token: string;
        user: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
    };
    CreateAuthorizationRequest: {
        challenge: string;
        permissions?: (
            | { permission: "package/publish"; scope: string }
            | { package: string; permission: "package/publish"; scope: string }
            | {
                package: string;
                permission: "package/publish";
                scope: string;
                tarballHash: string;
                version: string;
            }
        )[];
    };
    CreateAuthorizationResponse: {
        code: string;
        exchangeToken: string;
        expiresAt: string;
        pollInterval: number;
        verificationUrl?: string;
    };
    CreatePackageRequest: { package: string };
    CreateScopeRequest: { scope?: string };
    Dependency: {
        constraint: string;
        kind: "jsr" | "npm";
        name: string;
        path: string;
    };
    Dependent: {
        name: string;
        scope: string;
        totalVersions: number;
        versions?: string[];
    };
    Error: { code: string; message: string };
    GitHubRepository: { name?: string; owner?: string };
    Package: {
        createdAt: string;
        description: string;
        githubRepository?: { name?: string; owner?: string };
        name: string;
        runtimeCompat?: {
            browser?: null | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
        scope: string;
        score?: number;
        updatedAt: string;
    };
    PackageName: string;
    PackageScore: {
        allEntrypointsDocs: boolean;
        allFastCheck: boolean;
        atLeastOneRuntimeCompatible: boolean;
        hasDescription: boolean;
        hasProvenance: boolean;
        hasReadme: boolean;
        hasReadmeExamples: boolean;
        multipleRuntimesCompatible: boolean;
        percentageDocumentedSymbols: number;
        total?: number;
    };
    PackageVersion: {
        createdAt: string;
        package?: string;
        rekorLogId?: string;
        scope: string;
        updatedAt: string;
        version: string;
        yanked: boolean;
    };
    Permission: | { permission: "package/publish"; scope: string }
    | { package: string; permission: "package/publish"; scope: string }
    | {
        package: string;
        permission: "package/publish";
        scope: string;
        tarballHash: string;
        version: string;
    };
    PublishingTask: {
        createdAt: string;
        error: null
        | { code?: string; message?: string };
        id: string;
        packageName: string;
        packageScope: string;
        packageVersion: string;
        status: "pending" | "processing" | "processed" | "success" | "failure";
        updatedAt: string;
        userId: never;
    };
    RuntimeCompat: {
        browser?: null
        | boolean;
        bun?: null | boolean;
        deno?: null | boolean;
        node?: null | boolean;
        workerd?: null | boolean;
    };
    Scope: {
        createdAt: string;
        creator?: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
        ghActionsVerifyActor?: boolean;
        quotas?: {
            newPackagePerWeekLimit?: number;
            newPackagePerWeekUsage?: number;
            packageLimit?: number;
            packageUsage?: number;
            publishAttemptsPerWeekLimit?: number;
            publishAttemptsPerWeekUsage?: number;
        };
        requirePublishingFromCI?: boolean;
        scope: string;
        updatedAt: string;
    };
    ScopeInvite: {
        createdAt: string;
        inviter: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
        scope: string;
        targetUser: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
        updatedAt: string;
    };
    ScopeMember: {
        createdAt: string;
        isAdmin: boolean;
        scope: string;
        updatedAt: string;
        user: {
            avatarUrl: string;
            createdAt: string;
            email?: string;
            githubId?: number;
            id: string;
            inviteCount?: number;
            isBlocked?: boolean;
            isStaff?: boolean;
            name: string;
            scopeLimit?: number;
            scopeUsage?: number;
            updatedAt: string;
        };
    };
    ScopeName: string;
    Stats: {
        featured: {
            createdAt: string;
            description: string;
            githubRepository?: { name?: string; owner?: string };
            name: string;
            runtimeCompat?: {
                browser?: null | boolean;
                bun?: null | boolean;
                deno?: null | boolean;
                node?: null | boolean;
                workerd?: null | boolean;
            };
            scope: string;
            score?: number;
            updatedAt: string;
        }[];
        newest: {
            createdAt: string;
            description: string;
            githubRepository?: { name?: string; owner?: string };
            name: string;
            runtimeCompat?: {
                browser?: null | boolean;
                bun?: null | boolean;
                deno?: null | boolean;
                node?: null | boolean;
                workerd?: null | boolean;
            };
            scope: string;
            score?: number;
            updatedAt: string;
        }[];
        updated: {
            createdAt: string;
            package?: string;
            rekorLogId?: string;
            scope: string;
            updatedAt: string;
            version: string;
            yanked: boolean;
        }[];
    };
    UpdatePackageRequest: | { description: string }
    | { githubRepository: null | { owner: string; repo: string } }
    | {
        runtimeCompat: {
            browser?: null | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
    }
    | { isArchived: boolean };
    UpdatePackageVersionRequest: { yanked: boolean };
    UpdateScopeMemberRequest: { isAdmin: boolean };
    UpdateScopeRequest:
        | { ghActionsVerifyActor: boolean }
        | { requirePublishingFromCI: boolean };
    User: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
    UserId: string;
    Version: string;
}

Type declaration

AddScopeMemberRequest: { githubLogin: string }
- githubLogin: string
  Description
  The GitHub login of the user to add to the scope.
  Example
```
ry
```
Authorization: {
    code: string;
    expiresAt: string;
    permissions: (
        | { permission: "package/publish"; scope: string }
        | { package: string; permission: "package/publish"; scope: string }
        | {
            package: string;
            permission: "package/publish";
            scope: string;
            tarballHash: string;
            version: string;
        }
    )[];
}
- code: string
  Description
  The authorization code.
- expiresAt: string
  Format: date-time
  
  Description
  The date and time until which the authorization can be approved / exchanged.
- permissions: (
      | { permission: "package/publish"; scope: string }
      | { package: string; permission: "package/publish"; scope: string }
      | {
          package: string;
          permission: "package/publish";
          scope: string;
          tarballHash: string;
          version: string;
      }
  )[]
  Description
  The permissions that the token will have.
AuthorizationExchangeRequest: { exchangeToken: string; verifier: string }
- exchangeToken: string
  Description
  The token that can be used to exchange for a device token after the authorization has been approved.
- verifier: string
  Description
  The verifier that was used to generate the challenge.
AuthorizationExchangeResponse: {
    token: string;
    user: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
}
- token: string
  Description
  The device token that can be used to authenticate requests.
- user: {
      avatarUrl: string;
      createdAt: string;
      email?: string;
      githubId?: number;
      id: string;
      inviteCount?: number;
      isBlocked?: boolean;
      isStaff?: boolean;
      name: string;
      scopeLimit?: number;
      scopeUsage?: number;
      updatedAt: string;
  }
  - avatarUrl: string
    Description
    The URL to the user's avatar.
    Example
    https://avatars.githubusercontent.com/u/80?v=4
  - createdAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was created.
  - Optionalemail?: string
    Description
    The user's email address.
    Example
    ry@example.com
  - OptionalgithubId?: number
    Description
    The user's GitHub ID.
    Example
    80
  - id: string
  - OptionalinviteCount?: number
    Description
    The number of invites pending for the user.
    Example
    3
  - OptionalisBlocked?: boolean
    Description
    Whether the user is blocked from using the registry.
  - OptionalisStaff?: boolean
    Description
    Whether the user is a staff member.
  - name: string
    Description
    The user's display name.
    Example
    Ryan Dahl
  - OptionalscopeLimit?: number
    Description
    The maximum number of scopes the user can create.
    Example
    10
  - OptionalscopeUsage?: number
    Description
    The number of scopes the user created.
    Example
    3
  - updatedAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was last updated.
CreateAuthorizationRequest: {
    challenge: string;
    permissions?: (
        | { permission: "package/publish"; scope: string }
        | { package: string; permission: "package/publish"; scope: string }
        | {
            package: string;
            permission: "package/publish";
            scope: string;
            tarballHash: string;
            version: string;
        }
    )[];
}
- challenge: string
  Description
  The challenge that will later be needed to retrieve the token after authorization.
  Example
```
1234567890abcdef
```
- Optionalpermissions?: (
      | { permission: "package/publish"; scope: string }
      | { package: string; permission: "package/publish"; scope: string }
      | {
          package: string;
          permission: "package/publish";
          scope: string;
          tarballHash: string;
          version: string;
      }
  )[]
  Description
  The permissions that the token will have.
CreateAuthorizationResponse: {
    code: string;
    exchangeToken: string;
    expiresAt: string;
    pollInterval: number;
    verificationUrl?: string;
}
- code: string
  Description
  The authorization code that the user can manually enter if they can not directly visit the link.
- exchangeToken: string
  Description
  The token that can be used to exchange for a device token after the authorization has been approved.
- expiresAt: string
  Format: date-time
  
  Description
  The date and time until which the authorization can be approved / exchanged.
- pollInterval: number
  Description
  The number of seconds that should be waited between polling the status of the authorization.
- OptionalverificationUrl?: string
  Description
  The URL that the user should visit to approve the authorization.
CreatePackageRequest: { package: string }
CreateScopeRequest: { scope?: string }
Dependency: { constraint: string; kind: "jsr" | "npm"; name: string; path: string }
- constraint: string
  Description
  The semver constraint of the dependency.
  Example
```
^0.50.0
```
- kind: "jsr" | "npm"
  Description
  The kind of dependency.
- name: string
  Description
  The fully qualified name of the dependency.
  Example
```
@std/fs
```
- path: string
  Description
  The path being imported from the dependency. This may be the empty string if the "default entrypoint" is being imported.
  Example
```
/exists
```
Dependent: { name: string; scope: string; totalVersions: number; versions?: string[] }
- name: string
- scope: string
- totalVersions: number
  Description
  The total number of versions of the package.
- Optionalversions?: string[]
Error: { code: string; message: string }
- code: string
  Description
  The error code.
- message: string
  Description
  The error message.
GitHubRepository: { name?: string; owner?: string }
- Optionalname?: string
  Description
  The GitHub repository name.
  Example
```
deno
```
- Optionalowner?: string
  Description
  The GitHub user / organization of the repository.
  Example
```
denoland
```
Package: {
    createdAt: string;
    description: string;
    githubRepository?: { name?: string; owner?: string };
    name: string;
    runtimeCompat?: {
        browser?: null | boolean;
        bun?: null | boolean;
        deno?: null | boolean;
        node?: null | boolean;
        workerd?: null | boolean;
    };
    scope: string;
    score?: number;
    updatedAt: string;
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the package was created.
- description: string
  Description
  The description of the package.
  Example
```
A module for formatting strings.
```
- OptionalgithubRepository?: { name?: string; owner?: string }
  - Optionalname?: string
    Description
    The GitHub repository name.
    Example
    deno
  - Optionalowner?: string
    Description
    The GitHub user / organization of the repository.
    Example
    denoland
- name: string
- OptionalruntimeCompat?: {
      browser?: null | boolean;
      bun?: null | boolean;
      deno?: null | boolean;
      node?: null | boolean;
      workerd?: null | boolean;
  }
  - Optionalbrowser?: null | boolean
    Description
    Whether the package is compatible with web browsers.
  - Optionalbun?: null | boolean
    Description
    Whether the package is compatible with Bun.
  - Optionaldeno?: null | boolean
    Description
    Whether the package is compatible with Deno.
  - Optionalnode?: null | boolean
    Description
    Whether the package is compatible with Node.js.
  - Optionalworkerd?: null | boolean
    Description
    Whether the package is compatible with workerd.
- scope: string
- Optionalscore?: number
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the package was last updated.
PackageName: string
Description
The name of a package.
Example
```
fmt
```
PackageScore: {
    allEntrypointsDocs: boolean;
    allFastCheck: boolean;
    atLeastOneRuntimeCompatible: boolean;
    hasDescription: boolean;
    hasProvenance: boolean;
    hasReadme: boolean;
    hasReadmeExamples: boolean;
    multipleRuntimesCompatible: boolean;
    percentageDocumentedSymbols: number;
    total?: number;
}
PackageVersion: {
    createdAt: string;
    package?: string;
    rekorLogId?: string;
    scope: string;
    updatedAt: string;
    version: string;
    yanked: boolean;
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the package version was created.
- Optionalpackage?: string
- OptionalrekorLogId?: string
  Description
  Rekor log ID for the published package version.
- scope: string
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the package version was last updated.
- version: string
- yanked: boolean
  Description
  Whether the version has been yanked.
Permission:
    | { permission: "package/publish"; scope: string }
    | { package: string; permission: "package/publish"; scope: string }
    | {
        package: string;
        permission: "package/publish";
        scope: string;
        tarballHash: string;
        version: string;
    }
PublishingTask: {
    createdAt: string;
    error: null | { code?: string; message?: string };
    id: string;
    packageName: string;
    packageScope: string;
    packageVersion: string;
    status: "pending" | "processing" | "processed" | "success" | "failure";
    updatedAt: string;
    userId: never;
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the publishing task was created.
- error: null | { code?: string; message?: string }
- id: string
  Format: uuid
  
  Description
  The ID of the publishing task.
- packageName: string
- packageScope: string
- packageVersion: string
- status: "pending" | "processing" | "processed" | "success" | "failure"
  Description
  The status of the publishing task.
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the publishing task was last updated.
- userId: never
RuntimeCompat: {
    browser?: null | boolean;
    bun?: null | boolean;
    deno?: null | boolean;
    node?: null | boolean;
    workerd?: null | boolean;
}
- Optionalbrowser?: null | boolean
  Description
  Whether the package is compatible with web browsers.
- Optionalbun?: null | boolean
  Description
  Whether the package is compatible with Bun.
- Optionaldeno?: null | boolean
  Description
  Whether the package is compatible with Deno.
- Optionalnode?: null | boolean
  Description
  Whether the package is compatible with Node.js.
- Optionalworkerd?: null | boolean
  Description
  Whether the package is compatible with workerd.
Scope: {
    createdAt: string;
    creator?: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
    ghActionsVerifyActor?: boolean;
    quotas?: {
        newPackagePerWeekLimit?: number;
        newPackagePerWeekUsage?: number;
        packageLimit?: number;
        packageUsage?: number;
        publishAttemptsPerWeekLimit?: number;
        publishAttemptsPerWeekUsage?: number;
    };
    requirePublishingFromCI?: boolean;
    scope: string;
    updatedAt: string;
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the scope was created.
- Optionalcreator?: {
      avatarUrl: string;
      createdAt: string;
      email?: string;
      githubId?: number;
      id: string;
      inviteCount?: number;
      isBlocked?: boolean;
      isStaff?: boolean;
      name: string;
      scopeLimit?: number;
      scopeUsage?: number;
      updatedAt: string;
  }
  - avatarUrl: string
    Description
    The URL to the user's avatar.
    Example
    https://avatars.githubusercontent.com/u/80?v=4
  - createdAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was created.
  - Optionalemail?: string
    Description
    The user's email address.
    Example
    ry@example.com
  - OptionalgithubId?: number
    Description
    The user's GitHub ID.
    Example
    80
  - id: string
  - OptionalinviteCount?: number
    Description
    The number of invites pending for the user.
    Example
    3
  - OptionalisBlocked?: boolean
    Description
    Whether the user is blocked from using the registry.
  - OptionalisStaff?: boolean
    Description
    Whether the user is a staff member.
  - name: string
    Description
    The user's display name.
    Example
    Ryan Dahl
  - OptionalscopeLimit?: number
    Description
    The maximum number of scopes the user can create.
    Example
    10
  - OptionalscopeUsage?: number
    Description
    The number of scopes the user created.
    Example
    3
  - updatedAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was last updated.
- OptionalghActionsVerifyActor?: boolean
  Description
  Whether to verify the actor of a GitHub Actions run when authenticating publishing with a GitHub Actions OIDC token.
- Optionalquotas?: {
      newPackagePerWeekLimit?: number;
      newPackagePerWeekUsage?: number;
      packageLimit?: number;
      packageUsage?: number;
      publishAttemptsPerWeekLimit?: number;
      publishAttemptsPerWeekUsage?: number;
  }
  - OptionalnewPackagePerWeekLimit?: number
    Description
    The maximum number of new packages allowed to be created in the scope in a week.
    Example
    5
  - OptionalnewPackagePerWeekUsage?: number
    Description
    The number of new packages created in the scope in the last week.
    Example
    1
  - OptionalpackageLimit?: number
    Description
    The maximum number of packages allowed in the scope.
    Example
    10
  - OptionalpackageUsage?: number
    Description
    The number of packages in the scope.
    Example
    3
  - OptionalpublishAttemptsPerWeekLimit?: number
    Description
    The maximum number of times packages in the scope can be published in a week.
    Example
    5
  - OptionalpublishAttemptsPerWeekUsage?: number
    Description
    The number of times packages in the scope have been published in the last week.
    Example
    1
- OptionalrequirePublishingFromCI?: boolean
  Description
  Whether to require publishing from a CI environment. This disables publishing from a local environment.
- scope: string
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the scope was last updated.
ScopeInvite: {
    createdAt: string;
    inviter: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
    scope: string;
    targetUser: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
    updatedAt: string;
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the invite was created.
- inviter: {
      avatarUrl: string;
      createdAt: string;
      email?: string;
      githubId?: number;
      id: string;
      inviteCount?: number;
      isBlocked?: boolean;
      isStaff?: boolean;
      name: string;
      scopeLimit?: number;
      scopeUsage?: number;
      updatedAt: string;
  }
  - avatarUrl: string
    Description
    The URL to the user's avatar.
    Example
    https://avatars.githubusercontent.com/u/80?v=4
  - createdAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was created.
  - Optionalemail?: string
    Description
    The user's email address.
    Example
    ry@example.com
  - OptionalgithubId?: number
    Description
    The user's GitHub ID.
    Example
    80
  - id: string
  - OptionalinviteCount?: number
    Description
    The number of invites pending for the user.
    Example
    3
  - OptionalisBlocked?: boolean
    Description
    Whether the user is blocked from using the registry.
  - OptionalisStaff?: boolean
    Description
    Whether the user is a staff member.
  - name: string
    Description
    The user's display name.
    Example
    Ryan Dahl
  - OptionalscopeLimit?: number
    Description
    The maximum number of scopes the user can create.
    Example
    10
  - OptionalscopeUsage?: number
    Description
    The number of scopes the user created.
    Example
    3
  - updatedAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was last updated.
- scope: string
- targetUser: {
      avatarUrl: string;
      createdAt: string;
      email?: string;
      githubId?: number;
      id: string;
      inviteCount?: number;
      isBlocked?: boolean;
      isStaff?: boolean;
      name: string;
      scopeLimit?: number;
      scopeUsage?: number;
      updatedAt: string;
  }
  - avatarUrl: string
    Description
    The URL to the user's avatar.
    Example
    https://avatars.githubusercontent.com/u/80?v=4
  - createdAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was created.
  - Optionalemail?: string
    Description
    The user's email address.
    Example
    ry@example.com
  - OptionalgithubId?: number
    Description
    The user's GitHub ID.
    Example
    80
  - id: string
  - OptionalinviteCount?: number
    Description
    The number of invites pending for the user.
    Example
    3
  - OptionalisBlocked?: boolean
    Description
    Whether the user is blocked from using the registry.
  - OptionalisStaff?: boolean
    Description
    Whether the user is a staff member.
  - name: string
    Description
    The user's display name.
    Example
    Ryan Dahl
  - OptionalscopeLimit?: number
    Description
    The maximum number of scopes the user can create.
    Example
    10
  - OptionalscopeUsage?: number
    Description
    The number of scopes the user created.
    Example
    3
  - updatedAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was last updated.
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the invite was last updated.
ScopeMember: {
    createdAt: string;
    isAdmin: boolean;
    scope: string;
    updatedAt: string;
    user: {
        avatarUrl: string;
        createdAt: string;
        email?: string;
        githubId?: number;
        id: string;
        inviteCount?: number;
        isBlocked?: boolean;
        isStaff?: boolean;
        name: string;
        scopeLimit?: number;
        scopeUsage?: number;
        updatedAt: string;
    };
}
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the user was added to the scope.
- isAdmin: boolean
  Description
  Whether the user is an admin of the scope.
- scope: string
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the scope member roles were last updated.
- user: {
      avatarUrl: string;
      createdAt: string;
      email?: string;
      githubId?: number;
      id: string;
      inviteCount?: number;
      isBlocked?: boolean;
      isStaff?: boolean;
      name: string;
      scopeLimit?: number;
      scopeUsage?: number;
      updatedAt: string;
  }
  - avatarUrl: string
    Description
    The URL to the user's avatar.
    Example
    https://avatars.githubusercontent.com/u/80?v=4
  - createdAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was created.
  - Optionalemail?: string
    Description
    The user's email address.
    Example
    ry@example.com
  - OptionalgithubId?: number
    Description
    The user's GitHub ID.
    Example
    80
  - id: string
  - OptionalinviteCount?: number
    Description
    The number of invites pending for the user.
    Example
    3
  - OptionalisBlocked?: boolean
    Description
    Whether the user is blocked from using the registry.
  - OptionalisStaff?: boolean
    Description
    Whether the user is a staff member.
  - name: string
    Description
    The user's display name.
    Example
    Ryan Dahl
  - OptionalscopeLimit?: number
    Description
    The maximum number of scopes the user can create.
    Example
    10
  - OptionalscopeUsage?: number
    Description
    The number of scopes the user created.
    Example
    3
  - updatedAt: string
    Format: date-time
    
    Description
    The date and time when the user profile was last updated.
ScopeName: string
Description
The name of a scope. This must not be @ prefixed.
Example
```
denoland
```
Stats: {
    featured: {
        createdAt: string;
        description: string;
        githubRepository?: { name?: string; owner?: string };
        name: string;
        runtimeCompat?: {
            browser?: null | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
        scope: string;
        score?: number;
        updatedAt: string;
    }[];
    newest: {
        createdAt: string;
        description: string;
        githubRepository?: { name?: string; owner?: string };
        name: string;
        runtimeCompat?: {
            browser?: null | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
        scope: string;
        score?: number;
        updatedAt: string;
    }[];
    updated: {
        createdAt: string;
        package?: string;
        rekorLogId?: string;
        scope: string;
        updatedAt: string;
        version: string;
        yanked: boolean;
    }[];
}
- featured: {
      createdAt: string;
      description: string;
      githubRepository?: { name?: string; owner?: string };
      name: string;
      runtimeCompat?: {
          browser?: null | boolean;
          bun?: null | boolean;
          deno?: null | boolean;
          node?: null | boolean;
          workerd?: null | boolean;
      };
      scope: string;
      score?: number;
      updatedAt: string;
  }[]
  Description
  The featured packages
- newest: {
      createdAt: string;
      description: string;
      githubRepository?: { name?: string; owner?: string };
      name: string;
      runtimeCompat?: {
          browser?: null | boolean;
          bun?: null | boolean;
          deno?: null | boolean;
          node?: null | boolean;
          workerd?: null | boolean;
      };
      scope: string;
      score?: number;
      updatedAt: string;
  }[]
  Description
  The newest packages.
- updated: {
      createdAt: string;
      package?: string;
      rekorLogId?: string;
      scope: string;
      updatedAt: string;
      version: string;
      yanked: boolean;
  }[]
  Description
  The recently uploaded package versions.
UpdatePackageRequest:
    | { description: string }
    | { githubRepository: null | { owner: string; repo: string } }
    | {
        runtimeCompat: {
            browser?: null | boolean;
            bun?: null | boolean;
            deno?: null | boolean;
            node?: null | boolean;
            workerd?: null | boolean;
        };
    }
    | { isArchived: boolean }
UpdatePackageVersionRequest: { yanked: boolean }
- yanked: boolean
  Description
  Whether the version is yanked or not.
UpdateScopeMemberRequest: { isAdmin: boolean }
- isAdmin: boolean
  Description
  Whether the user should be an admin of the scope.
UpdateScopeRequest: { ghActionsVerifyActor: boolean } | { requirePublishingFromCI: boolean }
User: {
    avatarUrl: string;
    createdAt: string;
    email?: string;
    githubId?: number;
    id: string;
    inviteCount?: number;
    isBlocked?: boolean;
    isStaff?: boolean;
    name: string;
    scopeLimit?: number;
    scopeUsage?: number;
    updatedAt: string;
}
- avatarUrl: string
  Description
  The URL to the user's avatar.
  Example
```
https://avatars.githubusercontent.com/u/80?v=4
```
- createdAt: string
  Format: date-time
  
  Description
  The date and time when the user profile was created.
- Optionalemail?: string
  Description
  The user's email address.
  Example
```
ry@example.com
```
- OptionalgithubId?: number
  Description
  The user's GitHub ID.
  Example
```
80
```
- id: string
- OptionalinviteCount?: number
  Description
  The number of invites pending for the user.
  Example
```
3
```
- OptionalisBlocked?: boolean
  Description
  Whether the user is blocked from using the registry.
- OptionalisStaff?: boolean
  Description
  Whether the user is a staff member.
- name: string
  Description
  The user's display name.
  Example
```
Ryan Dahl
```
- OptionalscopeLimit?: number
  Description
  The maximum number of scopes the user can create.
  Example
```
10
```
- OptionalscopeUsage?: number
  Description
  The number of scopes the user created.
  Example
```
3
```
- updatedAt: string
  Format: date-time
  
  Description
  The date and time when the user profile was last updated.
UserId: string
Format: uuid

Description
The ID of a user.
Version: string
Description
A semantic version.
Example
```
1.2.3
```

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type declaration

AddScopeMemberRequest: { githubLogin: string }

githubLogin: string

Description

Example

Authorization: { code: string; expiresAt: string; permissions: ( | { permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string; tarballHash: string; version: string; } )[];}

code: string

Description

expiresAt: string

Description

permissions: ( | { permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string; tarballHash: string; version: string; })[]

Description

AuthorizationExchangeRequest: { exchangeToken: string; verifier: string }

exchangeToken: string

Description

verifier: string

Description

AuthorizationExchangeResponse: { token: string; user: { avatarUrl: string; createdAt: string; email?: string; githubId?: number; id: string; inviteCount?: number; isBlocked?: boolean; isStaff?: boolean; name: string; scopeLimit?: number; scopeUsage?: number; updatedAt: string; };}

token: string

Description

user: { avatarUrl: string; createdAt: string; email?: string; githubId?: number; id: string; inviteCount?: number; isBlocked?: boolean; isStaff?: boolean; name: string; scopeLimit?: number; scopeUsage?: number; updatedAt: string;}

avatarUrl: string

Description

Example

createdAt: string

Description

Optionalemail?: string

Description

Example

OptionalgithubId?: number

Description

Example

id: string

OptionalinviteCount?: number

Description

Example

OptionalisBlocked?: boolean

Description

OptionalisStaff?: boolean

Description

name: string

Description

Example

OptionalscopeLimit?: number

Description

Example

OptionalscopeUsage?: number

Description

Example

updatedAt: string

Description

CreateAuthorizationRequest: { challenge: string; permissions?: ( | { permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string; tarballHash: string; version: string; } )[];}

challenge: string

Description

Example

Optionalpermissions?: ( | { permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string } | { package: string; permission: "package/publish"; scope: string; tarballHash: string; version: string; })[]

Description

CreateAuthorizationResponse: { code: string; exchangeToken: string; expiresAt: string; pollInterval: number; verificationUrl?: string;}

code: string

Description

exchangeToken: string

Description

expiresAt: string

Description

pollInterval: number

Description

OptionalverificationUrl?: string

Description

CreatePackageRequest: { package: string }

CreateScopeRequest: { scope?: string }

Authorization: {
code: string;
expiresAt: string;
permissions: (
| { permission: "package/publish"; scope: string }
| { package: string; permission: "package/publish"; scope: string }
| {
package: string;
permission: "package/publish";
scope: string;
tarballHash: string;
version: string;
}
)[];
}

permissions: (
| { permission: "package/publish"; scope: string }
| { package: string; permission: "package/publish"; scope: string }
| {
package: string;
permission: "package/publish";
scope: string;
tarballHash: string;
version: string;
}
)[]

AuthorizationExchangeResponse: {
token: string;
user: {
avatarUrl: string;
createdAt: string;
email?: string;
githubId?: number;
id: string;
inviteCount?: number;
isBlocked?: boolean;
isStaff?: boolean;
name: string;
scopeLimit?: number;
scopeUsage?: number;
updatedAt: string;
};
}

user: {
avatarUrl: string;
createdAt: string;
email?: string;
githubId?: number;
id: string;
inviteCount?: number;
isBlocked?: boolean;
isStaff?: boolean;
name: string;
scopeLimit?: number;
scopeUsage?: number;
updatedAt: string;
}

`Optional`email?: string

`Optional`githubId?: number

`Optional`inviteCount?: number

`Optional`isBlocked?: boolean

`Optional`isStaff?: boolean

`Optional`scopeLimit?: number

`Optional`scopeUsage?: number

CreateAuthorizationRequest: {
challenge: string;
permissions?: (
| { permission: "package/publish"; scope: string }
| { package: string; permission: "package/publish"; scope: string }
| {
package: string;
permission: "package/publish";
scope: string;
tarballHash: string;
version: string;
}
)[];
}

`Optional`permissions?: (
| { permission: "package/publish"; scope: string }
| { package: string; permission: "package/publish"; scope: string }
| {
package: string;
permission: "package/publish";
scope: string;
tarballHash: string;
version: string;
}
)[]

CreateAuthorizationResponse: {
code: string;
exchangeToken: string;
expiresAt: string;
pollInterval: number;
verificationUrl?: string;
}

`Optional`verificationUrl?: string

`Optional`versions?: string[]

`Optional`name?: string

`Optional`owner?: string

`Optional`githubRepository?: { name?: string; owner?: string }

`Optional`name?: string

`Optional`owner?: string

`Optional`runtimeCompat?: {
browser?: null | boolean;
bun?: null | boolean;
deno?: null | boolean;
node?: null | boolean;
workerd?: null | boolean;
}

`Optional`browser?: null | boolean

`Optional`bun?: null | boolean

`Optional`deno?: null | boolean

`Optional`node?: null | boolean

`Optional`workerd?: null | boolean

`Optional`score?: number

PackageScore: {
allEntrypointsDocs: boolean;
allFastCheck: boolean;
atLeastOneRuntimeCompatible: boolean;
hasDescription: boolean;
hasProvenance: boolean;
hasReadme: boolean;
hasReadmeExamples: boolean;
multipleRuntimesCompatible: boolean;
percentageDocumentedSymbols: number;
total?: number;
}

PackageVersion: {
createdAt: string;
package?: string;
rekorLogId?: string;
scope: string;
updatedAt: string;
version: string;
yanked: boolean;
}

`Optional`package?: string

`Optional`rekorLogId?: string