@halo-dev/admin-api - npm Package Compare versions

Comparing version 1.0.0-alpha.3 to 1.0.0-alpha.4

lib/clients/AttachmentClient.d.ts

@@ -6,11 +6,64 @@ import { HttpClient } from "@halo-dev/rest-api-client";
     constructor(client: HttpClient);
+    /**
+     * Gets attachment detail by id.
+     *
+     * @param attachmentId attachment id
+     * @returns Returns attachment detail response.
+     */
     getById(attachmentId: number): Promise<Response<Attachment>>;
+    /**
+     * Page query attachment list.
+     *
+     * @param params attachment query parameter
+     * @returns Returns attachment page response.
+     */
     list(params: AttachmentQuery): Promise<Page<Attachment>>;
+    /**
+     * Batch delete attachment permanently by attachment ids.
+     *
+     * @param attachmentIds a collection of attachment id
+     * @returns Returns attachments of deleted
+     */
     deleteInBatch(attachmentIds: Array<number>): Promise<Response<Array<Attachment>>>;
+    /**
+     * Delete attachment permanently by attachment id.
+     *
+     * @param attachmentId attachment id
+     * @returns Returns attachment detail of deleted
+     */
     deleteById(attachmentId: number): Promise<Response<Array<Attachment>>>;
+    /**
+     * Update attachment name by id.
+     *
+     * @param attachmentId attachment id
+     * @param name a new attachment name
+     * @returns Returns an updated attachment response.
+     */
     updateById(attachmentId: number, name: string): Promise<Response<Attachment>>;
+    /**
+     * List all of attachment media types.
+     *
+     * @returns Returns attachment media types response.
+     */
     listMediaTypes(): Promise<Response<Array<string>>>;
+    /**
+     * List all of attachment types.
+     *
+     * @returns Returns a response of attachment types.
+     */
     listTypes(): Promise<Response<Array<string>>>;
-    upload(data: unknown): Promise<Response<Array<string>>>;
-    uploadInBatch(data: Array<unknown>): Promise<Response<Array<string>>>;
+    /**
+     * Upload a single attachment file.
+     *
+     * @param data attachment file object.
+     * @returns Returns a response of uploaded attachment
+     */
+    upload(data: unknown): Promise<Response<Attachment>>;
+    /**
+     * Batch upload attachments.
+     *
+     * @param data attachment file object.
+     * @returns Returns a response of uploaded attachments.
+     */
+    uploadInBatch(data: Array<unknown>): Promise<Response<Array<Attachment>>>;
 }

lib/clients/AttachmentClient.js

@@ -10,2 +10,8 @@ "use strict";
     }
+    /**
+     * Gets attachment detail by id.
+     *
+     * @param attachmentId attachment id
+     * @returns Returns attachment detail response.
+     */
     getById(attachmentId) {
@@ -17,2 +23,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Page query attachment list.
+     *
+     * @param params attachment query parameter
+     * @returns Returns attachment page response.
+     */
     list(params) {
@@ -24,2 +36,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Batch delete attachment permanently by attachment ids.
+     *
+     * @param attachmentIds a collection of attachment id
+     * @returns Returns attachments of deleted
+     */
     deleteInBatch(attachmentIds) {
@@ -31,2 +49,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Delete attachment permanently by attachment id.
+     *
+     * @param attachmentId attachment id
+     * @returns Returns attachment detail of deleted
+     */
     deleteById(attachmentId) {
@@ -38,2 +62,9 @@ const path = url_1.buildPath({
     }
+    /**
+     * Update attachment name by id.
+     *
+     * @param attachmentId attachment id
+     * @param name a new attachment name
+     * @returns Returns an updated attachment response.
+     */
     updateById(attachmentId, name) {
@@ -45,2 +76,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * List all of attachment media types.
+     *
+     * @returns Returns attachment media types response.
+     */
     listMediaTypes() {
@@ -52,2 +88,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * List all of attachment types.
+     *
+     * @returns Returns a response of attachment types.
+     */
     listTypes() {
@@ -59,2 +100,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Upload a single attachment file.
+     *
+     * @param data attachment file object.
+     * @returns Returns a response of uploaded attachment
+     */
     upload(data) {
@@ -68,2 +115,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Batch upload attachments.
+     *
+     * @param data attachment file object.
+     * @returns Returns a response of uploaded attachments.
+     */
     uploadInBatch(data) {
@@ -70,0 +123,0 @@ const path = url_1.buildPath({

lib/clients/AttachmentClient.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"AttachmentClient.js","sourceRoot":"","sources":["../../src/clients/AttachmentClient.ts"],"names":[],"mappings":";;;AAAA,+DAAiE;AACjE,gCAAmC;AAGnC,MAAa,gBAAgB;IAG3B,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,OAAO,CAAC,YAAoB;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,IAAI,CAAC,MAAuB;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,oBAAO,MAAM,EAAG,CAAC;IAC9C,CAAC;IAEM,aAAa,CAClB,aAA4B;QAE5B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACjD,CAAC;IAEM,UAAU,CACf,YAAoB;QAEpB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAEM,UAAU,CACf,YAAoB,EACpB,IAAY;QAEZ,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAEM,cAAc;QACnB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,SAAS;QACd,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,mBAAmB;SAClC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,IAAa;QACzB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB;SACnC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEM,aAAa,CAAC,IAAoB;QACvC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,qBAAqB;SACpC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC1B,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACF;AAlFD,4CAkFC"}
+{"version":3,"file":"AttachmentClient.js","sourceRoot":"","sources":["../../src/clients/AttachmentClient.ts"],"names":[],"mappings":";;;AAAA,+DAAiE;AACjE,gCAAmC;AAGnC,MAAa,gBAAgB;IAG3B,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,YAAoB;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,MAAuB;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,oBAAO,MAAM,EAAG,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAClB,aAA4B;QAE5B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,aAAa;SAC5B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,YAAoB;QAEpB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CACf,YAAoB,EACpB,IAAY;QAEZ,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,eAAe,YAAY,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,SAAS;QACd,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,mBAAmB;SAClC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAa;QACzB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB;SACnC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAClB,IAAoB;QAEpB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,qBAAqB;SACpC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC1B,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACF;AAzID,4CAyIC"}

lib/clients/BackupClient.d.ts

@@ -6,17 +6,100 @@ import { HttpClient } from "@halo-dev/rest-api-client";
     constructor(client: HttpClient);
+    /**
+     * List all exported data
+     *
+     * @returns Returns a response of exported data.
+     */
     list(): Promise<Response<Array<Backup>>>;
+    /**
+     * Export all data.
+     *
+     * @returns Returns a response of all exported backup data.
+     */
     exportAll(): Promise<Response<Backup>>;
+    /**
+     * Delete a exported data by filename.
+     *
+     * @param filename file name
+     */
     delete(filename: string): Promise<void>;
+    /**
+     * Download a exported data by filename.
+     *
+     * @param filename a filename of exported data
+     * @returns Returns a resource object of exported data file.
+     */
     download(filename: string): Promise<any>;
+    /**
+     * Fetch a backup.
+     *
+     * @param filename filename
+     * @returns Returns a response of fetched backup.
+     */
     fetch(filename: string): Promise<Response<Backup>>;
+    /**
+     * Get all markdown backups.
+     *
+     * @returns Returns a response of exported markdown backup.
+     */
     listMarkdown(): Promise<Response<Array<Backup>>>;
+    /**
+     * Export backup to markdown.
+     *
+     * @param needFrontMatter true if need frontMatter
+     * @returns Returns a response of markdown backup.
+     */
     exportToMarkdown(needFrontMatter?: boolean): Promise<Response<Backup>>;
+    /**
+     * Delete a exported markdown backup by filename.
+     *
+     * @param filename filename
+     */
     deleteMarkdown(filename: string): Promise<void>;
+    /**
+     * Download a exported markdown backup file.
+     *
+     * @param filename filename
+     * @returns Returns a binary stream of exported markdown backup file.
+     */
     downloadMarkdown(filename: string): Promise<any>;
+    /**
+     * Fetch a markdown backup by filename.
+     *
+     * @param filename filename
+     * @returns Returns a response of markdown backup.
+     */
     fetchMarkdown(filename: string): Promise<Response<Backup>>;
+    /**
+     * Import a backup by file.
+     *
+     * @param data a backuped markdown file.
+     * @returns Returns a response of imported post detail by backup file.
+     */
     importMarkdown(data: unknown): Promise<Response<BasePostDetail>>;
+    /**
+     * Get all work directory backups.
+     *
+     * @returns Returns a response of all backups from work dir.
+     */
     listFromWorkDir(): Promise<Response<Backup>>;
+    /**
+     * Delete a backup from work directory by filename.
+     *
+     * @param filename filename
+     */
     deleteFromWorkDir(filename: string): Promise<void>;
+    /**
+     * Download a backup file from workdir.
+     *
+     * @param filename filename
+     * @returns Returns a binary stream of backup from work directory.
+     */
     downloadFromWorkDir(filename: string): Promise<any>;
+    /**
+     * Fetch a backup from work directory.
+     *
+     * @param filename filename
+     * @returns Returns a response of backup from work directory.
+     */
     fetchFromWorkDir(filename: string): Promise<Response<Backup>>;
 }

lib/clients/BackupClient.js

@@ -19,2 +19,7 @@ "use strict";
     }
+    /**
+     * List all exported data
+     *
+     * @returns Returns a response of exported data.
+     */
     list() {
@@ -26,2 +31,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Export all data.
+     *
+     * @returns Returns a response of all exported backup data.
+     */
     exportAll() {
@@ -33,2 +43,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Delete a exported data by filename.
+     *
+     * @param filename file name
+     */
     delete(filename) {
@@ -42,2 +57,8 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Download a exported data by filename.
+     *
+     * @param filename a filename of exported data
+     * @returns Returns a resource object of exported data file.
+     */
     download(filename) {
@@ -49,2 +70,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Fetch a backup.
+     *
+     * @param filename filename
+     * @returns Returns a response of fetched backup.
+     */
     fetch(filename) {
@@ -56,2 +83,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Get all markdown backups.
+     *
+     * @returns Returns a response of exported markdown backup.
+     */
     listMarkdown() {
@@ -63,2 +95,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Export backup to markdown.
+     *
+     * @param needFrontMatter true if need frontMatter
+     * @returns Returns a response of markdown backup.
+     */
     exportToMarkdown(needFrontMatter) {
@@ -70,2 +108,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Delete a exported markdown backup by filename.
+     *
+     * @param filename filename
+     */
     deleteMarkdown(filename) {
@@ -79,2 +122,8 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Download a exported markdown backup file.
+     *
+     * @param filename filename
+     * @returns Returns a binary stream of exported markdown backup file.
+     */
     downloadMarkdown(filename) {
@@ -86,2 +135,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Fetch a markdown backup by filename.
+     *
+     * @param filename filename
+     * @returns Returns a response of markdown backup.
+     */
     fetchMarkdown(filename) {
@@ -93,2 +148,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Import a backup by file.
+     *
+     * @param data a backuped markdown file.
+     * @returns Returns a response of imported post detail by backup file.
+     */
     importMarkdown(data) {
@@ -102,2 +163,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Get all work directory backups.
+     *
+     * @returns Returns a response of all backups from work dir.
+     */
     listFromWorkDir() {
@@ -109,2 +175,7 @@ const path = url_1.buildPath({
     }
+    /**
+     * Delete a backup from work directory by filename.
+     *
+     * @param filename filename
+     */
     deleteFromWorkDir(filename) {
@@ -118,2 +189,8 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Download a backup file from workdir.
+     *
+     * @param filename filename
+     * @returns Returns a binary stream of backup from work directory.
+     */
     downloadFromWorkDir(filename) {
@@ -125,2 +202,8 @@ const path = url_1.buildPath({
     }
+    /**
+     * Fetch a backup from work directory.
+     *
+     * @param filename filename
+     * @returns Returns a response of backup from work directory.
+     */
     fetchFromWorkDir(filename) {
@@ -127,0 +210,0 @@ const path = url_1.buildPath({

lib/clients/BackupClient.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"BackupClient.js","sourceRoot":"","sources":["../../src/clients/BackupClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAAiE;AACjE,gCAAmC;AAGnC,MAAa,YAAY;IAGvB,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,IAAI;QACT,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,cAAc;SAC7B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,SAAS;QACd,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,cAAc;SAC7B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC;IAEY,MAAM,CAAC,QAAgB;;YAClC,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,cAAc;aAC7B,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEM,QAAQ,CAAC,QAAgB;QAC9B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,gBAAgB,QAAQ,EAAE;SACzC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,QAAgB;QAC3B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB;SACnC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,YAAY;QACjB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,gBAAgB,CACrB,eAAyB;QAEzB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IACrD,CAAC;IAEY,cAAc,CAAC,QAAgB;;YAC1C,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,yBAAyB;aACxC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEM,gBAAgB,CAAC,QAAgB;QACtC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,2BAA2B,QAAQ,EAAE;SACpD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,aAAa,CAAC,QAAgB;QACnC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,wBAAwB;SACvC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,IAAa;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEM,eAAe;QACpB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,kBAAkB;SACjC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEY,iBAAiB,CAAC,QAAgB;;YAC7C,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,kBAAkB;aACjC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEM,mBAAmB,CAAC,QAAgB;QACzC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB,QAAQ,EAAE;SAC7C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,gBAAgB,CAAC,QAAgB;QACtC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,wBAAwB;SACvC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAnHD,oCAmHC"}
+{"version":3,"file":"BackupClient.js","sourceRoot":"","sources":["../../src/clients/BackupClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAAiE;AACjE,gCAAmC;AAGnC,MAAa,YAAY;IAGvB,YAAY,MAAkB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,cAAc;SAC7B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,SAAS;QACd,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,cAAc;SAC7B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACU,MAAM,CAAC,QAAgB;;YAClC,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,cAAc;aAC7B,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;;OAKG;IACI,QAAQ,CAAC,QAAgB;QAC9B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,gBAAgB,QAAQ,EAAE;SACzC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAgB;QAC3B,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB;SACnC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,YAAY;QACjB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,eAAyB;QAEzB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACU,cAAc,CAAC,QAAgB;;YAC1C,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,yBAAyB;aACxC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,QAAgB;QACtC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,2BAA2B,QAAQ,EAAE;SACpD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,QAAgB;QACnC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,wBAAwB;SACvC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,IAAa;QACjC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,0BAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,eAAe;QACpB,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,kBAAkB;SACjC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACU,iBAAiB,CAAC,QAAgB;;YAC7C,MAAM,IAAI,GAAG,eAAS,CAAC;gBACrB,YAAY,EAAE,kBAAkB;aACjC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;;OAKG;IACI,mBAAmB,CAAC,QAAgB;QACzC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,oBAAoB,QAAQ,EAAE;SAC7C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,QAAgB;QACtC,MAAM,IAAI,GAAG,eAAS,CAAC;YACrB,YAAY,EAAE,wBAAwB;SACvC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAtMD,oCAsMC"}

lib/clients/ThemeClient.d.ts

@@ -7,18 +7,18 @@ import { HttpClient } from "@halo-dev/rest-api-client";
     listAll(): Promise<Response<Array<ThemeProperty>>>;
-    getById(themeId: number): Promise<Response<ThemeProperty>>;
-    deleteById(themeId: number, deleteSettings?: boolean): Promise<Response<ThemeProperty>>;
-    active(themeId: number): Promise<Response<ThemeProperty>>;
+    getById(themeId: string): Promise<Response<ThemeProperty>>;
+    deleteById(themeId: string, deleteSettings?: boolean): Promise<Response<ThemeProperty>>;
+    active(themeId: string): Promise<Response<ThemeProperty>>;
     fetchConfig(): Promise<Response<Array<Group>>>;
-    fetchConfigById(themeId: number): Promise<Response<Array<Group>>>;
-    listFilesById(themeId: number): Promise<Response<Array<ThemeFile>>>;
+    fetchConfigById(themeId: string): Promise<Response<Array<Group>>>;
+    listFilesById(themeId: string): Promise<Response<Array<ThemeFile>>>;
     listFiles(): Promise<Response<Array<ThemeFile>>>;
     getContentByPath(filepath: string): Promise<Response<string>>;
-    getContentById(themeId: number, filepath: string): Promise<Response<string>>;
-    updateContentById(themeId: number, params: {
+    getContentById(themeId: string, filepath: string): Promise<Response<string>>;
+    updateContentById(themeId: string, params: {
         path?: string;
         content?: string;
     }): Promise<void>;
-    listSettingsById(themeId: number): Promise<Response<Map<String, any>>>;
+    listSettingsById(themeId: string): Promise<Response<Map<String, any>>>;
     listSettings(): Promise<Response<Map<String, any>>>;
-    saveSettingsById(themeId: number, settings: Map<String, Object>): Promise<void>;
+    saveSettingsById(themeId: string, settings: Map<String, Object>): Promise<void>;
     saveSettings(settings: Map<String, Object>): Promise<void>;
@@ -30,3 +30,3 @@ getActivateTheme(): Promise<Response<ThemeProperty>>;
     fetchTheme(uri: string): Promise<object>;
-    updateThemeByFetching(themeId: number): Promise<object>;
+    updateThemeByFetching(themeId: string): Promise<object>;
     updateContent(params: {
@@ -38,3 +38,3 @@ path?: string;
     uploadTheme(data: unknown): Promise<Response<ThemeProperty>>;
-    updateThemeByUpload(themeId: number, data: unknown): Promise<Response<ThemeProperty>>;
+    updateThemeByUpload(themeId: string, data: unknown): Promise<Response<ThemeProperty>>;
 }

lib/types/index.d.ts

@@ -416,3 +416,3 @@ export declare type Response<T = any> = {
     hasOptions: boolean;
-    isActivated: boolean;
+    activated: boolean;
     screenshots: string;
@@ -419,0 +419,0 @@ postMetaField: Array<string>;

package.json

 {
   "name": "@halo-dev/admin-api",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "description": "Halo admin api client.",
@@ -50,3 +50,3 @@ "main": "lib/index.js",
   },
-  "homepage": "https://github.com/halo-dev/js-sdk#readme",
+  "homepage": "https://github.com/halo-dev/js-sdk/tree/master/packages/admin-api#readme",
   "lint-staged": {
@@ -59,6 +59,6 @@ "*.{js,ts}": [
   "dependencies": {
-    "@halo-dev/rest-api-client": "^1.0.0-alpha.3"
+    "@halo-dev/rest-api-client": "^1.0.0-alpha.4"
   },
   "devDependencies": {
-    "typescript": "^4.0.3"
+    "typescript": "^4.3.5"
   },
@@ -65,0 +65,0 @@ "exports": {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

140417

5.59%

Lines of code

2746

10.99%

Worsened metrics

Number of medium supply chain risk alerts

6

20%

Dependency changes

• Updated

  @halo-dev/rest-api-client@^1.0.0-alpha.4