swoop-common 2.1.89 → 2.1.91

package/README.md

@@ -1,9 +1,9 @@
 # Swoop Library
 
-This library is used for rendering **Swoop itinerary templates**. 
-It provides tools for defining **custom field types**, registering **custom components**, 
-rendering templates from a **MasterSchema**, and includes SDKs for all related services. 
-It supports both input mode (for creating templates) and presentation mode (for rendering them for end users). 
+This library is used for rendering **Swoop itinerary templates**.
+It provides tools for defining **custom field types**, registering **custom components**,
+rendering templates from a **MasterSchema**, and includes SDKs for all related services.
+It supports both input mode (for creating templates) and presentation mode (for rendering them for end users).
 The schema system is stage-aware, enabling precise control over what data is editable or displayed at which stage.
 
 > Note: This package is intended for internal use only.
@@ -17,12 +17,11 @@ The schema system is stage-aware, enabling precise control over what data is edi
 Before using the Swoop Library, you must initialize it with service URLs:
 
 ```ts
-import { init } from 'swoop-common';
+import { init } from "swoop-common";
 
 init({
-  itineraryServiceUrl: 'https://your.itinerary.service',
-  coreServiceUrl: 'https://your.core.service',
-  swoopServiceForwardUrl: 'https://your.forward.service'
+  coreServiceUrl: "https://your.core.service",
+  swoopServiceForwardUrl: "https://your.forward.service",
 });
 ```
 
@@ -31,7 +30,6 @@ init({
 The library provides three primary service interfaces to interact with backend systems:
 
 - **SwoopService** — Interfaces with the Swoop API.
-- **ItineraryService** — For itinerary service.
 - **CoreService** — For core service.
 
 These interfaces offer convenient methods to work seamlessly with the underlying services required by the itinerary system.
@@ -41,7 +39,7 @@ These interfaces offer convenient methods to work seamlessly with the underlying
 The `StyledFormView` component is the entry point for rendering a full itinerary template. It handles schema parsing and renderer injection based on mode and form stage.
 
 ```tsx
-import { StyledFormView } from 'your-form-library';
+import { StyledFormView } from "your-form-library";
 
 <StyledFormView
   initialData={/* object */}
@@ -50,19 +48,19 @@ import { StyledFormView } from 'your-form-library';
   pool="FORM"
   readonly={false}
   stage="Inst"
-/>
+/>;
 ```
 
 ### Props
 
-| Name         | Type                          | Description                                                                 |
-|--------------|-------------------------------|-----------------------------------------------------------------------------|
-| initialData  | `any`                         | Initial values for the template. Should not be updated frequently.          |
-| schema       | `MasterSchema`                | Template definition object.                                                 |
-| onChange     | `(val: any) => void`          | Callback with updated data.                                                 |
-| pool         | `ComponentPool`               | `"FORM"` or `"PRESENTATION"` depending on context.                          |
-| readonly     | `boolean`                     | Disables inputs if true (only relevant in FORM pool).                       |
-| stage        | `Stage`                       | Controls which data segment is being rendered.                              |
+| Name        | Type                 | Description                                                        |
+| ----------- | -------------------- | ------------------------------------------------------------------ |
+| initialData | `any`                | Initial values for the template. Should not be updated frequently. |
+| schema      | `MasterSchema`       | Template definition object.                                        |
+| onChange    | `(val: any) => void` | Callback with updated data.                                        |
+| pool        | `ComponentPool`      | `"FORM"` or `"PRESENTATION"` depending on context.                 |
+| readonly    | `boolean`            | Disables inputs if true (only relevant in FORM pool).              |
+| stage       | `Stage`              | Controls which data segment is being rendered.                     |
 
 ### Stages
 
@@ -83,7 +81,13 @@ Custom components define how individual fields render. These can behave like typ
 ### Example
 
 ```tsx
-const FormExample: React.FC<Props> = ({ text, onChange, getError, label, enabled }) => {
+const FormExample: React.FC<Props> = ({
+  text,
+  onChange,
+  getError,
+  label,
+  enabled,
+}) => {
   const [val, setVal] = useState(text);
   const error = getError ? getError("example")?.message : undefined;
   const onChangeDebounced = useMemo(() => debounce(onChange, 300), [onChange]);
@@ -94,9 +98,18 @@ const FormExample: React.FC<Props> = ({ text, onChange, getError, label, enabled
   };
 
   return (
-    <Paper sx={{ display: 'flex', flexDirection: 'column', gap: 1, p: 2, background: "#CBC3E3", mb: 1 }}>
+    <Paper
+      sx={{
+        display: "flex",
+        flexDirection: "column",
+        gap: 1,
+        p: 2,
+        background: "#CBC3E3",
+        mb: 1,
+      }}
+    >
       {!enabled && "THIS IS DISABLED"}
-      <Typography variant='h6'>{label}</Typography>
+      <Typography variant="h6">{label}</Typography>
       <TextField
         label="Example label"
         value={val}
@@ -109,7 +122,13 @@ const FormExample: React.FC<Props> = ({ text, onChange, getError, label, enabled
   );
 };
 
-const FormRendererExample: React.FC<ControlProps> = ({ data, handleChange, path, label, enabled }) => {
+const FormRendererExample: React.FC<ControlProps> = ({
+  data,
+  handleChange,
+  path,
+  label,
+  enabled,
+}) => {
   const getError = useLocalErrors(path);
   return (
     <FormExample
@@ -126,7 +145,7 @@ registerComponent("example", FormRendererExample, ComponentPool.FORM);
 registerComponent("example", FormRendererExample, ComponentPool.PRESENTATION);
 ```
 
-> Important: You **cannot register two components with the same name within the same pool**. You *can* register the same component name across different pools (e.g., `"example"` in both `"FORM"` and `"PRESENTATION"`).
+> Important: You **cannot register two components with the same name within the same pool**. You _can_ register the same component name across different pools (e.g., `"example"` in both `"FORM"` and `"PRESENTATION"`).
 
 ### Presentation Pool
 
@@ -142,18 +161,20 @@ Custom field types define what kinds of fields can be used when **building a tem
 
 ```ts
 registerType(
-  "typeId",             // Unique type string
-  "Display Name",       // Name shown in template builder
-  schema,               // JSON Schema defining the data structure
-  optionsSchema,        // JSON Schema defining configuration data structure
-  requiredOptions       // boolean: must the options be filled?
+  "typeId", // Unique type string
+  "Display Name", // Name shown in template builder
+  schema, // JSON Schema defining the data structure
+  optionsSchema, // JSON Schema defining configuration data structure
+  requiredOptions // boolean: must the options be filled?
 );
 ```
 
 ### Example
 
 ```ts
-registerType("enum", "Dropdown",
+registerType(
+  "enum",
+  "Dropdown",
   { type: "array" },
   {
     type: "object",
@@ -162,9 +183,9 @@ registerType("enum", "Dropdown",
       enumValues: {
         title: "Dropdown Values",
         type: "array",
-        items: { type: "string" }
-      }
-    }
+        items: { type: "string" },
+      },
+    },
   },
   true
 );
@@ -176,7 +197,7 @@ This type defines a dropdown field where the values are defined via the `enumVal
 
 If you want to render a **custom options block** (i.e., how the field type's options are displayed in the template editor), you must do the following:
 
-1. In the top-level `optionsSchema` of the type, define `"x-type": "yourTypeName"`  
+1. In the top-level `optionsSchema` of the type, define `"x-type": "yourTypeName"`
 2. Create and register a custom component with the name `"yourTypeName"` in the `"FORM"` pool.
 
 This component will then be used to render the configuration UI for that field type.

package/dist/api/generated/core/core/OpenAPI.js

@@ -1,6 +1,6 @@
 export const OpenAPI = {
     BASE: 'http://localhost:8080/core-data-service/v1',
-    VERSION: '1',
+    VERSION: '1.0.0',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/api/generated/core/index.d.ts

@@ -97,7 +97,11 @@ export { UrgencyCTA } from './models/UrgencyCTA';
 export type { UserComponentInstanceField } from './models/UserComponentInstanceField';
 export type { ValidationSchemas } from './models/ValidationSchemas';
 export type { VersionPathParam } from './models/VersionPathParam';
+export { AuditService } from './services/AuditService';
 export { ComponentService } from './services/ComponentService';
 export { CoreService } from './services/CoreService';
+export { ItineraryService } from './services/ItineraryService';
+export { RegionService } from './services/RegionService';
+export { SnapshotService } from './services/SnapshotService';
 export { SwooperService } from './services/SwooperService';
 export { TemplateService } from './services/TemplateService';

package/dist/api/generated/core/index.js

@@ -13,7 +13,11 @@ export { Meals } from './models/Meals';
 export { OrderQueryParam } from './models/OrderQueryParam';
 export { OrgId } from './models/OrgId';
 export { UrgencyCTA } from './models/UrgencyCTA';
+export { AuditService } from './services/AuditService';
 export { ComponentService } from './services/ComponentService';
 export { CoreService } from './services/CoreService';
+export { ItineraryService } from './services/ItineraryService';
+export { RegionService } from './services/RegionService';
+export { SnapshotService } from './services/SnapshotService';
 export { SwooperService } from './services/SwooperService';
 export { TemplateService } from './services/TemplateService';

package/dist/api/generated/core/models/DTOItineraryCreate.d.ts

@@ -1,10 +1,12 @@
 import type { ComponentInstance } from './ComponentInstance';
 import type { Discount } from './Discount';
+import type { EnquiryId } from './EnquiryId';
 import type { Fee } from './Fee';
 import type { ItineraryValue } from './ItineraryValue';
 import type { QuoteOptions } from './QuoteOptions';
 import type { Title } from './Title';
 export type DTOItineraryCreate = {
+    enquiryId?: EnquiryId;
     title: Title;
     welcomeNote?: string;
     values?: Array<ItineraryValue>;

package/dist/api/generated/core/models/DTOSwooperCreate.d.ts

@@ -4,7 +4,10 @@ import type { SwooperExperience } from './SwooperExperience';
 import type { SwooperInfo } from './SwooperInfo';
 import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
 export type DTOSwooperCreate = {
-    avatar: string;
+    portrait?: string;
+    avatar?: string;
+    banner?: string;
+    bio?: string;
     name: string;
     fullName: string;
     media?: Media;

package/dist/api/generated/core/models/DTOSwooperEntity.d.ts

@@ -8,7 +8,10 @@ import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
 export type DTOSwooperEntity = {
     id: SwooperId;
     metadata: Metadata;
+    portrait: string;
     avatar: string;
+    banner: string;
+    bio: string;
     name: string;
     fullName: string;
     media: Media;

package/dist/api/generated/core/models/DTOSwooperRead.d.ts

@@ -8,7 +8,10 @@ import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
 export type DTOSwooperRead = {
     id: SwooperId;
     metadata: Metadata;
-    avatar: string;
+    portrait?: string;
+    avatar?: string;
+    banner?: string;
+    bio?: string;
     name: string;
     fullName: string;
     media: Media;

package/dist/api/generated/core/models/DTOSwooperUpdate.d.ts

@@ -4,7 +4,10 @@ import type { SwooperExperience } from './SwooperExperience';
 import type { SwooperInfo } from './SwooperInfo';
 import type { SwooperPersonalInfo } from './SwooperPersonalInfo';
 export type DTOSwooperUpdate = {
+    portrait?: string;
     avatar?: string;
+    banner?: string;
+    bio?: string;
     name?: string;
     fullName?: string;
     media?: Media;

package/dist/api/generated/core/services/ComponentService.d.ts

@@ -49,7 +49,7 @@ export declare class ComponentService {
     static componentUpdateAsNewRevision(componentId: ComponentId, requestBody: DTOComponentUpdate): CancelablePromise<DTOComponentRead>;
     /**
      * Update Component
-     * Updates an component
+     * Updates a component
      * @param componentId Id of a component
      * @param requestBody
      * @returns DTOComponentRead When a component is updated successfully

package/dist/api/generated/core/services/ComponentService.js

@@ -16,7 +16,7 @@ export class ComponentService {
     static componentList(page, limit, order, sort, search, on) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/components',
+            url: '/component',
             query: {
                 'page': page,
                 'limit': limit,
@@ -43,7 +43,7 @@ export class ComponentService {
     static componentCreate(requestBody) {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/components',
+            url: '/component',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -64,7 +64,7 @@ export class ComponentService {
     static componentGet(componentId) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/components/{componentId}',
+            url: '/component/{componentId}',
             path: {
                 'componentId': componentId,
             },
@@ -85,8 +85,8 @@ export class ComponentService {
      */
     static componentUpdateAsNewRevision(componentId, requestBody) {
         return __request(OpenAPI, {
-            method: 'PATCH',
-            url: '/components/{componentId}',
+            method: 'PUT',
+            url: '/component/{componentId}',
             path: {
                 'componentId': componentId,
             },
@@ -103,7 +103,7 @@ export class ComponentService {
     }
     /**
      * Update Component
-     * Updates an component
+     * Updates a component
      * @param componentId Id of a component
      * @param requestBody
      * @returns DTOComponentRead When a component is updated successfully
@@ -111,8 +111,8 @@ export class ComponentService {
      */
     static componentUpdate(componentId, requestBody) {
         return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/components/{componentId}',
+            method: 'PATCH',
+            url: '/component/{componentId}',
             path: {
                 'componentId': componentId,
             },
@@ -137,7 +137,7 @@ export class ComponentService {
     static componentDelete(componentId) {
         return __request(OpenAPI, {
             method: 'DELETE',
-            url: '/components/{componentId}',
+            url: '/component/{componentId}',
             path: {
                 'componentId': componentId,
             },
@@ -161,7 +161,7 @@ export class ComponentService {
     static componentStateUpdate(componentId, state) {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/components/{componentId}/state',
+            url: '/component/{componentId}/state',
             path: {
                 'componentId': componentId,
             },

package/dist/api/generated/core/services/CoreService.d.ts

@@ -1,19 +1,189 @@
+import type { Branches } from '../models/Branches';
+import type { BranchTag } from '../models/BranchTag';
 import type { ComponentId } from '../models/ComponentId';
 import type { ComponentState } from '../models/ComponentState';
 import type { DTOComponentCreate } from '../models/DTOComponentCreate';
 import type { DTOComponentRead } from '../models/DTOComponentRead';
 import type { DTOComponentUpdate } from '../models/DTOComponentUpdate';
+import type { DTOItineraryCreate } from '../models/DTOItineraryCreate';
+import type { DTOItineraryRead } from '../models/DTOItineraryRead';
+import type { DTOItineraryUpdate } from '../models/DTOItineraryUpdate';
+import type { DTORegionCreate } from '../models/DTORegionCreate';
+import type { DTORegionRead } from '../models/DTORegionRead';
+import type { DTOSnapshotCreate } from '../models/DTOSnapshotCreate';
+import type { DTOSnapshotRead } from '../models/DTOSnapshotRead';
 import type { DTOSwooperCreate } from '../models/DTOSwooperCreate';
 import type { DTOSwooperRead } from '../models/DTOSwooperRead';
 import type { DTOSwooperUpdate } from '../models/DTOSwooperUpdate';
 import type { DTOTemplateCreate } from '../models/DTOTemplateCreate';
 import { DTOTemplateRead } from '../models/DTOTemplateRead';
 import type { DTOTemplateUpdate } from '../models/DTOTemplateUpdate';
+import type { EnquiryId } from '../models/EnquiryId';
+import type { ItineraryId } from '../models/ItineraryId';
 import type { Pagination } from '../models/Pagination';
+import type { SnapshotId } from '../models/SnapshotId';
 import type { SwooperId } from '../models/SwooperId';
 import type { TemplateId } from '../models/TemplateId';
 import { CancelablePromise } from '../core/CancelablePromise';
 export declare class CoreService {
+    /**
+     * Audit a Copy to Clipboard
+     * Audits when a user copies something to their clipboard
+     * @param itineraryId Itinerary Id
+     * @param content Base64 encoding of the copied content
+     * @returns void
+     * @throws ApiError
+     */
+    auditCopyClipboard(itineraryId: ItineraryId, content: string): CancelablePromise<void>;
+    /**
+     * Create a Snapshot
+     * Creates a new snapshot. A snapshot is a reference to a specific itinerary revision group id.
+     * @param requestBody
+     * @returns DTOSnapshotRead When a snapshot is created
+     * @throws ApiError
+     */
+    snapshotCreate(requestBody: DTOSnapshotCreate): CancelablePromise<DTOSnapshotRead>;
+    /**
+     * List Snapshots
+     * List all available snapshots relating to the query params
+     * @param enquiryId
+     * @param page Pagination, starting at page 1
+     * @param limit Number of items per page
+     * @param order Order the sort query parameter values either by ascending or descending order
+     * @param sort List of fields to sort by, this requires the order query param
+     * @param search The search strings to apply to the on query parameter values
+     * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
+     * @returns any The list of all snapshots given the parameters used
+     * @throws ApiError
+     */
+    snapshotList(enquiryId?: string, page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        snapshots?: Array<DTOSnapshotRead>;
+    }>;
+    /**
+     * Get Snapshot va ID
+     * Returns the specific snapshot given its Id
+     * @param snapshotId
+     * @returns any OK
+     * @throws ApiError
+     */
+    snapshotGet(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
+    /**
+     * Delete Snapshot via ID
+     * Deletes a specific snapshot given its Id
+     * @param snapshotId
+     * @returns void
+     * @throws ApiError
+     */
+    snapshotDelete(snapshotId: SnapshotId): CancelablePromise<void>;
+    /**
+     * Restore Snapshot
+     * Creates a new itinerary revision given the content the snapshot refers to
+     * @param snapshotId
+     * @returns any When a snapshot is restored as the latest version
+     * @throws ApiError
+     */
+    snapshotRestore(snapshotId: SnapshotId): CancelablePromise<{
+        snapshot?: DTOSnapshotRead;
+        itinerary?: DTOItineraryRead;
+    }>;
+    /**
+     * List Tree view of Itineraries
+     * List all itineraries in a tree view for a specific enquiry id
+     * @param enquiryId Enquiry Id
+     * @returns any The tree list view of all itineraries given the parameters used
+     * @throws ApiError
+     */
+    itineraryList(enquiryId: EnquiryId): CancelablePromise<{
+        tree?: Array<Branches>;
+    }>;
+    /**
+     * Create an Itinerary on an Enquiry
+     * Creates a new itinerary on an Enquiry
+     * @param enquiryId Enquiry Id
+     * @param requestBody
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns any When a itinerary is created
+     * @throws ApiError
+     */
+    itineraryCreate(enquiryId: EnquiryId, requestBody: DTOItineraryCreate, error?: number): CancelablePromise<{
+        itinerary?: DTOItineraryRead;
+        tag?: BranchTag;
+        enquiryId?: EnquiryId;
+    }>;
+    /**
+     * Get Itinerary
+     * Get itinerary via ID
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @returns any The corresponding itinerary that matches the enquiry id, tag, and version
+     * @throws ApiError
+     */
+    itineraryGet(enquiryId: EnquiryId, tag: string, version: string): CancelablePromise<any>;
+    /**
+     * Update Itinerary as New Revision
+     * Updates an itinerary as a new revision on the latest version of a branch
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param requestBody
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead When a new revision is created successfully
+     * @throws ApiError
+     */
+    itineraryUpdateAsNewRevision(enquiryId: EnquiryId, tag: string, requestBody: DTOItineraryUpdate, error?: number): CancelablePromise<DTOItineraryRead>;
+    /**
+     * Fork an Itinerary
+     * this will create a new sub branch off the corresponding itinerary (enquiry id/tag/version)
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns any When the fork was successful
+     * @throws ApiError
+     */
+    forkItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<{
+        itinerary?: DTOItineraryRead;
+        tag?: BranchTag;
+        enquiryId?: EnquiryId;
+    }>;
+    /**
+     * Promote an Itinerary
+     * This will take itinerary that matches the enquiry id, tag, and version to create a new revision on the head of it's parent branch. This will delete the old sub branch that is being promoted as will exist as the new main head of its parent. Promotions of any tag will always promote into the main branch.
+     * @param enquiryId Enquiry Id
+     * @param tag the branch tag
+     * @param version the version of a branch
+     * @param error error can be set to 1, 100, 101, 200, and 201 to mock sync error responses
+     * @returns DTOItineraryRead The new head of the parent branch
+     * @throws ApiError
+     */
+    promoteItinerary(enquiryId: EnquiryId, tag: string, version: string, error?: number): CancelablePromise<DTOItineraryRead>;
+    /**
+     * List Regions
+     * List all regions
+     * @param page Pagination, starting at page 1
+     * @param limit Number of items per page
+     * @param order Order the sort query parameter values either by ascending or descending order
+     * @param sort List of fields to sort by, this requires the order query param
+     * @param search The search strings to apply to the on query parameter values
+     * @param on The fields to apply the search to, the list follows the order and length of the search values in the search query
+     * @returns any OK
+     * @throws ApiError
+     */
+    regionList(page?: number, limit?: number, order?: 'asc' | 'desc', sort?: any[], search?: Array<string>, on?: Array<string>): CancelablePromise<{
+        data?: Array<DTORegionRead>;
+        pagination?: Pagination;
+    }>;
+    /**
+     * Create Region
+     * Create a region
+     * @param requestBody
+     * @returns DTORegionRead OK
+     * @throws ApiError
+     */
+    regionCreate(requestBody?: DTORegionCreate): CancelablePromise<DTORegionRead>;
     /**
      * List Templates
      * List all available templates
@@ -106,7 +276,7 @@ export declare class CoreService {
     componentUpdateAsNewRevision(componentId: ComponentId, requestBody: DTOComponentUpdate): CancelablePromise<DTOComponentRead>;
     /**
      * Update Component
-     * Updates an component
+     * Updates a component
      * @param componentId Id of a component
      * @param requestBody
      * @returns DTOComponentRead When a component is updated successfully