@air/api-rest 0.2.0 → 0.3.0

package/dist/index.cjs

@@ -42,6 +42,7 @@ __export(index_exports, {
   CustomFields: () => CustomFields,
   Imports: () => Imports,
   InternalServerError: () => import_api_core2.InternalServerError,
+  Libraries: () => Libraries,
   NotFoundError: () => import_api_core2.NotFoundError,
   PagePromise: () => import_api_core2.PagePromise,
   PermissionError: () => import_api_core2.PermissionError,
@@ -172,7 +173,9 @@ var Boards = class {
       limit: params.limit,
       cursor: params.cursor,
       name: params.name,
-      parentBoardId: params.parentBoardId
+      parentBoardId: params.parentBoardId,
+      libraryId: params.libraryId,
+      inGeneralLibrary: params.inGeneralLibrary
     };
     if (params.customField) {
       query.customField = params.customField;
@@ -338,6 +341,50 @@ var Imports = class {
   }
 };
 
+// src/resources/libraries.ts
+var Libraries = class {
+  constructor(client) {
+    this.client = client;
+  }
+  list(params = {}) {
+    const query = {
+      limit: params.limit,
+      cursor: params.cursor,
+      search: params.search
+    };
+    return this.client.requestCursorPage(
+      { method: "GET", path: "/libraries", query },
+      query
+    );
+  }
+  async get(libraryId) {
+    return this.client.request({
+      method: "GET",
+      path: `/libraries/${libraryId}`
+    });
+  }
+  async create(params) {
+    return this.client.request({
+      method: "POST",
+      path: "/libraries",
+      body: params
+    });
+  }
+  async update(libraryId, params) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/libraries/${libraryId}`,
+      body: params
+    });
+  }
+  async delete(libraryId) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/libraries/${libraryId}`
+    });
+  }
+};
+
 // src/resources/roles.ts
 var Roles = class {
   constructor(client) {
@@ -642,6 +689,7 @@ var Workspaces = class {
 var AirApi = class extends import_api_core.AirBase {
   assets;
   boards;
+  libraries;
   tags;
   customFields;
   roles;
@@ -652,6 +700,7 @@ var AirApi = class extends import_api_core.AirBase {
     super(options);
     this.assets = new Assets(this);
     this.boards = new Boards(this);
+    this.libraries = new Libraries(this);
     this.tags = new Tags(this);
     this.customFields = new CustomFields(this);
     this.roles = new Roles(this);
@@ -677,6 +726,7 @@ var import_api_core2 = require("@air/api-core");
   CustomFields,
   Imports,
   InternalServerError,
+  Libraries,
   NotFoundError,
   PagePromise,
   PermissionError,

package/dist/index.d.cts

@@ -102,6 +102,17 @@ interface BoardListParams extends CursorPageParams {
     name?: string;
     parentBoardId?: string;
     customField?: string | string[];
+    /**
+     * Only return boards in this library. Mutually exclusive with
+     * `inGeneralLibrary` — passing both results in a `400` (BadRequestError).
+     */
+    libraryId?: string;
+    /**
+     * Only return boards in the General library (boards not in any real library).
+     * Mutually exclusive with `libraryId` — passing both results in a `400`
+     * (BadRequestError).
+     */
+    inGeneralLibrary?: boolean;
 }
 interface BoardCreateParams {
     title: string;
@@ -264,6 +275,41 @@ declare class Imports {
     getStatus(importId: string): Promise<ImportStatusResponse>;
 }
 
+interface Library {
+    id: string;
+    title: string;
+    accessibility: "public" | "private";
+    visibility: "workspaceMembers" | "libraryMembers";
+    createdAt: string;
+    updatedAt: string;
+    description?: string;
+}
+interface LibraryListParams extends CursorPageParams {
+    search?: string;
+}
+interface LibraryCreateParams {
+    title: string;
+    description?: string;
+    accessibility?: "public" | "private";
+    visibility?: "workspaceMembers" | "libraryMembers";
+}
+interface LibraryUpdateParams {
+    title?: string;
+    description?: string | null;
+    accessibility?: "public" | "private";
+    visibility?: "workspaceMembers" | "libraryMembers";
+}
+
+declare class Libraries {
+    private client;
+    constructor(client: AirBase);
+    list(params?: LibraryListParams): PagePromise<Library>;
+    get(libraryId: string): Promise<Library>;
+    create(params: LibraryCreateParams): Promise<Library>;
+    update(libraryId: string, params: LibraryUpdateParams): Promise<void>;
+    delete(libraryId: string): Promise<void>;
+}
+
 interface Role {
     id: string;
     name: string;
@@ -420,6 +466,7 @@ interface AirApiOptions extends AirBaseOptions {
 declare class AirApi extends AirBase {
     readonly assets: Assets;
     readonly boards: Boards;
+    readonly libraries: Libraries;
     readonly tags: Tags;
     readonly customFields: CustomFields;
     readonly roles: Roles;
@@ -429,4 +476,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };

package/dist/index.d.ts

@@ -102,6 +102,17 @@ interface BoardListParams extends CursorPageParams {
     name?: string;
     parentBoardId?: string;
     customField?: string | string[];
+    /**
+     * Only return boards in this library. Mutually exclusive with
+     * `inGeneralLibrary` — passing both results in a `400` (BadRequestError).
+     */
+    libraryId?: string;
+    /**
+     * Only return boards in the General library (boards not in any real library).
+     * Mutually exclusive with `libraryId` — passing both results in a `400`
+     * (BadRequestError).
+     */
+    inGeneralLibrary?: boolean;
 }
 interface BoardCreateParams {
     title: string;
@@ -264,6 +275,41 @@ declare class Imports {
     getStatus(importId: string): Promise<ImportStatusResponse>;
 }
 
+interface Library {
+    id: string;
+    title: string;
+    accessibility: "public" | "private";
+    visibility: "workspaceMembers" | "libraryMembers";
+    createdAt: string;
+    updatedAt: string;
+    description?: string;
+}
+interface LibraryListParams extends CursorPageParams {
+    search?: string;
+}
+interface LibraryCreateParams {
+    title: string;
+    description?: string;
+    accessibility?: "public" | "private";
+    visibility?: "workspaceMembers" | "libraryMembers";
+}
+interface LibraryUpdateParams {
+    title?: string;
+    description?: string | null;
+    accessibility?: "public" | "private";
+    visibility?: "workspaceMembers" | "libraryMembers";
+}
+
+declare class Libraries {
+    private client;
+    constructor(client: AirBase);
+    list(params?: LibraryListParams): PagePromise<Library>;
+    get(libraryId: string): Promise<Library>;
+    create(params: LibraryCreateParams): Promise<Library>;
+    update(libraryId: string, params: LibraryUpdateParams): Promise<void>;
+    delete(libraryId: string): Promise<void>;
+}
+
 interface Role {
     id: string;
     name: string;
@@ -420,6 +466,7 @@ interface AirApiOptions extends AirBaseOptions {
 declare class AirApi extends AirBase {
     readonly assets: Assets;
     readonly boards: Boards;
+    readonly libraries: Libraries;
     readonly tags: Tags;
     readonly customFields: CustomFields;
     readonly roles: Roles;
@@ -429,4 +476,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };

package/dist/index.js

@@ -112,7 +112,9 @@ var Boards = class {
       limit: params.limit,
       cursor: params.cursor,
       name: params.name,
-      parentBoardId: params.parentBoardId
+      parentBoardId: params.parentBoardId,
+      libraryId: params.libraryId,
+      inGeneralLibrary: params.inGeneralLibrary
     };
     if (params.customField) {
       query.customField = params.customField;
@@ -278,6 +280,50 @@ var Imports = class {
   }
 };
 
+// src/resources/libraries.ts
+var Libraries = class {
+  constructor(client) {
+    this.client = client;
+  }
+  list(params = {}) {
+    const query = {
+      limit: params.limit,
+      cursor: params.cursor,
+      search: params.search
+    };
+    return this.client.requestCursorPage(
+      { method: "GET", path: "/libraries", query },
+      query
+    );
+  }
+  async get(libraryId) {
+    return this.client.request({
+      method: "GET",
+      path: `/libraries/${libraryId}`
+    });
+  }
+  async create(params) {
+    return this.client.request({
+      method: "POST",
+      path: "/libraries",
+      body: params
+    });
+  }
+  async update(libraryId, params) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/libraries/${libraryId}`,
+      body: params
+    });
+  }
+  async delete(libraryId) {
+    return this.client.request({
+      method: "DELETE",
+      path: `/libraries/${libraryId}`
+    });
+  }
+};
+
 // src/resources/roles.ts
 var Roles = class {
   constructor(client) {
@@ -582,6 +628,7 @@ var Workspaces = class {
 var AirApi = class extends AirBase {
   assets;
   boards;
+  libraries;
   tags;
   customFields;
   roles;
@@ -592,6 +639,7 @@ var AirApi = class extends AirBase {
     super(options);
     this.assets = new Assets(this);
     this.boards = new Boards(this);
+    this.libraries = new Libraries(this);
     this.tags = new Tags(this);
     this.customFields = new CustomFields(this);
     this.roles = new Roles(this);
@@ -633,6 +681,7 @@ export {
   CustomFields,
   Imports,
   InternalServerError,
+  Libraries,
   NotFoundError,
   PagePromise,
   PermissionError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@air/api-rest",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "description": "Typed REST client for Air API",
   "main": "./dist/index.cjs",
@@ -29,7 +29,7 @@
     "clean": "rm -rf dist .tsc-out tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@air/api-core": "0.2.0"
+    "@air/api-core": "0.3.0"
   },
   "engines": {
     "node": ">=18"