Merge pull request #25 from code-store-platform/feat/add-video-api-and-types

Add Video Center API

Author: msadovyi

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @code.store/arcxp-sdk-ts
 
+## 5.6.0
+
+### Minor Changes
+
+- b1cd942: Add VideoCenter API with importVideo, deleteVideo, and updateVideoUrl methods
+
 ## 5.5.0
 
 ### Minor Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "5.5.0",
+  "version": "5.6.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": "module",
   "main": "./dist/index.js",

src/api/index.ts

@@ -16,6 +16,7 @@ import { ArcSales, ArcSalesV2 } from './sales/index.js';
 import { ArcSigningService } from './signing-service/index.js';
 import { ArcSite } from './site/index.js';
 import { ArcTags } from './tags/index.js';
+import { ArcVideoCenter } from './video-center/index.js';
 import { ArcWebsked } from './websked/index.js';
 
 export const ArcAPI = (options: ArcAPIOptions) => {
@@ -38,6 +39,7 @@ export const ArcAPI = (options: ArcAPIOptions) => {
     ContentOps: new ArcContentOps(options),
     RetailEvents: new ArcRetailEvents(options),
     DeveloperRetail: new ArcDeveloperRetail(options),
+    VideoCenter: new ArcVideoCenter(options),
     Custom: new Custom(options),
   };
 

src/api/video-center/index.ts

@@ -0,0 +1,20 @@
+import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
+import type { DeleteVideoParams, ImportVideoParams, ImportVideoPayload, UpdateVideoUrlParams } from './types.js';
+
+export class ArcVideoCenter extends ArcAbstractAPI {
+  constructor(options: ArcAPIOptions) {
+    super({ ...options, apiPath: 'goldfish' });
+  }
+
+  async importVideo(payload: ImportVideoPayload, params: ImportVideoParams): Promise<void> {
+    await this.client.post('/video/v2/import/ans', payload, { params });
+  }
+
+  async deleteVideo(params: DeleteVideoParams): Promise<void> {
+    await this.client.delete('/video/v2/import/ans', { params });
+  }
+
+  async updateVideoUrl(params: UpdateVideoUrlParams): Promise<void> {
+    await this.client.post('/video/v2/url/update', undefined, { params });
+  }
+}

src/api/video-center/types.ts

@@ -0,0 +1,26 @@
+export type ImportVideoParams = {
+  encode: boolean;
+  isLive: boolean;
+  useLastUpdated: boolean;
+};
+
+export type ImportVideoPayload = {
+  id?: string;
+  type?: 'AUTHOR' | 'CLARIFICATION' | 'CORRECTION' | 'IMAGE' | 'REDIRECT' | 'REFERENCE' | 'SECTION' | 'SITE' | 'STORY' | 'VIDEO';
+  version?: '_0_5_7' | '_0_5_8' | '_0_5_9' | '_0_6_0' | '_0_6_2' | '_0_8_0';
+  canonicalWebsite?: string;
+  embedHtml?: string;
+  promoImage?: Record<string, unknown>;
+  promoItems?: { basic?: Record<string, unknown> };
+  streams?: Record<string, unknown>[];
+  websites?: Record<string, unknown>;
+};
+
+export type DeleteVideoParams = {
+  uuid: string;
+  hardDelete?: boolean;
+};
+
+export type UpdateVideoUrlParams = {
+  uuid: string;
+};

src/types/index.ts

@@ -13,6 +13,7 @@ export * from '../api/sales/types.js';
 export * from '../api/signing-service/types.js';
 export * from '../api/site/types.js';
 export * from '../api/tags/types.js';
+export * from '../api/video-center/types.js';
 export * from '../api/websked/types.js';
 export * from '../content-elements/types.js';
 export * as ANS from './ans-types';