@code.store/arcxp-sdk-ts 4.21.0 → 4.22.0

package/dist/api/index.d.ts

@@ -13,6 +13,7 @@ import { ArcSite } from './site';
 import { ArcWebsked } from './websked';
 import { WsClient } from './ws.client';
 import { GlobalSettings } from './global-settings';
+import { ArcTags } from './tags';
 export declare const ArcAPI: (options: ArcAPIOptions) => {
     setMaxRPS: (rps: number) => void;
     RetailEvents: (index?: '0' | '1' | 'string') => WsClient;
@@ -29,4 +30,5 @@ export declare const ArcAPI: (options: ArcAPIOptions) => {
     SigningService: ArcSigningService;
     PhotoCenter: ArcProtoCenter;
     GlobalSettings: GlobalSettings;
+    Tags: ArcTags;
 };

package/dist/api/index.js

@@ -15,6 +15,7 @@ const site_1 = require("./site");
 const websked_1 = require("./websked");
 const ws_client_1 = require("./ws.client");
 const global_settings_1 = require("./global-settings");
+const tags_1 = require("./tags");
 const ArcAPI = (options) => {
     const API = {
         Author: new author_1.ArcAuthor(options),
@@ -30,6 +31,7 @@ const ArcAPI = (options) => {
         SigningService: new signing_service_1.ArcSigningService(options),
         PhotoCenter: new photo_center_1.ArcProtoCenter(options),
         GlobalSettings: new global_settings_1.GlobalSettings(options),
+        Tags: new tags_1.ArcTags(options),
     };
     return {
         ...API,

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;AACA,qCAAqC;AACrC,uCAAuC;AACvC,mCAAmC;AACnC,yCAAyC;AACzC,+BAA+B;AAC/B,yCAAyC;AACzC,yDAAwD;AACxD,iDAAgD;AAChD,mCAAmC;AACnC,uDAAsD;AACtD,iCAAiC;AACjC,uCAAuC;AACvC,2CAAuC;AACvC,uDAAmD;AAE5C,MAAM,MAAM,GAAG,CAAC,OAAsB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG;QACV,MAAM,EAAE,IAAI,kBAAS,CAAC,OAAO,CAAC;QAC9B,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,GAAG,EAAE,IAAI,YAAM,CAAC,OAAO,CAAC;QACxB,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,eAAe,EAAE,IAAI,qCAAkB,CAAC,OAAO,CAAC;QAChD,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,cAAc,EAAE,IAAI,mCAAiB,CAAC,OAAO,CAAC;QAC9C,WAAW,EAAE,IAAI,6BAAc,CAAC,OAAO,CAAC;QACxC,cAAc,EAAE,IAAI,gCAAc,CAAC,OAAO,CAAC;KAC5C,CAAC;IAEF,OAAO;QACL,GAAG,GAAG;QACN,SAAS,EAAE,CAAC,GAAW,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,YAAY,EAAE,CAAC,QAA8B,GAAG,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,aAAa,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;YAC1H,MAAM,OAAO,GAAG;gBACd,aAAa,EAAE,UAAU,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;aAC3D,CAAC;YACF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA9BW,QAAA,MAAM,UA8BjB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;AACA,qCAAqC;AACrC,uCAAuC;AACvC,mCAAmC;AACnC,yCAAyC;AACzC,+BAA+B;AAC/B,yCAAyC;AACzC,yDAAwD;AACxD,iDAAgD;AAChD,mCAAmC;AACnC,uDAAsD;AACtD,iCAAiC;AACjC,uCAAuC;AACvC,2CAAuC;AACvC,uDAAmD;AACnD,iCAAiC;AAE1B,MAAM,MAAM,GAAG,CAAC,OAAsB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG;QACV,MAAM,EAAE,IAAI,kBAAS,CAAC,OAAO,CAAC;QAC9B,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,GAAG,EAAE,IAAI,YAAM,CAAC,OAAO,CAAC;QACxB,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,eAAe,EAAE,IAAI,qCAAkB,CAAC,OAAO,CAAC;QAChD,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,cAAc,EAAE,IAAI,mCAAiB,CAAC,OAAO,CAAC;QAC9C,WAAW,EAAE,IAAI,6BAAc,CAAC,OAAO,CAAC;QACxC,cAAc,EAAE,IAAI,gCAAc,CAAC,OAAO,CAAC;QAC3C,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;KAC3B,CAAC;IAEF,OAAO;QACL,GAAG,GAAG;QACN,SAAS,EAAE,CAAC,GAAW,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,YAAY,EAAE,CAAC,QAA8B,GAAG,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,aAAa,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;YAC1H,MAAM,OAAO,GAAG;gBACd,aAAa,EAAE,UAAU,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;aAC3D,CAAC;YACF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA/BW,QAAA,MAAM,UA+BjB"}

package/dist/api/migration-center/index.d.ts

@@ -2,7 +2,10 @@ import { PostANSParams, PostANSPayload, GetANSParams, Summary, Count, DetailRepo
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
 export declare class ArcMigrationCenter extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
-    summary(params?: SummaryReportRequest): Promise<Summary>;
+    summary(params?: SummaryReportRequest): Promise<{
+        records: Summary;
+        nextFromId: string | undefined;
+    }>;
     detailed(params?: DetailReportRequest): Promise<DetailReport>;
     count(params?: CountRequest): Promise<Count>;
     postAns(params: PostANSParams, payload: PostANSPayload): Promise<any>;

package/dist/api/migration-center/index.js

@@ -8,8 +8,9 @@ class ArcMigrationCenter extends abstract_api_1.ArcAbstractAPI {
         super({ ...options, apiPath: 'migrations/v3' });
     }
     async summary(params) {
-        const { data } = await this.client.get(`/report/summary?${(0, querystring_1.stringify)(params)}`);
-        return data;
+        const { data, headers } = await this.client.get(`/report/summary?${(0, querystring_1.stringify)(params)}`);
+        const nextFromId = headers['amc-record-id'];
+        return { records: data, nextFromId };
     }
     async detailed(params) {
         const { data } = await this.client.get(`/report/detail?${(0, querystring_1.stringify)(params)}`);

package/dist/api/migration-center/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/migration-center/index.ts"],"names":[],"mappings":";;;AAWA,kDAAgE;AAChE,6CAAwC;AAExC,MAAa,kBAAmB,SAAQ,6BAAc;IACpD,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAA6B;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,mBAAmB,IAAA,uBAAS,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAA4B;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAe,kBAAkB,IAAA,uBAAS,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAqB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAQ,sBAAsB,EAAE;YACpE,MAAM,EAAE;gBACN,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE;gBAC3C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE;aACxC;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,OAAuB;QAC1D,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtCD,gDAsCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/migration-center/index.ts"],"names":[],"mappings":";;;AAWA,kDAAgE;AAChE,6CAAwC;AAExC,MAAa,kBAAmB,SAAQ,6BAAc;IACpD,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAA6B;QACzC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,mBAAmB,IAAA,uBAAS,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACjG,MAAM,UAAU,GAAuB,OAAO,CAAC,eAAe,CAAC,CAAC;QAEhE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAA4B;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAe,kBAAkB,IAAA,uBAAS,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAqB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAQ,sBAAsB,EAAE;YACpE,MAAM,EAAE;gBACN,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE;gBAC3C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE;aACxC;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,OAAuB;QAC1D,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxCD,gDAwCC"}

package/dist/api/tags/index.d.ts

@@ -0,0 +1,8 @@
+import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
+import { DeleteTagRequest, GetTagsParams, AddTagRequest, GetTagsResponse, AddTagsResponse, DeleteTagsResponse } from './types';
+export declare class ArcTags extends ArcAbstractAPI {
+    constructor(options: ArcAPIOptions);
+    getTags(params: GetTagsParams): Promise<GetTagsResponse>;
+    addTags(payload: AddTagRequest): Promise<AddTagsResponse>;
+    deleteTags(payload: DeleteTagRequest): Promise<DeleteTagsResponse>;
+}

package/dist/api/tags/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcTags = void 0;
+const abstract_api_1 = require("../abstract-api");
+class ArcTags extends abstract_api_1.ArcAbstractAPI {
+    constructor(options) {
+        super({ ...options, apiPath: 'tags' });
+    }
+    async getTags(params) {
+        const { data } = await this.client.get(`/search`, { params });
+        return data;
+    }
+    async addTags(payload) {
+        const { data } = await this.client.post(`/add`, payload);
+        return data;
+    }
+    async deleteTags(payload) {
+        const { data } = await this.client.post(`/delete`, payload);
+        return data;
+    }
+}
+exports.ArcTags = ArcTags;
+//# sourceMappingURL=index.js.map

package/dist/api/tags/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/tags/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAUhE,MAAa,OAAQ,SAAQ,6BAAc;IACzC,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,MAAqB;QACjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAkB,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAsB;QAClC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAkB,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAyB;QACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAqB,SAAS,EAAE,OAAO,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlBD,0BAkBC"}

package/dist/api/tags/types.d.ts

@@ -0,0 +1,55 @@
+export type Tag = {
+    slug: string;
+    name: string;
+    description?: string;
+    usage_counter: number;
+    organization: string;
+    /**
+     * Path is always /.
+     */
+    path: string;
+};
+export type GetTagsParams = {
+    term?: string;
+    /**
+    *  Should always set to /.
+    */
+    path?: string;
+    /**
+    *  Limit the number of items to return. Does not currently work. Check the documentation
+    */
+    size?: number;
+};
+export type GetTagsResponse = {
+    StatusCode: 200 | 400;
+    Payload: {
+        items: Tag[];
+        count: string;
+        next: string;
+        message?: string;
+    };
+};
+export type AddTagsResponse = {
+    StatusCode: 200 | 400;
+    Payload: {
+        message?: string;
+    };
+};
+export type DeleteTagsResponse = {
+    StatusCode: 200 | 400;
+    Payload: {
+        message?: string;
+    };
+};
+/**
+ * Create new tags. The maximum limit per request is 25 tags or 16 MB of data.
+ */
+export type AddTagRequest = {
+    slug: string;
+    name: string;
+    description?: string;
+}[];
+/**
+ * Delete tags. The maximum limit per request is 25 tags or 16 MB of data.
+ */
+export type DeleteTagRequest = string[];

package/dist/api/tags/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/api/tags/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/tags/types.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -15,4 +15,5 @@ export * from './api/websked/types';
 export * from './api/content/types';
 export * from './api/photo-center/types';
 export * from './api/global-settings/types';
+export * from './api/tags/types';
 export { ArcAPI, ArcUtils, WsClient, ContentElement, ContentElementType, ArcTypes, ArcError };

package/dist/index.js

@@ -50,4 +50,5 @@ __exportStar(require("./api/websked/types"), exports);
 __exportStar(require("./api/content/types"), exports);
 __exportStar(require("./api/photo-center/types"), exports);
 __exportStar(require("./api/global-settings/types"), exports);
+__exportStar(require("./api/tags/types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA+B;AAmBtB,uFAnBA,YAAM,OAmBA;AAlBf,yDAAwE;AAkBnC,+FAlB5B,iCAAc,OAkB4B;AAjBnD,+CAA2C;AAiBhB,yFAjBlB,oBAAQ,OAiBkB;AAhBnC,uCAAuC;AAgB4C,yFAhB1E,gBAAQ,OAgB0E;AAf3F,kDAAoC;AAeqC,4BAAQ;AAdjF,qCAAuC;AActB,yFAdR,cAAQ,OAcQ;AAZzB,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC;AACpC,sDAAoC;AACpC,2DAAyC;AACzC,8DAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA+B;AAoBtB,uFApBA,YAAM,OAoBA;AAnBf,yDAAwE;AAmBnC,+FAnB5B,iCAAc,OAmB4B;AAlBnD,+CAA2C;AAkBhB,yFAlBlB,oBAAQ,OAkBkB;AAjBnC,uCAAuC;AAiB4C,yFAjB1E,gBAAQ,OAiB0E;AAhB3F,kDAAoC;AAgBqC,4BAAQ;AAfjF,qCAAuC;AAetB,yFAfR,cAAQ,OAeQ;AAbzB,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC;AACpC,sDAAoC;AACpC,2DAAyC;AACzC,8DAA4C;AAC5C,mDAAiC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.21.0",
+  "version": "4.22.0",
   "description": "A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.",
   "type": "commonjs",
   "main": "./dist/index.js",