@kevisual/cnb 0.0.56 → 0.0.58

package/src/package/registry.ts

@@ -0,0 +1,145 @@
+import { CNBCore, CNBCoreOptions, Result } from "../cnb-core.ts";
+
+/**
+ * 制品类型
+ */
+export type PackageType =
+  | "all"
+  | "docker"
+  | "helm"
+  | "docker-model"
+  | "maven"
+  | "npm"
+  | "ohpm"
+  | "pypi"
+  | "nuget"
+  | "composer"
+  | "conan"
+  | "cargo";
+
+/**
+ * 制品库可见性类型
+ */
+export type VisibilityType = "private" | "public";
+
+/**
+ * 制品库排序类型
+ */
+export type PackageOrderingType = "pull_count" | "last_push_at" | "name_ascend" | "name_descend";
+
+/**
+ * 最后推送者信息
+ */
+export type LastPusher = {
+  is_frozen: boolean;
+  is_lock: boolean;
+  name: string;
+  username: string;
+};
+
+/**
+ * 制品基本信息
+ */
+export type Package = {
+  count: number;
+  description: string;
+  labels: string[];
+  last_artifact_name: string;
+  last_pusher: LastPusher;
+  name: string;
+  package: string;
+  package_type: PackageType;
+  pull_count: number;
+  recent_pull_count: number;
+};
+
+/**
+ * 制品库信息
+ */
+export type Registry = {
+  created_at: string;
+  description: string;
+  name: string;
+  owner: string;
+  type: PackageType;
+  visibility: VisibilityType;
+};
+
+/**
+ * 制品库列表查询参数
+ */
+export type ListGroupRegistriesParams = {
+  /** 页码 */
+  page?: number;
+  /** 每页数量 */
+  page_size?: number;
+  /** 制品仓库类型 */
+  registry_type?: "npm" | "maven" | "ohpm";
+  /** 制品仓库可见性类型 */
+  filter_type?: VisibilityType;
+  /** 排序字段 */
+  order_by?: "created_at" | "name";
+};
+
+/**
+ * 制品列表查询参数
+ */
+export type ListPackagesParams = {
+  /** 顺序类型 */
+  ordering?: PackageOrderingType;
+  /** 关键字，搜索制品名称 */
+  name?: string;
+};
+
+/**
+ * 制品库管理
+ */
+export class RegistryPackage extends CNBCore {
+  constructor(options: CNBCoreOptions) {
+    super(options);
+  }
+
+  /**
+   * 查询组织下面用户有权限查看到的制品仓库
+   * @param slug 组织 slug
+   * @param params 查询参数
+   */
+  listGroupRegistries(
+    slug: string,
+    params?: ListGroupRegistriesParams
+  ): Promise<Result<Registry[]>> {
+    const url = `/${slug}/-/registries`;
+    return this.get({
+      url,
+      params,
+      headers: {
+        Accept: "application/vnd.cnb.api+json",
+      },
+    });
+  }
+
+  /**
+   * 设置制品库可见性
+   * @param registry 制品库路径
+   * @param data 可见性设置
+   */
+  setVisibility(
+    registry: string,
+    data: { visibility: VisibilityType }
+  ): Promise<Result<void>> {
+    const url = `/${registry}/-/settings/set_visibility`;
+    return this.post({
+      url,
+      data,
+    });
+  }
+
+  /**
+   * 删除制品库
+   * @param registry 制品库路径
+   */
+  remove(registry: string): Promise<Result<void>> {
+    const url = `/${registry}`;
+    return this.delete({ url });
+  }
+}