@code.store/arcxp-sdk-ts 4.3.0 → 4.4.0

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

@@ -1,7 +1,8 @@
-import { GetStoryParams } from './types';
+import { GetStoryParams, SearchParams, SearchResponse } from './types';
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
 import { AStory } from '../../types/story';
 export declare class ArcContent extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     getStory(params: GetStoryParams): Promise<AStory>;
+    search(params: SearchParams): Promise<SearchResponse>;
 }

package/dist/api/content/index.js

@@ -2,15 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArcContent = void 0;
 const abstract_api_1 = require("../abstract-api");
+const querystring_1 = require("querystring");
 class ArcContent extends abstract_api_1.ArcAbstractAPI {
     constructor(options) {
         super({ ...options, apiPath: 'content/v4' });
     }
     async getStory(params) {
-        const search = new URLSearchParams({ ...params, published: params.published.toString() }).toString();
+        const search = (0, querystring_1.stringify)(params);
         const { data } = await this.client.get(`/stories?${search}`);
         return data;
     }
+    async search(params) {
+        const search = (0, querystring_1.stringify)(params);
+        const { data } = await this.client.get(`/search?${search}`);
+        return data;
+    }
 }
 exports.ArcContent = ArcContent;
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/content/index.ts"],"names":[],"mappings":";;;AACA,kDAAgE;AAGhE,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;QAErG,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAXD,gCAWC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/content/index.ts"],"names":[],"mappings":";;;AACA,kDAAgE;AAEhE,6CAAwC;AAExC,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7D,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,WAAW,MAAM,EAAE,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlBD,gCAkBC"}

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

@@ -1,5 +1,26 @@
+import { AGallery } from '../../types/gallery';
+import { ARedirectObject, AStory } from '../../types/story';
 export type GetStoryParams = {
     _id: string;
     published: boolean;
     website: string;
 };
+export type SearchParams = {
+    website: string;
+    q?: string;
+    body?: string;
+    sort?: string;
+    from?: number;
+    size?: number;
+    single?: boolean;
+    _sourceInclude?: string;
+    _sourceExclude?: string;
+    include_distributor_name?: string;
+    exclude_distributor_name?: string;
+    include_distributor_category?: string;
+    exclude_distributor_category?: string;
+};
+export type SearchResponse = {
+    type: 'results';
+    content_elements: (AStory | AGallery | ARedirectObject)[];
+};

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

@@ -1,7 +1,9 @@
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
-import { CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, DocumentRedirect, ExternalRedirect } from './types';
+import { CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, DocumentRedirect, ExternalRedirect, Revision, Document } from './types';
 export declare class ArcDraft extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     generateId(id: string): Promise<string>;
+    unpublishDocument(id: string, type?: string): Promise<Revision>;
+    deleteDocument(id: string, type?: string): Promise<Document>;
     createRedirect<P extends CreateRedirectPayload, R = P extends CreateExternalRedirectPayload ? ExternalRedirect : P extends CreateDocumentRedirectPayload ? DocumentRedirect : never>(website: string, websiteUrl: string, payload: P): Promise<R>;
 }

package/dist/api/draft/index.js

@@ -10,6 +10,14 @@ class ArcDraft extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.get('/arcuuid', { params: { id } });
         return data.id;
     }
+    async unpublishDocument(id, type = 'story') {
+        const { data } = await this.client.delete(`/${type}/${id}/revision/published`);
+        return data;
+    }
+    async deleteDocument(id, type = 'story') {
+        const { data } = await this.client.delete(`/${type}/${id}`);
+        return data;
+    }
     async createRedirect(website, websiteUrl, payload) {
         const { data } = await this.client.post(`/redirect/${website}/${websiteUrl}`, payload);
         return data;

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/draft/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAShE,MAAa,QAAS,SAAQ,6BAAc;IAC1C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAiB,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,cAAc,CAOlB,OAAe,EAAE,UAAkB,EAAE,OAAU;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAI,aAAa,OAAO,IAAI,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArBD,4BAqBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/draft/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAWhE,MAAa,QAAS,SAAQ,6BAAc;IAC1C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAiB,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAChD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAOlB,OAAe,EAAE,UAAkB,EAAE,OAAU;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAI,aAAa,OAAO,IAAI,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/BD,4BA+BC"}

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

@@ -1,3 +1,4 @@
+import { AStory } from '../../types/story';
 export type CreateExternalRedirectPayload = {
     redirect_to: string;
     document_id?: undefined;
@@ -19,4 +20,23 @@ export type DocumentRedirect = {
 export type ExternalRedirect = {
     redirect_to: string;
 } & BaseRedirectData;
+export type Revision = {
+    id: string;
+    document_id: string;
+    created_at: string;
+    type: string;
+    user_id?: string;
+    ans: AStory;
+};
+export type Document = {
+    id: string;
+    type: 'STORY';
+    created_at: string;
+    draft_revision_id: string;
+    published_revision_id?: string;
+    first_published_at?: string;
+    last_published_at?: string;
+    first_unpublished_at?: string;
+    last_unpublished_at?: string;
+};
 export {};

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

@@ -20,12 +20,12 @@ class ArcMigrationCenter extends abstract_api_1.ArcAbstractAPI {
         return data;
     }
     async postAns(params, payload) {
-        const search = new URLSearchParams(params).toString();
+        const search = (0, querystring_1.stringify)(params);
         const { data } = await this.client.post(`/content/ans?${search}`, payload);
         return data;
     }
     async getAns(params) {
-        const search = new URLSearchParams(params).toString();
+        const search = (0, querystring_1.stringify)(params);
         const { data } = await this.client.get(`/content/ans?${search}`);
         return data;
     }

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":";;;AAUA,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;QACT,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAQ,sBAAsB,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,OAAuB;QAC1D,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEtD,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,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEtD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjCD,gDAiCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/migration-center/index.ts"],"names":[],"mappings":";;;AAUA,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;QACT,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAQ,sBAAsB,CAAC,CAAC;QACtE,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;AAjCD,gDAiCC"}

package/dist/scripts/json-schema-to-ts.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/scripts/json-schema-to-ts.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const json_schema_to_typescript_1 = require("json-schema-to-typescript");
+const input = './input.json';
+const output = './output.ts';
+(0, json_schema_to_typescript_1.compileFromFile)(input).then((ts) => (0, fs_1.writeFileSync)(output, ts));
+//# sourceMappingURL=json-schema-to-ts.js.map

package/dist/scripts/json-schema-to-ts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-schema-to-ts.js","sourceRoot":"","sources":["../../src/scripts/json-schema-to-ts.ts"],"names":[],"mappings":";;AAAA,2BAAmC;AACnC,yEAA4D;AAE5D,MAAM,KAAK,GAAG,cAAc,CAAC;AAC7B,MAAM,MAAM,GAAG,aAAa,CAAC;AAE7B,IAAA,2CAAe,EAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,kBAAa,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC"}

package/dist/types/gallery.d.ts

@@ -0,0 +1,52 @@
+import { GloballyUniqueIDTrait, DescribesTheANSVersionOfThisObject, SubtypeOrTemplate, ChannelTrait, Alignment, Locale, CopyrightInformation, CanonicalURL, CanonicalWebsite, Website, WebsiteURL, Short_Url, CreatedDate, LastUpdatedDate, Publish_Date, FirstPublishDate, Display_Date, LocationRelatedTrait, Geo, Address, Editor_Note, Status, Headlines, SubHeadlines, Description, CreditTrait, VanityCreditsTrait, Taxonomy, PromoItems, Related_Content, OwnerInformation, SchedulingInformation, WorkflowInformation, Pitches, Revision, Syndication, Source, Distributor, Tracking, Comments, Label, Slug, ContentRestrictions, HasAdditionalProperties, AliasesTrait, ACollectionOfContent, WebsitesInput, Contributors } from './story';
+export interface AGallery {
+    type: 'gallery';
+    _id?: GloballyUniqueIDTrait;
+    version: DescribesTheANSVersionOfThisObject;
+    subtype?: SubtypeOrTemplate;
+    channels?: ChannelTrait;
+    alignment?: Alignment;
+    language?: Locale;
+    copyright?: CopyrightInformation;
+    canonical_url?: CanonicalURL;
+    canonical_website?: CanonicalWebsite;
+    website?: Website;
+    website_url?: WebsiteURL;
+    short_url?: Short_Url;
+    created_date?: CreatedDate;
+    last_updated_date?: LastUpdatedDate;
+    publish_date?: Publish_Date;
+    first_publish_date?: FirstPublishDate;
+    display_date?: Display_Date;
+    location?: LocationRelatedTrait;
+    geo?: Geo;
+    address?: Address;
+    editor_note?: Editor_Note;
+    status?: Status;
+    headlines?: Headlines;
+    subheadlines?: SubHeadlines;
+    description?: Description;
+    credits?: CreditTrait;
+    vanity_credits?: VanityCreditsTrait;
+    taxonomy?: Taxonomy;
+    promo_items?: PromoItems;
+    related_content?: Related_Content;
+    owner?: OwnerInformation;
+    planning?: SchedulingInformation;
+    workflow?: WorkflowInformation;
+    pitches?: Pitches;
+    revision?: Revision;
+    syndication?: Syndication;
+    source?: Source;
+    distributor?: Distributor;
+    tracking?: Tracking;
+    comments?: Comments;
+    label?: Label;
+    slug?: Slug;
+    content_restrictions?: ContentRestrictions;
+    additional_properties?: HasAdditionalProperties;
+    content_aliases?: AliasesTrait;
+    content_elements?: ACollectionOfContent;
+    websites?: WebsitesInput;
+    contributors?: Contributors;
+}

package/dist/types/gallery.js

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

package/dist/types/gallery.js.map

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

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * as Author from './author';
 export * as Story from './story';
 export * as Section from './section';
+export * as Gallery from './gallery';

package/dist/types/index.js

@@ -23,8 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Section = exports.Story = exports.Author = void 0;
+exports.Gallery = exports.Section = exports.Story = exports.Author = void 0;
 exports.Author = __importStar(require("./author"));
 exports.Story = __importStar(require("./story"));
 exports.Section = __importStar(require("./section"));
+exports.Gallery = __importStar(require("./gallery"));
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,iDAAiC;AACjC,qDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,iDAAiC;AACjC,qDAAqC;AACrC,qDAAqC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -16,6 +16,7 @@
     "build": "tsc",
     "lint": "tsc --noEmit && TIMING=1 eslint \"src/**/*.ts*\"",
     "test": "vitest",
+    "gen:ts": "npx ts-node-dev ./src/scripts/json-schema-to-ts.ts",
     "cs": "npx changeset && npx changeset version"
   },
   "keywords": [
@@ -43,6 +44,7 @@
     "eslint": "^8.31.0",
     "eslint-config-custom-server": "*",
     "openapi-typescript": "^6.2.7",
+    "json-schema-to-typescript": "13.1.1",
     "tap": "^16.3.4",
     "ts-node-dev": "^2.0.0",
     "vitest": "^0.33.0"