@mterminal/marketplace-types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mTerminal contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,112 @@
+type Category = 'productivity' | 'language' | 'theme' | 'remote' | 'ai' | 'git' | 'other';
+interface ExtSummary {
+    id: string;
+    displayName: string;
+    description: string;
+    category: Category;
+    iconUrl?: string;
+    latestVersion: string;
+    downloadTotal: number;
+    avgStars?: number;
+    ratingCount: number;
+    authorLogin: string;
+    recommended: boolean;
+    apiRange: string;
+}
+interface VersionInfo {
+    version: string;
+    apiRange: string;
+    sizeBytes: number;
+    publishedAt: number;
+    yanked: boolean;
+}
+interface RatingDto {
+    userId: string;
+    userLogin: string;
+    stars: number;
+    comment?: string;
+    helpful: number;
+    createdAt: number;
+}
+interface ExtensionDetail extends ExtSummary {
+    homepageUrl?: string;
+    repoUrl?: string;
+    versions: VersionInfo[];
+    manifest: unknown;
+    ratings: RatingDto[];
+    readmeMd?: string;
+}
+interface DownloadInfo {
+    url: string;
+    sha256: string;
+    signatureB64: string;
+    keyId: string;
+    authorId: string;
+    sizeBytes: number;
+}
+type PolicyErrorCode = 'manifest' | 'signature' | 'static-scan' | 'capability' | 'duplicate-version' | 'unknown-key' | 'size-limit' | 'unauthorized' | 'banned' | 'publisher-mismatch';
+interface PolicyIssue {
+    message: string;
+    path?: string;
+    line?: number;
+    col?: number;
+}
+interface PolicyError {
+    code: PolicyErrorCode;
+    issues: PolicyIssue[];
+}
+interface PublishResult {
+    ok: boolean;
+    id?: string;
+    version?: string;
+    errors?: PolicyError[];
+}
+interface SearchRequest {
+    q?: string;
+    category?: Category;
+    recommended?: boolean;
+    sort?: 'downloads' | 'stars' | 'recent' | 'name';
+    page?: number;
+    pageSize?: number;
+    ids?: string[];
+}
+interface SearchResult {
+    items: ExtSummary[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+interface DeviceFlowStartResult {
+    deviceCode: string;
+    userCode: string;
+    verificationUri: string;
+    expiresIn: number;
+    interval: number;
+}
+interface DeviceFlowPollResult {
+    status: 'pending' | 'authorized' | 'expired' | 'denied';
+    apiKey?: string;
+    authorId?: string;
+    githubLogin?: string;
+}
+interface KeyRegisterRequest {
+    pubkeyB64: string;
+    name?: string;
+}
+interface KeyRegisterResponse {
+    keyId: string;
+}
+interface KeyInfo {
+    keyId: string;
+    authorId: string;
+    pubkeyB64: string;
+    revokedAt: number | null;
+    createdAt: number;
+}
+interface RatingSubmitRequest {
+    extensionId: string;
+    stars: number;
+    comment?: string;
+}
+
+export type { Category, DeviceFlowPollResult, DeviceFlowStartResult, DownloadInfo, ExtSummary, ExtensionDetail, KeyInfo, KeyRegisterRequest, KeyRegisterResponse, PolicyError, PolicyErrorCode, PolicyIssue, PublishResult, RatingDto, RatingSubmitRequest, SearchRequest, SearchResult, VersionInfo };

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@mterminal/marketplace-types",
+  "version": "0.1.0",
+  "description": "shared dto types for the mterminal marketplace",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}

package/src/index.ts

@@ -0,0 +1,144 @@
+export type Category =
+  | 'productivity'
+  | 'language'
+  | 'theme'
+  | 'remote'
+  | 'ai'
+  | 'git'
+  | 'other'
+
+export interface ExtSummary {
+  id: string
+  displayName: string
+  description: string
+  category: Category
+  iconUrl?: string
+  latestVersion: string
+  downloadTotal: number
+  avgStars?: number
+  ratingCount: number
+  authorLogin: string
+  recommended: boolean
+  apiRange: string
+}
+
+export interface VersionInfo {
+  version: string
+  apiRange: string
+  sizeBytes: number
+  publishedAt: number
+  yanked: boolean
+}
+
+export interface RatingDto {
+  userId: string
+  userLogin: string
+  stars: number
+  comment?: string
+  helpful: number
+  createdAt: number
+}
+
+export interface ExtensionDetail extends ExtSummary {
+  homepageUrl?: string
+  repoUrl?: string
+  versions: VersionInfo[]
+  manifest: unknown
+  ratings: RatingDto[]
+  readmeMd?: string
+}
+
+export interface DownloadInfo {
+  url: string
+  sha256: string
+  signatureB64: string
+  keyId: string
+  authorId: string
+  sizeBytes: number
+}
+
+export type PolicyErrorCode =
+  | 'manifest'
+  | 'signature'
+  | 'static-scan'
+  | 'capability'
+  | 'duplicate-version'
+  | 'unknown-key'
+  | 'size-limit'
+  | 'unauthorized'
+  | 'banned'
+  | 'publisher-mismatch'
+
+export interface PolicyIssue {
+  message: string
+  path?: string
+  line?: number
+  col?: number
+}
+
+export interface PolicyError {
+  code: PolicyErrorCode
+  issues: PolicyIssue[]
+}
+
+export interface PublishResult {
+  ok: boolean
+  id?: string
+  version?: string
+  errors?: PolicyError[]
+}
+
+export interface SearchRequest {
+  q?: string
+  category?: Category
+  recommended?: boolean
+  sort?: 'downloads' | 'stars' | 'recent' | 'name'
+  page?: number
+  pageSize?: number
+  ids?: string[]
+}
+
+export interface SearchResult {
+  items: ExtSummary[]
+  total: number
+  page: number
+  pageSize: number
+}
+
+export interface DeviceFlowStartResult {
+  deviceCode: string
+  userCode: string
+  verificationUri: string
+  expiresIn: number
+  interval: number
+}
+
+export interface DeviceFlowPollResult {
+  status: 'pending' | 'authorized' | 'expired' | 'denied'
+  apiKey?: string
+  authorId?: string
+  githubLogin?: string
+}
+
+export interface KeyRegisterRequest {
+  pubkeyB64: string
+  name?: string
+}
+
+export interface KeyRegisterResponse {
+  keyId: string
+}
+
+export interface KeyInfo {
+  keyId: string
+  authorId: string
+  pubkeyB64: string
+  revokedAt: number | null
+  createdAt: number
+}
+
+export interface RatingSubmitRequest {
+  extensionId: string
+  stars: number
+  comment?: string
+}