@code.store/arcxp-sdk-ts 5.3.3 → 5.5.0

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

@@ -1,7 +1,11 @@
 import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
-import type { ListAuthorsParams, ListAuthorsResponse } from './types.js';
+import type { AuthorANS, AuthorConfigurationResponse, CreateAuthorPayload, GetAuthorParams, ListAuthorsParams, ListAuthorsResponse, UpdateAuthorPayload } from './types.js';
 export declare class ArcAuthor extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
+    getAuthor(params: GetAuthorParams): Promise<AuthorANS>;
     listAuthors(params?: ListAuthorsParams): Promise<ListAuthorsResponse>;
-    delete(userId: string): Promise<void>;
+    createAuthor(payload: CreateAuthorPayload): Promise<AuthorANS>;
+    updateAuthor(id: string, payload: UpdateAuthorPayload): Promise<AuthorANS>;
+    deleteAuthor(id: string): Promise<void>;
+    getConfiguration(): Promise<AuthorConfigurationResponse>;
 }

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

@@ -1,4 +1,12 @@
 export type ListAuthorsParams = Partial<{
+    sort_by: 'lastName' | 'last_updated_date';
+    order: 'asc' | 'desc';
+    byline: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    slug: string;
+    include_inactive: boolean;
     limit: number;
     last: string;
 }>;
@@ -7,6 +15,34 @@ export type ListAuthorsResponse = {
     more?: boolean;
     last?: string;
 };
+export type CreateAuthorPayload = Omit<AuthorANS, 'last_updated_date'>;
+export type UpdateAuthorPayload = Partial<Omit<AuthorANS, '_id' | 'last_updated_date'>>;
+export type GetAuthorParams = {
+    _id: string;
+};
+export type AuthorConfigurationResponse = {
+    q_results: AuthorFieldConfig[];
+    count: number;
+    limit: number;
+    offset: number;
+    total_count: number;
+};
+export type AuthorFieldConfig = {
+    _id: string;
+    key: string;
+    label?: string;
+    type?: string;
+    required?: boolean;
+    hidden?: boolean;
+    placeholder?: string;
+    default?: string;
+    max?: number;
+    versionAdded?: number;
+    picklist_options?: {
+        value: string;
+        label: string;
+    }[];
+};
 export type AuthorANS = {
     type: 'author';
     _id: string;
@@ -16,6 +52,9 @@ export type AuthorANS = {
     slug: string;
     email: string;
     image?: string;
+    url?: string;
+    middleName?: string;
+    suffix?: string;
     affiliations?: string;
     author_type?: string;
     education?: {
@@ -24,6 +63,16 @@ export type AuthorANS = {
     awards?: {
         name: string;
     }[];
+    books?: {
+        title: string;
+        url?: string;
+        publisher?: string;
+    }[];
+    podcasts?: {
+        name?: string;
+        url?: string;
+        download_url?: string;
+    }[];
     bio_page?: string;
     bio?: string;
     longBio?: string;
@@ -33,9 +82,22 @@ export type AuthorANS = {
     location?: string;
     role?: string;
     expertise?: string;
+    languages?: string;
+    beat?: string;
     personal_website?: string;
     twitter?: string;
     facebook?: string;
     linkedin?: string;
+    youtube?: string;
+    tumblr?: string;
+    pinterest?: string;
+    soundcloud?: string;
+    instagram?: string;
+    rss?: string;
+    snapchat?: string;
+    whatsapp?: string;
+    medium?: string;
+    reddit?: string;
+    last_updated_date?: string;
     status?: boolean;
 };

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

@@ -1,25 +1,48 @@
 import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
-import type { AddSecretPayload, Bundle, CreateIntegrationPayload, GenereteDeleteTokenResponse, GetBundlesResponse, GetSubscriptionsResponse, Integration, SubscribePayload, UpdateIntegrationPayload } from './types.js';
+import type { AddSecretPayload, Bundle, CreateIntegrationPayload, CreateWebhookPayload, CustomEvent, CustomEventUpdatePayload, GenereteDeleteTokenResponse, GetBundlesResponse, GetCustomEventsResponse, GetEventHistoryParams, GetEventHistoryResponse, GetEventPayloadResponse, GetIntegrationsResponse, GetLogQueriesResponse, GetLogsResponse, GetSubscriptionsResponse, GetWebhooksResponse, InitializeLogQueryParams, IntegrationDetail, SubscribePayload, TriggerWebhookPayload, UpdateIntegrationPayload, Webhook } from './types.js';
 export declare class ArcIFX extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     createIntegration(payload: CreateIntegrationPayload): Promise<void>;
+    getIntegration(integrationName: string): Promise<IntegrationDetail>;
+    getIntegrations(page?: number, pageSize?: number): Promise<GetIntegrationsResponse>;
     updateIntegration(integrationName: string, payload: UpdateIntegrationPayload): Promise<void>;
     deleteIntegration(integrationName: string, token: string): Promise<void>;
     generateDeleteIntegrationToken(integrationName: string): Promise<GenereteDeleteTokenResponse>;
-    getIntegrations(): Promise<Integration[]>;
-    getJobs(integrationName: string): Promise<any>;
-    getStatus(integrationName: string): Promise<any>;
-    initializeQuery(integrationName: string, query?: string): Promise<{
-        queryId: string;
-    }>;
-    getLogs(queryId: string, raw?: boolean): Promise<any>;
+    getBundles(integrationName: string): Promise<GetBundlesResponse>;
+    uploadBundle(integrationName: string, name: string, bundlePath: string): Promise<Bundle>;
+    deployBundle(integrationName: string, bundleName: string): Promise<Bundle>;
+    downloadBundle(integrationName: string, bundleName: string): Promise<Buffer>;
+    promoteBundle(integrationName: string, version: number): Promise<Bundle>;
     subscribe(payload: SubscribePayload): Promise<any>;
     updateSubscription(payload: SubscribePayload): Promise<any>;
     getSubscriptions(): Promise<GetSubscriptionsResponse>;
+    getEventPayload(integrationName: string, invocationId: string): Promise<GetEventPayloadResponse>;
+    getEventHistory(integrationName: string, params?: GetEventHistoryParams): Promise<GetEventHistoryResponse>;
+    getCustomEvents(page?: number, pageSize?: number): Promise<GetCustomEventsResponse>;
+    createCustomEvent(payload: CustomEvent): Promise<CustomEvent>;
+    updateCustomEvent(eventName: string, payload: CustomEventUpdatePayload): Promise<CustomEvent>;
+    deleteCustomEvent(eventName: string): Promise<{
+        message: string;
+    }>;
+    deleteCustomEventSchedule(eventName: string): Promise<{
+        message: string;
+    }>;
+    getWebhooks(page?: number, pageSize?: number): Promise<GetWebhooksResponse>;
+    createWebhook(eventName: string, payload?: CreateWebhookPayload): Promise<Webhook>;
+    updateWebhook(eventName: string, payload: CreateWebhookPayload): Promise<Webhook>;
+    deleteWebhook(eventName: string): Promise<{
+        message: string;
+    }>;
+    triggerWebhook(uuid: string, payload: TriggerWebhookPayload): Promise<void>;
     addSecret(payload: AddSecretPayload): Promise<any>;
-    getSecrets(integrationName: string): Promise<any>;
-    getBundles(integrationName: string): Promise<GetBundlesResponse>;
-    uploadBundle(integrationName: string, name: string, bundlePath: string): Promise<Bundle>;
-    deployBundle(integrationName: string, name: string): Promise<Bundle>;
-    promoteBundle(integrationName: string, version: number): Promise<Bundle>;
+    updateSecret(payload: AddSecretPayload): Promise<any>;
+    getSecrets(integrationName: string): Promise<string[]>;
+    initializeLogQuery(integrationName: string, params?: InitializeLogQueryParams): Promise<{
+        queryId: string;
+    }>;
+    getLogs(queryId: string, raw?: boolean): Promise<GetLogsResponse>;
+    cancelLogQuery(queryId: string): Promise<{
+        message: string;
+    }>;
+    getLogQueries(page?: number, pageSize?: number): Promise<GetLogQueriesResponse>;
 }

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

@@ -59,3 +59,118 @@ export type Integration = {
 export type GenereteDeleteTokenResponse = {
     deleteToken: string;
 };
+export type IntegrationDetail = {
+    integrationName: string;
+    enabled: boolean;
+    description: string;
+    runtime: string;
+    email: string;
+    liveBundle: string;
+    created: string;
+    status: string;
+};
+export type GetIntegrationsResponse = {
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    results: IntegrationDetail[];
+};
+export type EventInvocation = {
+    invocationID: string;
+    eventTime: string;
+    eventStatus: string;
+    eventName: string;
+    payloadUrl: string;
+    logsUrl: string;
+};
+export type GetEventHistoryParams = {
+    start?: string;
+    end?: string;
+    from?: string;
+    size?: number;
+    eventName?: string;
+    eventStatus?: string;
+};
+export type GetEventHistoryResponse = {
+    from: string | null;
+    count: number;
+    size: number;
+    events: EventInvocation[];
+};
+export type GetEventPayloadResponse = {
+    payload: Record<string, unknown>;
+};
+export type CustomEventSchedule = {
+    cron: string;
+};
+export type CustomEvent = {
+    eventName: string;
+    description?: string;
+    schedule?: CustomEventSchedule;
+};
+export type CustomEventUpdatePayload = {
+    description?: string;
+    schedule?: CustomEventSchedule;
+};
+export type GetCustomEventsResponse = {
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    results: CustomEvent[];
+};
+export type Webhook = {
+    webhookUrl: string;
+    eventName: string;
+    description: string;
+};
+export type CreateWebhookPayload = {
+    description?: string;
+};
+export type GetWebhooksResponse = {
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    results: Webhook[];
+};
+export type TriggerWebhookPayload = Record<string, unknown>;
+export type InitializeLogQueryParams = {
+    start?: number;
+    end?: number;
+    limit?: number;
+    sort?: 'asc' | 'desc';
+    q?: string;
+    queryName?: string;
+};
+export type LogEvent = {
+    timestamp: string;
+    message: string;
+    logStream: string;
+};
+export type GetLogsResponse = {
+    status: string;
+    statistics: {
+        recordsMatched: number;
+        recordsScanned: number;
+        bytesScanned: number;
+    };
+    events: LogEvent[];
+};
+export type LogQuery = {
+    queryId: string;
+    created: number;
+    createdBy: string;
+    startTime: number;
+    endTime: number;
+    integrationName: string;
+    queryName: string;
+    limit: number;
+    sort: string;
+    queryString: string;
+    status: string;
+};
+export type GetLogQueriesResponse = {
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    results: LogQuery[];
+};

package/dist/index.cjs

@@ -129,12 +129,27 @@ class ArcAuthor extends ArcAbstractAPI {
     constructor(options) {
         super({ ...options, apiPath: 'author' });
     }
+    async getAuthor(params) {
+        const { data } = await this.client.get('/v1/author-service', { params });
+        return data;
+    }
     async listAuthors(params) {
         const { data } = await this.client.get('/v2/author-service', { params });
         return data;
     }
-    async delete(userId) {
-        const { data } = await this.client.delete(`/v2/author-service/${userId}`);
+    async createAuthor(payload) {
+        const { data } = await this.client.post('/v2/author-service', payload);
+        return data;
+    }
+    async updateAuthor(id, payload) {
+        const { data } = await this.client.post(`/v2/author-service/${id}`, payload);
+        return data;
+    }
+    async deleteAuthor(id) {
+        await this.client.delete(`/v2/author-service/${id}`);
+    }
+    async getConfiguration() {
+        const { data } = await this.client.get('/v1/configuration');
         return data;
     }
 }
@@ -444,9 +459,22 @@ class ArcIFX extends ArcAbstractAPI {
     constructor(options) {
         super({ ...options, apiPath: 'ifx/api/v1' });
     }
+    // ---------------------------------------------------------------------------
+    // Integrations
+    // ---------------------------------------------------------------------------
     async createIntegration(payload) {
         await this.client.post('/admin/integration', payload);
     }
+    async getIntegration(integrationName) {
+        const { data } = await this.client.get(`/admin/integration/${integrationName}`);
+        return data;
+    }
+    async getIntegrations(page = 1, pageSize = 50) {
+        const { data } = await this.client.get('/admin/integration', {
+            params: { page, pageSize },
+        });
+        return data;
+    }
     async updateIntegration(integrationName, payload) {
         await this.client.put(`/admin/integration/${integrationName}`, payload);
     }
@@ -454,29 +482,45 @@ class ArcIFX extends ArcAbstractAPI {
         await this.client.delete(`/admin/integration/${integrationName}`, { params: { token } });
     }
     async generateDeleteIntegrationToken(integrationName) {
-        const response = await this.client.get(`/admin/integration/${integrationName}/token`);
-        return response.data;
+        const { data } = await this.client.get(`/admin/integration/${integrationName}/token`);
+        return data;
     }
-    async getIntegrations() {
-        const { data } = await this.client.get('/admin/integrations');
+    // ---------------------------------------------------------------------------
+    // Bundles
+    // ---------------------------------------------------------------------------
+    async getBundles(integrationName) {
+        const { data } = await this.client.get(`/admin/bundles/${integrationName}`);
         return data;
     }
-    async getJobs(integrationName) {
-        const { data } = await this.client.get(`/admin/jobs/status/${integrationName}`);
+    async uploadBundle(integrationName, name, bundlePath) {
+        const fs = await platform.fs();
+        const FormData = await platform.form_data();
+        const form = new FormData();
+        const bundle = fs.createReadStream(bundlePath);
+        form.append('bundle', bundle);
+        form.append('name', name);
+        const { data } = await this.client.post(`/admin/bundles/${integrationName}`, form, {
+            headers: form.getHeaders(),
+        });
         return data;
     }
-    async getStatus(integrationName) {
-        const { data } = await this.client.get(`/admin/integration/${integrationName}/provisionStatus`);
+    async deployBundle(integrationName, bundleName) {
+        const { data } = await this.client.post(`/admin/bundles/${integrationName}/deploy/${bundleName}`);
         return data;
     }
-    async initializeQuery(integrationName, query) {
-        const { data } = await this.client.get(`/admin/logs/integration/${integrationName}?${query}`);
+    async downloadBundle(integrationName, bundleName) {
+        const { data } = await this.client.get(`/admin/bundles/${integrationName}/download/${bundleName}`, {
+            responseType: 'arraybuffer',
+        });
         return data;
     }
-    async getLogs(queryId, raw = true) {
-        const { data } = await this.client.get('/admin/logs/results', { params: { queryId, raw } });
+    async promoteBundle(integrationName, version) {
+        const { data } = await this.client.post(`/admin/bundles/${integrationName}/promote/${version}`);
         return data;
     }
+    // ---------------------------------------------------------------------------
+    // Event Subscriptions
+    // ---------------------------------------------------------------------------
     async subscribe(payload) {
         const { data } = await this.client.post('/admin/events/subscriptions', payload);
         return data;
@@ -489,6 +533,69 @@ class ArcIFX extends ArcAbstractAPI {
         const { data } = await this.client.get('/admin/events/subscriptions');
         return data;
     }
+    // ---------------------------------------------------------------------------
+    // Events
+    // ---------------------------------------------------------------------------
+    async getEventPayload(integrationName, invocationId) {
+        const { data } = await this.client.get(`/eventdata/${integrationName}/${invocationId}`);
+        return data;
+    }
+    async getEventHistory(integrationName, params) {
+        const { data } = await this.client.get(`/admin/events/${integrationName}/history`, { params });
+        return data;
+    }
+    // ---------------------------------------------------------------------------
+    // Custom Events
+    // ---------------------------------------------------------------------------
+    async getCustomEvents(page = 1, pageSize = 50) {
+        const { data } = await this.client.get('/admin/events/custom', {
+            params: { page, pageSize },
+        });
+        return data;
+    }
+    async createCustomEvent(payload) {
+        const { data } = await this.client.post('/admin/events/custom', payload);
+        return data;
+    }
+    async updateCustomEvent(eventName, payload) {
+        const { data } = await this.client.put(`/admin/events/custom/${eventName}`, payload);
+        return data;
+    }
+    async deleteCustomEvent(eventName) {
+        const { data } = await this.client.delete(`/admin/events/custom/${eventName}`);
+        return data;
+    }
+    async deleteCustomEventSchedule(eventName) {
+        const { data } = await this.client.delete(`/admin/events/custom/${eventName}/schedule`);
+        return data;
+    }
+    // ---------------------------------------------------------------------------
+    // Webhooks
+    // ---------------------------------------------------------------------------
+    async getWebhooks(page = 1, pageSize = 50) {
+        const { data } = await this.client.get('/admin/events/custom/webhooks', {
+            params: { page, pageSize },
+        });
+        return data;
+    }
+    async createWebhook(eventName, payload) {
+        const { data } = await this.client.post(`/admin/events/custom/${eventName}/webhooks`, payload ?? {});
+        return data;
+    }
+    async updateWebhook(eventName, payload) {
+        const { data } = await this.client.put(`/admin/events/custom/${eventName}/webhooks`, payload);
+        return data;
+    }
+    async deleteWebhook(eventName) {
+        const { data } = await this.client.delete(`/admin/events/custom/${eventName}/webhooks`);
+        return data;
+    }
+    async triggerWebhook(uuid, payload) {
+        await this.client.post(`/webhook/${uuid}`, payload);
+    }
+    // ---------------------------------------------------------------------------
+    // Secrets
+    // ---------------------------------------------------------------------------
     async addSecret(payload) {
         const { data } = await this.client.post(`/admin/secret?integrationName=${payload.integrationName}`, {
             secretName: payload.secretName,
@@ -496,34 +603,40 @@ class ArcIFX extends ArcAbstractAPI {
         });
         return data;
     }
+    async updateSecret(payload) {
+        const { data } = await this.client.put(`/admin/secret?integrationName=${payload.integrationName}`, {
+            secretName: payload.secretName,
+            secretValue: payload.secretValue,
+        });
+        return data;
+    }
     async getSecrets(integrationName) {
-        const { data } = await this.client.get(`/admin/secret?integrationName=${integrationName}`);
+        const { data } = await this.client.get(`/admin/secret`, { params: { integrationName } });
         return data;
     }
-    async getBundles(integrationName) {
-        const { data } = await this.client.get(`/admin/bundles/${integrationName}`);
+    // ---------------------------------------------------------------------------
+    // Logs
+    // ---------------------------------------------------------------------------
+    async initializeLogQuery(integrationName, params) {
+        const { data } = await this.client.get(`/admin/logs/integration/${integrationName}`, { params });
         return data;
     }
-    async uploadBundle(integrationName, name, bundlePath) {
-        const fs = await platform.fs();
-        const FormData = await platform.form_data();
-        const form = new FormData();
-        console.log('platform', platform);
-        console.log(form);
-        const bundle = fs.createReadStream(bundlePath);
-        form.append('bundle', bundle);
-        form.append('name', name);
-        const { data } = await this.client.post(`/admin/bundles/${integrationName}`, form, {
-            headers: form.getHeaders(),
+    async getLogs(queryId, raw = false) {
+        const { data } = await this.client.get('/admin/logs/results', {
+            params: { queryId, raw },
         });
         return data;
     }
-    async deployBundle(integrationName, name) {
-        const { data } = await this.client.post(`/admin/bundles/${integrationName}/deploy/${name}`);
+    async cancelLogQuery(queryId) {
+        const { data } = await this.client.delete('/admin/logs/cancel', {
+            params: { queryId },
+        });
         return data;
     }
-    async promoteBundle(integrationName, version) {
-        const { data } = await this.client.post(`/admin/bundles/${integrationName}/promote/${version}`);
+    async getLogQueries(page, pageSize) {
+        const { data } = await this.client.get('/admin/logs/queries', {
+            params: { page, pageSize },
+        });
         return data;
     }
 }