@ultikits/cli 1.2.0 → 2.0.0

package/dist/src/lib/paging.d.ts

@@ -0,0 +1,5 @@
+import type { Page } from '../types.js';
+/** Largest pageSize the contract allows for the list routes. */
+export declare const MAX_PAGE_SIZE = 100;
+/** Fetches page 1, 2, … until `total` items are collected or a page comes back empty. */
+export declare function fetchAllPages<T>(fetchPage: (page: number) => Promise<Page<T>>): Promise<T[]>;

package/dist/src/lib/paging.js

@@ -0,0 +1,16 @@
+/** Largest pageSize the contract allows for the list routes. */
+export const MAX_PAGE_SIZE = 100;
+/** Hard stop so a server that keeps reporting a larger total cannot loop forever. */
+const MAX_PAGES = 1000;
+/** Fetches page 1, 2, … until `total` items are collected or a page comes back empty. */
+export async function fetchAllPages(fetchPage) {
+    const items = [];
+    for (let page = 1; page <= MAX_PAGES; page++) {
+        const result = await fetchPage(page);
+        items.push(...result.items);
+        if (result.items.length === 0 || items.length >= result.total)
+            break;
+    }
+    return items;
+}
+//# sourceMappingURL=paging.js.map

package/dist/src/types.d.ts

@@ -1,16 +1,13 @@
-export interface OAuthCredentials {
-    type: 'oauth';
-    access_token: string;
-    refresh_token: string;
-    expires_at: string;
-    api_url: string;
-}
-export interface AccessTokenCredentials {
-    type: 'access_token';
-    token: string;
-    api_url: string;
-}
-export type Credentials = OAuthCredentials | AccessTokenCredentials;
+/** Credential kinds the UltiCloud machine API accepts (contract: developer-client 1.1.0). */
+export type CredentialKind = 'cli' | 'developer';
+/** ~/.ultikits/credentials.json, format version 2. */
+export interface StoredCredential {
+    version: 2;
+    kind: CredentialKind;
+    credential: string;
+    credentialId?: string;
+    apiUrl: string;
+}
 export interface ProjectConfig {
     identifyString: string;
     name: string;
@@ -25,17 +22,13 @@ export interface PluginYml {
 }
 export interface ModuleMetadata {
     identifyString: string;
-    name: string;
+    /** Display name; only needed when publish has to create the module. */
+    name?: string;
     version: string;
     shortDescription?: string;
     changelog?: string;
     categoryId?: number;
 }
-export interface ApiResponse<T = any> {
-    code: string;
-    msg: string;
-    data?: T;
-}
 export interface CreateParams {
     moduleName: string;
     packageName: string;
@@ -43,3 +36,134 @@ export interface CreateParams {
     author: string;
     apiVersion: string;
 }
+export interface DeviceAuthorization {
+    deviceCode: string;
+    userCode: string;
+    verificationUri: string;
+    verificationUriComplete: string;
+    expiresIn: number;
+    interval: number;
+}
+export interface DeviceTokenResult {
+    kind: 'cli';
+    credential: string;
+    credentialId: string;
+    userId: number;
+}
+export interface Whoami {
+    id: number;
+    username: string;
+    developerName: string;
+    /** Optional in the contract; treat absence as "unknown". */
+    credential?: {
+        kind: CredentialKind;
+        scope: 'upload' | 'manage';
+    };
+}
+export interface UploadTicket {
+    uploadUrl: string;
+    method: 'PUT';
+    headers: Record<string, string>;
+    expiresAt: string;
+    maxBytes: number;
+}
+interface DevModuleVersionBase {
+    version: string;
+    sizeBytes: number;
+    sha256: string;
+}
+/** Status-specific fields from the frozen developer-client 1.1.0 export. */
+export type DevModuleVersion = DevModuleVersionBase & ({
+    status: 'pending_upload';
+    withdrawnAt: null;
+    isLatest: false;
+    downloadUrl: null;
+} | {
+    status: 'published';
+    withdrawnAt: null;
+    isLatest: boolean;
+    downloadUrl: string | null;
+} | {
+    status: 'withdrawn';
+    withdrawnAt: string;
+    isLatest: false;
+    downloadUrl: null;
+});
+export interface CreateVersionBody {
+    version: string;
+    changelog: string | null;
+    sha256: string;
+    sizeBytes: number;
+}
+export interface CreateVersionResult {
+    version: Extract<DevModuleVersion, {
+        status: 'pending_upload';
+    }>;
+    upload: UploadTicket;
+}
+export interface CreateModuleBody {
+    name: string;
+    identifier: string;
+    shortDescription: string;
+    description: string | null;
+    categoryId: number | null;
+    compatibleApiVersions: string | null;
+    tags: string[];
+}
+export interface DeveloperModule {
+    id: string;
+    identifier: string;
+    name: string;
+}
+export interface Page<T> {
+    items: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+/** developer.modules.list item; also the body of update and restore. */
+export interface ModuleListItem extends DeveloperModule {
+    shortDescription: string;
+    iconUrl: string | null;
+    category: {
+        id: number;
+        name: string;
+    } | null;
+    downloads: number;
+    latestVersion: string | null;
+    updatedAt: string;
+}
+/** PATCH body: every key optional, only the given ones are sent. */
+export interface UpdateModuleBody {
+    name?: string;
+    shortDescription?: string;
+    description?: string | null;
+    categoryId?: number | null;
+}
+export interface ModuleDeletion {
+    deletedAt: string;
+    restorableUntil: string;
+}
+export type WithdrawnVersion = Extract<DevModuleVersion, {
+    status: 'withdrawn';
+}>;
+/** catalogue.modules.versions.list item. */
+export interface PublicModuleVersion {
+    version: string;
+    isLatest: boolean;
+    publishedAt: string;
+    sizeBytes: number;
+    sha256: string;
+    changelog: string | null;
+    apiLevel: number | null;
+    download: {
+        kind: 'public';
+        url: string;
+    } | {
+        kind: 'license_required';
+    } | {
+        kind: 'withdrawn';
+        withdrawnAt: string;
+    };
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ultikits/cli",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "CLI tool for publishing UltiTools plugin modules to UltiCloud marketplace",
   "type": "module",
   "bin": {