@code.store/arcxp-sdk-ts 1.1.0 → 2.0.0

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "",
   "main": "./src/index.ts",
   "scripts": {
     "build": "tsc",
     "lint": "tsc --noEmit && TIMING=1 eslint \"src/**/*.ts*\"",
-    "test": "vitest",
-    "publish": "npm publish --access public"
+    "test": "vitest"
   },
   "keywords": [],
   "author": "code.store",

package/src/api/draft/index.ts

@@ -7,7 +7,6 @@ export class ArcDraft extends ArcAbstractAPI {
 
   async generateId(id: string) {
     const { data } = await this.client.get<{ id: string }>('/arcuuid', { params: { id } });
-  
     return data.id;
   }
 }

package/src/api/draft/types.ts

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

package/src/api/error.ts

@@ -12,16 +12,19 @@ export class ArcError extends Error {
   constructor(service: string, e: AxiosError) {
     const ratelimitRemaining = e.response?.headers['arcpub-ratelimit-remaining'];
     const ratelimitReset = e.response?.headers['arcpub-ratelimit-reset'];
-    const message = safeJSONStringify(e.message);
+    const data = {
+      name: `${service}Error`,
+      responseData: e.response?.data,
+      responseStatus: e.response?.status,
+      responseConfig: e.response?.config,
+      ratelimitRemaining,
+      ratelimitReset,
+      service,
+    };
+    const message = safeJSONStringify(data);
 
     super(message);
 
-    this.name = `${service}Error`;
-    this.responseData = e.response?.data;
-    this.responseStatus = e.response?.status;
-    this.responseConfig = e.response?.config;
-    this.ratelimitRemaining = ratelimitRemaining;
-    this.ratelimitReset = ratelimitReset;
-    this.service = service;
+    Object.assign(this, data);
   }
 }

package/src/api/ifx/index.ts

@@ -50,7 +50,7 @@ export class ArcIFX extends ArcAbstractAPI {
   }
 
   async addSecret(payload: AddSecretPayload) {
-    const { data } = await this.client.post(`/admin/secret?integrationName=${payload.intergrationName}`, {
+    const { data } = await this.client.post(`/admin/secret?integrationName=${payload.integrationName}`, {
       secretName: payload.secretName,
       secretValue: payload.secretValue,
     });

package/src/api/ifx/types.ts

@@ -21,7 +21,7 @@ export type SubscribePayload = {
 };
 
 export type AddSecretPayload = {
-  intergrationName: string;
+  integrationName: string;
   secretName: string;
   secretValue: string;
 };

package/src/api/index.ts

@@ -10,7 +10,7 @@ import { ArcWebsked } from './websked';
 import WsClient from './ws.client';
 
 export const ArcAPI = (options: ArcAPIOptions) => {
-  const api = {
+  const API = {
     Author: new ArcAuthor(options),
     Draft: new ArcDraft(options),
     Identity: new ArcIdentity(options),
@@ -22,7 +22,10 @@ export const ArcAPI = (options: ArcAPIOptions) => {
   };
 
   return {
-    api,
+    ...API,
+    setMaxRPS: (rps: number) => {
+      Object.values(API).forEach((a) => a.setMaxRPS(rps));
+    },
     RetailEvents: (index: '0' | '1' | 'string' = '0') => {
       const address = `wss://api.${options.credentials.organizationName}.arcpublishing.com/retail/api/v1/event/stream/${index}`;
       const headers = {
@@ -30,8 +33,5 @@ export const ArcAPI = (options: ArcAPIOptions) => {
       };
       return new WsClient(address, { headers });
     },
-    setMaxRPS: (rps: number) => {
-      Object.values(api).forEach((a) => a.setMaxRPS(rps));
-    },
   };
 };

package/src/api/migration-center/types.ts

@@ -1,3 +1,4 @@
+import { SectionReference } from '../../types/section';
 import { AStory, AnImage, Tag } from '../../types/story';
 
 type TagANS = Tag & { name: string };
@@ -29,15 +30,6 @@ type AuthorANS = {
   status: boolean;
 };
 
-export type SectionReference = {
-  type: 'reference';
-  referent: {
-    id: string;
-    website: string;
-    type: 'section';
-  };
-};
-
 export type PostANSPayload = {
   sourceId: string;
   sourceType: string;
@@ -78,7 +70,7 @@ export type PostANSPayload = {
 export type PostANSParams = {
   website: string;
   groupId: string;
-  priority: 'historical';
+  priority: 'historical' | 'live';
 };
 
 export type GetANSParams = {
@@ -165,8 +157,8 @@ export type SummaryReportRequest = {
   website: string;
   groupId?: string;
   fetchFromId?: string;
-  sort: SummarySortBy;
-  sortOrder: SummarySortOrder;
+  sort?: SummarySortBy;
+  sortOrder?: SummarySortOrder;
 };
 
 export enum SummarySortBy {

package/src/api/site/types.ts

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

package/src/index.ts

@@ -2,4 +2,12 @@ import { ArcAPI } from './api';
 import { ContentElement, ContentElementType } from './content-elements';
 import * as ArcTypes from './types';
 
+export * from './api/identity/types';
+export * from './api/draft/types';
+export * from './api/site/types';
+export * from './api/ifx/types';
+export * from './api/migration-center/types';
+export * from './api/sales/types';
+export * from './api/websked/types';
+
 export { ArcAPI, ContentElement, ContentElementType, ArcTypes };

package/src/tests/api/basic.test.ts

@@ -7,11 +7,9 @@ describe('Arc API', () => {
     vi.clearAllMocks();
   });
 
-  test('should throw error (Invalid token)', async () => {
-    const Arc = ArcAPI({ credentials: { organizationName: 'codestore', accessToken: Date.now().toString() } });
+  test('Should throw authorization error (Invalid token)', async () => {
+    const API = ArcAPI({ credentials: { organizationName: 'codestore', accessToken: Date.now().toString() } });
 
-    await expect(Arc.api.Draft.generateId(Date.now().toString())).rejects.toThrowError(
-      'Request failed with status code 401'
-    );
+    await expect(API.Draft.generateId(Date.now().toString())).rejects.toThrowError(/401 Authorization Required/);
   });
 });

package/src/types/{author.d.ts → author.ts}

@@ -12,7 +12,7 @@ export type GloballyUniqueIDTrait = string;
 /**
  * The version of ANS that this object was serialized as, in major.minor.patch format.  For top-level content objects, this is a required trait.
  */
-export type DescribesTheANSVersionOfThisObject = "0.10.9";
+export type DescribesTheANSVersionOfThisObject = '0.10.9';
 /**
  * The full human name of contributor. See also byline, first_name, last_name, middle_name, suffix.
  */
@@ -28,7 +28,7 @@ export type ChannelTrait = string[];
 /**
  * A property used to determine horizontal positioning of a content element relative to the elements that immediately follow it in the element sequence.
  */
-export type Alignment = "left" | "right" | "center";
+export type Alignment = 'left' | 'right' | 'center';
 /**
  * The primary language of the content. The value should follow IETF BCP47. (e.g. 'en', 'es-419', etc.)
  */
@@ -243,20 +243,20 @@ export type Distributor =
       /**
        * The machine-readable category of how this content was produced. Use 'staff' if this content was produced by an employee of the organization who owns this document repository. (Multisite note: content produced within a single *organization*, but shared across multiple *websites* should still be considered 'staff.') Use ‘wires’ if this content was produced for another organization and shared with the one who owns this document repository. Use 'freelance' if this content was produced by an individual on behalf of the organization who owns this document repository. Use 'stock' if this content is stock media distributed directly from a stock media provider. Use 'handout' if this is content provided from a source for an article (usually promotional media distributed directly from a company). Use 'other' for all other cases.
        */
-      category?: "staff" | "wires" | "freelance" | "stock" | "handout" | "other";
+      category?: 'staff' | 'wires' | 'freelance' | 'stock' | 'handout' | 'other';
       /**
        * The machine-readable subcategory of how this content was produced. E.g., 'freelance - signed'. May vary between organizations.
        */
       subcategory?: string;
       additional_properties?: HasAdditionalProperties;
-      mode?: "custom";
+      mode?: 'custom';
     }
   | {
       /**
        * The ARC UUID of the distributor of this content. E.g., ABCDEFGHIJKLMNOPQRSTUVWXYZ.
        */
       reference_id: string;
-      mode: "reference";
+      mode: 'reference';
     };
 /**
  * An list of alternate names that this content can be fetched by instead of id.
@@ -385,7 +385,7 @@ export interface AnAuthorOfAPieceOfContent {
   /**
    * Indicates that this is an author
    */
-  type: "author";
+  type: 'author';
   version?: DescribesTheANSVersionOfThisObject;
   name: Name;
   image?: AnImage;
@@ -421,7 +421,7 @@ export interface AnAuthorOfAPieceOfContent {
  * Holds attributes of an ANS image component. In the Arc ecosystem, these are stored in Anglerfish.
  */
 export interface AnImage {
-  type: "image";
+  type: 'image';
   _id?: GloballyUniqueIDTrait;
   version: DescribesTheANSVersionOfThisObject;
   subtype?: SubtypeOrTemplate;
@@ -582,7 +582,7 @@ export interface CreditTrait {
    * This interface was referenced by `CreditTrait`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*".
    */
-  [k: string]: (AnAuthorOfAPieceOfContent1 | RepresentationOfANormalizedElement)[];
+  [k: string]: (AnAuthorOfAPieceOfContent1 | RepresentationOfANormalizedElement)[] | undefined;
 }
 /**
  * Models attribution to an individual or group for contribution towards some content item. In the Arc ecosystem, these are stored in the arc-author-service.
@@ -592,7 +592,7 @@ export interface AnAuthorOfAPieceOfContent1 {
   /**
    * Indicates that this is an author
    */
-  type: "author";
+  type: 'author';
   version?: DescribesTheANSVersionOfThisObject;
   name: Name1;
   image?: AnImage;
@@ -635,7 +635,7 @@ export interface School {
  * This represents a reference to external content that should be denormalized
  */
 export interface RepresentationOfANormalizedElement {
-  type: "reference";
+  type: 'reference';
   additional_properties?: HasAdditionalProperties;
   _id?: GloballyUniqueIDTrait;
   subtype?: SubtypeOrTemplate;
@@ -680,7 +680,7 @@ export interface VanityCreditsTrait {
    * This interface was referenced by `VanityCreditsTrait`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*".
    */
-  [k: string]: (AnAuthorOfAPieceOfContent1 | RepresentationOfANormalizedElement)[];
+  [k: string]: (AnAuthorOfAPieceOfContent1 | RepresentationOfANormalizedElement)[] | undefined;
 }
 /**
  * Holds the collection of tags, categories, keywords, etc that describe content.
@@ -710,7 +710,7 @@ export interface Taxonomy {
     | Site
     | (RepresentationOfANormalizedElement & {
         referent?: {
-          type?: "site";
+          type?: 'site';
           [k: string]: unknown;
         };
         [k: string]: unknown;
@@ -722,7 +722,7 @@ export interface Taxonomy {
     | Section
     | (RepresentationOfANormalizedElement & {
         referent?: {
-          type?: "section";
+          type?: 'section';
           [k: string]: unknown;
         };
         [k: string]: unknown;
@@ -734,7 +734,7 @@ export interface Taxonomy {
     | Site
     | (RepresentationOfANormalizedElement & {
         referent?: {
-          type?: "site";
+          type?: 'site';
           [k: string]: unknown;
         };
         [k: string]: unknown;
@@ -747,7 +747,7 @@ export interface Taxonomy {
     | Section
     | (RepresentationOfANormalizedElement & {
         referent?: {
-          type?: "section";
+          type?: 'section';
           [k: string]: unknown;
         };
         [k: string]: unknown;
@@ -851,7 +851,7 @@ export interface Auxiliary {
  */
 export interface Tag {
   _id?: GloballyUniqueIDTrait;
-  type?: "tag";
+  type?: 'tag';
   subtype?: SubtypeOrTemplate;
   /**
    * The text of the tag as displayed to users.
@@ -868,7 +868,7 @@ export interface Tag {
  * A hierarchical section or 'site' in a taxonomy. In the Arc ecosystem, these are stored in the arc-site-service.
  */
 export interface Site {
-  type: "site";
+  type: 'site';
   _id?: GloballyUniqueIDTrait;
   version: DescribesTheANSVersionOfThisObject;
   additional_properties?: HasAdditionalProperties;
@@ -897,7 +897,7 @@ export interface Site {
  * A hierarchical section in a taxonomy. In the Arc ecosystem, these are stored in the arc-site-service.
  */
 export interface Section {
-  type: "section";
+  type: 'section';
   _id?: GloballyUniqueIDTrait;
   _website?: Website;
   version: DescribesTheANSVersionOfThisObject;
@@ -947,7 +947,8 @@ export interface PromoItems {
     | AContentObject
     | RepresentationOfANormalizedElement
     | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns0109StoryElementsRawHtmlJson
-    | CustomEmbed;
+    | CustomEmbed
+    | undefined;
 }
 /**
  * Holds common attributes of ANS Content objects.
@@ -1013,13 +1014,13 @@ export interface Related_Content {
    * This interface was referenced by `Related_Content`'s JSON-Schema definition
    * via the `patternProperty` ".*".
    */
-  [k: string]: (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[];
+  [k: string]: undefined | [ARedirectObject] | (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[];
 }
 /**
  * A redirect to another story.
  */
 export interface ARedirectObject {
-  type: "redirect";
+  type: 'redirect';
   _id?: GloballyUniqueIDTrait;
   version: DescribesTheANSVersionOfThisObject;
   owner?: OwnerInformation;
@@ -1079,7 +1080,7 @@ export interface Revision {
  * A custom embed element. Can be used to reference content from external providers about which little is known.
  */
 export interface CustomEmbed {
-  type: "custom_embed";
+  type: 'custom_embed';
   _id?: GloballyUniqueIDTrait;
   subtype?: SubtypeOrTemplate;
   channels?: ChannelTrait;
@@ -1320,7 +1321,7 @@ export interface Syndication {
    * This interface was referenced by `Syndication`'s JSON-Schema definition
    * via the `patternProperty` ".*".
    */
-  [k: string]: boolean;
+  [k: string]: boolean | undefined;
 }
 /**
  * Information about the original source and/or owner of this content
@@ -1405,21 +1406,23 @@ export interface Label {
    * This interface was referenced by `Label`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*$".
    */
-  [k: string]: {
-    /**
-     * The text of this label.
-     */
-    text: string;
-    /**
-     * An optional destination url of this label.
-     */
-    url?: string;
-    /**
-     * If false, this label should be hidden.
-     */
-    display?: boolean;
-    additional_properties?: HasAdditionalProperties;
-  };
+  [k: string]:
+    | {
+        /**
+         * The text of this label.
+         */
+        text: string;
+        /**
+         * An optional destination url of this label.
+         */
+        url?: string;
+        /**
+         * If false, this label should be hidden.
+         */
+        display?: boolean;
+        additional_properties?: HasAdditionalProperties;
+      }
+    | undefined;
 }
 /**
  * Trait that applies contains the content restrictions of an ANS object.
@@ -1490,7 +1493,7 @@ export interface Contributors {
  * An html content element
  */
 export interface HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns0109StoryElementsRawHtmlJson {
-  type: "raw_html";
+  type: 'raw_html';
   _id?: GloballyUniqueIDTrait;
   subtype?: SubtypeOrTemplate;
   channels?: ChannelTrait;

package/src/types/index.ts

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

package/src/types/{section.d.ts → section.ts}

@@ -1,3 +1,12 @@
+export type SectionReference = {
+  type: 'reference';
+  referent: {
+    id: string;
+    website: string;
+    type: 'section';
+  };
+};
+
 export type Section = {
   _id: string;
   site?: {
@@ -15,7 +24,7 @@ export type Section = {
   site_topper?: { site_logo_image: null };
   _admin?: { alias_ids: string[] };
   _website?: string;
-  name: strign;
+  name: string;
   order?: any;
   parent?: { default?: string; footer?: null | string; header?: string };
   ancestors?: { default: []; footer: []; header: [] };

package/src/types/{story.d.ts → story.ts}

@@ -636,7 +636,7 @@ export interface CreditTrait {
    * This interface was referenced by `CreditTrait`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*".
    */
-  [k: string]: (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement)[];
+  [k: string]: (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement)[] | undefined;
 }
 /**
  * Models attribution to an individual or group for contribution towards some content item. In the Arc ecosystem, these are stored in the arc-author-service.
@@ -765,7 +765,7 @@ export interface VanityCreditsTrait {
    * This interface was referenced by `VanityCreditsTrait`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*".
    */
-  [k: string]: (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement)[];
+  [k: string]: (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement)[] | undefined;
 }
 /**
  * This represents a reference to external content that should be denormalized
@@ -1071,7 +1071,8 @@ export interface PromoItems {
     | AContentObject
     | RepresentationOfANormalizedElement
     | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns0109StoryElementsRawHtmlJson
-    | CustomEmbed;
+    | CustomEmbed
+    | undefined;
 }
 /**
  * Holds common attributes of ANS Content objects.
@@ -1137,7 +1138,7 @@ export interface Related_Content {
    * This interface was referenced by `Related_Content`'s JSON-Schema definition
    * via the `patternProperty` ".*".
    */
-  [k: string]: (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[];
+  [k: string]: undefined | [ARedirectObject] | (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[];
 }
 /**
  * A redirect to another story.
@@ -1444,7 +1445,7 @@ export interface Syndication {
    * This interface was referenced by `Syndication`'s JSON-Schema definition
    * via the `patternProperty` ".*".
    */
-  [k: string]: boolean;
+  [k: string]: boolean | undefined;
 }
 /**
  * Information about the original source and/or owner of this content
@@ -1529,21 +1530,23 @@ export interface Label {
    * This interface was referenced by `Label`'s JSON-Schema definition
    * via the `patternProperty` "^[a-zA-Z0-9_]*$".
    */
-  [k: string]: {
-    /**
-     * The text of this label.
-     */
-    text: string;
-    /**
-     * An optional destination url of this label.
-     */
-    url?: string;
-    /**
-     * If false, this label should be hidden.
-     */
-    display?: boolean;
-    additional_properties?: HasAdditionalProperties;
-  };
+  [k: string]:
+    | {
+        /**
+         * The text of this label.
+         */
+        text: string;
+        /**
+         * An optional destination url of this label.
+         */
+        url?: string;
+        /**
+         * If false, this label should be hidden.
+         */
+        display?: boolean;
+        additional_properties?: HasAdditionalProperties;
+      }
+    | undefined;
 }
 /**
  * Trait that applies contains the content restrictions of an ANS object.

package/src/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './author';
-export * from './story';
-export * from './section';